added info to Commands.hs

Haddock stuff.

darcs-hash:20070613190908-32816-e64687cb5102b479a97da7897d26406366f76c0f.gz

1 files changed, 27 insertions, 18 deletions

diff --git a/Commands.hs b/Commands.hs
index e9b5452..03aec49 100644
--- a/Commands.hs
+++ b/Commands.hs
@@ -2,50 +2,59 @@
 -- |
 -- Module      :  XMonadContrib.Commands
 -- Copyright   :  (c) David Glasser 2007
+-- License     :  BSD3
 -- 
 -- Maintainer  :  glasser@mit.edu
 -- Stability   :  stable
 -- Portability :  portable
 --
------------------------------------------------------------------------------
---
 -- Allows you to run internal xmonad commands (X () actions) using
 -- a dmenu menu in addition to key bindings.  Requires dmenu and
 -- the Dmenu XMonadContrib module.
 --
+-----------------------------------------------------------------------------
+
+module XMonadContrib.Commands (
+                             -- * Usage
+                             -- $usage
+                             runCommand,
+                             defaultCommands
+                              ) where
+  
+import XMonad
+import Operations
+import {-# SOURCE #-} Config (workspaces, commands)
+import XMonadContrib.Dmenu (dmenu)
+
+import qualified Data.Map as M
+import System.Exit
+import Data.Maybe
+
+-- $usage
+--
 -- To use, modify your Config.hs to:
 --
---      import XMonadContrib.Commands
+-- >    import XMonadContrib.Commands
 --
 -- and add a keybinding to the runCommand action:
 --
---     , ((modMask .|. controlMask, xK_y), runCommand)
+-- >    , ((modMask .|. controlMask, xK_y), runCommand)
 --
 -- and define the list commands:
 --
---     commands = defaultCommands
+-- >    commands = defaultCommands
 --
 -- Finally, add the following lines to Config.hs-boot:
 -- 
---     import XMonad (X)
---     workspaces  :: Int
---     commands    :: [(String, X ())]
+-- >   import XMonad (X)
+-- >    workspaces  :: Int
+-- >    commands    :: [(String, X ())]
 --
 -- A popup menu of internal xmonad commands will appear.  You can
 -- change the commands by changing the contents of the list
 -- 'commands'.  (If you like it enough, you may even want to get rid
 -- of many of your other key bindings!)
 
-module XMonadContrib.Commands where
-
-import XMonad
-import Operations
-import {-# SOURCE #-} Config (workspaces, commands)
-import XMonadContrib.Dmenu (dmenu)
-
-import qualified Data.Map as M
-import System.Exit
-import Data.Maybe
 
 commandMap :: M.Map String (X ())
 commandMap = M.fromList commands