Haddock syntax for enumeration

This commit is contained in:
Malebria 2008-06-01 20:49:51 +00:00
parent 46ac2ca24b
commit 942572c830
4 changed files with 15 additions and 0 deletions

View File

@ -62,11 +62,17 @@ usage = do
-- | Build "~/.xmonad/xmonad.hs" with ghc, then execute it. If there are no -- | Build "~/.xmonad/xmonad.hs" with ghc, then execute it. If there are no
-- errors, this function does not return. An exception is raised in any of -- errors, this function does not return. An exception is raised in any of
-- these cases: -- these cases:
--
-- * ghc missing -- * ghc missing
--
-- * ~/.xmonad/xmonad.hs missing -- * ~/.xmonad/xmonad.hs missing
--
-- * xmonad.hs fails to compile -- * xmonad.hs fails to compile
--
-- ** wrong ghc in path (fails to compile) -- ** wrong ghc in path (fails to compile)
--
-- ** type error, syntax error, .. -- ** type error, syntax error, ..
--
-- * Missing xmonad/XMonadContrib modules due to ghc upgrade -- * Missing xmonad/XMonadContrib modules due to ghc upgrade
-- --
buildLaunch :: IO () buildLaunch :: IO ()

View File

@ -109,7 +109,9 @@ manageHook = composeAll
-- | Perform an arbitrary action on each internal state change or X event. -- | Perform an arbitrary action on each internal state change or X event.
-- Examples include: -- Examples include:
--
-- * do nothing -- * do nothing
--
-- * log the state to stdout -- * log the state to stdout
-- --
-- See the 'DynamicLog' extension for examples. -- See the 'DynamicLog' extension for examples.

View File

@ -367,8 +367,11 @@ getXMonadDir = io $ getAppUserDataDirectory "xmonad"
-- | 'recompile force', recompile @~\/.xmonad\/xmonad.hs@ when any of the -- | 'recompile force', recompile @~\/.xmonad\/xmonad.hs@ when any of the
-- following apply: -- following apply:
--
-- * force is True -- * force is True
--
-- * the xmonad executable does not exist -- * the xmonad executable does not exist
--
-- * the xmonad executable is older than xmonad.hs -- * the xmonad executable is older than xmonad.hs
-- --
-- The -i flag is used to restrict recompilation to the xmonad.hs file only. -- The -i flag is used to restrict recompilation to the xmonad.hs file only.

View File

@ -459,13 +459,17 @@ insertUp a s = if member a s then s else insert
-- There are 4 cases to consider: -- There are 4 cases to consider:
-- --
-- * delete on an Nothing workspace leaves it Nothing -- * delete on an Nothing workspace leaves it Nothing
--
-- * otherwise, try to move focus to the down -- * otherwise, try to move focus to the down
--
-- * otherwise, try to move focus to the up -- * otherwise, try to move focus to the up
--
-- * otherwise, you've got an empty workspace, becomes Nothing -- * otherwise, you've got an empty workspace, becomes Nothing
-- --
-- Behaviour with respect to the master: -- Behaviour with respect to the master:
-- --
-- * deleting the master window resets it to the newly focused window -- * deleting the master window resets it to the newly focused window
--
-- * otherwise, delete doesn't affect the master. -- * otherwise, delete doesn't affect the master.
-- --
delete :: (Ord a, Eq s) => a -> StackSet i l a s sd -> StackSet i l a s sd delete :: (Ord a, Eq s) => a -> StackSet i l a s sd -> StackSet i l a s sd