NamedWindows.hs: info and documentation

darcs-hash:20070614144135-32816-802403aac2a2059780a0c9a18bee1240cee47dee.gz

1 files changed, 26 insertions, 3 deletions

diff --git a/NamedWindows.hs b/NamedWindows.hs
index c2aa910..d807a0c 100644
--- a/NamedWindows.hs
+++ b/NamedWindows.hs
@@ -1,7 +1,26 @@
-module XMonadContrib.NamedWindows ( NamedWindow, getName, withNamedWindow, unName ) where
-
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.NamedWindows
+-- Copyright   :  (c) David Roundy <droundy@darcs.net>
+-- License     :  BSD3-style (see LICENSE)
+--
+-- Maintainer  :  David Roundy <droundy@darcs.net>
+-- Stability   :  unstable
+-- Portability :  unportable
+--
 -- This module allows you to associate the X titles of windows with
--- them.  See XMonadContrib.Mosaic for an example of its use.
+-- them.
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.NamedWindows (
+                                   -- * Usage
+                                   -- $usage
+                                   NamedWindow, 
+                                   getName, 
+                                   withNamedWindow, 
+                                   unName 
+                                  ) where
 
 import Control.Monad.Reader ( asks )
 import Control.Monad.State ( gets )
@@ -13,6 +32,10 @@ import Graphics.X11.Xlib.Extras ( fetchName )
 
 import XMonad
 
+-- $usage
+--   See "XMonadContrib.Mosaic" for an example of its use.
+
+
 data NamedWindow = NW !String !Window
 instance Eq NamedWindow where
     (NW s _) == (NW s' _) = s == s'