Correct L.Drawer haddock markup and re-export required module.

This commit is contained in:
Adam Vogt 2010-03-08 22:52:58 +00:00
parent 8f58fb4c2f
commit 8cc604c4ad

View File

@ -27,6 +27,8 @@ module XMonad.Layout.Drawer
-- * Placing drawers -- * Placing drawers
-- The drawer can be placed on any side of the screen with these functions -- The drawer can be placed on any side of the screen with these functions
, onLeft, onTop, onRight, onBottom , onLeft, onTop, onRight, onBottom
, module XMonad.Util.WindowProperties
) where ) where
import XMonad import XMonad
@ -38,18 +40,17 @@ import XMonad.Layout.Reflect
-- $usage -- $usage
-- To use this module, add the following import to @~\/.xmonad\/xmonad.hs@: -- To use this module, add the following import to @~\/.xmonad\/xmonad.hs@:
-- --
-- @ -- > import XMonad.Layout.Drawer
-- import XMonad.Layout.Drawer
-- import "XMonad.Util.WindowProperties"
-- --
-- myLayout = drawer \``onTop'\` (Tall 1 0.03 0.5) ||| Full ||| RandomOtherLayout... -- > myLayout = drawer `onTop` (Tall 1 0.03 0.5) ||| Full ||| RandomOtherLayout...
-- where -- > where
-- drawer = 'simpleDrawer' 0.01 0.3 (ClassName \"Rhythmbox\" \`Or\` ClassName \"Xchat\") -- > drawer = simpleDrawer 0.01 0.3 (ClassName "Rhythmbox" `Or` ClassName "Xchat")
-- main = xmonad defaultConfig { layoutHook = myLayout } -- >
-- @ -- > main = xmonad defaultConfig { layoutHook = myLayout }
-- --
-- This will place the Rhythmbox and Xchat windows in at the top of the screen. -- This will place the Rhythmbox and Xchat windows in at the top of the screen
-- See "XMonad.Util.WindowProperties" for more information on selecting windows. -- only when using the 'Tall' layout. See "XMonad.Util.WindowProperties" for
-- more information on selecting windows.
data Drawer l a = Drawer Rational Rational Property (l a) data Drawer l a = Drawer Rational Rational Property (l a)
deriving (Read, Show) deriving (Read, Show)