template for module information e documentation

darcs-hash:20070613131029-32816-c60792d6cdcabc37ca1bc5ffa9d61c6babf84cc0.gz

1 files changed, 28 insertions, 10 deletions

diff --git a/Tabbed.hs b/Tabbed.hs
index adcb470..d62a591 100644
--- a/Tabbed.hs
+++ b/Tabbed.hs
@@ -1,14 +1,22 @@
-module XMonadContrib.Tabbed ( tabbed ) where
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.Tabbed
+-- Copyright   :  (c) David Roundy
+-- License     :  ??? GPL 2 ???
+-- 
+-- Maintainer  :  email@address.com
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- A tabbed layout for the Xmonad Window Manager 
+--
+-----------------------------------------------------------------------------
 
--- This module defines a tabbed layout.
-
--- You can use this module with the following in your config file:
-
--- import XMonadContrib.Tabbed
-
--- defaultLayouts :: [Layout]
--- defaultLayouts = [ tabbed
---                  , ... ]
+module XMonadContrib.Tabbed ( 
+                             -- * Usage:
+                             -- $usage
+                             tabbed
+                            ) where
 
 import Control.Monad ( forM, liftM )
 import Control.Monad.State ( gets )
@@ -21,6 +29,16 @@ import qualified StackSet as W
 
 import XMonadContrib.NamedWindows
 
+-- $usage
+-- You can use this module with the following in your configuration file:
+--
+-- > import XMonadContrib.Tabbed
+--
+-- > defaultLayouts :: [Layout]
+-- > defaultLayouts = [ tabbed
+-- >                 , ... ]
+
+
 tabbed :: Layout
 tabbed =  Layout { doLayout = dolay, modifyLayout = const (return Nothing) }