BackCompat.hs info e documentation

darcs-hash:20070614064850-32816-56d53ce021acf3932d5c89d8275ba7be0a55236b.gz

1 files changed, 28 insertions, 7 deletions

diff --git a/BackCompat.hs b/BackCompat.hs
index b743b83..bb0e99b 100644
--- a/BackCompat.hs
+++ b/BackCompat.hs
@@ -1,14 +1,35 @@
-module XMonadContrib.BackCompat (forM, forM_) where
-
-{- This file will contain all the things GHC 6.4 users need to compile xmonad.
- - Currently, the steps to get compilation are:
- - add the following line to StackSet.hs, Operations.hs, and Main.hs:
- - import XMonadContrib.BackCompat
- -}
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.BackCompat
+-- Copyright   :  (c) daniel@wagner-home.com
+-- License     :  BSD-style (see xmonad/LICENSE)
+-- 
+-- Maintainer  :  daniel@wagner-home.com
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- A module that provides back compatibility with GHC 6.4
+--
+-----------------------------------------------------------------------------
+module XMonadContrib.BackCompat (
+                                 -- * Usage
+                                 -- $usage
+                                 forM, forM_
+                                ) where
 
 import Data.Map (Map, fromList)
 import GHC.Read
 
+{- $usage
+ 
+This file will contain all the things GHC 6.4 users need to compile xmonad.
+Currently, the steps to get compilation are:
+add the following line to StackSet.hs, Operations.hs, and Main.hs:
+
+> import XMonadContrib.BackCompat
+
+-}
+
 forM_ :: (Monad m) => [a] -> (a -> m b) -> m ()
 forM_ = flip mapM_