HintedTile.hs: info and documentation

darcs-hash:20070614144019-32816-c10be6884bfc25bed84c8e6bce50b69f86c409d2.gz

1 files changed, 24 insertions, 1 deletions

diff --git a/HintedTile.hs b/HintedTile.hs
index 22ea946..6ec408e 100644
--- a/HintedTile.hs
+++ b/HintedTile.hs
@@ -1,4 +1,22 @@
-module XMonadContrib.HintedTile (tall, wide) where
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.HintedTile
+-- Copyright   :  (c) Peter De Wachter <pdewacht@gmail.com>
+-- License     :  BSD3-style (see LICENSE)
+--
+-- Maintainer  :  Peter De Wachter <pdewacht@gmail.com>
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- A gapless tiled layout that attempts to obey window size hints, 
+-- rather than simply ignoring them.
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.HintedTile (
+                                 -- * Usage
+                                 -- $usage
+                                 tall, wide) where
 
 import XMonad
 import Operations (Resize(..), IncMasterN(..), applySizeHints)
@@ -8,6 +26,11 @@ import Graphics.X11.Xlib
 import Graphics.X11.Xlib.Extras
 import Control.Monad
 
+-- $usage
+-- You can use this module with the following in your Config.hs file:
+--
+-- > import XMonadContrib.HintedTile
+
 -- this sucks
 addBorder, substractBorder :: (Dimension, Dimension) -> (Dimension, Dimension)
 addBorder (w, h) = (w + 2 * borderWidth, h + 2 * borderWidth)