Note:This goal should be used as a Maven report.
Full name:
com.soebes.maven.plugins:doxygen-maven-plugin:1.1.0:report
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| reportOutputDirectory | File | - | Specifies the destination directory where javadoc saves the
generated HTML files. Default value is: ${project.reporting.outputDirectory}. User property is: reportOutputDirectory. |
| Name | Type | Since | Description |
|---|---|---|---|
| abbreviateBrief | String | - | This tag implements a quasi-intelligent brief description
abbreviator that is used to form the text in various listings. Each
string in this list, if found as the leading text of the brief
description, will be stripped from the text and the result after
processing the whole list, is used as the annotated text.
Otherwise, the brief description is used as-is. If left blank, the
following values are used ("$name" is automatically replaced with
the name of the entity): "The $name class" "The $name widget" "The
$name file" "is" "provides" "specifies" "contains" "represents" "a"
"an" "the" User property is: doxygen.abbreviateBrief. |
| aliases | String | - | This tag can be used to specify a number of aliases that acts as
commands in the documentation. An alias has the form "name=value".
For example adding "sideeffect=\par Side Effects:\n" will allow you
to put the command \sideeffect (or @sideeffect) in the
documentation, which will result in a user-defined paragraph with
heading "Side Effects:". You can put \n's in the value part of an
alias to insert newlines. User property is: doxygen.aliases. |
| allexternals | boolean | - | If the ALLEXTERNALS tag is set to YES all external classes will be
listed in the class index. If set to NO only the inherited external
classes will be listed. Default value is: false. User property is: doxygen.allexternals. |
| alphabeticalIndex | boolean | - | If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
of all compounds will be generated. Enable this if the project
contains a lot of classes, structs, unions or interfaces. Default value is: true. User property is: doxygen.alphabeticalIndex. |
| alwaysDetailedSec | boolean | - | 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. Default value is: false. User property is: doxygen.alwaysDetailedSec. |
| binaryToc | boolean | - | 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. Default value is: false. User property is: doxygen.binaryToc. |
| briefMemberDesc | boolean | - | 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).
Set to NO to disable this. Default value is: true. User property is: doxygen.briefMemberDesc. |
| builtinStlSupport | boolean | - | 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. func(std::string) {}). This
also make the inheritance and collaboration diagrams that involve
STL classes more complete and accurate. Default value is: true. User property is: doxygen.builtinStlSupport. |
| callGraph | boolean | - | If the CALL_GRAPH and HAVE_DOT options are set to YES then doxygen
will generate a call dependency graph for every global function or
class method. Note that enabling this option will significantly
increase the time of a run. So in most cases it will be better to
enable call graphs for selected functions only using the \callgraph
command. Default value is: false. User property is: doxygen.callGraph. |
| callerGraph | boolean | - | If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen
will generate a caller dependency graph for every global function
or class method. Note that enabling this option will significantly
increase the time of a run. So in most cases it will be better to
enable caller graphs for selected functions only using the
\callergraph command. Default value is: false. User property is: doxygen.callerGraph. |
| caseSenseNames | boolean | - | If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only
generate file names in lower-case letters. If set to YES upper-case
letters are also allowed. This is useful if you have classes or
files whose names only differ in case and if your file system
supports case sensitive file names. Windows and Mac users are
advised to set this option to NO. Default value is: true. User property is: doxygen.caseSenseNames. |
| chmFile | String | - | If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can be
used to specify the file name of the resulting .chm file. You can
add a path in front of the file if the result should not be written
to the html output directory. User property is: doxygen.chmFile. |
| chmIndexEncoding | String | - | If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
is used to encode HtmlHelp index (hhk), content (hhc) and project
file content. User property is: doxygen.chmIndexEncoding. |
| classDiagrams | boolean | - | 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. Setting the tag to NO turns the
diagrams off. Note that this option is superseded by the HAVE_DOT
option below. This is only a fallback. It is recommended to install
and use dot, since it yields more powerful graphs. Default value is: true. User property is: doxygen.classDiagrams. |
| classGraph | boolean | - | 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. Setting this tag to YES will
force the the CLASS_DIAGRAMS tag to NO. Default value is: true. User property is: doxygen.classGraph. |
| collaborationGraph | boolean | - | 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. Default value is: true. User property is: doxygen.collaborationGraph. |
| colsInAlphaIndex | Integer | - | 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]) Default value is: 5. User property is: doxygen.colsInAlphaIndex. |
| compactLatex | boolean | - | If the COMPACT_LATEX tag is set to YES Doxygen generates more
compact LaTeX documents. This may be useful for small projects and
may help to save some trees in general. Default value is: false. User property is: doxygen.compactLatex. |
| compactRtf | boolean | - | If the COMPACT_RTF tag is set to YES Doxygen generates more compact
RTF documents. This may be useful for small projects and may help
to save some trees in general. Default value is: false. User property is: doxygen.compactRtf. |
| configurationFile | File | - | This defines which file will be used as Doxygen configuration file
instead of creating one. User property is: doxygen.configurationFile. |
| cppCliSupport | boolean | - | If you use Microsoft's C++/CLI language, you should set this option
to YES to enable parsing support. Default value is: false. User property is: doxygen.cppCliSupport. |
| createSubdirs | boolean | - | 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. Enabling this option can be useful when feeding
doxygen a huge amount of source files, where putting all generated
files in the same directory would otherwise cause performance
problems for the file system. Default value is: false. User property is: doxygen.createSubdirs. |
| destDir | String | - | The name of the destination directory. Default value is: doxygen. User property is: destDir. |
| directoryGraph | boolean | - | 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. The dependency relations are
determined by the #include relations between the files in the
directories. Default value is: true. User property is: doxygen.directoryGraph. |
| disableIndex | boolean | - | The DISABLE_INDEX tag can be used to turn on/off the condensed
index at top of each HTML page. The value NO (the default) enables
the index and the value YES disables it. Default value is: false. User property is: doxygen.disableIndex. |
| distributeGroupDoc | boolean | - | 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. By default all members of a group must
be documented explicitly. Default value is: false. User property is: doxygen.distributeGroupDoc. |
| docsetBundleId | String | - | When GENERATE_DOCSET tag is set to YES, this tag specifies a string
that should uniquely identify the documentation set bundle. This
should be a reverse domain-name style string, e.g.
com.mycompany.MyDocSet. Doxygen will append .docset to the name. Default value is: org.doxygen.Project. User property is: doxygen.docsetBundleId. |
| docsetFeedname | String | - | When GENERATE_DOCSET tag is set to YES, this tag determines the
name of the feed. A documentation feed provides an umbrella under
which multiple documentation sets from a single provider (such as a
company or product suite) can be grouped. Default value is: "Doxygen generated docs". User property is: doxygen.docsetFeedname. |
| dotCleanup | boolean | - | If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
remove the intermediate dot files that are used to generate the
various graphs. Default value is: true. User property is: doxygen.dotCleanup. |
| dotFontname | String | - | By default doxygen will write a font called FreeSans.ttf to the
output directory and reference it in all dot files that doxygen
generates. This font does not include all possible unicode
characters however, so when you need these (or just want a
differently looking font) you can specify the font name using
DOT_FONTNAME. You need need to make sure dot is able to find the
font, which can be done by putting it in a standard location or by
setting the DOTFONTPATH environment variable or by setting
DOT_FONTPATH to the directory containing the font. Default value is: FreeSans. User property is: doxygen.dotFontname. |
| dotFontpath | String | - | By default doxygen will tell dot to use the output directory to
look for the FreeSans.ttf font (which doxygen will put there
itself). If you specify a different font using DOT_FONTNAME you can
set the path where dot can find it using this tag. User property is: doxygen.dotFontpath. |
| dotFontsize | Integer | - | The DOT_FONTSIZE tag can be used to set the size of the font of dot
graphs. The default size is 10pt. Default value is: 10. User property is: doxygen.dotFontsize. |
| dotGraphMaxNodes | Integer | - | The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number
of nodes that will be shown in the graph. If the number of nodes in
a graph becomes larger than this value, doxygen will truncate the
graph, which is visualized by representing a node as a red box.
Note that doxygen if the number of direct children of the root node
in a graph is already larger than DOT_GRAPH_MAX_NODES then the
graph will not be shown at all. Also note that the size of a graph
can be further restricted by MAX_DOT_GRAPH_DEPTH. Default value is: 50. User property is: doxygen.dotGraphMaxNodes. |
| dotImageFormat | String | - | The DOT_IMAGE_FORMAT tag can be used to set the image format of the
images generated by dot. Possible values are png, jpg, or gif If
left blank png will be used. Default value is: png. User property is: doxygen.dotImageFormat. |
| dotMultiTargets | boolean | - | Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple
output files in one run (i.e. multiple -o and -T options on the
command line). This makes dot run faster, but since only newer
versions of dot (>1.8.10) support this, this feature is disabled
by default. Default value is: true. User property is: doxygen.dotMultiTargets. |
| dotPath | String | - | The tag DOT_PATH can be used to specify the path where the dot tool
can be found. If left blank, it is assumed the dot tool can be
found in the path. Default value is: /usr/bin. User property is: doxygen.dotPath. |
| dotTransparent | boolean | - | Set the DOT_TRANSPARENT tag to YES to generate images with a
transparent background. This is disabled by default, because dot on
Windows does not seem to support this out of the box. Warning:
Depending on the platform used, enabling this option may lead to
badly anti-aliased labels on the edges of a graph (i.e. they become
hard to read). Default value is: true. User property is: doxygen.dotTransparent. |
| dotfileDirs | String | - | 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). User property is: doxygen.dotfileDirs. |
| doxyfileEncoding | String | - | This tag specifies the encoding used for all characters in the
config file that follow. The default is UTF-8 which is also the
encoding used for all text before the first occurrence of this tag.
Doxygen uses libiconv (or the iconv built into libc) for the
transcoding. See http://www.gnu.org/software/libiconv for the list
of possible encodings. Default value is: UTF-8. User property is: doxygen.doxyfileEncoding. |
| enablePreprocessing | boolean | - | 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. Default value is: true. User property is: doxygen.enablePreprocessing. |
| enabledSections | String | - | The ENABLED_SECTIONS tag can be used to enable conditional
documentation sections, marked by \if sectionname ... \endif. User property is: doxygen.enabledSections. |
| enumValuesPerLine | Integer | - | This tag can be used to set the number of enum values (range
[1..20]) that doxygen will group on one line in the generated HTML
documentation. Default value is: 4. User property is: doxygen.enumValuesPerLine. |
| examplePath | String | - | 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). User property is: doxygen.examplePath. |
| examplePatterns | String | - | 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 left blank all files are included. User property is: doxygen.examplePatterns. |
| exampleRecursive | boolean | - | 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. Possible values are YES and NO. If left blank NO is used. Default value is: false. User property is: doxygen.exampleRecursive. |
| exclude | String | - | The EXCLUDE tag can be used to specify files and/or directories
that should excluded from the INPUT source files. This way you can
easily exclude a subdirectory from a directory tree whose root is
specified with the INPUT tag. Default value is: .svn. User property is: doxygen.exclude. |
| excludePatterns | String | - | 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. Note that the
wildcards are matched against the file with absolute path, so to
exclude all test directories for example use the pattern
&x2a/test/&x2a User property is: doxygen.excludePatterns. |
| excludeSymbols | String | - | 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 symbol name can be a fully qualified
name, a word, or if the wildcard * is used, a substring. Examples:
ANamespace, AClass, AClass::ANamespace, ANamespace::*Test User property is: doxygen.excludeSymbols. |
| excludeSymlinks | boolean | - | 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. Default value is: false. User property is: doxygen.excludeSymlinks. |
| executable | String | - | This defines the name and/or the absolute path to he doxygen
executable. Usually you shouldn't change this, cause the plugin
will automatically search for the executable. Default value is: doxygen. User property is: doxygen.executable. |
| expandAsDefined | String | - | If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES
then this tag can be used to specify a list of macro names that
should be expanded. The macro definition that is found in the
sources will be used. Use the PREDEFINED tag if you want to use a
different macro definition. User property is: doxygen.expandAsDefined. |
| expandOnlyPredef | boolean | - | 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. Default value is: false. User property is: doxygen.expandOnlyPredef. |
| externalGroups | boolean | - | If the EXTERNAL_GROUPS tag is set to YES all external groups will
be listed in the modules index. If set to NO, only the current
project's groups will be listed. Default value is: true. User property is: doxygen.externalGroups. |
| extraPackages | String | - | The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
packages that should be included in the LaTeX output. User property is: doxygen.extraPackages. |
| extractAll | boolean | - | If the EXTRACT_ALL tag is set to YES doxygen will assume all
entities in documentation are documented, even if no documentation
was available. Private class members and static file members will
be hidden unless the EXTRACT_PRIVATE and EXTRACT_STATIC tags are
set to YES Default value is: false. User property is: doxygen.extractAll. |
| extractAnonNspaces | boolean | - | 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. By default anonymous namespace are hidden. Default value is: false. User property is: doxygen.extractAnonNspaces. |
| extractLocalClasses | boolean | - | If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and
structs) defined locally in source files will be included in the
documentation. If set to NO only classes defined in header files
are included. Default value is: true. User property is: doxygen.extractLocalClasses. |
| extractLocalMethods | boolean | - | This flag is only useful for Objective-C code. When set to YES
local methods, which are defined in the implementation section but
not in the interface are included in the documentation. If set to
NO (the default) only methods in the interface are included. Default value is: false. User property is: doxygen.extractLocalMethods. |
| extractPrivate | boolean | - | If the EXTRACT_PRIVATE tag is set to YES all private members of a
class will be included in the documentation. Default value is: false. User property is: doxygen.extractPrivate. |
| extractStatic | boolean | - | If the EXTRACT_STATIC tag is set to YES all static members of a
file will be included in the documentation. Default value is: false. User property is: doxygen.extractStatic. |
| filePatterns | String | - | 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.
If left blank the following patterns are tested: *.c *.cc *.cxx
*.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
*.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 Default value is: *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90. User property is: doxygen.filePatterns. |
| fileVersionFilter | String | - | 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). Doxygen will
invoke the program by executing (via popen()) the command
<command> <input-file>, where <command> is the
value of the FILE_VERSION_FILTER tag, and <input-file> is the
name of an input file provided by doxygen. Whatever the program
writes to standard output is used as the file version. See the
manual for examples. User property is: doxygen.fileVersionFilter. |
| filterPatterns | String | - | The FILTER_PATTERNS tag can be used to specify filters on a per
file pattern basis. Doxygen will compare the file name with each
pattern and apply the filter if there is a match. The filters are a
list of the form: pattern=filter (like *.cpp=my_cpp_filter). See
INPUT_FILTER for further info on how filters are used. If
FILTER_PATTERNS is empty, INPUT_FILTER is applied to all files. User property is: doxygen.filterPatterns. |
| filterSourceFiles | boolean | - | 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). Default value is: false. User property is: doxygen.filterSourceFiles. |
| formulaFontsize | Integer | - | Use this tag to change the font size of Latex formulas included as
images in the HTML documentation. The default is 10. Note that when
you change the font size after a successful doxygen run you need to
manually remove any form_*.png images from the HTML output
directory to force them to be regenerated. Default value is: 10. User property is: doxygen.formulaFontsize. |
| fullPathNames | boolean | - | If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend
the full path before files name in the file list and in the header
files. If set to NO the shortest path that makes the file name
unique will be used. Default value is: true. User property is: doxygen.fullPathNames. |
| generateAutogenDef | boolean | - | 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. Note that this
feature is still experimental and incomplete at the moment. Default value is: false. User property is: doxygen.generateAutogenDef. |
| generateBuglist | boolean | - | The GENERATE_BUGLIST tag can be used to enable (YES) or disable
(NO) the bug list. This list is created by putting \bug commands in
the documentation. Default value is: true. User property is: doxygen.generateBuglist. |
| generateChi | boolean | - | 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). Default value is: false. User property is: doxygen.generateChi. |
| generateDeprecatedlist | boolean | - | The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
disable (NO) the deprecated list. This list is created by putting
\deprecated commands in the documentation. Default value is: true. User property is: doxygen.generateDeprecatedlist. |
| generateDocset | boolean | - | 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). To create a documentation set, doxygen will generate a
Makefile in the HTML output directory. Running make will produce
the docset in that directory and running "make install" will
install the docset in
~/Library/Developer/Shared/Documentation/DocSets so that Xcode will
find it at startup. See
http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
for more information. Default value is: false. User property is: doxygen.generateDocset. |
| generateHtml | boolean | - | If the GENERATE_HTML tag is set to YES (the default) Doxygen will
generate HTML output. Default value is: true. User property is: doxygen.generateHtml. |
| generateHtmlhelp | boolean | - | 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. Default value is: false. User property is: doxygen.generateHtmlhelp. |
| generateLatex | boolean | - | If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
generate Latex output. Default value is: false. User property is: doxygen.generateLatex. |
| generateLegend | boolean | - | 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. Default value is: true. User property is: doxygen.generateLegend. |
| generateMan | boolean | - | If the GENERATE_MAN tag is set to YES (the default) Doxygen will
generate man pages Default value is: false. User property is: doxygen.generateMan. |
| generatePerlmod | boolean | - | 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. Note that this feature is still experimental and
incomplete at the moment. Default value is: false. User property is: doxygen.generatePerlmod. |
| generateQhp | boolean | - | 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. Default value is: false. User property is: doxygen.generateQhp. |
| generateRtf | boolean | - | 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. Default value is: false. User property is: doxygen.generateRtf. |
| generateTagfile | String | - | When a file name is specified after GENERATE_TAGFILE, doxygen will
create a tag file that is based on the input files it reads. User property is: doxygen.generateTagfile. |
| generateTestlist | boolean | - | The GENERATE_TESTLIST tag can be used to enable (YES) or disable
(NO) the test list. This list is created by putting \test commands
in the documentation. Default value is: true. User property is: doxygen.generateTestlist. |
| generateTodolist | boolean | - | The GENERATE_TODOLIST tag can be used to enable (YES) or disable
(NO) the todo list. This list is created by putting \todo commands
in the documentation. Default value is: true. User property is: doxygen.generateTodolist. |
| generateTreeview | String | - | The GENERATE_TREEVIEW tag is used to specify whether a tree-like
index structure should be generated to display hierarchical
information. If the tag value is set to FRAME, a side panel will be
generated containing a tree-like index structure (just like the one
that is generated for HTML Help). For this to work a browser that
supports JavaScript, DHTML, CSS and frames is required (for
instance Mozilla 1.0+, Netscape 6.0+, Internet explorer 5.0+, or
Konqueror). Windows users are probably better off using the HTML
help feature. Other possible values for this tag are: HIERARCHIES,
which will generate the Groups, Directories, and Class Hierarchy
pages using a tree view instead of an ordered list; ALL, which
combines the behavior of FRAME and HIERARCHIES; and NONE, which
disables this behavior completely. For backwards compatibility with
previous releases of Doxygen, the values YES and NO are equivalent
to FRAME and NONE respectively. Default value is: ALL. User property is: doxygen.generateTreeview. |
| generateXml | boolean | - | If the GENERATE_XML tag is set to YES Doxygen will generate an XML
file that captures the structure of the code including all
documentation. Default value is: false. User property is: doxygen.generateXml. |
| graphicalHierarchy | boolean | - | If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then
doxygen will graphical hierarchy of all classes instead of a
textual one. Default value is: true. User property is: doxygen.graphicalHierarchy. |
| groupGraphs | boolean | - | If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
will generate a graph for groups, showing the direct groups
dependencies Default value is: true. User property is: doxygen.groupGraphs. |
| haveDot | boolean | - | If you set the HAVE_DOT tag to YES then doxygen will assume the dot
tool is available from the path. This tool is part of Graphviz, a
graph visualization toolkit from AT&T and Lucent Bell Labs. The
other options in this section have no effect if this option is set
to NO (the default) Default value is: true. User property is: doxygen.haveDot. |
| hhcLocation | String | - | 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 non-empty doxygen
will try to run the HTML help compiler on the generated index.hhp. User property is: doxygen.hhcLocation. |
| hideFriendCompounds | boolean | - | If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide
all friend (class|struct|union) declarations. If set to NO (the
default) these declarations will be included in the documentation. Default value is: false. User property is: doxygen.hideFriendCompounds. |
| hideInBodyDocs | boolean | - | If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
documentation blocks found inside the body of a function. If set to
NO (the default) these blocks will be appended to the function's
detailed documentation block. Default value is: false. User property is: doxygen.hideInBodyDocs. |
| hideScopeNames | boolean | - | If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
will show members with their full class and namespace scopes in the
documentation. If set to YES the scope will be hidden. Default value is: false. User property is: doxygen.hideScopeNames. |
| hideUndocClasses | boolean | - | If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
undocumented classes that are normally visible in the class
hierarchy. If set to NO (the default) these classes will be
included in the various overviews. This option has no effect if
EXTRACT_ALL is enabled. Default value is: false. User property is: doxygen.hideUndocClasses. |
| hideUndocMembers | boolean | - | If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
undocumented members of documented classes, files or namespaces. If
set to NO (the default) these members will be included in the
various overviews, but no documentation section is generated. This
option has no effect if EXTRACT_ALL is enabled. Default value is: false. User property is: doxygen.hideUndocMembers. |
| hideUndocRelations | boolean | - | If set to YES, the inheritance and collaboration graphs will hide
inheritance and usage relations if the target is undocumented or is
not a class. Default value is: true. User property is: doxygen.hideUndocRelations. |
| htmlAlignMembers | boolean | - | If the HTML_ALIGN_MEMBERS tag is set to YES, the members of
classes, files or namespaces will be aligned in HTML using tables.
If set to NO a bullet list will be used. Default value is: true. User property is: doxygen.htmlAlignMembers. |
| htmlDynamicSections | boolean | - | 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. For this to work a browser that
supports JavaScript and DHTML is required (for instance Mozilla
1.0+, Firefox Netscape 6.0+, Internet explorer 5.0+, Konqueror, or
Safari). Default value is: true. User property is: doxygen.htmlDynamicSections. |
| htmlFileExtension | String | - | The HTML_FILE_EXTENSION tag can be used to specify the file
extension for each generated HTML page (for example:
.htm,.php,.asp). If it is left blank doxygen will generate files
with .html extension. Default value is: .html. User property is: doxygen.htmlFileExtension. |
| htmlFooter | String | - | The HTML_FOOTER tag can be used to specify a personal HTML footer
for each generated HTML page. If it is left blank doxygen will
generate a standard footer. User property is: doxygen.htmlFooter. |
| htmlHeader | String | - | The HTML_HEADER tag can be used to specify a personal HTML header
for each generated HTML page. If it is left blank doxygen will
generate a standard header. User property is: doxygen.htmlHeader. |
| htmlOutput | String | - | The HTML_OUTPUT tag is used to specify where the HTML docs will be
put. If a relative path is entered the value of OUTPUT_DIRECTORY
will be put in front of it. If left blank `html' will be used as
the default path. Default value is: doxygen. User property is: doxygen.htmlOutput. |
| htmlStylesheet | String | - | The HTML_STYLESHEET tag can be used to specify a user-defined
cascading style sheet that is used by each HTML page. It can be
used to fine-tune the look of the HTML output. If the tag is left
blank doxygen will generate a default style sheet. Note that
doxygen will try to copy the style sheet file to the HTML output
directory, so don't put your own stylesheet in the HTML output
directory as well, or it will be erased! User property is: doxygen.htmlStylesheet. |
| idlPropertySupport | boolean | - | For Microsoft's IDL there are propget and propput attributes to
indicate getter and setter methods for a property. Setting this
option to YES (the default) will make doxygen to replace the get
and set methods by a property in the documentation. This will only
work if the methods are indeed getting or setting a simple type. If
this is not the case, or you want to show the methods anyway, you
should set this option to NO. Default value is: true. User property is: doxygen.idlPropertySupport. |
| ignorePrefix | String | - | In case all classes in a project start with a common prefix, all
classes will be put under the same header in the alphabetical
index. The IGNORE_PREFIX tag can be used to specify one or more
prefixes that should be ignored while generating the index headers. User property is: doxygen.ignorePrefix. |
| imagePath | String | - | 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). User property is: doxygen.imagePath. |
| includeFilePatterns | String | - | 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 left blank, the patterns
specified with FILE_PATTERNS will be used. User property is: doxygen.includeFilePatterns. |
| includeGraph | boolean | - | 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. Default value is: true. User property is: doxygen.includeGraph. |
| includePath | String | - | 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. User property is: doxygen.includePath. |
| includedByGraph | boolean | - | 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. Default value is: true. User property is: doxygen.includedByGraph. |
| inheritDocs | boolean | - | 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. Default value is: true. User property is: doxygen.inheritDocs. |
| inlineInfo | boolean | - | If the INLINE_INFO tag is set to YES (the default) then a tag
[inline] is inserted in the documentation for inline members. Default value is: true. User property is: doxygen.inlineInfo. |
| inlineInheritedMemb | boolean | - | 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. Constructors,
destructors and assignment operators of the base classes will not
be shown. Default value is: false. User property is: doxygen.inlineInheritedMemb. |
| inlineSources | boolean | - | Setting the INLINE_SOURCES tag to YES will include the body of
functions and classes directly in the documentation. Default value is: false. User property is: doxygen.inlineSources. |
| input | String | - | The INPUT tag can be used to specify the files and/or directories
that contain documented source files. You may enter file names like
"myfile.cpp" or directories like "/usr/src/myproject". Separate the
files or directories with spaces. Default value is: ${project.build.sourceDirectory}. User property is: doxygen.input. |
| inputEncoding | String | - | This tag can be used to specify the character encoding of the
source files that doxygen parses. Internally doxygen uses the UTF-8
encoding, which is also the default input encoding. Doxygen uses
libiconv (or the iconv built into libc) for the transcoding. See
http://www.gnu.org/software/libiconv for the list of possible
encodings. Default value is: UTF-8. User property is: doxygen.inputEncoding. |
| inputFilter | String | - | The INPUT_FILTER tag can be used to specify a program that doxygen
should invoke to filter for each input file. Doxygen will invoke
the filter program by executing (via popen()) the command
<filter> <input-file>, where <filter> is the
value of the INPUT_FILTER tag, and <input-file> is the name
of an input file. Doxygen will then use the output that the filter
program writes to standard output. If FILTER_PATTERNS is specified,
this tag will be ignored. User property is: doxygen.inputFilter. |
| internalDocs | boolean | - | The INTERNAL_DOCS tag determines if documentation that is typed
after a \internal command is included. If the tag is set to NO (the
default) then the documentation will be excluded. Set it to YES to
include the internal documentation. Default value is: false. User property is: doxygen.internalDocs. |
| javadocAutobrief | boolean | - | 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 set to NO, the JavaDoc
comments will behave just like regular Qt-style comments (thus
requiring an explicit @brief command for a brief description.) Default value is: false. User property is: doxygen.javadocAutobrief. |
| latexBatchmode | boolean | - | If the LATEX_BATCHMODE tag is set to YES, doxygen will add the
\\batchmode. command to the generated LaTeX files. This will
instruct LaTeX to keep running if errors occur, instead of asking
the user for help. This option is also used when generating
formulas in HTML. Default value is: false. User property is: doxygen.latexBatchmode. |
| latexCmdName | String | - | The LATEX_CMD_NAME tag can be used to specify the LaTeX command
name to be invoked. If left blank `latex' will be used as the
default command name. Default value is: latex. User property is: doxygen.latexCmdName. |
| latexHeader | String | - | The LATEX_HEADER tag can be used to specify a personal LaTeX header
for the generated latex document. The header should contain
everything until the first chapter. If it is left blank doxygen
will generate a standard header. Notice: only use this tag if you
know what you are doing! User property is: doxygen.latexHeader. |
| latexHideIndices | boolean | - | If LATEX_HIDE_INDICES is set to YES then doxygen will not include
the index chapters (such as File Index, Compound Index, etc.) in
the output. Default value is: false. User property is: doxygen.latexHideIndices. |
| latexOutput | String | - | The LATEX_OUTPUT tag is used to specify where the LaTeX docs will
be put. If a relative path is entered the value of OUTPUT_DIRECTORY
will be put in front of it. If left blank `latex' will be used as
the default path. Default value is: latex. User property is: doxygen.latexOutput. |
| layoutFile | String | - | The LAYOUT_FILE tag can be used to specify a layout file which will
be parsed by doxygen. The layout file controls the global structure
of the generated output files in an output format independent way.
The create the layout file that represents doxygen's defaults, run
doxygen with the -l option. You can optionally specify a file name
after the option, if omitted DoxygenLayout.xml will be used as the
name of the layout file. User property is: doxygen.layoutFile. |
| macroExpansion | boolean | - | If the MACRO_EXPANSION tag is set to YES Doxygen will expand all
macro names in the source code. If set to NO (the default) only
conditional compilation will be performed. Macro expansion can be
done in a controlled way by setting EXPAND_ONLY_PREDEF to YES. Default value is: false. User property is: doxygen.macroExpansion. |
| makeindexCmdName | String | - | The MAKEINDEX_CMD_NAME tag can be used to specify the command name
to generate index for LaTeX. If left blank `makeindex' will be used
as the default command name. Default value is: makeindex. User property is: doxygen.makeindexCmdName. |
| manExtension | String | - | The MAN_EXTENSION tag determines the extension that is added to the
generated man pages (default is the subroutine's section .3) Default value is: .3. User property is: doxygen.manExtension. |
| manLinks | boolean | - | 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). These additional files
only source the real man page, but without them the man command
would be unable to find the correct page. The default is NO. Default value is: false. User property is: doxygen.manLinks. |
| manOutput | String | - | The MAN_OUTPUT tag is used to specify where the man pages will be
put. If a relative path is entered the value of OUTPUT_DIRECTORY
will be put in front of it. If left blank `man' will be used as the
default path. Default value is: man. User property is: doxygen.manOutput. |
| maxDotGraphDepth | Integer | - | The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of
the graphs generated by dot. A depth value of 3 means that only
nodes reachable from the root by following a path via at most 3
edges will be shown. Nodes that lay further from the root node will
be omitted. Note that setting this option to 1 or 2 may greatly
reduce the computation time needed for large code bases. Also note
that the size of a graph can be further restricted by
DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. Default value is: 0. User property is: doxygen.maxDotGraphDepth. |
| maxInitializerLines | Integer | - | 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 initializer consists of more
lines than specified here it will be hidden. Use a value of 0 to
hide initializers completely. The appearance of the initializer of
individual variables and defines in the documentation can be
controlled using \showinitializer or \hideinitializer command in
the documentation regardless of this setting. Default value is: 30. User property is: doxygen.maxInitializerLines. |
| mscgenPath | String | - | You can define message sequence charts within doxygen comments
using the \msc command. Doxygen will then run the mscgen tool (see
http://www.mcternan.me.uk/mscgen/) to produce the chart and insert
it in the documentation. The MSCGEN_PATH tag allows you to specify
the directory where the mscgen tool resides. If left empty the tool
is assumed to be found in the default search path. User property is: doxygen.mscgenPath. |
| multilineCppIsBrief | boolean | - | The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
treat a multi-line C++ special comment block (i.e. a block of //!
or /// comments) as a brief description. This used to be the
default behaviour. The new default is to treat a multi-line C++
comment block as a detailed description. Set this tag to YES if you
prefer the old behaviour instead. Default value is: false. User property is: doxygen.multilineCppIsBrief. |
| optimizeForFortran | boolean | - | Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of
Fortran sources only. Doxygen will then generate output that is
more tailored for Fortran. Default value is: false. User property is: doxygen.optimizeForFortran. |
| optimizeOutputForC | boolean | - | Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists
of C sources only. Doxygen will then generate output that is more
tailored for C. For instance, some of the names that are used will
be different. The list of all members will be omitted, etc. Default value is: false. User property is: doxygen.optimizeOutputForC. |
| optimizeOutputJava | boolean | - | Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of
Java sources only. Doxygen will then generate output that is more
tailored for Java. For instance, namespaces will be presented as
packages, qualified scopes will look different, etc. Default value is: false. User property is: doxygen.optimizeOutputJava. |
| optimizeOutputVhdl | boolean | - | Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of
VHDL sources. Doxygen will then generate output that is tailored
for VHDL. Default value is: false. User property is: doxygen.optimizeOutputVhdl. |
| outputDirectory | File | - | The OUTPUT_DIRECTORY tag is used to specify the (relative or
absolute) base path where the generated documentation will be put.
If a relative path is entered, it will be relative to the location
where doxygen was started. If left blank the current directory will
be used. Default value is: ${project.reporting.outputDirectory}. User property is: doxygen.outputDirectory. |
| outputLanguage | String | - | The OUTPUT_LANGUAGE tag is used to specify the language in which
all documentation generated by doxygen is written. Doxygen will use
this information to generate all constant output in the proper
language. The default language is English, other supported
languages are: Afrikaans, Arabic, Brazilian, Catalan, Chinese,
Chinese-Traditional, Croatian, Czech, Danish, Dutch, Farsi,
Finnish, French, German, Greek, Hungarian, Italian, Japanese,
Japanese-en (Japanese with English messages), Korean, Korean-en,
Lithuanian, Norwegian, Macedonian, Persian, Polish, Portuguese,
Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
Spanish, Swedish, and Ukrainian. Default value is: English. User property is: doxygen.outputLanguage. |
| paperType | String | - | The PAPER_TYPE tag can be used to set the paper type that is used
by the printer. Possible values are: a4, a4wide, letter, legal and
executive. If left blank a4wide will be used. Default value is: a4wide. User property is: doxygen.paperType. |
| pdfHyperlinks | boolean | - | If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is
generated is prepared for conversion to pdf (using ps2pdf). The pdf
file will contain links (just like the HTML output) instead of page
references This makes the output suitable for online browsing using
a pdf viewer. Default value is: true. User property is: doxygen.pdfHyperlinks. |
| perlPath | String | - | The PERL_PATH should be the absolute path and name of the perl
script interpreter (i.e. the result of `which perl'). Default value is: /usr/bin/perl. User property is: doxygen.perlPath. |
| perlmodLatex | boolean | - | 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. Default value is: false. User property is: doxygen.perlmodLatex. |
| perlmodMakevarPrefix | String | - | The names of the make variables in the generated doxyrules.make
file are prefixed with the string contained in
PERLMOD_MAKEVAR_PREFIX. This is useful so different doxyrules.make
files included by the same Makefile don't overwrite each other's
variables. User property is: doxygen.perlmodMakevarPrefix. |
| perlmodPretty | boolean | - | If the PERLMOD_PRETTY tag is set to YES the Perl module output will
be nicely formatted so it can be parsed by a human reader. This is
useful if you want to understand what is going on. On the other
hand, if this tag is set to NO the size of the Perl module output
will be much smaller and Perl will parse it just the same. Default value is: true. User property is: doxygen.perlmodPretty. |
| predefined | String | - | 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). The argument of the tag is a list of macros of
the form: name or name=definition (no spaces). If the definition
and the = are omitted =1 is assumed. To prevent a macro definition
from being undefined via #undef or recursively expanded use the :=
operator instead of the = operator. User property is: doxygen.predefined. |
| projectName | String | - | The PROJECT_NAME tag is a single word (or a sequence of words
surrounded by quotes) that should identify the project. Default value is: ${project.name}. User property is: doxygen.projectName. |
| projectNumber | String | - | The PROJECT_NUMBER tag can be used to enter a project or revision
number. This could be handy for archiving the generated
documentation or if some version control system is used. User property is: doxygen.projectNumber. |
| qchFile | String | - | If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used
to specify the file name of the resulting .qch file. The path
specified is relative to the HTML output folder. User property is: doxygen.qchFile. |
| qhgLocation | String | - | If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can be
used to specify the location of Qt's qhelpgenerator. If non-empty
doxygen will try to run qhelpgenerator on the generated .qhp file . User property is: doxygen.qhgLocation. |
| qhpNamespace | String | - | The QHP_NAMESPACE tag specifies the namespace to use when
generating Qt Help Project output. For more information please see
<a
href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt
Help Project / Namespace</a>. Default value is: org.doxygen.Project. User property is: doxygen.qhpNamespace. |
| qhpVirtualFolder | String | - | The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when
generating Qt Help Project output. For more information please see
<a
href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt
Help Project / Virtual Folders</a>. Default value is: doc. User property is: doxygen.qhpVirtualFolder. |
| qtAutobrief | boolean | - | If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret
the first line (until the first dot) of a Qt-style comment as the
brief description. If set to NO, the comments will behave just like
regular Qt-style comments (thus requiring an explicit \brief
command for a brief description.) Default value is: false. User property is: doxygen.qtAutobrief. |
| quiet | boolean | - | The QUIET tag can be used to turn on/off the messages that are
generated by doxygen. Possible values are YES and NO. If left blank
NO is used. Default value is: true. User property is: doxygen.quiet. |
| recursive | boolean | - | The RECURSIVE tag can be used to turn specify whether or not
subdirectories should be searched for input files as well. Possible
values are YES and NO. If left blank NO is used. Default value is: false. User property is: doxygen.recursive. |
| referencedByRelation | boolean | - | If the REFERENCED_BY_RELATION tag is set to YES then for each
documented function all documented functions referencing it will be
listed. Default value is: false. User property is: doxygen.referencedByRelation. |
| referencesLinkSource | boolean | - | 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. Otherwise they will link to the
documentstion. Default value is: true. User property is: doxygen.referencesLinkSource. |
| referencesRelation | boolean | - | If the REFERENCES_RELATION tag is set to YES then for each
documented function all documented entities called/used by that
function will be listed. Default value is: false. User property is: doxygen.referencesRelation. |
| repeatBrief | boolean | - | 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. Note: if both HIDE_UNDOC_MEMBERS and
BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
completely suppressed. Default value is: true. User property is: doxygen.repeatBrief. |
| rtfExtensionsFile | String | - | Set optional variables used in the generation of an rtf document.
Syntax is similar to doxygen's config file. User property is: doxygen.rtfExtensionsFile. |
| rtfHyperlinks | boolean | - | If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
will contain hyperlink fields. The RTF file will contain links
(just like the HTML output) instead of page references. This makes
the output suitable for online browsing using WORD or other
programs which support those fields. Note: wordpad (write) and
others do not support links. Default value is: false. User property is: doxygen.rtfHyperlinks. |
| rtfOutput | String | - | The RTF_OUTPUT tag is used to specify where the RTF docs will be
put. If a relative path is entered the value of OUTPUT_DIRECTORY
will be put in front of it. If left blank `rtf' will be used as the
default path. Default value is: rtf. User property is: doxygen.rtfOutput. |
| rtfStylesheetFile | String | - | Load stylesheet definitions from file. Syntax is similar to
doxygen's config file, i.e. a series of assignments. You only have
to provide replacements, missing definitions are set to their
default value. User property is: doxygen.rtfStylesheetFile. |
| searchIncludes | boolean | - | If the SEARCH_INCLUDES tag is set to YES (the default) the includes
files in the INCLUDE_PATH (see below) will be search if a #include
is found. Default value is: true. User property is: doxygen.searchIncludes. |
| searchengine | boolean | - | The SEARCHENGINE tag specifies whether or not a search engine
should be used. If set to NO the values of all tags below this one
will be ignored. Default value is: false. User property is: doxygen.searchengine. |
| separateMemberPages | boolean | - | If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will
produce a new page for each member. If set to NO, the documentation
of a member will be part of the file/class/namespace that contains
it. Default value is: false. User property is: doxygen.separateMemberPages. |
| shortNames | boolean | - | If the SHORT_NAMES tag is set to YES, doxygen will generate much
shorter (but less readable) file names. This can be useful is your
file systems doesn't support long names like on DOS, Mac, or
CD-ROM. Default value is: false. User property is: doxygen.shortNames. |
| showDirectories | boolean | - | 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. The default is NO. Default value is: true. User property is: doxygen.showDirectories. |
| showFiles | boolean | - | Set the SHOW_FILES tag to NO to disable the generation of the Files
page. This will remove the Files entry from the Quick Index and
from the Folder Tree View (if specified). The default is YES. Default value is: true. User property is: doxygen.showFiles. |
| showIncludeFiles | boolean | - | 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. Default value is: true. User property is: doxygen.showIncludeFiles. |
| showNamespaces | boolean | - | Set the SHOW_NAMESPACES tag to NO to disable the generation of the
Namespaces page. This will remove the Namespaces entry from the
Quick Index and from the Folder Tree View (if specified). The
default is YES. Default value is: true. User property is: doxygen.showNamespaces. |
| showUsedFiles | boolean | - | Set the SHOW_USED_FILES tag to NO to disable the list of files
generated at the bottom of the documentation of classes and
structs. If set to YES the list will mention the files that were
used to generate the documentation. Default value is: true. User property is: doxygen.showUsedFiles. |
| sipSupport | boolean | - | Set the SIP_SUPPORT tag to YES if your project consists of sip
sources only. Doxygen will parse them like normal C++ but will
assume all classes use public instead of private inheritance when
no explicit protection keyword is present. Default value is: false. User property is: doxygen.sipSupport. |
| skipFunctionMacros | boolean | - | 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. Such function macros are typically used for
boiler-plate code, and will confuse the parser if not removed. Default value is: true. User property is: doxygen.skipFunctionMacros. |
| sortBriefDocs | boolean | - | 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 set to NO (the default) the
members will appear in declaration order. Default value is: false. User property is: doxygen.sortBriefDocs. |
| sortByScopeName | boolean | - | If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
sorted by fully-qualified names, including namespaces. If set to NO
(the default), the class list will be sorted only by class name,
not including the namespace part. Note: This option is not very
useful if HIDE_SCOPE_NAMES is set to YES. Note: This option applies
only to the class list, not to the alphabetical list. Default value is: false. User property is: doxygen.sortByScopeName. |
| sortGroupNames | boolean | - | If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort
the hierarchy of group names into alphabetical order. If set to NO
(the default) the group names will appear in their defined order. Default value is: false. User property is: doxygen.sortGroupNames. |
| sortMemberDocs | boolean | - | 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. If set to NO the members
will appear in declaration order. Default value is: true. User property is: doxygen.sortMemberDocs. |
| sourceBrowser | boolean | - | If the SOURCE_BROWSER tag is set to YES then a list of source files
will be generated. Documented entities will be cross-referenced
with these sources. Note: To get rid of all source code in the
generated output, make sure also VERBATIM_HEADERS is set to NO. Default value is: true. User property is: doxygen.sourceBrowser. |
| stripCodeComments | boolean | - | Setting the STRIP_CODE_COMMENTS tag to YES (the default) will
instruct doxygen to hide any special comment blocks from generated
source code fragments. Normal C and C++ comments will always remain
visible. Default value is: true. User property is: doxygen.stripCodeComments. |
| stripFromIncPath | String | - | 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. If left blank only the name of the header file containing
the class definition is used. Otherwise one should specify the
include paths that are normally passed to the compiler using the -I
flag. User property is: doxygen.stripFromIncPath. |
| stripFromPath | String | - | If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH
tag can be used to strip a user-defined part of the path. Stripping
is only done if one of the specified strings matches the left-hand
part of the path. The tag can be used to show relative paths in the
file list. If left blank the directory from which doxygen is run is
used as the path to strip. User property is: doxygen.stripFromPath. |
| subgrouping | boolean | - | 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). Set it to NO to prevent subgrouping.
Alternatively, this can be done per class using the \nosubgrouping
command. Default value is: true. User property is: doxygen.subgrouping. |
| symbolCacheSize | Integer | - | The SYMBOL_CACHE_SIZE determines the size of the internal cache use
to determine which symbols to keep in memory and which to flush to
disk. When the cache is full, less often used symbols will be
written to disk. For small to medium size projects (<1000 input
files) the default value is probably good enough. For larger
projects a too small cache size can cause doxygen to be busy
swapping symbols to and from disk most of the time causing a
significant performance penality. If the system has enough physical
memory increasing the cache will improve the performance by keeping
more symbols in memory. Note that the value works on a logarithmic
scale so increasing the size by one will rougly double the memory
usage. The cache size is given by this formula:
2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is
0, corresponding to a cache size of 2^16 = 65536 symbols Default value is: 0. User property is: doxygen.symbolCacheSize. |
| tabSize | Integer | - | The TAB_SIZE tag can be used to set the number of spaces in a tab.
Doxygen uses this value to replace tabs by spaces in code
fragments. Default value is: 8. User property is: doxygen.tabSize. |
| tagfiles | String | - | The TAGFILES option can be used to specify one or more tagfiles.
Optionally an initial location of the external documentation can be
added for each tagfile. The format of a tag file without this
location is as follows: TAGFILES = file1 file2 ... Adding location
for the tag files is done as follows: TAGFILES = file1=loc1 "file2
= loc2" ... where "loc1" and "loc2" can be relative or absolute
paths or URLs. If a location is present for each tag, the
installdox tool does not have to be run to correct the links. Note
that each tag file must have a unique name (where the name does NOT
include the path) If a tag file is not located in the directory in
which doxygen is run, you must also specify the path to the tagfile
here. User property is: doxygen.tagfiles. |
| templateRelations | boolean | - | If set to YES, the inheritance and collaboration graphs will show
the relations between templates and their instances. Default value is: false. User property is: doxygen.templateRelations. |
| tocExpand | boolean | - | The TOC_EXPAND flag can be set to YES to add extra items for group
members to the contents of the HTML help documentation and to the
tree view. Default value is: false. User property is: doxygen.tocExpand. |
| treeviewWidth | Integer | - | 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. Default value is: 250. User property is: doxygen.treeviewWidth. |
| typedefHidesStruct | boolean | - | When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union,
or enum is documented as struct, union, or enum with the name of
the typedef. So typedef struct TypeS {} TypeT, will appear in the
documentation as a struct with name TypeT. When disabled the
typedef will appear as a member of a file, namespace, or class. And
the struct will be named TypeS. This can typically be useful for C
code in case the coding convention dictates that all compound types
are typedef'ed and only the typedef is referenced, never the tag
name. Default value is: false. User property is: doxygen.typedefHidesStruct. |
| umlLook | boolean | - | 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. Default value is: false. User property is: doxygen.umlLook. |
| useHtags | boolean | - | 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. The htags tool is part of GNU's
global source tagging system (see
http://www.gnu.org/software/global/global.html). You will need
version 4.8.6 or higher. Default value is: false. User property is: doxygen.useHtags. |
| usePdflatex | boolean | - | If the USE_PDFLATEX tag is set to YES, pdflatex will be used
instead of plain latex in the generated Makefile. Set this option
to YES to get a higher quality PDF documentation. Default value is: true. User property is: doxygen.usePdflatex. |
| verbatimHeaders | boolean | - | 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. Set to NO to disable this. Default value is: true. User property is: doxygen.verbatimHeaders. |
| warnFormat | String | - | The WARN_FORMAT tag determines the format of the warning messages
that doxygen can produce. The string should contain the $file,
$line, and $text tags, which will be replaced by the file and line
number from which the warning originated and the warning text.
Optionally the format may contain $version, which will be replaced
by the version of the file (if it could be obtained via
FILE_VERSION_FILTER) Default value is: "$file:$line: $text". User property is: doxygen.warnFormat. |
| warnIfDocError | boolean | - | 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. Default value is: true. User property is: doxygen.warnIfDocError. |
| warnIfUndocumented | boolean | - | If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate
warnings for undocumented members. If EXTRACT_ALL is set to YES
then this flag will automatically be disabled. Default value is: true. User property is: doxygen.warnIfUndocumented. |
| warnLogfile | String | - | The WARN_LOGFILE tag can be used to specify a file to which warning
and error messages should be written. If left blank the output is
written to stderr. User property is: doxygen.warnLogfile. |
| warnNoParamdoc | boolean | - | 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 set to NO (the default) doxygen will
only warn about wrong or incomplete parameter documentation, but
not about the absence of documentation. Default value is: true. User property is: doxygen.warnNoParamdoc. |
| warnings | boolean | - | The WARNINGS tag can be used to turn on/off the warning messages
that are generated by doxygen. Possible values are YES and NO. If
left blank NO is used. Default value is: true. User property is: doxygen.warnings. |
| xmlDtd | String | - | The XML_DTD tag can be used to specify an XML DTD, which can be
used by a validating XML parser to check the syntax of the XML
files. User property is: doxygen.xmlDtd. |
| xmlOutput | String | - | The XML_OUTPUT tag is used to specify where the XML pages will be
put. If a relative path is entered the value of OUTPUT_DIRECTORY
will be put in front of it. If left blank `xml' will be used as the
default path. Default value is: xml. User property is: doxygen.xmlOutput. |
| xmlProgramlisting | boolean | - | 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. Note that
enabling this will significantly increase the size of the XML
output. Default value is: true. User property is: doxygen.xmlProgramlisting. |
| xmlSchema | String | - | The XML_SCHEMA tag can be used to specify an XML schema, which can
be used by a validating XML parser to check the syntax of the XML
files. User property is: doxygen.xmlSchema. |