FindEmptyWorkspace.hs: info and documentation

darcs-hash:20070614143909-32816-8196ba0b7dde6a56585ecc39c045b79f80656ff1.gz

1 files changed, 21 insertions, 15 deletions

diff --git a/FindEmptyWorkspace.hs b/FindEmptyWorkspace.hs
index d94d0a8..2240d41 100644
--- a/FindEmptyWorkspace.hs
+++ b/FindEmptyWorkspace.hs
@@ -5,25 +5,16 @@
 -- License     :  BSD3-style (see LICENSE)
 --
 -- Maintainer  :  arcatan@kapsi.fi
+-- Stability   :  unstable
+-- Portability :  unportable
 --
------------------------------------------------------------------------------
---
--- Find an empty workspace in xmonad.
---
--- To use, modify your Config.hs to:
---
---     import XMonadContrib.FindEmptyWorkspace
---
--- and add a keybinding:
---
---     , ((modMask,                xK_m    ), viewEmptyWorkspace)
---     , ((modMask .|. shiftMask,  xK_m    ), tagToEmptyWorkspace)
---
--- Now you can jump to an empty workspace with mod-m. Mod-shift-m will
--- tag the current window to an empty workspace and view it.
+-- Find an empty workspace in XMonad.
 --
+-----------------------------------------------------------------------------
 
 module XMonadContrib.FindEmptyWorkspace (
+    -- * Usage
+    -- $usage
     viewEmptyWorkspace, tagToEmptyWorkspace
   ) where
 
@@ -36,6 +27,21 @@ import StackSet
 
 import qualified Operations as O
 
+-- $usage
+-- 
+-- To use, modify your Config.hs to:
+--
+-- >   import XMonadContrib.FindEmptyWorkspace
+--
+-- and add a keybinding:
+--
+--  >   , ((modMask,                xK_m    ), viewEmptyWorkspace)
+--  >   , ((modMask .|. shiftMask,  xK_m    ), tagToEmptyWorkspace)
+--
+-- Now you can jump to an empty workspace with mod-m. Mod-shift-m will
+-- tag the current window to an empty workspace and view it.
+
+
 -- | Find the first hidden empty workspace in a StackSet. Returns
 -- Nothing if all workspaces are in use. Function searches currently
 -- focused workspace, other visible workspaces (when in Xinerama) and