MagicFocus.hs: add module header and usage instructions.

darcs-hash:20070618205421-ea16c-4882c1f204419027d8014525d087308ebc743448.gz

1 files changed, 21 insertions, 1 deletions

diff --git a/MagicFocus.hs b/MagicFocus.hs
index 275f722..32f1b75 100644
--- a/MagicFocus.hs
+++ b/MagicFocus.hs
@@ -1,8 +1,28 @@
-module XMonadContrib.MagicFocus (magicFocus) where
+-----------------------------------------------------------------------------
+-- |
+-- Module       : XMonadContrib.MagicFocus
+-- Copyright    : (c) Peter De Wachter <pdewacht@gmail.com>
+-- License      : BSD
+--
+-- Maintainer   : Peter De Wachter <pdewacht@gmail.com>
+-- Stability    : unstable
+-- Portability  : unportable
+--
+-- Automagically put the focused window in the master area.
+-----------------------------------------------------------------------------
+
+module XMonadContrib.MagicFocus (
+                 -- * Usage
+                 -- $ usage
+                 magicFocus) where
 
 import XMonad
 import StackSet
 
+-- $ usage
+-- > import XMonadContrib.MagicFocus
+-- > defaultLayouts = [ magicFocus tiled , magicFocus $ mirror tiled ]
+
 magicFocus :: Layout -> Layout
 magicFocus l = l { doLayout = \s -> (doLayout l) s . swap
                  , modifyLayout = \x -> fmap magicFocus `fmap` modifyLayout l x }