From f25252a4849ab205856629480178946b2b454aa3 Mon Sep 17 00:00:00 2001 From: Dana Jansens Date: Tue, 5 Nov 2002 05:56:44 +0000 Subject: [PATCH] updated doxygen documentation --- doc/doxygen/Makefile.am | 2 +- doc/doxygen/comments | 14 ++++++++++++++ doc/doxygen/doxygen.conf.in | 14 +++++++------- src/configuration.hh | 8 ++++++++ src/main.cc | 4 ++++ src/openbox.hh | 13 +++++++------ src/xatom.hh | 4 ++++ src/xeventhandler.hh | 5 +++++ 8 files changed, 50 insertions(+), 14 deletions(-) create mode 100644 doc/doxygen/comments diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am index 0a09e70a..d6951361 100644 --- 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 index 00000000..dab4fe56 --- /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 b053cd5e..c203b1f7 100644 --- 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 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 #include +} + #include 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 } @@ -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 #include 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 }