SwitchTrans.hs: minor haddock corrections

This commit is contained in:
Andrea Rossato
2007-08-04 10:44:58 +00:00
parent c8fb4b763c
commit c3da853d3b

View File

@@ -1,3 +1,4 @@
{-# OPTIONS_GHC -fglasgow-exts #-}
----------------------------------------------------------------------------- -----------------------------------------------------------------------------
-- | -- |
-- Module : XMonadContrib.SwitchTrans -- Module : XMonadContrib.SwitchTrans
@@ -8,11 +9,8 @@
-- Stability : unstable -- Stability : unstable
-- Portability : unportable -- Portability : unportable
-- --
----------------------------------------------------------------------------- --
-- Ordinary layout transformers are simple and easy to use but inflexible.
{-# OPTIONS_GHC -fglasgow-exts #-}
-- | Ordinary layout transformers are simple and easy to use but inflexible.
-- This module provides a more structured interface to them. -- This module provides a more structured interface to them.
-- --
-- The basic idea is to have a base layout and a set of layout transformers, -- The basic idea is to have a base layout and a set of layout transformers,
@@ -33,7 +31,7 @@
-- > mkSwitch (M.singleton "mirror" mirror) -- > mkSwitch (M.singleton "mirror" mirror)
-- > ) [ tiled ] -- > ) [ tiled ]
-- --
-- (The noBorders transformer is from @XMonadContrib.NoBorders@.) -- (The noBorders transformer is from 'XMonadContrib.NoBorders'.)
-- --
-- This example is probably overkill but it's very close to what I actually use. -- This example is probably overkill but it's very close to what I actually use.
-- Anyway, this layout behaves like the default @tiled@ layout, until you send it -- Anyway, this layout behaves like the default @tiled@ layout, until you send it
@@ -54,11 +52,13 @@
-- --
-- The reason I use two stacked @SwitchTrans@ transformers instead of -- The reason I use two stacked @SwitchTrans@ transformers instead of
-- @mkSwitch (M.fromList [("full", const $ noBorders full), ("mirror", mirror)])@ -- @mkSwitch (M.fromList [("full", const $ noBorders full), ("mirror", mirror)])@
-- is that I use @mod-f@ to "zoom in" on interesting windows, no matter what other -- is that I use @mod-f@ to \"zoom in\" on interesting windows, no matter what other
-- layout transformers may be active. Having an extra fullscreen mode on top of -- layout transformers may be active. Having an extra fullscreen mode on top of
-- everything else means I can zoom in and out without implicitly undoing "normal" -- everything else means I can zoom in and out without implicitly undoing \"normal\"
-- layout transformers, like @mirror@. Remember, inside a @SwitchTrans@ there can -- layout transformers, like @mirror@. Remember, inside a @SwitchTrans@ there can
-- be at most one active layout transformer. -- be at most one active layout transformer.
-----------------------------------------------------------------------------
module XMonadContrib.SwitchTrans ( module XMonadContrib.SwitchTrans (
Toggle(..), Toggle(..),
Enable(..), Enable(..),