From 11a8b30381c6cc4c0fe2a5a6f4e68558a50d77f4 Mon Sep 17 00:00:00 2001
From: fluxgen <fluxgen>
Date: Sat, 31 Mar 2007 19:16:48 +0000
Subject: more documentation

---
 src/Screen.hh | 12 ++++++------
 src/Window.hh | 23 +++++++++++++----------
 2 files changed, 19 insertions(+), 16 deletions(-)

diff --git a/src/Screen.hh b/src/Screen.hh
index ab6ce7d..f3096c1 100644
--- a/src/Screen.hh
+++ b/src/Screen.hh
@@ -88,17 +88,17 @@ public:
     /// a window becomes active / focussed on a different workspace
     enum FollowModel { 
         IGNORE_OTHER_WORKSPACES = 0, ///< who cares?
-        FOLLOW_ACTIVE_WINDOW, ///< go to that workspace
+        FOLLOW_ACTIVE_WINDOW,     ///< go to that workspace
         SEMIFOLLOW_ACTIVE_WINDOW, ///< fetch iconified windows, else follow
-        FETCH_ACTIVE_WINDOW ///< put that window to the current workspace 
+        FETCH_ACTIVE_WINDOW       ///< put that window to the current workspace 
     };
 
     /// Different resize modes when resizing a window
     enum ResizeModel { 
-        BOTTOMRESIZE = 0,  //< resizes from the bottom right corner
-        QUADRANTRESIZE,  //< resizes from one quadrant
-        CENTERRESIZE, //< resizes from center
-        DEFAULTRESIZE = BOTTOMRESIZE //< default resize mode is bottom
+        BOTTOMRESIZE = 0,            ///< resizes from the bottom right corner
+        QUADRANTRESIZE,              ///< resizes from one quadrant
+        CENTERRESIZE,                ///< resizes from center
+        DEFAULTRESIZE = BOTTOMRESIZE ///< default resize mode is bottom
     };
 
 
diff --git a/src/Window.hh b/src/Window.hh
index 090b4e8..91bd4a5 100644
--- a/src/Window.hh
+++ b/src/Window.hh
@@ -97,14 +97,14 @@ public:
 
     /// attributes for BlackboxHints
     enum Attrib {
-        ATTRIB_SHADED = 0x01,
-        ATTRIB_MAXHORIZ = 0x02,
-        ATTRIB_MAXVERT = 0x04,
-        ATTRIB_OMNIPRESENT = 0x08,
-        ATTRIB_WORKSPACE = 0x10,
-        ATTRIB_STACK = 0x20,
-        ATTRIB_DECORATION = 0x40,
-        ATTRIB_HIDDEN = 0x80,
+        ATTRIB_SHADED = 0x01,      ///< shaded
+        ATTRIB_MAXHORIZ = 0x02,    ///< maximized horizontal
+        ATTRIB_MAXVERT = 0x04,     ///< maximized vertical
+        ATTRIB_OMNIPRESENT = 0x08, ///< omnipresent (sticky)
+        ATTRIB_WORKSPACE = 0x10,   ///< workspace
+        ATTRIB_STACK = 0x20,       ///< stack
+        ATTRIB_DECORATION = 0x40,  ///< decorations 
+        ATTRIB_HIDDEN = 0x80,      ///< hidden
     };
 
     /**
@@ -136,7 +136,9 @@ public:
         DECORM_LAST     = (1<<11) // useful for getting "All"
     };
 
-
+    /**
+     * Resize direction while resizing
+     */
      enum ResizeDirection {
          NOCORNER = -1, 
          LEFTTOP  = 0,
@@ -149,12 +151,13 @@ public:
          LEFT         = 7,
          ALLCORNERS   = 8
     };
-
+    /// holds old blackbox specific hints
     typedef struct _blackbox_hints {
         unsigned long flags, attrib, workspace, stack;
         long decoration;
     } BlackboxHints;
 
+    /// holds old blackbox attributes
     typedef struct _blackbox_attributes {
         unsigned long flags, attrib, workspace, stack;
         long premax_x, premax_y;
-- 
cgit v0.11.2