NoBorders.hs: info and documentation

darcs-hash:20070614144200-32816-6b78e41214d282adaabfd5f500014f1ee74b6f8d.gz

1 files changed, 25 insertions, 7 deletions

diff --git a/NoBorders.hs b/NoBorders.hs
index 7d34cfe..e0862f8 100644
--- a/NoBorders.hs
+++ b/NoBorders.hs
@@ -1,15 +1,26 @@
-module XMonadContrib.NoBorders ( noBorders, withBorder ) where
-
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.NoBorders
+-- Copyright   :  (c) David Roundy <droundy@darcs.net>
+-- License     :  BSD3-style (see LICENSE)
+--
+-- Maintainer  :  David Roundy <droundy@darcs.net>
+-- Stability   :  unstable
+-- Portability :  unportable
+--
 -- Make a given layout display without borders.  This is useful for
 -- full-screen or tabbed layouts, where you don't really want to waste a
 -- couple of pixels of real estate just to inform yourself that the visible
 -- window has focus.
+--
+-----------------------------------------------------------------------------
 
--- Usage:
-
--- import XMonadContrib.NoBorders
-
--- layouts = [ noBorders full, tall, ... ]
+module XMonadContrib.NoBorders (
+                                -- * Usage
+                                -- $usage
+                                noBorders, 
+                                withBorder 
+                               ) where
 
 import Control.Monad.State ( gets )
 import Graphics.X11.Xlib
@@ -19,6 +30,13 @@ import Operations ( UnDoLayout(UnDoLayout) )
 import qualified StackSet as W
 import {-# SOURCE #-} Config (borderWidth)
 
+-- $usage
+-- You can use this module with the following in your Config.hs file:
+--
+-- > import XMonadContrib.NoBorders
+--
+-- > layouts = [ noBorders full, tall, ... ]
+
 noBorders :: Layout -> Layout
 noBorders = withBorder 0