If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Doxygen will generate a detailed section even if there is only a brief
description.
If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
controls whether a binary table of contents is generated (YES) or a
normal table of contents (NO) in the .chm file.
If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
include brief member descriptions after the members that are listed in
the file and class documentation (similar to JavaDoc).
If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
to include (a tag file for) the STL sources as input, then you should
set this tag to YES in order to let doxygen match functions declarations and
definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
or super classes.
If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
will generate a graph for each documented class showing the direct and
indirect inheritance relations.
If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
will generate a graph for each documented class showing the direct and
indirect implementation dependencies (inheritance, containment, and
class references variables) of the class with other documented classes.
If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
in which this list will be split (can be a number in the range [1..20])
If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
4096 sub-directories (in 2 levels) under the output directory of each output
format and will distribute the generated files over these directories.
If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
then doxygen will show the dependencies a directory has on other directories
in a graphical way.
If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
tag is set to YES, then doxygen will reuse the documentation of the first
member in the group (if any) for the other members of the group.
The DOTFILE_DIRS tag can be used to specify one or more directories that
contain dot files that are included in the documentation (see the
\dotfile command).
If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
evaluate all C-preprocessor directives found in the sources and include
files.
The EXAMPLE_PATH tag can be used to specify one or more files or
directories that contain example code fragments that are included (see
the \include command).
If the value of the EXAMPLE_PATH tag contains directories, you can use the
EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
and *.h) to filter out the source-files in the directories.
If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
searched for input files to be used with the \include or \dontinclude
commands irrespective of the value of the RECURSIVE tag.
If the value of the INPUT tag contains directories, you can use the
EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
certain files from those directories.
The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
(namespaces, classes, functions, etc.) that should be excluded from the
output.
The EXCLUDE_SYMLINKS tag can be used select whether or not files or
directories that are symbolic links (a Unix filesystem feature) are excluded
from the input.
If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
then the macro expansion is limited to the macros specified with the
PREDEFINED and EXPAND_AS_DEFINED tags.
If this flag is set to YES, the members of anonymous namespaces will be
extracted and appear in the documentation as a namespace called
'anonymous_namespace{file}', where file will be replaced with the base
name of the file that contains the anonymous namespace.
If the value of the INPUT tag contains directories, you can use the
FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
and *.h) to filter out the source-files in the directories.
The FILE_VERSION_FILTER tag can be used to specify a program or script that
doxygen should invoke to get the current version for each file (typically from
the version control system).
If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
INPUT_FILTER) will be used to filter the input files when producing source
files to browse (i.e. when SOURCE_BROWSER is set to YES).
If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
generate an AutoGen Definitions (see autogen.sf.net) file
that captures the structure of the code including all
documentation.
If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
controls if a separate .chi index file is generated (YES) or that
it should be included in the master .chm file (NO).
If the GENERATE_DOCSET tag is set to YES, additional index files
will be generated that can be used as input for Apple's Xcode 3
integrated development environment, introduced with OSX 10.5 (Leopard).
If the GENERATE_HTMLHELP tag is set to YES, additional index files
will be generated that can be used as input for tools like the
Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
of the generated HTML documentation.
If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
generate a legend page explaining the meaning of the various boxes and
arrows in the dot generated graphs.
If the GENERATE_PERLMOD tag is set to YES Doxygen will
generate a Perl module file that captures the structure of
the code including all documentation.
If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
are set, an additional index file will be generated that can be used as input for
Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
HTML documentation.
If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
The RTF output is optimized for Word 97 and may not look very pretty with
other RTF readers or editors.
This code is lent from
http://fisheye.codehaus.org/browse/~raw,r=8882/mojo/trunk/mojo/exec-maven-plugin/src/main/java/org/codehaus/mojo/exec/ExecMojo.java
If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
be used to specify the location (absolute path including file name) of
the HTML help compiler (hhc.exe).
If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
documentation will contain sections that can be hidden and shown after the
page has loaded.
The IMAGE_PATH tag can be used to specify one or more files or
directories that contain image that are included in the documentation (see
the \image command).
If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
HAVE_DOT tags are set to YES then doxygen will generate a graph for each
documented header file showing the documented files that directly or
indirectly include this file.
You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
patterns (like *.h and *.hpp) to filter out the header-files in the
directories.
If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
tags are set to YES then doxygen will generate a graph for each documented
file showing the direct and indirect include dependencies of the file with
other documented files.
The INCLUDE_PATH tag can be used to specify one or more directories that
contain include files that are not input files but should be processed by
the preprocessor.
If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
member inherits the documentation from any documented member that it
re-implements.
If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
inherited members of a class in the documentation of that class as if those
members were ordinary class members.
If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
will interpret the first line (until the first dot) of a JavaDoc-style
comment as the brief description.
If the MAN_LINKS tag is set to YES and Doxygen generates man output,
then it will generate one additional man file for each entity
documented in the real man page(s).
The MAX_INITIALIZER_LINES tag determines the maximum number of lines
the initial value of a variable or define consists of for it to appear in
the documentation.
If the PERLMOD_LATEX tag is set to YES Doxygen will generate
the necessary Makefile rules, Perl scripts and LaTeX code to be able
to generate PDF and DVI output from the Perl module output.
The PREDEFINED tag can be used to specify one or more macro names that
are defined before the preprocessor is started (similar to the -D option of
gcc).
If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
link to the source code.
If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
the brief description of a member or function before the detailed description.
If the sources in your project are distributed over multiple directories
then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
in the documentation.
If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
will put a list of the files that are included by a file in the documentation
of that file.
If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
doxygen's preprocessor will remove all function-like macros that are alone
on a line, have an all uppercase name, and do not end with a semicolon.
If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
brief documentation of file, namespace and class members alphabetically
by member name.
If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
will sort the (detailed) documentation of file and class members
alphabetically by member name.
Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
doxygen to hide any special comment blocks from generated source code
fragments.
The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
the path mentioned in the documentation of a class, which tells
the reader which header file to include in order to use a class.
Set the SUBGROUPING tag to YES (the default) to allow class member groups of
the same type (for instance a group of public functions) to be put as a
subgroup of that type (e.g. under the Public Functions section).
If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
used to set the initial width (in pixels) of the frame in which the tree
is shown.
If the UML_LOOK tag is set to YES doxygen will generate inheritance and
collaboration diagrams in a style similar to the OMG's Unified Modeling
Language.
If the USE_HTAGS tag is set to YES then the references to source code
will point to the HTML generated by the htags(1) tool instead of doxygen
built-in source browser.
If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
will generate a verbatim copy of the header file for each class for
which an include is specified.
If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
potential errors in the documentation, such as not documenting some
parameters in a documented function, or documenting parameters that
don't exist or using markup commands wrongly.
This WARN_NO_PARAMDOC option can be abled to get warnings for
functions that are documented, but have no documentation for their parameters
or return value.
If the XML_PROGRAMLISTING tag is set to YES Doxygen will
dump the program listings (including syntax highlighting
and cross-referencing information) to the XML output.