Circle.hs: info and documentation

darcs-hash:20070614143550-32816-dbb753e8f771f69bc7f0dfb3bdc0df4ac1440415.gz

1 files changed, 24 insertions, 1 deletions

diff --git a/Circle.hs b/Circle.hs
index 18edf17..211d8b9 100644
--- a/Circle.hs
+++ b/Circle.hs
@@ -1,9 +1,32 @@
-module XMonadContrib.Circle (circle) where -- actually it's an ellipse
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.Circle
+-- Copyright   :  (c) Peter De Wachter
+-- License     :  BSD-style (see LICENSE)
+-- 
+-- Maintainer  :  Peter De Wachter <pdewacht@gmail.com>
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- Circle is an elliptical, overlapping layout, by Peter De Wachter
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.Circle (
+                             -- * Usage
+                             -- $usage
+                             circle
+                            ) where -- actually it's an ellipse
 
 import Graphics.X11.Xlib
 import XMonad
 import StackSet (integrate)
 
+-- $usage
+-- You can use this module with the following in your Config.hs file:
+--
+-- > import XMonadContrib.Circle
+
 circle :: Layout
 circle = Layout { doLayout = \r -> circleLayout r . integrate,
                   modifyLayout = return . const Nothing }