From f25252a4849ab205856629480178946b2b454aa3 Mon Sep 17 00:00:00 2001
From: Dana Jansens <danakj@orodu.net>
Date: Tue, 5 Nov 2002 05:56:44 +0000
Subject: updated doxygen documentation

---
 src/configuration.hh |  8 ++++++++
 src/main.cc          |  4 ++++
 src/openbox.hh       | 13 +++++++------
 src/xatom.hh         |  4 ++++
 src/xeventhandler.hh |  5 +++++
 5 files changed, 28 insertions(+), 6 deletions(-)

(limited to 'src')

diff --git a/src/configuration.hh b/src/configuration.hh
index a45bd3f8..8a14604a 100644
--- 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 af0dcf38..3bab740a 100644
--- 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 ea0b854a..2feb8f0f 100644
--- 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 df9bdf4f..0b5ec435 100644
--- 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 7b960cd3..87afee3a 100644
--- 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>
 }
-- 
cgit v1.2.3