From 8c88e102b443ac11c41f12a64c56930c25ea56f2 Mon Sep 17 00:00:00 2001
From: Spencer Janssen <sjanssen@cse.unl.edu>
Date: Mon, 9 Apr 2007 07:34:14 +0000
Subject: [PATCH] Document XState fields

---
 XMonad.hs | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

diff --git a/XMonad.hs b/XMonad.hs
index 9c983e6..2ab1d70 100644
--- a/XMonad.hs
+++ b/XMonad.hs
@@ -33,21 +33,19 @@ import qualified Data.Map as M
 -- | XState, the window manager state.
 -- Just the display, width, height and a window list
 data XState = XState
-    { display           :: Display
+    { display           :: Display                 -- ^ the X11 display
     , screen            :: !ScreenNumber
 
-    , xineScreens       :: ![Rectangle]
-    -- a mapping of workspaces to xinerama screen numbers
+    , xineScreens       :: ![Rectangle]            -- ^ dimensions of each screen
 
-    , wsOnScreen        :: !(M.Map Int Int)
-    , theRoot           :: !Window
-    , wmdelete          :: !Atom
-    , wmprotocols       :: !Atom
-    , dimensions        :: !(Int,Int)
-    , workspace         :: !WorkSpace      -- ^ workspace list
-    , defaultLayoutDesc :: !LayoutDesc
-    , layoutDescs       :: !(M.Map Int LayoutDesc)
-    -- ^ mapping of workspaces to descriptions of their layouts
+    , wsOnScreen        :: !(M.Map Int Int)        -- ^ mapping of workspaces to xinerama screen numbers
+    , theRoot           :: !Window                 -- ^ the root window
+    , wmdelete          :: !Atom                   -- ^ window deletion atom
+    , wmprotocols       :: !Atom                   -- ^ wm protocols atom
+    , dimensions        :: !(Int,Int)              -- ^ dimensions of the screen, used for hiding windows
+    , workspace         :: !WorkSpace              -- ^ workspace list
+    , defaultLayoutDesc :: !LayoutDesc             -- ^ default layout
+    , layoutDescs       :: !(M.Map Int LayoutDesc) -- ^ mapping of workspaces to descriptions of their layouts
     }
 
 type WorkSpace = StackSet Window