public abstract class AbstractDoxygenConfigurationMojo
extends org.apache.maven.plugin.AbstractMojo
Modifier and Type | Field and Description |
---|---|
private String |
abbreviateBrief
This tag implements a quasi-intelligent brief description abbreviator
that is used to form the text in various listings.
|
private String |
aliases
This tag can be used to specify a number of aliases that acts as commands
in the documentation.
|
private boolean |
allexternals
If the ALLEXTERNALS tag is set to YES all external classes will be listed
in the class index.
|
private boolean |
alphabeticalIndex
If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
compounds will be generated.
|
private boolean |
alwaysDetailedSec
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.
|
private boolean |
binaryToc
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.
|
private boolean |
briefMemberDesc
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).
|
private boolean |
builtinStlSupport
If you use STL classes (i.e.
|
private boolean |
callerGraph
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.
|
private boolean |
callGraph
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.
|
private boolean |
caseSenseNames
If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
file names in lower-case letters.
|
private String |
chmFile
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.
|
private String |
chmIndexEncoding
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.
|
private boolean |
classDiagrams
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.
|
private boolean |
classGraph
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.
|
private boolean |
collaborationGraph
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.
|
private Integer |
colsInAlphaIndex
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])
|
private boolean |
compactLatex
If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
LaTeX documents.
|
private boolean |
compactRtf
If the COMPACT_RTF tag is set to YES Doxygen generates more compact RTF
documents.
|
private File |
configurationFile
This defines which file will be used as Doxygen configuration file
instead of creating one.
|
private boolean |
cppCliSupport
If you use Microsoft's C++/CLI language, you should set this option to
YES to enable parsing support.
|
private boolean |
createSubdirs
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.
|
private boolean |
directoryGraph
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.
|
private boolean |
disableIndex
The DISABLE_INDEX tag can be used to turn on/off the condensed index at
top of each HTML page.
|
private boolean |
distributeGroupDoc
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.
|
private String |
docsetBundleId
When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
should uniquely identify the documentation set bundle.
|
private String |
docsetFeedname
When GENERATE_DOCSET tag is set to YES, this tag determines the name of
the feed.
|
private boolean |
dotCleanup
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.
|
private String |
dotfileDirs
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).
|
private String |
dotFontname
By default doxygen will write a font called FreeSans.ttf to the output
directory and reference it in all dot files that doxygen generates.
|
private String |
dotFontpath
By default doxygen will tell dot to use the output directory to look for
the FreeSans.ttf font (which doxygen will put there itself).
|
private Integer |
dotFontsize
The DOT_FONTSIZE tag can be used to set the size of the font of dot
graphs.
|
private Integer |
dotGraphMaxNodes
The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
nodes that will be shown in the graph.
|
private String |
dotImageFormat
The DOT_IMAGE_FORMAT tag can be used to set the image format of the
images generated by dot.
|
private boolean |
dotMultiTargets
Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple
output files in one run (i.e.
|
private String |
dotPath
The tag DOT_PATH can be used to specify the path where the dot tool can
be found.
|
private boolean |
dotTransparent
Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
background.
|
private String |
doxyfileEncoding
This tag specifies the encoding used for all characters in the config
file that follow.
|
private String |
enabledSections
The ENABLED_SECTIONS tag can be used to enable conditional documentation
sections, marked by \if sectionname ...
|
private boolean |
enablePreprocessing
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.
|
private Integer |
enumValuesPerLine
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.
|
private String |
examplePath
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).
|
private String |
examplePatterns
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.
|
private boolean |
exampleRecursive
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.
|
private String |
exclude
The EXCLUDE tag can be used to specify files and/or directories that
should excluded from the INPUT source files.
|
private String |
excludePatterns
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.
|
private String |
excludeSymbols
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.
|
private boolean |
excludeSymlinks
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.
|
private String |
expandAsDefined
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.
|
private boolean |
expandOnlyPredef
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.
|
private boolean |
externalGroups
If the EXTERNAL_GROUPS tag is set to YES all external groups will be
listed in the modules index.
|
private boolean |
extractAll
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 boolean |
extractAnonNspaces
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.
|
private boolean |
extractLocalClasses
If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
defined locally in source files will be included in the documentation.
|
private boolean |
extractLocalMethods
This flag is only useful for Objective-C code.
|
private boolean |
extractPrivate
If the EXTRACT_PRIVATE tag is set to YES all private members of a class
will be included in the documentation.
|
private boolean |
extractStatic
If the EXTRACT_STATIC tag is set to YES all static members of a file will
be included in the documentation.
|
private String |
extraPackages
The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
packages that should be included in the LaTeX output.
|
private String |
filePatterns
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.
|
private String |
fileVersionFilter
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).
|
private String |
filterPatterns
The FILTER_PATTERNS tag can be used to specify filters on a per file
pattern basis.
|
private boolean |
filterSourceFiles
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.
|
private Integer |
formulaFontsize
Use this tag to change the font size of Latex formulas included as images
in the HTML documentation.
|
private boolean |
fullPathNames
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.
|
private boolean |
generateAutogenDef
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.
|
private boolean |
generateBuglist
The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the
bug list.
|
private boolean |
generateChi
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).
|
private boolean |
generateDeprecatedlist
The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable
(NO) the deprecated list.
|
private boolean |
generateDocset
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).
|
private boolean |
generateHtml
If the GENERATE_HTML tag is set to YES (the default) Doxygen will
generate HTML output.
|
private boolean |
generateHtmlhelp
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.
|
private boolean |
generateLatex
If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
generate Latex output.
|
private boolean |
generateLegend
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.
|
private boolean |
generateMan
If the GENERATE_MAN tag is set to YES (the default) Doxygen will generate
man pages
|
private boolean |
generatePerlmod
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.
|
private boolean |
generateQhp
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.
|
private boolean |
generateRtf
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.
|
private String |
generateTagfile
When a file name is specified after GENERATE_TAGFILE, doxygen will create
a tag file that is based on the input files it reads.
|
private boolean |
generateTestlist
The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the
test list.
|
private boolean |
generateTodolist
The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the
todo list.
|
private String |
generateTreeview
The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
structure should be generated to display hierarchical information.
|
private boolean |
generateXml
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.
|
private boolean |
graphicalHierarchy
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.
|
private boolean |
groupGraphs
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
|
private boolean |
haveDot
If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool
is available from the path.
|
private String |
hhcLocation
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).
|
private boolean |
hideFriendCompounds
If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
friend (class|struct|union) declarations.
|
private boolean |
hideInBodyDocs
If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
documentation blocks found inside the body of a function.
|
private boolean |
hideScopeNames
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.
|
private boolean |
hideUndocClasses
If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
undocumented classes that are normally visible in the class hierarchy.
|
private boolean |
hideUndocMembers
If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
undocumented members of documented classes, files or namespaces.
|
private boolean |
hideUndocRelations
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.
|
private boolean |
htmlAlignMembers
If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
files or namespaces will be aligned in HTML using tables.
|
private boolean |
htmlDynamicSections
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.
|
private String |
htmlFileExtension
The HTML_FILE_EXTENSION tag can be used to specify the file extension for
each generated HTML page (for example: .htm,.php,.asp).
|
private String |
htmlFooter
The HTML_FOOTER tag can be used to specify a personal HTML footer for
each generated HTML page.
|
private String |
htmlHeader
The HTML_HEADER tag can be used to specify a personal HTML header for
each generated HTML page.
|
private String |
htmlOutput
The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
private String |
htmlStylesheet
The HTML_STYLESHEET tag can be used to specify a user-defined cascading
style sheet that is used by each HTML page.
|
private boolean |
idlPropertySupport
For Microsoft's IDL there are propget and propput attributes to indicate
getter and setter methods for a property.
|
private String |
ignorePrefix
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.
|
private String |
imagePath
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).
|
private boolean |
includedByGraph
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.
|
private String |
includeFilePatterns
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.
|
private boolean |
includeGraph
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.
|
private String |
includePath
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.
|
private boolean |
inheritDocs
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.
|
private boolean |
inlineInfo
If the INLINE_INFO tag is set to YES (the default) then a tag [inline] is
inserted in the documentation for inline members.
|
private boolean |
inlineInheritedMemb
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.
|
private boolean |
inlineSources
Setting the INLINE_SOURCES tag to YES will include the body of functions
and classes directly in the documentation.
|
private String |
input
The INPUT tag can be used to specify the files and/or directories that
contain documented source files.
|
private String |
inputEncoding
This tag can be used to specify the character encoding of the source
files that doxygen parses.
|
private String |
inputFilter
The INPUT_FILTER tag can be used to specify a program that doxygen should
invoke to filter for each input file.
|
private boolean |
internalDocs
The INTERNAL_DOCS tag determines if documentation that is typed after a
\internal command is included.
|
private boolean |
javadocAutobrief
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.
|
private boolean |
latexBatchmode
If the LATEX_BATCHMODE tag is set to YES, doxygen will add the
\\batchmode.
|
private String |
latexCmdName
The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to
be invoked.
|
private String |
latexHeader
The LATEX_HEADER tag can be used to specify a personal LaTeX header for
the generated latex document.
|
private boolean |
latexHideIndices
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.
|
private String |
latexOutput
The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
private String |
layoutFile
The LAYOUT_FILE tag can be used to specify a layout file which will be
parsed by doxygen.
|
private boolean |
macroExpansion
If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
names in the source code.
|
private String |
makeindexCmdName
The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
generate index for LaTeX.
|
private String |
manExtension
The MAN_EXTENSION tag determines the extension that is added to the
generated man pages (default is the subroutine's section .3)
|
private boolean |
manLinks
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).
|
private String |
manOutput
The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
private Integer |
maxDotGraphDepth
The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
graphs generated by dot.
|
private Integer |
maxInitializerLines
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.
|
private String |
mscgenPath
You can define message sequence charts within doxygen comments using the
\msc command.
|
private boolean |
multilineCppIsBrief
The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
multi-line C++ special comment block (i.e.
|
private boolean |
optimizeForFortran
Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of
Fortran sources only.
|
private boolean |
optimizeOutputForC
Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
sources only.
|
private boolean |
optimizeOutputJava
Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
sources only.
|
private boolean |
optimizeOutputVhdl
Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
sources.
|
private String |
outputLanguage
The OUTPUT_LANGUAGE tag is used to specify the language in which all
documentation generated by doxygen is written.
|
private String |
paperType
The PAPER_TYPE tag can be used to set the paper type that is used by the
printer.
|
private boolean |
pdfHyperlinks
If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
prepared for conversion to pdf (using ps2pdf).
|
private boolean |
perlmodLatex
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.
|
private String |
perlmodMakevarPrefix
The names of the make variables in the generated doxyrules.make file are
prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
private boolean |
perlmodPretty
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.
|
private String |
perlPath
The PERL_PATH should be the absolute path and name of the perl script
interpreter (i.e.
|
private String |
predefined
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).
|
private String |
projectName
The PROJECT_NAME tag is a single word (or a sequence of words surrounded
by quotes) that should identify the project.
|
private String |
projectNumber
The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
private String |
qchFile
If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to
specify the file name of the resulting .qch file.
|
private String |
qhgLocation
If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can be used
to specify the location of Qt's qhelpgenerator.
|
private String |
qhpNamespace
The QHP_NAMESPACE tag specifies the namespace to use when generating Qt
Help Project output.
|
private String |
qhpVirtualFolder
The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
Qt Help Project output.
|
private boolean |
qtAutobrief
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.
|
private boolean |
quiet
The QUIET tag can be used to turn on/off the messages that are generated
by doxygen.
|
private boolean |
recursive
The RECURSIVE tag can be used to turn specify whether or not
subdirectories should be searched for input files as well.
|
private boolean |
referencedByRelation
If the REFERENCED_BY_RELATION tag is set to YES then for each documented
function all documented functions referencing it will be listed.
|
private boolean |
referencesLinkSource
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.
|
private boolean |
referencesRelation
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.
|
private boolean |
repeatBrief
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.
|
private String |
rtfExtensionsFile
Set optional variables used in the generation of an rtf document.
|
private boolean |
rtfHyperlinks
If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
contain hyperlink fields.
|
private String |
rtfOutput
The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
private String |
rtfStylesheetFile
Load stylesheet definitions from file.
|
private boolean |
searchengine
The SEARCHENGINE tag specifies whether or not a search engine should be
used.
|
private boolean |
searchIncludes
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.
|
private boolean |
separateMemberPages
If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
a new page for each member.
|
private boolean |
shortNames
If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
(but less readable) file names.
|
private boolean |
showDirectories
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.
|
private boolean |
showFiles
Set the SHOW_FILES tag to NO to disable the generation of the Files page.
|
private boolean |
showIncludeFiles
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.
|
private boolean |
showNamespaces
Set the SHOW_NAMESPACES tag to NO to disable the generation of the
Namespaces page.
|
private boolean |
showUsedFiles
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.
|
private boolean |
sipSupport
Set the SIP_SUPPORT tag to YES if your project consists of sip sources
only.
|
private boolean |
skipFunctionMacros
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.
|
private boolean |
sortBriefDocs
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.
|
private boolean |
sortByScopeName
If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
sorted by fully-qualified names, including namespaces.
|
private boolean |
sortGroupNames
If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
hierarchy of group names into alphabetical order.
|
private boolean |
sortMemberDocs
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.
|
private boolean |
sourceBrowser
If the SOURCE_BROWSER tag is set to YES then a list of source files will
be generated.
|
private boolean |
stripCodeComments
Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
doxygen to hide any special comment blocks from generated source code
fragments.
|
private String |
stripFromIncPath
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.
|
private String |
stripFromPath
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.
|
private boolean |
subgrouping
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.
|
private Integer |
symbolCacheSize
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.
|
private Integer |
tabSize
The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
private String |
tagfiles
The TAGFILES option can be used to specify one or more tagfiles.
|
private boolean |
templateRelations
If set to YES, the inheritance and collaboration graphs will show the
relations between templates and their instances.
|
private boolean |
tocExpand
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.
|
private Integer |
treeviewWidth
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.
|
private boolean |
typedefHidesStruct
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.
|
private boolean |
umlLook
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.
|
private boolean |
useHtags
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.
|
private boolean |
usePdflatex
If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
plain latex in the generated Makefile.
|
private boolean |
verbatimHeaders
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.
|
private String |
warnFormat
The WARN_FORMAT tag determines the format of the warning messages that
doxygen can produce.
|
private boolean |
warnIfDocError
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.
|
private boolean |
warnIfUndocumented
If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate
warnings for undocumented members.
|
private boolean |
warnings
The WARNINGS tag can be used to turn on/off the warning messages that are
generated by doxygen.
|
private String |
warnLogfile
The WARN_LOGFILE tag can be used to specify a file to which warning and
error messages should be written.
|
private boolean |
warnNoParamdoc
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.
|
private String |
xmlDtd
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.
|
private String |
xmlOutput
The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
private boolean |
xmlProgramlisting
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.
|
private String |
xmlSchema
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.
|
Constructor and Description |
---|
AbstractDoxygenConfigurationMojo() |
getLog, getPluginContext, setLog, setPluginContext
@Parameter(property="doxygen.configurationFile") private File configurationFile
@Parameter(property="doxygen.doxyfileEncoding", defaultValue="UTF-8") private String doxyfileEncoding
@Parameter(property="doxygen.projectName", defaultValue="${project.name}") private String projectName
@Parameter(property="doxygen.projectNumber") private String projectNumber
@Parameter(property="doxygen.createSubdirs", defaultValue="false") private boolean createSubdirs
@Parameter(property="doxygen.outputLanguage", defaultValue="English") private String outputLanguage
@Parameter(property="doxygen.briefMemberDesc", defaultValue="true") private boolean briefMemberDesc
@Parameter(property="doxygen.repeatBrief", defaultValue="true") private boolean repeatBrief
@Parameter(property="doxygen.abbreviateBrief") private String abbreviateBrief
@Parameter(property="doxygen.alwaysDetailedSec", defaultValue="false") private boolean alwaysDetailedSec
@Parameter(property="doxygen.inlineInheritedMemb", defaultValue="false") private boolean inlineInheritedMemb
@Parameter(property="doxygen.fullPathNames", defaultValue="true") private boolean fullPathNames
@Parameter(property="doxygen.stripFromPath") private String stripFromPath
@Parameter(property="doxygen.stripFromIncPath") private String stripFromIncPath
@Parameter(property="doxygen.shortNames", defaultValue="false") private boolean shortNames
@Parameter(property="doxygen.javadocAutobrief", defaultValue="false") private boolean javadocAutobrief
@Parameter(property="doxygen.qtAutobrief", defaultValue="false") private boolean qtAutobrief
@Parameter(property="doxygen.multilineCppIsBrief", defaultValue="false") private boolean multilineCppIsBrief
@Parameter(property="doxygen.inheritDocs", defaultValue="true") private boolean inheritDocs
@Parameter(property="doxygen.separateMemberPages", defaultValue="false") private boolean separateMemberPages
@Parameter(property="doxygen.tabSize", defaultValue="8") private Integer tabSize
@Parameter(property="doxygen.aliases") private String aliases
@Parameter(property="doxygen.optimizeOutputForC", defaultValue="false") private boolean optimizeOutputForC
@Parameter(property="doxygen.optimizeOutputJava", defaultValue="false") private boolean optimizeOutputJava
@Parameter(property="doxygen.optimizeForFortran", defaultValue="false") private boolean optimizeForFortran
@Parameter(property="doxygen.optimizeOutputVhdl", defaultValue="false") private boolean optimizeOutputVhdl
@Parameter(property="doxygen.builtinStlSupport", defaultValue="true") private boolean builtinStlSupport
@Parameter(property="doxygen.cppCliSupport", defaultValue="false") private boolean cppCliSupport
@Parameter(property="doxygen.sipSupport", defaultValue="false") private boolean sipSupport
@Parameter(property="doxygen.idlPropertySupport", defaultValue="true") private boolean idlPropertySupport
@Parameter(property="doxygen.distributeGroupDoc", defaultValue="false") private boolean distributeGroupDoc
@Parameter(property="doxygen.subgrouping", defaultValue="true") private boolean subgrouping
@Parameter(property="doxygen.typedefHidesStruct", defaultValue="false") private boolean typedefHidesStruct
@Parameter(property="doxygen.symbolCacheSize", defaultValue="0") private Integer symbolCacheSize
@Parameter(property="doxygen.extractAll", defaultValue="false") private boolean extractAll
@Parameter(property="doxygen.extractPrivate", defaultValue="false") private boolean extractPrivate
@Parameter(property="doxygen.extractStatic", defaultValue="false") private boolean extractStatic
@Parameter(property="doxygen.extractLocalClasses", defaultValue="true") private boolean extractLocalClasses
@Parameter(property="doxygen.extractLocalMethods", defaultValue="false") private boolean extractLocalMethods
@Parameter(property="doxygen.extractAnonNspaces", defaultValue="false") private boolean extractAnonNspaces
@Parameter(property="doxygen.hideUndocMembers", defaultValue="false") private boolean hideUndocMembers
@Parameter(property="doxygen.hideUndocClasses", defaultValue="false") private boolean hideUndocClasses
@Parameter(property="doxygen.hideFriendCompounds", defaultValue="false") private boolean hideFriendCompounds
@Parameter(property="doxygen.hideInBodyDocs", defaultValue="false") private boolean hideInBodyDocs
@Parameter(property="doxygen.internalDocs", defaultValue="false") private boolean internalDocs
@Parameter(property="doxygen.caseSenseNames", defaultValue="true") private boolean caseSenseNames
@Parameter(property="doxygen.hideScopeNames", defaultValue="false") private boolean hideScopeNames
@Parameter(property="doxygen.showIncludeFiles", defaultValue="true") private boolean showIncludeFiles
@Parameter(property="doxygen.inlineInfo", defaultValue="true") private boolean inlineInfo
@Parameter(property="doxygen.sortMemberDocs", defaultValue="true") private boolean sortMemberDocs
@Parameter(property="doxygen.sortBriefDocs", defaultValue="false") private boolean sortBriefDocs
@Parameter(property="doxygen.sortGroupNames", defaultValue="false") private boolean sortGroupNames
@Parameter(property="doxygen.sortByScopeName", defaultValue="false") private boolean sortByScopeName
@Parameter(property="doxygen.generateTodolist", defaultValue="true") private boolean generateTodolist
@Parameter(property="doxygen.generateTestlist", defaultValue="true") private boolean generateTestlist
@Parameter(property="doxygen.generateBuglist", defaultValue="true") private boolean generateBuglist
@Parameter(property="doxygen.generateDeprecatedlist", defaultValue="true") private boolean generateDeprecatedlist
@Parameter(property="doxygen.enabledSections") private String enabledSections
@Parameter(property="doxygen.maxInitializerLines", defaultValue="30") private Integer maxInitializerLines
@Parameter(property="doxygen.showUsedFiles", defaultValue="true") private boolean showUsedFiles
@Parameter(property="doxygen.showDirectories", defaultValue="true") private boolean showDirectories
@Parameter(property="doxygen.showFiles", defaultValue="true") private boolean showFiles
@Parameter(property="doxygen.showNamespaces", defaultValue="true") private boolean showNamespaces
@Parameter(property="doxygen.fileVersionFilter") private String fileVersionFilter
@Parameter(property="doxygen.layoutFile") private String layoutFile
@Parameter(property="doxygen.quiet", defaultValue="true") private boolean quiet
@Parameter(property="doxygen.warnings", defaultValue="true") private boolean warnings
@Parameter(property="doxygen.warnIfUndocumented", defaultValue="true") private boolean warnIfUndocumented
@Parameter(property="doxygen.warnIfDocError", defaultValue="true") private boolean warnIfDocError
@Parameter(property="doxygen.warnNoParamdoc", defaultValue="true") private boolean warnNoParamdoc
@Parameter(property="doxygen.warnFormat", defaultValue="\"$file:$line: $text\"") private String warnFormat
@Parameter(property="doxygen.warnLogfile") private String warnLogfile
@Parameter(property="doxygen.input", defaultValue="${project.build.sourceDirectory}") private String input
@Parameter(property="doxygen.inputEncoding", defaultValue="UTF-8") private String inputEncoding
@Parameter(property="doxygen.filePatterns", defaultValue="*.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") private String filePatterns
@Parameter(property="doxygen.recursive", defaultValue="false") private boolean recursive
@Parameter(property="doxygen.exclude", defaultValue=".svn") private String exclude
@Parameter(property="doxygen.excludeSymlinks", defaultValue="false") private boolean excludeSymlinks
@Parameter(property="doxygen.excludePatterns") private String excludePatterns
@Parameter(property="doxygen.excludeSymbols") private String excludeSymbols
@Parameter(property="doxygen.examplePath") private String examplePath
@Parameter(property="doxygen.examplePatterns") private String examplePatterns
@Parameter(property="doxygen.exampleRecursive", defaultValue="false") private boolean exampleRecursive
@Parameter(property="doxygen.imagePath") private String imagePath
@Parameter(property="doxygen.inputFilter") private String inputFilter
@Parameter(property="doxygen.filterPatterns") private String filterPatterns
@Parameter(property="doxygen.filterSourceFiles", defaultValue="false") private boolean filterSourceFiles
@Parameter(property="doxygen.sourceBrowser", defaultValue="true") private boolean sourceBrowser
@Parameter(property="doxygen.inlineSources", defaultValue="false") private boolean inlineSources
@Parameter(property="doxygen.stripCodeComments", defaultValue="true") private boolean stripCodeComments
@Parameter(property="doxygen.referencedByRelation", defaultValue="false") private boolean referencedByRelation
@Parameter(property="doxygen.referencesRelation", defaultValue="false") private boolean referencesRelation
@Parameter(property="doxygen.referencesLinkSource", defaultValue="true") private boolean referencesLinkSource
@Parameter(property="doxygen.useHtags", defaultValue="false") private boolean useHtags
@Parameter(property="doxygen.verbatimHeaders", defaultValue="true") private boolean verbatimHeaders
@Parameter(property="doxygen.alphabeticalIndex", defaultValue="true") private boolean alphabeticalIndex
@Parameter(property="doxygen.colsInAlphaIndex", defaultValue="5") private Integer colsInAlphaIndex
@Parameter(property="doxygen.ignorePrefix") private String ignorePrefix
@Parameter(property="doxygen.generateHtml", defaultValue="true") private boolean generateHtml
@Parameter(property="doxygen.htmlOutput", defaultValue="doxygen") private String htmlOutput
@Parameter(property="doxygen.htmlFileExtension", defaultValue=".html") private String htmlFileExtension
@Parameter(property="doxygen.htmlHeader") private String htmlHeader
@Parameter(property="doxygen.htmlFooter") private String htmlFooter
@Parameter(property="doxygen.htmlStylesheet") private String htmlStylesheet
@Parameter(property="doxygen.htmlAlignMembers", defaultValue="true") private boolean htmlAlignMembers
@Parameter(property="doxygen.htmlDynamicSections", defaultValue="true") private boolean htmlDynamicSections
@Parameter(property="doxygen.generateDocset", defaultValue="false") private boolean generateDocset
@Parameter(property="doxygen.docsetFeedname", defaultValue="\"Doxygen generated docs\"") private String docsetFeedname
@Parameter(property="doxygen.docsetBundleId", defaultValue="org.doxygen.Project") private String docsetBundleId
@Parameter(property="doxygen.generateHtmlhelp", defaultValue="false") private boolean generateHtmlhelp
@Parameter(property="doxygen.chmFile") private String chmFile
@Parameter(property="doxygen.hhcLocation") private String hhcLocation
@Parameter(property="doxygen.generateChi", defaultValue="false") private boolean generateChi
@Parameter(property="doxygen.chmIndexEncoding") private String chmIndexEncoding
@Parameter(property="doxygen.binaryToc", defaultValue="false") private boolean binaryToc
@Parameter(property="doxygen.tocExpand", defaultValue="false") private boolean tocExpand
@Parameter(property="doxygen.generateQhp", defaultValue="false") private boolean generateQhp
@Parameter(property="doxygen.qchFile") private String qchFile
@Parameter(property="doxygen.qhpNamespace", defaultValue="org.doxygen.Project") private String qhpNamespace
@Parameter(property="doxygen.qhpVirtualFolder", defaultValue="doc") private String qhpVirtualFolder
@Parameter(property="doxygen.qhgLocation") private String qhgLocation
@Parameter(property="doxygen.disableIndex", defaultValue="false") private boolean disableIndex
@Parameter(property="doxygen.enumValuesPerLine", defaultValue="4") private Integer enumValuesPerLine
@Parameter(property="doxygen.generateTreeview", defaultValue="ALL") private String generateTreeview
@Parameter(property="doxygen.treeviewWidth", defaultValue="250") private Integer treeviewWidth
@Parameter(property="doxygen.formulaFontsize", defaultValue="10") private Integer formulaFontsize
@Parameter(property="doxygen.generateLatex", defaultValue="false") private boolean generateLatex
@Parameter(property="doxygen.latexOutput", defaultValue="latex") private String latexOutput
@Parameter(property="doxygen.latexCmdName", defaultValue="latex") private String latexCmdName
@Parameter(property="doxygen.makeindexCmdName", defaultValue="makeindex") private String makeindexCmdName
@Parameter(property="doxygen.compactLatex", defaultValue="false") private boolean compactLatex
@Parameter(property="doxygen.paperType", defaultValue="a4wide") private String paperType
@Parameter(property="doxygen.extraPackages") private String extraPackages
@Parameter(property="doxygen.latexHeader") private String latexHeader
@Parameter(property="doxygen.pdfHyperlinks", defaultValue="true") private boolean pdfHyperlinks
@Parameter(property="doxygen.usePdflatex", defaultValue="true") private boolean usePdflatex
@Parameter(property="doxygen.latexBatchmode", defaultValue="false") private boolean latexBatchmode
@Parameter(property="doxygen.latexHideIndices", defaultValue="false") private boolean latexHideIndices
@Parameter(property="doxygen.generateRtf", defaultValue="false") private boolean generateRtf
@Parameter(property="doxygen.rtfOutput", defaultValue="rtf") private String rtfOutput
@Parameter(property="doxygen.compactRtf", defaultValue="false") private boolean compactRtf
@Parameter(property="doxygen.rtfHyperlinks", defaultValue="false") private boolean rtfHyperlinks
@Parameter(property="doxygen.rtfStylesheetFile") private String rtfStylesheetFile
@Parameter(property="doxygen.rtfExtensionsFile") private String rtfExtensionsFile
@Parameter(property="doxygen.generateMan", defaultValue="false") private boolean generateMan
@Parameter(property="doxygen.manOutput", defaultValue="man") private String manOutput
@Parameter(property="doxygen.manExtension", defaultValue=".3") private String manExtension
@Parameter(property="doxygen.manLinks", defaultValue="false") private boolean manLinks
@Parameter(property="doxygen.generateXml", defaultValue="false") private boolean generateXml
@Parameter(property="doxygen.xmlOutput", defaultValue="xml") private String xmlOutput
@Parameter(property="doxygen.xmlSchema") private String xmlSchema
@Parameter(property="doxygen.xmlDtd") private String xmlDtd
@Parameter(property="doxygen.xmlProgramlisting", defaultValue="true") private boolean xmlProgramlisting
@Parameter(property="doxygen.generateAutogenDef", defaultValue="false") private boolean generateAutogenDef
@Parameter(property="doxygen.generatePerlmod", defaultValue="false") private boolean generatePerlmod
@Parameter(property="doxygen.perlmodLatex", defaultValue="false") private boolean perlmodLatex
@Parameter(property="doxygen.perlmodPretty", defaultValue="true") private boolean perlmodPretty
@Parameter(property="doxygen.perlmodMakevarPrefix") private String perlmodMakevarPrefix
@Parameter(property="doxygen.enablePreprocessing", defaultValue="true") private boolean enablePreprocessing
@Parameter(property="doxygen.macroExpansion", defaultValue="false") private boolean macroExpansion
@Parameter(property="doxygen.expandOnlyPredef", defaultValue="false") private boolean expandOnlyPredef
@Parameter(property="doxygen.searchIncludes", defaultValue="true") private boolean searchIncludes
@Parameter(property="doxygen.includePath") private String includePath
@Parameter(property="doxygen.includeFilePatterns") private String includeFilePatterns
@Parameter(property="doxygen.predefined") private String predefined
@Parameter(property="doxygen.expandAsDefined") private String expandAsDefined
@Parameter(property="doxygen.skipFunctionMacros", defaultValue="true") private boolean skipFunctionMacros
@Parameter(property="doxygen.tagfiles") private String tagfiles
@Parameter(property="doxygen.generateTagfile") private String generateTagfile
@Parameter(property="doxygen.allexternals", defaultValue="false") private boolean allexternals
@Parameter(property="doxygen.externalGroups", defaultValue="true") private boolean externalGroups
@Parameter(property="doxygen.perlPath", defaultValue="/usr/bin/perl") private String perlPath
@Parameter(property="doxygen.classDiagrams", defaultValue="true") private boolean classDiagrams
@Parameter(property="doxygen.mscgenPath") private String mscgenPath
@Parameter(property="doxygen.hideUndocRelations", defaultValue="true") private boolean hideUndocRelations
@Parameter(property="doxygen.haveDot", defaultValue="true") private boolean haveDot
@Parameter(property="doxygen.dotFontname", defaultValue="FreeSans") private String dotFontname
@Parameter(property="doxygen.dotFontsize", defaultValue="10") private Integer dotFontsize
@Parameter(property="doxygen.dotFontpath") private String dotFontpath
@Parameter(property="doxygen.classGraph", defaultValue="true") private boolean classGraph
@Parameter(property="doxygen.collaborationGraph", defaultValue="true") private boolean collaborationGraph
@Parameter(property="doxygen.groupGraphs", defaultValue="true") private boolean groupGraphs
@Parameter(property="doxygen.umlLook", defaultValue="false") private boolean umlLook
@Parameter(property="doxygen.templateRelations", defaultValue="false") private boolean templateRelations
@Parameter(property="doxygen.includeGraph", defaultValue="true") private boolean includeGraph
@Parameter(property="doxygen.includedByGraph", defaultValue="true") private boolean includedByGraph
@Parameter(property="doxygen.callGraph", defaultValue="false") private boolean callGraph
@Parameter(property="doxygen.callerGraph", defaultValue="false") private boolean callerGraph
@Parameter(property="doxygen.graphicalHierarchy", defaultValue="true") private boolean graphicalHierarchy
@Parameter(property="doxygen.directoryGraph", defaultValue="true") private boolean directoryGraph
@Parameter(property="doxygen.dotImageFormat", defaultValue="png") private String dotImageFormat
@Parameter(property="doxygen.dotPath", defaultValue="/usr/bin") private String dotPath
@Parameter(property="doxygen.dotfileDirs") private String dotfileDirs
@Parameter(property="doxygen.dotGraphMaxNodes", defaultValue="50") private Integer dotGraphMaxNodes
@Parameter(property="doxygen.maxDotGraphDepth", defaultValue="0") private Integer maxDotGraphDepth
@Parameter(property="doxygen.dotTransparent", defaultValue="true") private boolean dotTransparent
@Parameter(property="doxygen.dotMultiTargets", defaultValue="true") private boolean dotMultiTargets
@Parameter(property="doxygen.generateLegend", defaultValue="true") private boolean generateLegend
@Parameter(property="doxygen.dotCleanup", defaultValue="true") private boolean dotCleanup
@Parameter(property="doxygen.searchengine", defaultValue="false") private boolean searchengine
public File getConfigurationFile()
public void setConfigurationFile(File configurationFile)
public String getDoxyfileEncoding()
public void setDoxyfileEncoding(String doxyfileEncoding)
public String getProjectName()
public void setProjectName(String projectName)
public String getProjectNumber()
public void setProjectNumber(String projectNumber)
public boolean isCreateSubdirs()
public void setCreateSubdirs(boolean createSubdirs)
public String getOutputLanguage()
public void setOutputLanguage(String outputLanguage)
public boolean isBriefMemberDesc()
public void setBriefMemberDesc(boolean briefMemberDesc)
public boolean isRepeatBrief()
public void setRepeatBrief(boolean repeatBrief)
public String getAbbreviateBrief()
public void setAbbreviateBrief(String abbreviateBrief)
public boolean isAlwaysDetailedSec()
public void setAlwaysDetailedSec(boolean alwaysDetailedSec)
public boolean isInlineInheritedMemb()
public void setInlineInheritedMemb(boolean inlineInheritedMemb)
public boolean isFullPathNames()
public void setFullPathNames(boolean fullPathNames)
public String getStripFromPath()
public void setStripFromPath(String stripFromPath)
public String getStripFromIncPath()
public void setStripFromIncPath(String stripFromIncPath)
public boolean isShortNames()
public void setShortNames(boolean shortNames)
public boolean isJavadocAutobrief()
public void setJavadocAutobrief(boolean javadocAutobrief)
public boolean isQtAutobrief()
public void setQtAutobrief(boolean qtAutobrief)
public boolean isMultilineCppIsBrief()
public void setMultilineCppIsBrief(boolean multilineCppIsBrief)
public boolean isInheritDocs()
public void setInheritDocs(boolean inheritDocs)
public boolean isSeparateMemberPages()
public void setSeparateMemberPages(boolean separateMemberPages)
public Integer getTabSize()
public void setTabSize(Integer tabSize)
public String getAliases()
public void setAliases(String aliases)
public boolean isOptimizeOutputForC()
public void setOptimizeOutputForC(boolean optimizeOutputForC)
public boolean isOptimizeOutputJava()
public void setOptimizeOutputJava(boolean optimizeOutputJava)
public boolean isOptimizeForFortran()
public void setOptimizeForFortran(boolean optimizeForFortran)
public boolean isOptimizeOutputVhdl()
public void setOptimizeOutputVhdl(boolean optimizeOutputVhdl)
public boolean isBuiltinStlSupport()
public void setBuiltinStlSupport(boolean builtinStlSupport)
public boolean isCppCliSupport()
public void setCppCliSupport(boolean cppCliSupport)
public boolean isSipSupport()
public void setSipSupport(boolean sipSupport)
public boolean isIdlPropertySupport()
public void setIdlPropertySupport(boolean idlPropertySupport)
public boolean isDistributeGroupDoc()
public void setDistributeGroupDoc(boolean distributeGroupDoc)
public boolean isSubgrouping()
public void setSubgrouping(boolean subgrouping)
public boolean isTypedefHidesStruct()
public void setTypedefHidesStruct(boolean typedefHidesStruct)
public Integer getSymbolCacheSize()
public void setSymbolCacheSize(Integer symbolCacheSize)
public boolean isExtractAll()
public void setExtractAll(boolean extractAll)
public boolean isExtractPrivate()
public void setExtractPrivate(boolean extractPrivate)
public boolean isExtractStatic()
public void setExtractStatic(boolean extractStatic)
public boolean isExtractLocalClasses()
public void setExtractLocalClasses(boolean extractLocalClasses)
public boolean isExtractLocalMethods()
public void setExtractLocalMethods(boolean extractLocalMethods)
public boolean isExtractAnonNspaces()
public void setExtractAnonNspaces(boolean extractAnonNspaces)
public boolean isHideUndocMembers()
public void setHideUndocMembers(boolean hideUndocMembers)
public boolean isHideUndocClasses()
public void setHideUndocClasses(boolean hideUndocClasses)
public boolean isHideFriendCompounds()
public void setHideFriendCompounds(boolean hideFriendCompounds)
public boolean isHideInBodyDocs()
public void setHideInBodyDocs(boolean hideInBodyDocs)
public boolean isInternalDocs()
public void setInternalDocs(boolean internalDocs)
public boolean isCaseSenseNames()
public void setCaseSenseNames(boolean caseSenseNames)
public boolean isHideScopeNames()
public void setHideScopeNames(boolean hideScopeNames)
public boolean isShowIncludeFiles()
public void setShowIncludeFiles(boolean showIncludeFiles)
public boolean isInlineInfo()
public void setInlineInfo(boolean inlineInfo)
public boolean isSortMemberDocs()
public void setSortMemberDocs(boolean sortMemberDocs)
public boolean isSortBriefDocs()
public void setSortBriefDocs(boolean sortBriefDocs)
public boolean isSortGroupNames()
public void setSortGroupNames(boolean sortGroupNames)
public boolean isSortByScopeName()
public void setSortByScopeName(boolean sortByScopeName)
public boolean isGenerateTodolist()
public void setGenerateTodolist(boolean generateTodolist)
public boolean isGenerateTestlist()
public void setGenerateTestlist(boolean generateTestlist)
public boolean isGenerateBuglist()
public void setGenerateBuglist(boolean generateBuglist)
public boolean isGenerateDeprecatedlist()
public void setGenerateDeprecatedlist(boolean generateDeprecatedlist)
public String getEnabledSections()
public void setEnabledSections(String enabledSections)
public Integer getMaxInitializerLines()
public void setMaxInitializerLines(Integer maxInitializerLines)
public boolean isShowUsedFiles()
public void setShowUsedFiles(boolean showUsedFiles)
public boolean isShowDirectories()
public void setShowDirectories(boolean showDirectories)
public boolean isShowFiles()
public void setShowFiles(boolean showFiles)
public boolean isShowNamespaces()
public void setShowNamespaces(boolean showNamespaces)
public String getFileVersionFilter()
public void setFileVersionFilter(String fileVersionFilter)
public String getLayoutFile()
public void setLayoutFile(String layoutFile)
public boolean isQuiet()
public void setQuiet(boolean quiet)
public boolean isWarnings()
public void setWarnings(boolean warnings)
public boolean isWarnIfUndocumented()
public void setWarnIfUndocumented(boolean warnIfUndocumented)
public boolean isWarnIfDocError()
public void setWarnIfDocError(boolean warnIfDocError)
public boolean isWarnNoParamdoc()
public void setWarnNoParamdoc(boolean warnNoParamdoc)
public String getWarnFormat()
public void setWarnFormat(String warnFormat)
public String getWarnLogfile()
public void setWarnLogfile(String warnLogfile)
public String getInput()
public void setInput(String input)
public String getInputEncoding()
public void setInputEncoding(String inputEncoding)
public String getFilePatterns()
public void setFilePatterns(String filePatterns)
public boolean isRecursive()
public void setRecursive(boolean recursive)
public String getExclude()
public void setExclude(String exclude)
public boolean isExcludeSymlinks()
public void setExcludeSymlinks(boolean excludeSymlinks)
public String getExcludePatterns()
public void setExcludePatterns(String excludePatterns)
public String getExcludeSymbols()
public void setExcludeSymbols(String excludeSymbols)
public String getExamplePath()
public void setExamplePath(String examplePath)
public String getExamplePatterns()
public void setExamplePatterns(String examplePatterns)
public boolean isExampleRecursive()
public void setExampleRecursive(boolean exampleRecursive)
public String getImagePath()
public void setImagePath(String imagePath)
public String getInputFilter()
public void setInputFilter(String inputFilter)
public String getFilterPatterns()
public void setFilterPatterns(String filterPatterns)
public boolean isFilterSourceFiles()
public void setFilterSourceFiles(boolean filterSourceFiles)
public boolean isSourceBrowser()
public void setSourceBrowser(boolean sourceBrowser)
public boolean isInlineSources()
public void setInlineSources(boolean inlineSources)
public boolean isStripCodeComments()
public void setStripCodeComments(boolean stripCodeComments)
public boolean isReferencedByRelation()
public void setReferencedByRelation(boolean referencedByRelation)
public boolean isReferencesRelation()
public void setReferencesRelation(boolean referencesRelation)
public boolean isReferencesLinkSource()
public void setReferencesLinkSource(boolean referencesLinkSource)
public boolean isUseHtags()
public void setUseHtags(boolean useHtags)
public boolean isVerbatimHeaders()
public void setVerbatimHeaders(boolean verbatimHeaders)
public boolean isAlphabeticalIndex()
public void setAlphabeticalIndex(boolean alphabeticalIndex)
public Integer getColsInAlphaIndex()
public void setColsInAlphaIndex(Integer colsInAlphaIndex)
public String getIgnorePrefix()
public void setIgnorePrefix(String ignorePrefix)
public boolean isGenerateHtml()
public void setGenerateHtml(boolean generateHtml)
public String getHtmlOutput()
public void setHtmlOutput(String htmlOutput)
public String getHtmlFileExtension()
public void setHtmlFileExtension(String htmlFileExtension)
public String getHtmlHeader()
public void setHtmlHeader(String htmlHeader)
public String getHtmlFooter()
public void setHtmlFooter(String htmlFooter)
public String getHtmlStylesheet()
public void setHtmlStylesheet(String htmlStylesheet)
public boolean isHtmlAlignMembers()
public void setHtmlAlignMembers(boolean htmlAlignMembers)
public boolean isHtmlDynamicSections()
public void setHtmlDynamicSections(boolean htmlDynamicSections)
public boolean isGenerateDocset()
public void setGenerateDocset(boolean generateDocset)
public String getDocsetFeedname()
public void setDocsetFeedname(String docsetFeedname)
public String getDocsetBundleId()
public void setDocsetBundleId(String docsetBundleId)
public boolean isGenerateHtmlhelp()
public void setGenerateHtmlhelp(boolean generateHtmlhelp)
public String getChmFile()
public void setChmFile(String chmFile)
public String getHhcLocation()
public void setHhcLocation(String hhcLocation)
public boolean isGenerateChi()
public void setGenerateChi(boolean generateChi)
public String getChmIndexEncoding()
public void setChmIndexEncoding(String chmIndexEncoding)
public boolean isBinaryToc()
public void setBinaryToc(boolean binaryToc)
public boolean isTocExpand()
public void setTocExpand(boolean tocExpand)
public boolean isGenerateQhp()
public void setGenerateQhp(boolean generateQhp)
public String getQchFile()
public void setQchFile(String qchFile)
public String getQhpNamespace()
public void setQhpNamespace(String qhpNamespace)
public String getQhpVirtualFolder()
public void setQhpVirtualFolder(String qhpVirtualFolder)
public String getQhgLocation()
public void setQhgLocation(String qhgLocation)
public boolean isDisableIndex()
public void setDisableIndex(boolean disableIndex)
public Integer getEnumValuesPerLine()
public void setEnumValuesPerLine(Integer enumValuesPerLine)
public String getGenerateTreeview()
public void setGenerateTreeview(String generateTreeview)
public Integer getTreeviewWidth()
public void setTreeviewWidth(Integer treeviewWidth)
public Integer getFormulaFontsize()
public void setFormulaFontsize(Integer formulaFontsize)
public boolean isGenerateLatex()
public void setGenerateLatex(boolean generateLatex)
public String getLatexOutput()
public void setLatexOutput(String latexOutput)
public String getLatexCmdName()
public void setLatexCmdName(String latexCmdName)
public String getMakeindexCmdName()
public void setMakeindexCmdName(String makeindexCmdName)
public boolean isCompactLatex()
public void setCompactLatex(boolean compactLatex)
public String getPaperType()
public void setPaperType(String paperType)
public String getExtraPackages()
public void setExtraPackages(String extraPackages)
public String getLatexHeader()
public void setLatexHeader(String latexHeader)
public boolean isPdfHyperlinks()
public void setPdfHyperlinks(boolean pdfHyperlinks)
public boolean isUsePdflatex()
public void setUsePdflatex(boolean usePdflatex)
public boolean isLatexBatchmode()
public void setLatexBatchmode(boolean latexBatchmode)
public boolean isLatexHideIndices()
public void setLatexHideIndices(boolean latexHideIndices)
public boolean isGenerateRtf()
public void setGenerateRtf(boolean generateRtf)
public String getRtfOutput()
public void setRtfOutput(String rtfOutput)
public boolean isCompactRtf()
public void setCompactRtf(boolean compactRtf)
public boolean isRtfHyperlinks()
public void setRtfHyperlinks(boolean rtfHyperlinks)
public String getRtfStylesheetFile()
public void setRtfStylesheetFile(String rtfStylesheetFile)
public String getRtfExtensionsFile()
public void setRtfExtensionsFile(String rtfExtensionsFile)
public boolean isGenerateMan()
public void setGenerateMan(boolean generateMan)
public String getManOutput()
public void setManOutput(String manOutput)
public String getManExtension()
public void setManExtension(String manExtension)
public boolean isManLinks()
public void setManLinks(boolean manLinks)
public boolean isGenerateXml()
public void setGenerateXml(boolean generateXml)
public String getXmlOutput()
public void setXmlOutput(String xmlOutput)
public String getXmlSchema()
public void setXmlSchema(String xmlSchema)
public String getXmlDtd()
public void setXmlDtd(String xmlDtd)
public boolean isXmlProgramlisting()
public void setXmlProgramlisting(boolean xmlProgramlisting)
public boolean isGenerateAutogenDef()
public void setGenerateAutogenDef(boolean generateAutogenDef)
public boolean isGeneratePerlmod()
public void setGeneratePerlmod(boolean generatePerlmod)
public boolean isPerlmodLatex()
public void setPerlmodLatex(boolean perlmodLatex)
public boolean isPerlmodPretty()
public void setPerlmodPretty(boolean perlmodPretty)
public String getPerlmodMakevarPrefix()
public void setPerlmodMakevarPrefix(String perlmodMakevarPrefix)
public boolean isEnablePreprocessing()
public void setEnablePreprocessing(boolean enablePreprocessing)
public boolean isMacroExpansion()
public void setMacroExpansion(boolean macroExpansion)
public boolean isExpandOnlyPredef()
public void setExpandOnlyPredef(boolean expandOnlyPredef)
public boolean isSearchIncludes()
public void setSearchIncludes(boolean searchIncludes)
public String getIncludePath()
public void setIncludePath(String includePath)
public String getIncludeFilePatterns()
public void setIncludeFilePatterns(String includeFilePatterns)
public String getPredefined()
public void setPredefined(String predefined)
public String getExpandAsDefined()
public void setExpandAsDefined(String expandAsDefined)
public boolean isSkipFunctionMacros()
public void setSkipFunctionMacros(boolean skipFunctionMacros)
public String getTagfiles()
public void setTagfiles(String tagfiles)
public String getGenerateTagfile()
public void setGenerateTagfile(String generateTagfile)
public boolean isAllexternals()
public void setAllexternals(boolean allexternals)
public boolean isExternalGroups()
public void setExternalGroups(boolean externalGroups)
public String getPerlPath()
public void setPerlPath(String perlPath)
public boolean isClassDiagrams()
public void setClassDiagrams(boolean classDiagrams)
public String getMscgenPath()
public void setMscgenPath(String mscgenPath)
public boolean isHideUndocRelations()
public void setHideUndocRelations(boolean hideUndocRelations)
public boolean isHaveDot()
public void setHaveDot(boolean haveDot)
public String getDotFontname()
public void setDotFontname(String dotFontname)
public Integer getDotFontsize()
public void setDotFontsize(Integer dotFontsize)
public String getDotFontpath()
public void setDotFontpath(String dotFontpath)
public boolean isClassGraph()
public void setClassGraph(boolean classGraph)
public boolean isCollaborationGraph()
public void setCollaborationGraph(boolean collaborationGraph)
public boolean isGroupGraphs()
public void setGroupGraphs(boolean groupGraphs)
public boolean isUmlLook()
public void setUmlLook(boolean umlLook)
public boolean isTemplateRelations()
public void setTemplateRelations(boolean templateRelations)
public boolean isIncludeGraph()
public void setIncludeGraph(boolean includeGraph)
public boolean isIncludedByGraph()
public void setIncludedByGraph(boolean includedByGraph)
public boolean isCallGraph()
public void setCallGraph(boolean callGraph)
public boolean isCallerGraph()
public void setCallerGraph(boolean callerGraph)
public boolean isGraphicalHierarchy()
public void setGraphicalHierarchy(boolean graphicalHierarchy)
public boolean isDirectoryGraph()
public void setDirectoryGraph(boolean directoryGraph)
public String getDotImageFormat()
public void setDotImageFormat(String dotImageFormat)
public String getDotPath()
public void setDotPath(String dotPath)
public String getDotfileDirs()
public void setDotfileDirs(String dotfileDirs)
public Integer getDotGraphMaxNodes()
public void setDotGraphMaxNodes(Integer dotGraphMaxNodes)
public Integer getMaxDotGraphDepth()
public void setMaxDotGraphDepth(Integer maxDotGraphDepth)
public boolean isDotTransparent()
public void setDotTransparent(boolean dotTransparent)
public boolean isDotMultiTargets()
public void setDotMultiTargets(boolean dotMultiTargets)
public boolean isGenerateLegend()
public void setGenerateLegend(boolean generateLegend)
public boolean isDotCleanup()
public void setDotCleanup(boolean dotCleanup)
public boolean isSearchengine()
public void setSearchengine(boolean searchengine)
Copyright © 2010–2016 SoftwareEntwicklung Beratung Schulung. All rights reserved.