LayoutHints.hs: add usage thingie for Haddock.

This commit is contained in:
joachim.fasting
2007-06-18 14:32:34 +00:00
parent 09305f7f2f
commit 005369bb13

View File

@@ -11,10 +11,10 @@
-- Make layouts respect size hints. -- Make layouts respect size hints.
----------------------------------------------------------------------------- -----------------------------------------------------------------------------
module XMonadContrib.LayoutHints ( layoutHints ) where module XMonadContrib.LayoutHints (
-- * usage
-- to use: -- $ usage
-- defaultLayouts = [ layoutHints tiled, layoutHints $ mirror tiled , full ] layoutHints) where
import Operations ( applySizeHints, D ) import Operations ( applySizeHints, D )
import Graphics.X11.Xlib import Graphics.X11.Xlib
@@ -22,6 +22,10 @@ import Graphics.X11.Xlib.Extras ( getWMNormalHints )
import {-#SOURCE#-} Config (borderWidth) import {-#SOURCE#-} Config (borderWidth)
import XMonad hiding ( trace ) import XMonad hiding ( trace )
-- $ usage
-- > import XMonadContrib.LayoutHints
-- > defaultLayouts = [ layoutHints tiled , layoutHints $ mirror tiled ]
-- | Expand a size by the given multiple of the border width. The -- | Expand a size by the given multiple of the border width. The
-- multiple is most commonly 1 or -1. -- multiple is most commonly 1 or -1.
adjBorders :: Dimension -> D -> D adjBorders :: Dimension -> D -> D