updated doxygen documentation
@@ -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
@@ -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. +*/
@@ -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 @@ # configuration options related to the alphabetical class index
#--------------------------------------------------------------------------- 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 =
@@ -2,8 +2,16 @@ // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
#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 {
@@ -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
@@ -2,6 +2,10 @@ // -*- mode: C++; indent-tabs-mode: nil; -*-
#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 @@ static Openbox *instance;
//! 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:
@@ -2,6 +2,10 @@ // XAtom.h for Openbox
#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>
@@ -2,6 +2,11 @@ // -*- mode: C++; indent-tabs-mode: nil; -*-
#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> }