diff options
| author | Dana Jansens <danakj@orodu.net> | 2002-11-05 05:56:44 +0000 |
|---|---|---|
| committer | Dana Jansens <danakj@orodu.net> | 2002-11-05 05:56:44 +0000 |
| commit | f25252a4849ab205856629480178946b2b454aa3 (patch) | |
| tree | 2fde58f2bf991d9156edcbc8b762a62bd0c761eb /doc | |
| parent | c3946be073669491680949817b9baa61ab8206ff (diff) | |
updated doxygen documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/doxygen/comments | 14 | ||||
| -rw-r--r-- | doc/doxygen/doxygen.conf.in | 14 |
3 files changed, 22 insertions, 8 deletions
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 = |