From 9d61a97bdaf694dacf77fb4223cb8474387c3346 Mon Sep 17 00:00:00 2001
From: Andrea Rossato <andrea.rossato@unibz.it>
Date: Thu, 14 Jun 2007 16:37:31 +0200
Subject: Decoration.hs: info and documentation
darcs-hash:20070614143731-32816-13a6a61897ae831197810ac96a6527e1728cabd9.gz
---
Decoration.hs | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/Decoration.hs b/Decoration.hs
index f5b614e..6a9d606 100644
--- a/Decoration.hs
+++ b/Decoration.hs
@@ -1,5 +1,23 @@
{-# OPTIONS -fglasgow-exts #-}
-module XMonadContrib.Decoration ( newDecoration ) where
+-----------------------------------------------------------------------------
+-- |
+-- Module : XMonadContrib.Decoration
+-- Copyright : (c) David Roundy <droundy@darcs.net>
+-- License : BSD-style (see LICENSE)
+--
+-- Maintainer : David Roundy <droundy@darcs.net>
+-- Stability : unstable
+-- Portability : unportable
+--
+-- A module to be used to easily define decorations.
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.Decoration (
+ -- * Usage
+ -- $usage
+ newDecoration
+ ) where
import Data.Bits ( (.|.) )
import Control.Monad.Reader ( asks )
@@ -11,6 +29,10 @@ import XMonadContrib.LayoutHooks
import XMonad
import Operations ( UnDoLayout(UnDoLayout) )
+-- $usage
+-- You can use this module for writing other extensions.
+-- See, for instance, "XMonadContrib.Tabbed"
+
newDecoration :: Window -> Rectangle -> Int -> Pixel -> Pixel
-> (Display -> Window -> GC -> X ()) -> X () -> X Window
newDecoration decfor (Rectangle x y w h) th fg bg draw click = do
--
cgit v1.2.3