fix a bunch of comments, make default textures obvious

Thanks Jonas Koelker

14 files changed, 40 insertions, 24 deletions

diff --git a/ChangeLog b/ChangeLog
index 24faf6a..bbb74c6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,10 @@
 (Format: Year/Month/Day)
 Changes for 0.9.16:
 *06/04/25:
+   * Fix up comments for doxygen (Thanks Jonas Koelker)
+     Screen.cc CommandParser.cc Container.hh fluxbox.hh Workspace.hh 
+     ArrowButton.hh FbTk/Texture.cc FbTk/ThemeItems.cc FbTk/Texture.hh 
+     FbTk/Theme.hh FbTk/EventHandler.hh fluxbox.cc Remember.cc
    * Output the error message on fallback restart execs (sf patch#1475213)
      (Thanks Jonas Kölker, jonaskoelker at users.sourceforge.net).
      main.cc     
diff --git a/src/ArrowButton.hh b/src/ArrowButton.hh
index b42cce2..59f81fa 100644
--- a/src/ArrowButton.hh
+++ b/src/ArrowButton.hh
@@ -31,10 +31,10 @@ class ArrowButton: public FbTk::Button {
 public:
     enum Type { LEFT, RIGHT, UP, DOWN};
 
-    ArrowButton(Type arrow_type, const FbTk::FbWindow &parent,
+    ArrowButton(ArrowButton::Type arrow_type, const FbTk::FbWindow &parent,
                 int x, int y, 
                 unsigned int width, unsigned int height);
-    ArrowButton(Type arrow_type, int screen_num,
+    ArrowButton(ArrowButton::Type arrow_type, int screen_num,
                 int x, int y,
                 unsigned int width, unsigned int height);
     void clear();
diff --git a/src/CommandParser.cc b/src/CommandParser.cc
index 1f8218e..95630d0 100644
--- a/src/CommandParser.cc
+++ b/src/CommandParser.cc
@@ -45,7 +45,7 @@ CommandFactory::~CommandFactory() {
 
 }
 
-void CommandFactory::addCommand(const string &command_name) {
+void CommandFactory::addCommand(const std::string &command_name) {
     CommandParser::instance().associateCommand(command_name, *this);
 }
 
@@ -62,7 +62,7 @@ CommandParser &CommandParser::instance() {
     return *s_singleton;
 }
 
-FbTk::Command *CommandParser::parseLine(const string &line) {
+FbTk::Command *CommandParser::parseLine(const std::string &line) {
 
     // parse arguments and command
     string command = line;
diff --git a/src/Container.hh b/src/Container.hh
index 448abee..65dfbb9 100644
--- a/src/Container.hh
+++ b/src/Container.hh
@@ -97,7 +97,7 @@ public:
     inline unsigned int maxHeightPerClient() const { return (empty() ? height() : height()/size()); }    
     inline bool updateLock() const { return m_update_lock; }
 
-    void for_each(std::mem_fun_t<void, FbWindow> function);
+    void for_each(std::mem_fun_t<void, FbTk::FbWindow> function);
     void setAlpha(unsigned char alpha); // set alpha on all windows
 
     ItemList::iterator begin() { return m_item_list.begin(); }
diff --git a/src/FbTk/EventHandler.hh b/src/FbTk/EventHandler.hh
index 4ae1aa5..62e2cb9 100644
--- a/src/FbTk/EventHandler.hh
+++ b/src/FbTk/EventHandler.hh
@@ -1,4 +1,4 @@
-// EventHandler.cc for Fluxbox Window Manager
+// EventHandler.hh for Fluxbox Window Manager
 // Copyright (c) 2002-2003 Henrik Kinnunen (fluxgen at fluxbox dot org)
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -21,7 +21,7 @@
 
 // $Id$
 
-/// @file holds EventHandler interface for X events
+/// @file EventHandler.hh holds EventHandler interface for X events
 
 #ifndef FBTK_EVENTHANDLER_HH
 #define FBTK_EVENTHANDLER_HH
diff --git a/src/FbTk/Texture.cc b/src/FbTk/Texture.cc
index e06c328..0395cd5 100644
--- a/src/FbTk/Texture.cc
+++ b/src/FbTk/Texture.cc
@@ -77,15 +77,19 @@ void Texture::setFromString(const char * const texture_str) {
                 addType(Texture::VERTICAL);
             else
                 addType(Texture::DIAGONAL);
-        } else // default is "solid", according to ThemeItems.cc
+        } else if (strstr(ts, "solid"))
             addType(Texture::SOLID);
+        else
+            addType(Texture::DEFAULT_BEVEL);
 
         if (strstr(ts, "raised"))
             addType(Texture::RAISED);
         else if (strstr(ts, "sunken"))
             addType(Texture::SUNKEN);
-        else // default us "flat", according to ThemeItems.cc
+        else if (strstr(ts, "flat"))
             addType(Texture::FLAT);
+        else
+            addType(Texture::DEFAULT_TEXTURE);
 
         if (! (type() & Texture::FLAT))
             if (strstr(ts, "bevel2"))
diff --git a/src/FbTk/Texture.hh b/src/FbTk/Texture.hh
index 162cf44..35b628b 100644
--- a/src/FbTk/Texture.hh
+++ b/src/FbTk/Texture.hh
@@ -39,15 +39,18 @@ class Texture {
 public:
 
     enum Bevel {
+        // why are we not using the lowest-order bit?
         FLAT =     0x00002,
-        SUNKEN =   0x00004, 
-        RAISED =   0x00008
+        SUNKEN =   0x00004,
+        RAISED =   0x00008,
+        DEFAULT_BEVEL = FLAT,
     };
 
     enum Textures {
         NONE =     0x00000,
         SOLID =    0x00010,
-        GRADIENT = 0x00020
+        GRADIENT = 0x00020,
+        DEFAULT_TEXTURE = SOLID,
     };
 
     enum Gradients {
@@ -58,7 +61,7 @@ public:
         RECTANGLE =      0x00400,
         PYRAMID =        0x00800,
         PIPECROSS =      0x01000,
-        ELLIPTIC =       0x02000                
+        ELLIPTIC =       0x02000
     };
         
     enum {
diff --git a/src/FbTk/Theme.hh b/src/FbTk/Theme.hh
index 5edc840..e3fc5b4 100644
--- a/src/FbTk/Theme.hh
+++ b/src/FbTk/Theme.hh
@@ -22,7 +22,7 @@
 // $Id$
 
 /**
- @file holds ThemeItem<T>, Theme and ThemeManager which is the base for any theme
+ @file Theme.hh holds ThemeItem<T>, Theme and ThemeManager which is the base for any theme
 */
 
 #ifndef FBTK_THEME_HH
diff --git a/src/FbTk/ThemeItems.cc b/src/FbTk/ThemeItems.cc
index 41d05e8..2f58b2a 100644
--- a/src/FbTk/ThemeItems.cc
+++ b/src/FbTk/ThemeItems.cc
@@ -21,7 +21,7 @@
 
 // $Id$
 
-/// @file implements common theme items
+/// @file ThemeItems.cc implements common theme items
 
 #ifndef THEMEITEMS_HH
 #define THEMEITEMS_HH
@@ -71,7 +71,7 @@ void ThemeItem<string>::setFromString(const char *str) {
 }
 
 template <>
-void ThemeItem<int>::load(const string *name, const string *altname) { }
+void ThemeItem<int>::load(const std::string *name, const std::string *altname) { }
 
 template<>
 void ThemeItem<int>::setDefaultValue() {
@@ -233,7 +233,7 @@ void ThemeItem<Texture>::load(const string *o_name, const string *o_altname) {
 
 template <>
 void ThemeItem<Texture>::setDefaultValue() {
-    m_value.setType(Texture::FLAT | Texture::SOLID);
+    m_value.setType(Texture::DEFAULT_BEVEL | Texture::DEFAULT_TEXTURE);
     load(); // one might forget to add line something:  so we try to load something.*:  too
 }
 
diff --git a/src/Remember.cc b/src/Remember.cc
index 3a2aac4..33ed08d 100644
--- a/src/Remember.cc
+++ b/src/Remember.cc
@@ -297,7 +297,7 @@ Application * Remember::add(WinClient &winclient) {
     return app;
 }
 
-int Remember::parseApp(ifstream &file, Application &app, string *first_line) {
+int Remember::parseApp(std::ifstream &file, Application &app, std::string *first_line) {
     string line;
     _FB_USES_NLS;
     int row = 0;
diff --git a/src/Screen.cc b/src/Screen.cc
index 03ec510..0609cd4 100644
--- a/src/Screen.cc
+++ b/src/Screen.cc
@@ -293,7 +293,8 @@ BScreen::ScreenResource::ScreenResource(FbTk::ResourceManager &rm,
 }
 
 BScreen::BScreen(FbTk::ResourceManager &rm,
-                 const string &screenname, const string &altscreenname,
+                 const std::string &screenname,
+                 const std::string &altscreenname,
                  int scrn, int num_layers) : 
     m_clientlist_sig(*this),  // client signal
     m_iconlist_sig(*this), // icon list signal
diff --git a/src/Workspace.hh b/src/Workspace.hh
index 135ac4d..ffcde8a 100644
--- a/src/Workspace.hh
+++ b/src/Workspace.hh
@@ -42,8 +42,8 @@ class FluxboxWindow;
 class WinClient;
 
 /**
-    Handles a single workspace
-*/
+ * Handles a single workspace
+ */
 class Workspace:private FbTk::NotCopyable, private FbTk::Observer {
 public:
     typedef std::vector<FluxboxWindow *> Windows;
@@ -54,13 +54,17 @@ public:
 
     void setLastFocusedWindow(FluxboxWindow *w);
 
-    ///   Set workspace name
+    /// Set workspace name
     void setName(const std::string &name);
+    /// Deiconify all windows on this workspace
     void showAll();
     void hideAll(bool interrupt_moving);
+    /// Iconify all windows on this workspace
     void removeAll();
     void reconfigure();
     void shutdown();
+
+    /// Add @a win to this workspace, placing it if @a place is true
     void addWindow(FluxboxWindow &win, bool place = false);
     int removeWindow(FluxboxWindow *win, bool still_alive);
     void updateClientmenu();
diff --git a/src/fluxbox.cc b/src/fluxbox.cc
index c18cc32..48b67bf 100644
--- a/src/fluxbox.cc
+++ b/src/fluxbox.cc
@@ -1511,7 +1511,7 @@ string Fluxbox::getRcFilename() {
 }
 
 /// Provides default filename of data file
-void Fluxbox::getDefaultDataFilename(char *name, string &filename) {
+void Fluxbox::getDefaultDataFilename(char *name, std::string &filename) {
     filename = string(getenv("HOME") + string("/.") + m_RC_PATH + string("/") + name);
 }
 
diff --git a/src/fluxbox.hh b/src/fluxbox.hh
index da0a60a..7506dc6 100644
--- a/src/fluxbox.hh
+++ b/src/fluxbox.hh
@@ -199,7 +199,7 @@ public:
     bool menuTimestampsChanged() const;
     bool haveShape() const { return m_have_shape; }
     int shapeEventbase() const { return m_shape_eventbase; }
-    void getDefaultDataFilename(char *, std::string &);
+    void getDefaultDataFilename(char *name, std::string &);
     // screen mouse was in at last key event
     BScreen *mouseScreen() { return m_mousescreen; }
     // screen of window that last key event (i.e. focused window) went to