updated doxygen documentation

diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
index 0a09e70a3fad0ef9669533bf7198bc2ef13206bb..d6951361fb4094b58a7557830d46fc0d17b73fb7 100644 (file)
--- a/doc/doxygen/Makefile.am
+++ b/doc/doxygen/Makefile.am
@@ -4,6 +4,6 @@ doc: doxygen.conf
        @doxygen doxygen.conf
 
 doxygen.conf: doxygen.conf.in
-       @regex_cmd@ -e "s,\@VERSION\@,$(VERSION)," \
+       @regex_cmd@ -e "s,\@version\@,$(VERSION)," \
          -e "s,\@basedir\@,`cd $(top_builddir) && pwd`," \
          doxygen.conf.in > doxygen.conf

diff --git a/doc/doxygen/comments b/doc/doxygen/comments
new file mode 100644 (file)
index 0000000..dab4fe5
--- /dev/null
+++ b/doc/doxygen/comments
@@ -0,0 +1,14 @@
+// Further comments for doxygen on the src/ directory
+
+/*! @namespace ob
+  @brief The namespace containing the %Openbox window manager application
+*/
+
+/*! @namespace otk
+  @brief The namespace containing the Openbox toolkit
+*/
+/*! @namespace otk
+  The namespace containing a toolkit used by the Openbox window manager,
+  and also for use by external applications that wish to present a similar
+  visual appearance to Openbox.
+*/

diff --git a/doc/doxygen/doxygen.conf.in b/doc/doxygen/doxygen.conf.in
index b053cd5e3d1a0454579fa1865361b736085070e4..c203b1f7b5b2b551f466a26859a06baba05f0b44 100644 (file)
--- a/doc/doxygen/doxygen.conf.in
+++ b/doc/doxygen/doxygen.conf.in
@@ -4,7 +4,7 @@
 # General configuration options
 #---------------------------------------------------------------------------
 PROJECT_NAME           = Openbox
-PROJECT_NUMBER         = @VERSION@
+PROJECT_NUMBER         = @version@
 OUTPUT_DIRECTORY       = 
 OUTPUT_LANGUAGE        = English
 EXTRACT_ALL            = YES
@@ -28,7 +28,7 @@ HIDE_SCOPE_NAMES       = NO
 VERBATIM_HEADERS       = YES
 SHOW_INCLUDE_FILES     = YES
 JAVADOC_AUTOBRIEF      = NO
-MULTILINE_CPP_IS_BRIEF = NO
+MULTILINE_CPP_IS_BRIEF = YES
 DETAILS_AT_TOP         = YES
 INHERIT_DOCS           = YES
 INLINE_INFO            = YES
@@ -56,7 +56,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../../src ../../otk
+INPUT                  = ../../src ../../otk comments
 FILE_PATTERNS          = *.hh *.cc
 RECURSIVE              = NO
 EXCLUDE                = 
@@ -80,7 +80,7 @@ REFERENCES_RELATION    = YES
 #---------------------------------------------------------------------------
 ALPHABETICAL_INDEX     = NO
 COLS_IN_ALPHA_INDEX    = 5
-IGNORE_PREFIX          = 
+IGNORE_PREFIX          = OB OTK _
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
 #---------------------------------------------------------------------------
@@ -100,7 +100,7 @@ TOC_EXPAND             = NO
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 4
 GENERATE_TREEVIEW      = NO
-TREEVIEW_WIDTH         = 250
+TREEVIEW_WIDTH         = 200
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
@@ -109,7 +109,7 @@ LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
 COMPACT_LATEX          = NO
-PAPER_TYPE             = a4wide
+PAPER_TYPE             = letter
 EXTRA_PACKAGES         = 
 LATEX_HEADER           = 
 PDF_HYPERLINKS         = NO
@@ -172,7 +172,7 @@ COLLABORATION_GRAPH    = YES
 TEMPLATE_RELATIONS     = YES
 INCLUDE_GRAPH          = YES
 INCLUDED_BY_GRAPH      = YES
-GRAPHICAL_HIERARCHY    = YES
+GRAPHICAL_HIERARCHY    = NO
 DOT_IMAGE_FORMAT       = png
 DOT_PATH               = 
 DOTFILE_DIRS           = 

diff --git a/src/configuration.hh b/src/configuration.hh
index a45bd3f8ac193021f635c0227d8be9b62e9d4c43..8a14604a8885d8c8d4d13ccf5b67b42d2b16efcd 100644 (file)
--- a/src/configuration.hh
+++ b/src/configuration.hh
@@ -2,8 +2,16 @@
 #ifndef   __Configuration_hh
 #define   __Configuration_hh
 
+/*! @file configuration.hh
+  @brief Loads, saves, and provides configuration options for the window
+         manager
+*/
+
+extern "C" {
 #include <X11/Xlib.h>
 #include <X11/Xresource.h>
+}
+
 #include <string>
 
 namespace ob {

diff --git a/src/main.cc b/src/main.cc
index af0dcf38b4b6dacf5fdf00d13faef7dbeb92b763..3bab740af93c3f78dd70dfe321755d6084eb2459 100644 (file)
--- a/src/main.cc
+++ b/src/main.cc
@@ -1,5 +1,9 @@
 // -*- mode: C++; indent-tabs-mode: nil; -*-
 
+/*! @file main.cc
+  @brief Main entry point for the application
+*/
+
 #ifdef    HAVE_CONFIG_H
 #  include "../config.h"
 #endif // HAVE_CONFIG_H

diff --git a/src/openbox.hh b/src/openbox.hh
index ea0b854a04d12618fa106528ab563b3ba7946b62..2feb8f0f90d05bad5bb122aab22041ab02064357 100644 (file)
--- a/src/openbox.hh
+++ b/src/openbox.hh
@@ -2,6 +2,10 @@
 #ifndef   __openbox_hh
 #define   __openbox_hh
 
+/*! @file openbox.hh
+  @brief The main class for the Openbox window manager
+*/
+
 extern "C" {
 #include <X11/Xlib.h>
 }
@@ -37,12 +41,9 @@ public:
 
   //! The posible running states of the window manager
   enum RunState {
-    //! The window manager is starting up (being created)
-    State_Starting,
-    //! The window manager is running in its normal state
-    State_Normal,
-    //! The window manager is exiting (being destroyed)
-    State_Exiting
+    State_Starting, //!< The window manager is starting up (being created)
+    State_Normal,   //!< The window manager is running in its normal state
+    State_Exiting   //!< The window manager is exiting (being destroyed)
   };
   
 private:

diff --git a/src/xatom.hh b/src/xatom.hh
index df9bdf4f59248ebe39fb2fa81a4aa7ca54a9d9b1..0b5ec43590611d174b83239208527f827bc8b8be 100644 (file)
--- a/src/xatom.hh
+++ b/src/xatom.hh
@@ -2,6 +2,10 @@
 #ifndef   __XAtom_h
 #define   __XAtom_h
 
+/*! @file xatom.hh
+  @brief Provides access to atoms on the display
+*/
+
 extern "C" {
 #include <X11/Xlib.h>
 #include <X11/Xatom.h>

diff --git a/src/xeventhandler.hh b/src/xeventhandler.hh
index 7b960cd3a945d27e495a63e6b3548bfcfb47be73..87afee3a406c8efe5b96f9b7075b1dbd6f12267c 100644 (file)
--- a/src/xeventhandler.hh
+++ b/src/xeventhandler.hh
@@ -2,6 +2,11 @@
 #ifndef   __xeventhandler_hh
 #define   __xeventhandler_hh
 
+/*! @file xeventhandler.hh
+  @brief The class which handles raw XEvents, turning them into high-level
+         user interaction sequences, or processing them as appropriate
+*/
+
 extern "C" {
 #include <X11/Xlib.h>
 }