From f040db94893f953780f4a3c4dd7e76c8c6cced81 Mon Sep 17 00:00:00 2001
From: fluxgen <fluxgen>
Date: Sat, 31 Mar 2007 19:29:00 +0000
Subject: added documentation

---
 src/ClientMenu.hh    | 20 +++++++++++++++-----
 src/WorkspaceMenu.hh |  9 +++++++++
 2 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/src/ClientMenu.hh b/src/ClientMenu.hh
index ca01e43..8a1878b 100644
--- a/src/ClientMenu.hh
+++ b/src/ClientMenu.hh
@@ -30,21 +30,31 @@
 
 class BScreen;
 class FluxboxWindow;
-
+/**
+ * A menu holding a set of client menus.
+ * @see WorkspaceMenu
+ */
 class ClientMenu: public FbMenu {
 public:
 
     typedef std::list<FluxboxWindow *> Focusables;
 
-    ClientMenu(BScreen &screen, Focusables &clients, FbTk::Subject *refresh);
+    /**
+     * @param screen the screen to show this menu on
+     * @param client a list of clients to show in this menu
+     * @param refresh the refresh subject to listen to
+     */
+    ClientMenu(BScreen &screen, 
+               Focusables &clients, FbTk::Subject *refresh);
 
 private:
-
+    /// refresh the entire menu
     void refreshMenu();
+    /// called when receiving a subject signal
     void update(FbTk::Subject *subj);
 
-    Focusables &m_list;
-    FbTk::Subject *m_refresh_sig;
+    Focusables &m_list; ///< clients 
+    FbTk::Subject *m_refresh_sig; ///< signal to listen to
 };
 
 #endif // CLIENTMENU_HH
diff --git a/src/WorkspaceMenu.hh b/src/WorkspaceMenu.hh
index 2a425a3..1b06dc6 100644
--- a/src/WorkspaceMenu.hh
+++ b/src/WorkspaceMenu.hh
@@ -28,12 +28,21 @@
 
 class BScreen;
 
+/**
+ * A menu specific for workspace.
+ * Contains some simple workspace commands
+ * such as new/delete workspace and edit
+ * workspace name.
+ * It also contains client menus for all clients.
+ */
 class WorkspaceMenu: public FbMenu {
 public:
     explicit WorkspaceMenu(BScreen &screen);
     virtual ~WorkspaceMenu() { }
+    /// called when a subject is sending a signal
     void update(FbTk::Subject *subj);
 private:
+    /// initialize menu for the screen
     void init(BScreen &screen);
 };
 
-- 
cgit v0.11.2