com.soebes.maven.plugins.dmg
Class AbstractDoxygenConfigurationMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      com.soebes.maven.plugins.dmg.AbstractDoxygenConfigurationMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractDoxygenMojo

public abstract class AbstractDoxygenConfigurationMojo
extends org.apache.maven.plugin.AbstractMojo

This class contains all configurable parameters for the doxygen call. These parameters can be defined in the configuration section of the plugin in.

Author:

Karl Heinz Marbaise

Field Summary

private java.lang.String	abbreviateBrief This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings.
private java.lang.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. 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.
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 java.lang.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 java.lang.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 java.lang.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 java.io.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 java.lang.String	docsetBundleId When GENERATE_DOCSET tag is set to YES, this tag specifies a string that should uniquely identify the documentation set bundle.
private java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.Integer	dotFontsize The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
private java.lang.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 java.lang.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. multiple -o and -T options on the command line).
private java.lang.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 java.lang.String	doxyfileEncoding This tag specifies the encoding used for all characters in the config file that follow.
private java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String	exclude The EXCLUDE tag can be used to specify files and/or directories that should excluded from the INPUT source files.
private java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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. when SOURCE_BROWSER is set to YES).
private java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String	htmlFooter The HTML_FOOTER tag can be used to specify a personal HTML footer for each generated HTML page.
private java.lang.String	htmlHeader The HTML_HEADER tag can be used to specify a personal HTML header for each generated HTML page.
private java.lang.String	htmlOutput The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
private java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String	input The INPUT tag can be used to specify the files and/or directories that contain documented source files.
private java.lang.String	inputEncoding This tag can be used to specify the character encoding of the source files that doxygen parses.
private java.lang.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 java.lang.String	latexCmdName The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked.
private java.lang.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.)
private java.lang.String	latexOutput The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
private java.lang.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 java.lang.String	makeindexCmdName The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for LaTeX.
private java.lang.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 java.lang.String	manOutput The MAN_OUTPUT tag is used to specify where the man pages will be put.
private java.lang.Integer	maxDotGraphDepth The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs generated by dot.
private java.lang.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 java.lang.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. a block of //!
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 java.lang.String	outputLanguage The OUTPUT_LANGUAGE tag is used to specify the language in which all documentation generated by doxygen is written.
private java.lang.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 java.lang.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 java.lang.String	perlPath The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `which perl').
private java.lang.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 java.lang.String	projectName The PROJECT_NAME tag is a single word (or a sequence of words surrounded by quotes) that should identify the project.
private java.lang.String	projectNumber The PROJECT_NUMBER tag can be used to enter a project or revision number.
private java.lang.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 java.lang.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 java.lang.String	qhpNamespace The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output.
private java.lang.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 java.lang.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 java.lang.String	rtfOutput The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
private java.lang.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 java.lang.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 java.lang.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. under the Public Functions section).
private java.lang.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 java.lang.Integer	tabSize The TAB_SIZE tag can be used to set the number of spaces in a tab.
private java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

AbstractDoxygenConfigurationMojo()

Method Summary

java.lang.String	getAbbreviateBrief()
java.lang.String	getAliases()
java.lang.String	getChmFile()
java.lang.String	getChmIndexEncoding()
java.lang.Integer	getColsInAlphaIndex()
java.io.File	getConfigurationFile()
java.lang.String	getDocsetBundleId()
java.lang.String	getDocsetFeedname()
java.lang.String	getDotfileDirs()
java.lang.String	getDotFontname()
java.lang.String	getDotFontpath()
java.lang.Integer	getDotFontsize()
java.lang.Integer	getDotGraphMaxNodes()
java.lang.String	getDotImageFormat()
java.lang.String	getDotPath()
java.lang.String	getDoxyfileEncoding()
java.lang.String	getEnabledSections()
java.lang.Integer	getEnumValuesPerLine()
java.lang.String	getExamplePath()
java.lang.String	getExamplePatterns()
java.lang.String	getExclude()
java.lang.String	getExcludePatterns()
java.lang.String	getExcludeSymbols()
java.lang.String	getExpandAsDefined()
java.lang.String	getExtraPackages()
java.lang.String	getFilePatterns()
java.lang.String	getFileVersionFilter()
java.lang.String	getFilterPatterns()
java.lang.Integer	getFormulaFontsize()
java.lang.String	getGenerateTagfile()
java.lang.String	getGenerateTreeview()
java.lang.String	getHhcLocation()
java.lang.String	getHtmlFileExtension()
java.lang.String	getHtmlFooter()
java.lang.String	getHtmlHeader()
java.lang.String	getHtmlOutput()
java.lang.String	getHtmlStylesheet()
java.lang.String	getIgnorePrefix()
java.lang.String	getImagePath()
java.lang.String	getIncludeFilePatterns()
java.lang.String	getIncludePath()
java.lang.String	getInput()
java.lang.String	getInputEncoding()
java.lang.String	getInputFilter()
java.lang.String	getLatexCmdName()
java.lang.String	getLatexHeader()
java.lang.String	getLatexOutput()
java.lang.String	getLayoutFile()
java.lang.String	getMakeindexCmdName()
java.lang.String	getManExtension()
java.lang.String	getManOutput()
java.lang.Integer	getMaxDotGraphDepth()
java.lang.Integer	getMaxInitializerLines()
java.lang.String	getMscgenPath()
java.lang.String	getOutputLanguage()
java.lang.String	getPaperType()
java.lang.String	getPerlmodMakevarPrefix()
java.lang.String	getPerlPath()
java.lang.String	getPredefined()
java.lang.String	getProjectName()
java.lang.String	getProjectNumber()
java.lang.String	getQchFile()
java.lang.String	getQhgLocation()
java.lang.String	getQhpNamespace()
java.lang.String	getQhpVirtualFolder()
java.lang.String	getRtfExtensionsFile()
java.lang.String	getRtfOutput()
java.lang.String	getRtfStylesheetFile()
java.lang.String	getStripFromIncPath()
java.lang.String	getStripFromPath()
java.lang.Integer	getSymbolCacheSize()
java.lang.Integer	getTabSize()
java.lang.String	getTagfiles()
java.lang.Integer	getTreeviewWidth()
java.lang.String	getWarnFormat()
java.lang.String	getWarnLogfile()
java.lang.String	getXmlDtd()
java.lang.String	getXmlOutput()
java.lang.String	getXmlSchema()
boolean	isAllexternals()
boolean	isAlphabeticalIndex()
boolean	isAlwaysDetailedSec()
boolean	isBinaryToc()
boolean	isBriefMemberDesc()
boolean	isBuiltinStlSupport()
boolean	isCallerGraph()
boolean	isCallGraph()
boolean	isCaseSenseNames()
boolean	isClassDiagrams()
boolean	isClassGraph()
boolean	isCollaborationGraph()
boolean	isCompactLatex()
boolean	isCompactRtf()
boolean	isCppCliSupport()
boolean	isCreateSubdirs()
boolean	isDirectoryGraph()
boolean	isDisableIndex()
boolean	isDistributeGroupDoc()
boolean	isDotCleanup()
boolean	isDotMultiTargets()
boolean	isDotTransparent()
boolean	isEnablePreprocessing()
boolean	isExampleRecursive()
boolean	isExcludeSymlinks()
boolean	isExpandOnlyPredef()
boolean	isExternalGroups()
boolean	isExtractAll()
boolean	isExtractAnonNspaces()
boolean	isExtractLocalClasses()
boolean	isExtractLocalMethods()
boolean	isExtractPrivate()
boolean	isExtractStatic()
boolean	isFilterSourceFiles()
boolean	isFullPathNames()
boolean	isGenerateAutogenDef()
boolean	isGenerateBuglist()
boolean	isGenerateChi()
boolean	isGenerateDeprecatedlist()
boolean	isGenerateDocset()
boolean	isGenerateHtml()
boolean	isGenerateHtmlhelp()
boolean	isGenerateLatex()
boolean	isGenerateLegend()
boolean	isGenerateMan()
boolean	isGeneratePerlmod()
boolean	isGenerateQhp()
boolean	isGenerateRtf()
boolean	isGenerateTestlist()
boolean	isGenerateTodolist()
boolean	isGenerateXml()
boolean	isGraphicalHierarchy()
boolean	isGroupGraphs()
boolean	isHaveDot()
boolean	isHideFriendCompounds()
boolean	isHideInBodyDocs()
boolean	isHideScopeNames()
boolean	isHideUndocClasses()
boolean	isHideUndocMembers()
boolean	isHideUndocRelations()
boolean	isHtmlAlignMembers()
boolean	isHtmlDynamicSections()
boolean	isIdlPropertySupport()
boolean	isIncludedByGraph()
boolean	isIncludeGraph()
boolean	isInheritDocs()
boolean	isInlineInfo()
boolean	isInlineInheritedMemb()
boolean	isInlineSources()
boolean	isInternalDocs()
boolean	isJavadocAutobrief()
boolean	isLatexBatchmode()
boolean	isLatexHideIndices()
boolean	isMacroExpansion()
boolean	isManLinks()
boolean	isMultilineCppIsBrief()
boolean	isOptimizeForFortran()
boolean	isOptimizeOutputForC()
boolean	isOptimizeOutputJava()
boolean	isOptimizeOutputVhdl()
boolean	isPdfHyperlinks()
boolean	isPerlmodLatex()
boolean	isPerlmodPretty()
boolean	isQtAutobrief()
boolean	isQuiet()
boolean	isRecursive()
boolean	isReferencedByRelation()
boolean	isReferencesLinkSource()
boolean	isReferencesRelation()
boolean	isRepeatBrief()
boolean	isRtfHyperlinks()
boolean	isSearchengine()
boolean	isSearchIncludes()
boolean	isSeparateMemberPages()
boolean	isShortNames()
boolean	isShowDirectories()
boolean	isShowFiles()
boolean	isShowIncludeFiles()
boolean	isShowNamespaces()
boolean	isShowUsedFiles()
boolean	isSipSupport()
boolean	isSkipFunctionMacros()
boolean	isSortBriefDocs()
boolean	isSortByScopeName()
boolean	isSortGroupNames()
boolean	isSortMemberDocs()
boolean	isSourceBrowser()
boolean	isStripCodeComments()
boolean	isSubgrouping()
boolean	isTemplateRelations()
boolean	isTocExpand()
boolean	isTypedefHidesStruct()
boolean	isUmlLook()
boolean	isUseHtags()
boolean	isUsePdflatex()
boolean	isVerbatimHeaders()
boolean	isWarnIfDocError()
boolean	isWarnIfUndocumented()
boolean	isWarnings()
boolean	isWarnNoParamdoc()
boolean	isXmlProgramlisting()
void	setAbbreviateBrief(java.lang.String abbreviateBrief)
void	setAliases(java.lang.String aliases)
void	setAllexternals(boolean allexternals)
void	setAlphabeticalIndex(boolean alphabeticalIndex)
void	setAlwaysDetailedSec(boolean alwaysDetailedSec)
void	setBinaryToc(boolean binaryToc)
void	setBriefMemberDesc(boolean briefMemberDesc)
void	setBuiltinStlSupport(boolean builtinStlSupport)
void	setCallerGraph(boolean callerGraph)
void	setCallGraph(boolean callGraph)
void	setCaseSenseNames(boolean caseSenseNames)
void	setChmFile(java.lang.String chmFile)
void	setChmIndexEncoding(java.lang.String chmIndexEncoding)
void	setClassDiagrams(boolean classDiagrams)
void	setClassGraph(boolean classGraph)
void	setCollaborationGraph(boolean collaborationGraph)
void	setColsInAlphaIndex(java.lang.Integer colsInAlphaIndex)
void	setCompactLatex(boolean compactLatex)
void	setCompactRtf(boolean compactRtf)
void	setConfigurationFile(java.io.File configurationFile)
void	setCppCliSupport(boolean cppCliSupport)
void	setCreateSubdirs(boolean createSubdirs)
void	setDirectoryGraph(boolean directoryGraph)
void	setDisableIndex(boolean disableIndex)
void	setDistributeGroupDoc(boolean distributeGroupDoc)
void	setDocsetBundleId(java.lang.String docsetBundleId)
void	setDocsetFeedname(java.lang.String docsetFeedname)
void	setDotCleanup(boolean dotCleanup)
void	setDotfileDirs(java.lang.String dotfileDirs)
void	setDotFontname(java.lang.String dotFontname)
void	setDotFontpath(java.lang.String dotFontpath)
void	setDotFontsize(java.lang.Integer dotFontsize)
void	setDotGraphMaxNodes(java.lang.Integer dotGraphMaxNodes)
void	setDotImageFormat(java.lang.String dotImageFormat)
void	setDotMultiTargets(boolean dotMultiTargets)
void	setDotPath(java.lang.String dotPath)
void	setDotTransparent(boolean dotTransparent)
void	setDoxyfileEncoding(java.lang.String doxyfileEncoding)
void	setEnabledSections(java.lang.String enabledSections)
void	setEnablePreprocessing(boolean enablePreprocessing)
void	setEnumValuesPerLine(java.lang.Integer enumValuesPerLine)
void	setExamplePath(java.lang.String examplePath)
void	setExamplePatterns(java.lang.String examplePatterns)
void	setExampleRecursive(boolean exampleRecursive)
void	setExclude(java.lang.String exclude)
void	setExcludePatterns(java.lang.String excludePatterns)
void	setExcludeSymbols(java.lang.String excludeSymbols)
void	setExcludeSymlinks(boolean excludeSymlinks)
void	setExpandAsDefined(java.lang.String expandAsDefined)
void	setExpandOnlyPredef(boolean expandOnlyPredef)
void	setExternalGroups(boolean externalGroups)
void	setExtractAll(boolean extractAll)
void	setExtractAnonNspaces(boolean extractAnonNspaces)
void	setExtractLocalClasses(boolean extractLocalClasses)
void	setExtractLocalMethods(boolean extractLocalMethods)
void	setExtractPrivate(boolean extractPrivate)
void	setExtractStatic(boolean extractStatic)
void	setExtraPackages(java.lang.String extraPackages)
void	setFilePatterns(java.lang.String filePatterns)
void	setFileVersionFilter(java.lang.String fileVersionFilter)
void	setFilterPatterns(java.lang.String filterPatterns)
void	setFilterSourceFiles(boolean filterSourceFiles)
void	setFormulaFontsize(java.lang.Integer formulaFontsize)
void	setFullPathNames(boolean fullPathNames)
void	setGenerateAutogenDef(boolean generateAutogenDef)
void	setGenerateBuglist(boolean generateBuglist)
void	setGenerateChi(boolean generateChi)
void	setGenerateDeprecatedlist(boolean generateDeprecatedlist)
void	setGenerateDocset(boolean generateDocset)
void	setGenerateHtml(boolean generateHtml)
void	setGenerateHtmlhelp(boolean generateHtmlhelp)
void	setGenerateLatex(boolean generateLatex)
void	setGenerateLegend(boolean generateLegend)
void	setGenerateMan(boolean generateMan)
void	setGeneratePerlmod(boolean generatePerlmod)
void	setGenerateQhp(boolean generateQhp)
void	setGenerateRtf(boolean generateRtf)
void	setGenerateTagfile(java.lang.String generateTagfile)
void	setGenerateTestlist(boolean generateTestlist)
void	setGenerateTodolist(boolean generateTodolist)
void	setGenerateTreeview(java.lang.String generateTreeview)
void	setGenerateXml(boolean generateXml)
void	setGraphicalHierarchy(boolean graphicalHierarchy)
void	setGroupGraphs(boolean groupGraphs)
void	setHaveDot(boolean haveDot)
void	setHhcLocation(java.lang.String hhcLocation)
void	setHideFriendCompounds(boolean hideFriendCompounds)
void	setHideInBodyDocs(boolean hideInBodyDocs)
void	setHideScopeNames(boolean hideScopeNames)
void	setHideUndocClasses(boolean hideUndocClasses)
void	setHideUndocMembers(boolean hideUndocMembers)
void	setHideUndocRelations(boolean hideUndocRelations)
void	setHtmlAlignMembers(boolean htmlAlignMembers)
void	setHtmlDynamicSections(boolean htmlDynamicSections)
void	setHtmlFileExtension(java.lang.String htmlFileExtension)
void	setHtmlFooter(java.lang.String htmlFooter)
void	setHtmlHeader(java.lang.String htmlHeader)
void	setHtmlOutput(java.lang.String htmlOutput)
void	setHtmlStylesheet(java.lang.String htmlStylesheet)
void	setIdlPropertySupport(boolean idlPropertySupport)
void	setIgnorePrefix(java.lang.String ignorePrefix)
void	setImagePath(java.lang.String imagePath)
void	setIncludedByGraph(boolean includedByGraph)
void	setIncludeFilePatterns(java.lang.String includeFilePatterns)
void	setIncludeGraph(boolean includeGraph)
void	setIncludePath(java.lang.String includePath)
void	setInheritDocs(boolean inheritDocs)
void	setInlineInfo(boolean inlineInfo)
void	setInlineInheritedMemb(boolean inlineInheritedMemb)
void	setInlineSources(boolean inlineSources)
void	setInput(java.lang.String input)
void	setInputEncoding(java.lang.String inputEncoding)
void	setInputFilter(java.lang.String inputFilter)
void	setInternalDocs(boolean internalDocs)
void	setJavadocAutobrief(boolean javadocAutobrief)
void	setLatexBatchmode(boolean latexBatchmode)
void	setLatexCmdName(java.lang.String latexCmdName)
void	setLatexHeader(java.lang.String latexHeader)
void	setLatexHideIndices(boolean latexHideIndices)
void	setLatexOutput(java.lang.String latexOutput)
void	setLayoutFile(java.lang.String layoutFile)
void	setMacroExpansion(boolean macroExpansion)
void	setMakeindexCmdName(java.lang.String makeindexCmdName)
void	setManExtension(java.lang.String manExtension)
void	setManLinks(boolean manLinks)
void	setManOutput(java.lang.String manOutput)
void	setMaxDotGraphDepth(java.lang.Integer maxDotGraphDepth)
void	setMaxInitializerLines(java.lang.Integer maxInitializerLines)
void	setMscgenPath(java.lang.String mscgenPath)
void	setMultilineCppIsBrief(boolean multilineCppIsBrief)
void	setOptimizeForFortran(boolean optimizeForFortran)
void	setOptimizeOutputForC(boolean optimizeOutputForC)
void	setOptimizeOutputJava(boolean optimizeOutputJava)
void	setOptimizeOutputVhdl(boolean optimizeOutputVhdl)
void	setOutputLanguage(java.lang.String outputLanguage)
void	setPaperType(java.lang.String paperType)
void	setPdfHyperlinks(boolean pdfHyperlinks)
void	setPerlmodLatex(boolean perlmodLatex)
void	setPerlmodMakevarPrefix(java.lang.String perlmodMakevarPrefix)
void	setPerlmodPretty(boolean perlmodPretty)
void	setPerlPath(java.lang.String perlPath)
void	setPredefined(java.lang.String predefined)
void	setProjectName(java.lang.String projectName)
void	setProjectNumber(java.lang.String projectNumber)
void	setQchFile(java.lang.String qchFile)
void	setQhgLocation(java.lang.String qhgLocation)
void	setQhpNamespace(java.lang.String qhpNamespace)
void	setQhpVirtualFolder(java.lang.String qhpVirtualFolder)
void	setQtAutobrief(boolean qtAutobrief)
void	setQuiet(boolean quiet)
void	setRecursive(boolean recursive)
void	setReferencedByRelation(boolean referencedByRelation)
void	setReferencesLinkSource(boolean referencesLinkSource)
void	setReferencesRelation(boolean referencesRelation)
void	setRepeatBrief(boolean repeatBrief)
void	setRtfExtensionsFile(java.lang.String rtfExtensionsFile)
void	setRtfHyperlinks(boolean rtfHyperlinks)
void	setRtfOutput(java.lang.String rtfOutput)
void	setRtfStylesheetFile(java.lang.String rtfStylesheetFile)
void	setSearchengine(boolean searchengine)
void	setSearchIncludes(boolean searchIncludes)
void	setSeparateMemberPages(boolean separateMemberPages)
void	setShortNames(boolean shortNames)
void	setShowDirectories(boolean showDirectories)
void	setShowFiles(boolean showFiles)
void	setShowIncludeFiles(boolean showIncludeFiles)
void	setShowNamespaces(boolean showNamespaces)
void	setShowUsedFiles(boolean showUsedFiles)
void	setSipSupport(boolean sipSupport)
void	setSkipFunctionMacros(boolean skipFunctionMacros)
void	setSortBriefDocs(boolean sortBriefDocs)
void	setSortByScopeName(boolean sortByScopeName)
void	setSortGroupNames(boolean sortGroupNames)
void	setSortMemberDocs(boolean sortMemberDocs)
void	setSourceBrowser(boolean sourceBrowser)
void	setStripCodeComments(boolean stripCodeComments)
void	setStripFromIncPath(java.lang.String stripFromIncPath)
void	setStripFromPath(java.lang.String stripFromPath)
void	setSubgrouping(boolean subgrouping)
void	setSymbolCacheSize(java.lang.Integer symbolCacheSize)
void	setTabSize(java.lang.Integer tabSize)
void	setTagfiles(java.lang.String tagfiles)
void	setTemplateRelations(boolean templateRelations)
void	setTocExpand(boolean tocExpand)
void	setTreeviewWidth(java.lang.Integer treeviewWidth)
void	setTypedefHidesStruct(boolean typedefHidesStruct)
void	setUmlLook(boolean umlLook)
void	setUseHtags(boolean useHtags)
void	setUsePdflatex(boolean usePdflatex)
void	setVerbatimHeaders(boolean verbatimHeaders)
void	setWarnFormat(java.lang.String warnFormat)
void	setWarnIfDocError(boolean warnIfDocError)
void	setWarnIfUndocumented(boolean warnIfUndocumented)
void	setWarnings(boolean warnings)
void	setWarnLogfile(java.lang.String warnLogfile)
void	setWarnNoParamdoc(boolean warnNoParamdoc)
void	setXmlDtd(java.lang.String xmlDtd)
void	setXmlOutput(java.lang.String xmlOutput)
void	setXmlProgramlisting(boolean xmlProgramlisting)
void	setXmlSchema(java.lang.String xmlSchema)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

configurationFile

private java.io.File configurationFile

This defines which file will be used as Doxygen configuration file instead of creating one.

doxyfileEncoding

private java.lang.String doxyfileEncoding

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.

projectName

private java.lang.String projectName

The PROJECT_NAME tag is a single word (or a sequence of words surrounded by quotes) that should identify the project.

projectNumber

private java.lang.String projectNumber

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.

createSubdirs

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. 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.

outputLanguage

private java.lang.String outputLanguage

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.

briefMemberDesc

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). Set to NO to disable this.

repeatBrief

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. Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be completely suppressed.

abbreviateBrief

private java.lang.String abbreviateBrief

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"

alwaysDetailedSec

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.

inlineInheritedMemb

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. Constructors, destructors and assignment operators of the base classes will not be shown.

fullPathNames

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. If set to NO the shortest path that makes the file name unique will be used.

stripFromPath

private java.lang.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. 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.

stripFromIncPath

private java.lang.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. 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.

shortNames

private boolean shortNames

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.

javadocAutobrief

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. 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.)

qtAutobrief

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. If set to NO, the comments will behave just like regular Qt-style comments (thus requiring an explicit \brief command for a brief description.)

multilineCppIsBrief

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. 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.

inheritDocs

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.

separateMemberPages

private boolean separateMemberPages

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.

tabSize

private java.lang.Integer tabSize

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.

aliases

private java.lang.String aliases

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.

optimizeOutputForC

private boolean optimizeOutputForC

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.

optimizeOutputJava

private boolean optimizeOutputJava

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.

optimizeForFortran

private boolean optimizeForFortran

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.

optimizeOutputVhdl

private boolean optimizeOutputVhdl

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.

builtinStlSupport

private boolean builtinStlSupport

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.

cppCliSupport

private boolean cppCliSupport

If you use Microsoft's C++/CLI language, you should set this option to YES to enable parsing support.

sipSupport

private boolean sipSupport

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.

idlPropertySupport

private boolean idlPropertySupport

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.

distributeGroupDoc

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. By default all members of a group must be documented explicitly.

subgrouping

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. under the Public Functions section). Set it to NO to prevent subgrouping. Alternatively, this can be done per class using the \nosubgrouping command.

typedefHidesStruct

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. 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.

symbolCacheSize

private java.lang.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. 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

extractAll

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 class members and static file members will be hidden unless the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

extractPrivate

private boolean extractPrivate

If the EXTRACT_PRIVATE tag is set to YES all private members of a class will be included in the documentation.

extractStatic

private boolean extractStatic

If the EXTRACT_STATIC tag is set to YES all static members of a file will be included in the documentation.

extractLocalClasses

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. If set to NO only classes defined in header files are included.

extractLocalMethods

private boolean extractLocalMethods

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.

extractAnonNspaces

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. By default anonymous namespace are hidden.

hideUndocMembers

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. 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.

hideUndocClasses

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. 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.

hideFriendCompounds

private boolean hideFriendCompounds

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.

hideInBodyDocs

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. If set to NO (the default) these blocks will be appended to the function's detailed documentation block.

internalDocs

private boolean internalDocs

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.

caseSenseNames

private boolean caseSenseNames

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.

hideScopeNames

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. If set to YES the scope will be hidden.

showIncludeFiles

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.

inlineInfo

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.

sortMemberDocs

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. If set to NO the members will appear in declaration order.

sortBriefDocs

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. If set to NO (the default) the members will appear in declaration order.

sortGroupNames

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. If set to NO (the default) the group names will appear in their defined order.

sortByScopeName

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. 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.

generateTodolist

private boolean generateTodolist

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.

generateTestlist

private boolean generateTestlist

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.

generateBuglist

private boolean generateBuglist

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.

generateDeprecatedlist

private boolean generateDeprecatedlist

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.

enabledSections

private java.lang.String enabledSections

The ENABLED_SECTIONS tag can be used to enable conditional documentation sections, marked by \if sectionname ... \endif.

maxInitializerLines

private java.lang.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. 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.

showUsedFiles

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. If set to YES the list will mention the files that were used to generate the documentation.

showDirectories

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. The default is NO.

showFiles

private boolean showFiles

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.

showNamespaces

private boolean showNamespaces

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.

fileVersionFilter

private java.lang.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). 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.

layoutFile

private java.lang.String layoutFile

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.

quiet

private boolean quiet

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.

warnings

private boolean warnings

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.

warnIfUndocumented

private boolean warnIfUndocumented

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.

warnIfDocError

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.

warnNoParamdoc

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. If set to NO (the default) doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence of documentation.

warnFormat

private java.lang.String warnFormat

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)

warnLogfile

private java.lang.String warnLogfile

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.

input

private java.lang.String input

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.

inputEncoding

private java.lang.String inputEncoding

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.

filePatterns

private java.lang.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. 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

recursive

private boolean recursive

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.

exclude

private java.lang.String exclude

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.

excludeSymlinks

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.

excludePatterns

private java.lang.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. 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

excludeSymbols

private java.lang.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. 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

examplePath

private java.lang.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).

examplePatterns

private java.lang.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. If left blank all files are included.

exampleRecursive

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. Possible values are YES and NO. If left blank NO is used.

imagePath

private java.lang.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).

inputFilter

private java.lang.String inputFilter

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.

filterPatterns

private java.lang.String filterPatterns

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.

filterSourceFiles

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. when SOURCE_BROWSER is set to YES).

sourceBrowser

private boolean sourceBrowser

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.

inlineSources

private boolean inlineSources

Setting the INLINE_SOURCES tag to YES will include the body of functions and classes directly in the documentation.

stripCodeComments

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. Normal C and C++ comments will always remain visible.

referencedByRelation

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.

referencesRelation

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.

referencesLinkSource

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. Otherwise they will link to the documentstion.

useHtags

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. 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.

verbatimHeaders

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. Set to NO to disable this.

alphabeticalIndex

private boolean alphabeticalIndex

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.

colsInAlphaIndex

private java.lang.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])

ignorePrefix

private java.lang.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. The IGNORE_PREFIX tag can be used to specify one or more prefixes that should be ignored while generating the index headers.

generateHtml

private boolean generateHtml

If the GENERATE_HTML tag is set to YES (the default) Doxygen will generate HTML output.

htmlOutput

private java.lang.String htmlOutput

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.

htmlFileExtension

private java.lang.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). If it is left blank doxygen will generate files with .html extension.

htmlHeader

private java.lang.String htmlHeader

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.

htmlFooter

private java.lang.String htmlFooter

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.

htmlStylesheet

private java.lang.String htmlStylesheet

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!

htmlAlignMembers

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. If set to NO a bullet list will be used.

htmlDynamicSections

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. 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).

generateDocset

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). 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.

docsetFeedname

private java.lang.String docsetFeedname

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.

docsetBundleId

private java.lang.String docsetBundleId

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.

generateHtmlhelp

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.

chmFile

private java.lang.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. You can add a path in front of the file if the result should not be written to the html output directory.

hhcLocation

private java.lang.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). If non-empty doxygen will try to run the HTML help compiler on the generated index.hhp.

generateChi

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).

chmIndexEncoding

private java.lang.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.

binaryToc

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.

tocExpand

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.

generateQhp

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.

qchFile

private java.lang.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. The path specified is relative to the HTML output folder.

qhpNamespace

private java.lang.String qhpNamespace

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>.

qhpVirtualFolder

private java.lang.String qhpVirtualFolder

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>.

qhgLocation

private java.lang.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. If non-empty doxygen will try to run qhelpgenerator on the generated .qhp file .

disableIndex

private boolean disableIndex

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.

enumValuesPerLine

private java.lang.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.

generateTreeview

private java.lang.String generateTreeview

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.

treeviewWidth

private java.lang.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.

formulaFontsize

private java.lang.Integer formulaFontsize

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.

generateLatex

private boolean generateLatex

If the GENERATE_LATEX tag is set to YES (the default) Doxygen will generate Latex output.

latexOutput

private java.lang.String latexOutput

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.

latexCmdName

private java.lang.String latexCmdName

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.

makeindexCmdName

private java.lang.String makeindexCmdName

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.

compactLatex

private boolean compactLatex

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.

paperType

private java.lang.String paperType

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.

extraPackages

private java.lang.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.

latexHeader

private java.lang.String latexHeader

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!

pdfHyperlinks

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). 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.

usePdflatex

private boolean usePdflatex

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.

latexBatchmode

private boolean latexBatchmode

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.

latexHideIndices

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.

generateRtf

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.

rtfOutput

private java.lang.String rtfOutput

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.

compactRtf

private boolean compactRtf

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.

rtfHyperlinks

private boolean rtfHyperlinks

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.

rtfStylesheetFile

private java.lang.String rtfStylesheetFile

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.

rtfExtensionsFile

private java.lang.String rtfExtensionsFile

Set optional variables used in the generation of an rtf document. Syntax is similar to doxygen's config file.

generateMan

private boolean generateMan

If the GENERATE_MAN tag is set to YES (the default) Doxygen will generate man pages

manOutput

private java.lang.String manOutput

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.

manExtension

private java.lang.String manExtension

The MAN_EXTENSION tag determines the extension that is added to the generated man pages (default is the subroutine's section .3)

manLinks

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). 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.

generateXml

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.

xmlOutput

private java.lang.String xmlOutput

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.

xmlSchema

private java.lang.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.

xmlDtd

private java.lang.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.

xmlProgramlisting

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. Note that enabling this will significantly increase the size of the XML output.

generateAutogenDef

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. Note that this feature is still experimental and incomplete at the moment.

generatePerlmod

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. Note that this feature is still experimental and incomplete at the moment.

perlmodLatex

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.

perlmodPretty

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. 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.

perlmodMakevarPrefix

private java.lang.String perlmodMakevarPrefix

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.

enablePreprocessing

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.

macroExpansion

private boolean macroExpansion

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.

expandOnlyPredef

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.

searchIncludes

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.

includePath

private java.lang.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.

includeFilePatterns

private java.lang.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. If left blank, the patterns specified with FILE_PATTERNS will be used.

predefined

private java.lang.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). 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.

expandAsDefined

private java.lang.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. 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.

skipFunctionMacros

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. Such function macros are typically used for boiler-plate code, and will confuse the parser if not removed.

tagfiles

private java.lang.String tagfiles

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.

generateTagfile

private java.lang.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.

allexternals

private boolean allexternals

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.

externalGroups

private boolean externalGroups

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.

perlPath

private java.lang.String perlPath

The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `which perl').

classDiagrams

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. 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.

mscgenPath

private java.lang.String mscgenPath

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.

hideUndocRelations

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.

haveDot

private boolean haveDot

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)

dotFontname

private java.lang.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. 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.

dotFontsize

private java.lang.Integer dotFontsize

The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. The default size is 10pt.

dotFontpath

private java.lang.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). If you specify a different font using DOT_FONTNAME you can set the path where dot can find it using this tag.

classGraph

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. Setting this tag to YES will force the the CLASS_DIAGRAMS tag to NO.

collaborationGraph

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.

groupGraphs

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

umlLook

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.

templateRelations

private boolean templateRelations

If set to YES, the inheritance and collaboration graphs will show the relations between templates and their instances.

includeGraph

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.

includedByGraph

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.

callGraph

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. 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.

callerGraph

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. 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.

graphicalHierarchy

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.

directoryGraph

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. The dependency relations are determined by the #include relations between the files in the directories.

dotImageFormat

private java.lang.String dotImageFormat

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.

dotPath

private java.lang.String dotPath

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.

dotfileDirs

private java.lang.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).

dotGraphMaxNodes

private java.lang.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. 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.

maxDotGraphDepth

private java.lang.Integer maxDotGraphDepth

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.

dotTransparent

private boolean dotTransparent

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).

dotMultiTargets

private boolean dotMultiTargets

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.

generateLegend

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.

dotCleanup

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.

searchengine

private boolean searchengine

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.

Constructor Detail

AbstractDoxygenConfigurationMojo

public AbstractDoxygenConfigurationMojo()

Method Detail

getConfigurationFile

public java.io.File getConfigurationFile()

setConfigurationFile

public void setConfigurationFile(java.io.File configurationFile)

getDoxyfileEncoding

public java.lang.String getDoxyfileEncoding()

setDoxyfileEncoding

public void setDoxyfileEncoding(java.lang.String doxyfileEncoding)

getProjectName

public java.lang.String getProjectName()

setProjectName

public void setProjectName(java.lang.String projectName)

getProjectNumber

public java.lang.String getProjectNumber()

setProjectNumber

public void setProjectNumber(java.lang.String projectNumber)

isCreateSubdirs

public boolean isCreateSubdirs()

setCreateSubdirs

public void setCreateSubdirs(boolean createSubdirs)

getOutputLanguage

public java.lang.String getOutputLanguage()

setOutputLanguage

public void setOutputLanguage(java.lang.String outputLanguage)

isBriefMemberDesc

public boolean isBriefMemberDesc()

setBriefMemberDesc

public void setBriefMemberDesc(boolean briefMemberDesc)

isRepeatBrief

public boolean isRepeatBrief()

setRepeatBrief

public void setRepeatBrief(boolean repeatBrief)

getAbbreviateBrief

public java.lang.String getAbbreviateBrief()

setAbbreviateBrief

public void setAbbreviateBrief(java.lang.String abbreviateBrief)

isAlwaysDetailedSec

public boolean isAlwaysDetailedSec()

setAlwaysDetailedSec

public void setAlwaysDetailedSec(boolean alwaysDetailedSec)

isInlineInheritedMemb

public boolean isInlineInheritedMemb()

setInlineInheritedMemb

public void setInlineInheritedMemb(boolean inlineInheritedMemb)

isFullPathNames

public boolean isFullPathNames()

setFullPathNames

public void setFullPathNames(boolean fullPathNames)

getStripFromPath

public java.lang.String getStripFromPath()

setStripFromPath

public void setStripFromPath(java.lang.String stripFromPath)

getStripFromIncPath

public java.lang.String getStripFromIncPath()

setStripFromIncPath

public void setStripFromIncPath(java.lang.String stripFromIncPath)

isShortNames

public boolean isShortNames()

setShortNames

public void setShortNames(boolean shortNames)

isJavadocAutobrief

public boolean isJavadocAutobrief()

setJavadocAutobrief

public void setJavadocAutobrief(boolean javadocAutobrief)

isQtAutobrief

public boolean isQtAutobrief()

setQtAutobrief

public void setQtAutobrief(boolean qtAutobrief)

isMultilineCppIsBrief

public boolean isMultilineCppIsBrief()

setMultilineCppIsBrief

public void setMultilineCppIsBrief(boolean multilineCppIsBrief)

isInheritDocs

public boolean isInheritDocs()

setInheritDocs

public void setInheritDocs(boolean inheritDocs)

isSeparateMemberPages

public boolean isSeparateMemberPages()

setSeparateMemberPages

public void setSeparateMemberPages(boolean separateMemberPages)

getTabSize

public java.lang.Integer getTabSize()

setTabSize

public void setTabSize(java.lang.Integer tabSize)

getAliases

public java.lang.String getAliases()

setAliases

public void setAliases(java.lang.String aliases)

isOptimizeOutputForC

public boolean isOptimizeOutputForC()

setOptimizeOutputForC

public void setOptimizeOutputForC(boolean optimizeOutputForC)

isOptimizeOutputJava

public boolean isOptimizeOutputJava()

setOptimizeOutputJava

public void setOptimizeOutputJava(boolean optimizeOutputJava)

isOptimizeForFortran

public boolean isOptimizeForFortran()

setOptimizeForFortran

public void setOptimizeForFortran(boolean optimizeForFortran)

isOptimizeOutputVhdl

public boolean isOptimizeOutputVhdl()

setOptimizeOutputVhdl

public void setOptimizeOutputVhdl(boolean optimizeOutputVhdl)

isBuiltinStlSupport

public boolean isBuiltinStlSupport()

setBuiltinStlSupport

public void setBuiltinStlSupport(boolean builtinStlSupport)

isCppCliSupport

public boolean isCppCliSupport()

setCppCliSupport

public void setCppCliSupport(boolean cppCliSupport)

isSipSupport

public boolean isSipSupport()

setSipSupport

public void setSipSupport(boolean sipSupport)

isIdlPropertySupport

public boolean isIdlPropertySupport()

setIdlPropertySupport

public void setIdlPropertySupport(boolean idlPropertySupport)

isDistributeGroupDoc

public boolean isDistributeGroupDoc()

setDistributeGroupDoc

public void setDistributeGroupDoc(boolean distributeGroupDoc)

isSubgrouping

public boolean isSubgrouping()

setSubgrouping

public void setSubgrouping(boolean subgrouping)

isTypedefHidesStruct

public boolean isTypedefHidesStruct()

setTypedefHidesStruct

public void setTypedefHidesStruct(boolean typedefHidesStruct)

getSymbolCacheSize

public java.lang.Integer getSymbolCacheSize()

setSymbolCacheSize

public void setSymbolCacheSize(java.lang.Integer symbolCacheSize)

isExtractAll

public boolean isExtractAll()

setExtractAll

public void setExtractAll(boolean extractAll)

isExtractPrivate

public boolean isExtractPrivate()

setExtractPrivate

public void setExtractPrivate(boolean extractPrivate)

isExtractStatic

public boolean isExtractStatic()

setExtractStatic

public void setExtractStatic(boolean extractStatic)

isExtractLocalClasses

public boolean isExtractLocalClasses()

setExtractLocalClasses

public void setExtractLocalClasses(boolean extractLocalClasses)

isExtractLocalMethods

public boolean isExtractLocalMethods()

setExtractLocalMethods

public void setExtractLocalMethods(boolean extractLocalMethods)

isExtractAnonNspaces

public boolean isExtractAnonNspaces()

setExtractAnonNspaces

public void setExtractAnonNspaces(boolean extractAnonNspaces)

isHideUndocMembers

public boolean isHideUndocMembers()

setHideUndocMembers

public void setHideUndocMembers(boolean hideUndocMembers)

isHideUndocClasses

public boolean isHideUndocClasses()

setHideUndocClasses

public void setHideUndocClasses(boolean hideUndocClasses)

isHideFriendCompounds

public boolean isHideFriendCompounds()

setHideFriendCompounds

public void setHideFriendCompounds(boolean hideFriendCompounds)

isHideInBodyDocs

public boolean isHideInBodyDocs()

setHideInBodyDocs

public void setHideInBodyDocs(boolean hideInBodyDocs)

isInternalDocs

public boolean isInternalDocs()

setInternalDocs

public void setInternalDocs(boolean internalDocs)

isCaseSenseNames

public boolean isCaseSenseNames()

setCaseSenseNames

public void setCaseSenseNames(boolean caseSenseNames)

isHideScopeNames

public boolean isHideScopeNames()

setHideScopeNames

public void setHideScopeNames(boolean hideScopeNames)

isShowIncludeFiles

public boolean isShowIncludeFiles()

setShowIncludeFiles

public void setShowIncludeFiles(boolean showIncludeFiles)

isInlineInfo

public boolean isInlineInfo()

setInlineInfo

public void setInlineInfo(boolean inlineInfo)

isSortMemberDocs

public boolean isSortMemberDocs()

setSortMemberDocs

public void setSortMemberDocs(boolean sortMemberDocs)

isSortBriefDocs

public boolean isSortBriefDocs()

setSortBriefDocs

public void setSortBriefDocs(boolean sortBriefDocs)

isSortGroupNames

public boolean isSortGroupNames()

setSortGroupNames

public void setSortGroupNames(boolean sortGroupNames)

isSortByScopeName

public boolean isSortByScopeName()

setSortByScopeName

public void setSortByScopeName(boolean sortByScopeName)

isGenerateTodolist

public boolean isGenerateTodolist()

setGenerateTodolist

public void setGenerateTodolist(boolean generateTodolist)

isGenerateTestlist

public boolean isGenerateTestlist()

setGenerateTestlist

public void setGenerateTestlist(boolean generateTestlist)

isGenerateBuglist

public boolean isGenerateBuglist()

setGenerateBuglist

public void setGenerateBuglist(boolean generateBuglist)

isGenerateDeprecatedlist

public boolean isGenerateDeprecatedlist()

setGenerateDeprecatedlist

public void setGenerateDeprecatedlist(boolean generateDeprecatedlist)

getEnabledSections

public java.lang.String getEnabledSections()

setEnabledSections

public void setEnabledSections(java.lang.String enabledSections)

getMaxInitializerLines

public java.lang.Integer getMaxInitializerLines()

setMaxInitializerLines

public void setMaxInitializerLines(java.lang.Integer maxInitializerLines)

isShowUsedFiles

public boolean isShowUsedFiles()

setShowUsedFiles

public void setShowUsedFiles(boolean showUsedFiles)

isShowDirectories

public boolean isShowDirectories()

setShowDirectories

public void setShowDirectories(boolean showDirectories)

isShowFiles

public boolean isShowFiles()

setShowFiles

public void setShowFiles(boolean showFiles)

isShowNamespaces

public boolean isShowNamespaces()

setShowNamespaces

public void setShowNamespaces(boolean showNamespaces)

getFileVersionFilter

public java.lang.String getFileVersionFilter()

setFileVersionFilter

public void setFileVersionFilter(java.lang.String fileVersionFilter)

getLayoutFile

public java.lang.String getLayoutFile()

setLayoutFile

public void setLayoutFile(java.lang.String layoutFile)

isQuiet

public boolean isQuiet()

setQuiet

public void setQuiet(boolean quiet)

isWarnings

public boolean isWarnings()

setWarnings

public void setWarnings(boolean warnings)

isWarnIfUndocumented

public boolean isWarnIfUndocumented()

setWarnIfUndocumented

public void setWarnIfUndocumented(boolean warnIfUndocumented)

isWarnIfDocError

public boolean isWarnIfDocError()

setWarnIfDocError

public void setWarnIfDocError(boolean warnIfDocError)

isWarnNoParamdoc

public boolean isWarnNoParamdoc()

setWarnNoParamdoc

public void setWarnNoParamdoc(boolean warnNoParamdoc)

getWarnFormat

public java.lang.String getWarnFormat()

setWarnFormat

public void setWarnFormat(java.lang.String warnFormat)

getWarnLogfile

public java.lang.String getWarnLogfile()

setWarnLogfile

public void setWarnLogfile(java.lang.String warnLogfile)

getInput

public java.lang.String getInput()

setInput

public void setInput(java.lang.String input)

getInputEncoding

public java.lang.String getInputEncoding()

setInputEncoding

public void setInputEncoding(java.lang.String inputEncoding)

getFilePatterns

public java.lang.String getFilePatterns()

setFilePatterns

public void setFilePatterns(java.lang.String filePatterns)

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)

getExclude

public java.lang.String getExclude()

setExclude

public void setExclude(java.lang.String exclude)

isExcludeSymlinks

public boolean isExcludeSymlinks()

setExcludeSymlinks

public void setExcludeSymlinks(boolean excludeSymlinks)

getExcludePatterns

public java.lang.String getExcludePatterns()

setExcludePatterns

public void setExcludePatterns(java.lang.String excludePatterns)

getExcludeSymbols

public java.lang.String getExcludeSymbols()

setExcludeSymbols

public void setExcludeSymbols(java.lang.String excludeSymbols)

getExamplePath

public java.lang.String getExamplePath()

setExamplePath

public void setExamplePath(java.lang.String examplePath)

getExamplePatterns

public java.lang.String getExamplePatterns()

setExamplePatterns

public void setExamplePatterns(java.lang.String examplePatterns)

isExampleRecursive

public boolean isExampleRecursive()

setExampleRecursive

public void setExampleRecursive(boolean exampleRecursive)

getImagePath

public java.lang.String getImagePath()

setImagePath

public void setImagePath(java.lang.String imagePath)

getInputFilter

public java.lang.String getInputFilter()

setInputFilter

public void setInputFilter(java.lang.String inputFilter)

getFilterPatterns

public java.lang.String getFilterPatterns()

setFilterPatterns

public void setFilterPatterns(java.lang.String filterPatterns)

isFilterSourceFiles

public boolean isFilterSourceFiles()

setFilterSourceFiles

public void setFilterSourceFiles(boolean filterSourceFiles)

isSourceBrowser

public boolean isSourceBrowser()

setSourceBrowser

public void setSourceBrowser(boolean sourceBrowser)

isInlineSources

public boolean isInlineSources()

setInlineSources

public void setInlineSources(boolean inlineSources)

isStripCodeComments

public boolean isStripCodeComments()

setStripCodeComments

public void setStripCodeComments(boolean stripCodeComments)

isReferencedByRelation

public boolean isReferencedByRelation()

setReferencedByRelation

public void setReferencedByRelation(boolean referencedByRelation)

isReferencesRelation

public boolean isReferencesRelation()

setReferencesRelation

public void setReferencesRelation(boolean referencesRelation)

isReferencesLinkSource

public boolean isReferencesLinkSource()

setReferencesLinkSource

public void setReferencesLinkSource(boolean referencesLinkSource)

isUseHtags

public boolean isUseHtags()

setUseHtags

public void setUseHtags(boolean useHtags)

isVerbatimHeaders

public boolean isVerbatimHeaders()

setVerbatimHeaders

public void setVerbatimHeaders(boolean verbatimHeaders)

isAlphabeticalIndex

public boolean isAlphabeticalIndex()

setAlphabeticalIndex

public void setAlphabeticalIndex(boolean alphabeticalIndex)

getColsInAlphaIndex

public java.lang.Integer getColsInAlphaIndex()

setColsInAlphaIndex

public void setColsInAlphaIndex(java.lang.Integer colsInAlphaIndex)

getIgnorePrefix

public java.lang.String getIgnorePrefix()

setIgnorePrefix

public void setIgnorePrefix(java.lang.String ignorePrefix)

isGenerateHtml

public boolean isGenerateHtml()

setGenerateHtml

public void setGenerateHtml(boolean generateHtml)

getHtmlOutput

public java.lang.String getHtmlOutput()

setHtmlOutput

public void setHtmlOutput(java.lang.String htmlOutput)

getHtmlFileExtension

public java.lang.String getHtmlFileExtension()

setHtmlFileExtension

public void setHtmlFileExtension(java.lang.String htmlFileExtension)

getHtmlHeader

public java.lang.String getHtmlHeader()

setHtmlHeader

public void setHtmlHeader(java.lang.String htmlHeader)

getHtmlFooter

public java.lang.String getHtmlFooter()

setHtmlFooter

public void setHtmlFooter(java.lang.String htmlFooter)

getHtmlStylesheet

public java.lang.String getHtmlStylesheet()

setHtmlStylesheet

public void setHtmlStylesheet(java.lang.String htmlStylesheet)

isHtmlAlignMembers

public boolean isHtmlAlignMembers()

setHtmlAlignMembers

public void setHtmlAlignMembers(boolean htmlAlignMembers)

isHtmlDynamicSections

public boolean isHtmlDynamicSections()

setHtmlDynamicSections

public void setHtmlDynamicSections(boolean htmlDynamicSections)

isGenerateDocset

public boolean isGenerateDocset()

setGenerateDocset

public void setGenerateDocset(boolean generateDocset)

getDocsetFeedname

public java.lang.String getDocsetFeedname()

setDocsetFeedname

public void setDocsetFeedname(java.lang.String docsetFeedname)

getDocsetBundleId

public java.lang.String getDocsetBundleId()

setDocsetBundleId

public void setDocsetBundleId(java.lang.String docsetBundleId)

isGenerateHtmlhelp

public boolean isGenerateHtmlhelp()

setGenerateHtmlhelp

public void setGenerateHtmlhelp(boolean generateHtmlhelp)

getChmFile

public java.lang.String getChmFile()

setChmFile

public void setChmFile(java.lang.String chmFile)

getHhcLocation

public java.lang.String getHhcLocation()

setHhcLocation

public void setHhcLocation(java.lang.String hhcLocation)

isGenerateChi

public boolean isGenerateChi()

setGenerateChi

public void setGenerateChi(boolean generateChi)

getChmIndexEncoding

public java.lang.String getChmIndexEncoding()

setChmIndexEncoding

public void setChmIndexEncoding(java.lang.String chmIndexEncoding)

isBinaryToc

public boolean isBinaryToc()

setBinaryToc

public void setBinaryToc(boolean binaryToc)

isTocExpand

public boolean isTocExpand()

setTocExpand

public void setTocExpand(boolean tocExpand)

isGenerateQhp

public boolean isGenerateQhp()

setGenerateQhp

public void setGenerateQhp(boolean generateQhp)

getQchFile

public java.lang.String getQchFile()

setQchFile

public void setQchFile(java.lang.String qchFile)

getQhpNamespace

public java.lang.String getQhpNamespace()

setQhpNamespace

public void setQhpNamespace(java.lang.String qhpNamespace)

getQhpVirtualFolder

public java.lang.String getQhpVirtualFolder()

setQhpVirtualFolder

public void setQhpVirtualFolder(java.lang.String qhpVirtualFolder)

getQhgLocation

public java.lang.String getQhgLocation()

setQhgLocation

public void setQhgLocation(java.lang.String qhgLocation)

isDisableIndex

public boolean isDisableIndex()

setDisableIndex

public void setDisableIndex(boolean disableIndex)

getEnumValuesPerLine

public java.lang.Integer getEnumValuesPerLine()

setEnumValuesPerLine

public void setEnumValuesPerLine(java.lang.Integer enumValuesPerLine)

getGenerateTreeview

public java.lang.String getGenerateTreeview()

setGenerateTreeview

public void setGenerateTreeview(java.lang.String generateTreeview)

getTreeviewWidth

public java.lang.Integer getTreeviewWidth()

setTreeviewWidth

public void setTreeviewWidth(java.lang.Integer treeviewWidth)

getFormulaFontsize

public java.lang.Integer getFormulaFontsize()

setFormulaFontsize

public void setFormulaFontsize(java.lang.Integer formulaFontsize)

isGenerateLatex

public boolean isGenerateLatex()

setGenerateLatex

public void setGenerateLatex(boolean generateLatex)

getLatexOutput

public java.lang.String getLatexOutput()

setLatexOutput

public void setLatexOutput(java.lang.String latexOutput)

getLatexCmdName

public java.lang.String getLatexCmdName()

setLatexCmdName

public void setLatexCmdName(java.lang.String latexCmdName)

getMakeindexCmdName

public java.lang.String getMakeindexCmdName()

setMakeindexCmdName

public void setMakeindexCmdName(java.lang.String makeindexCmdName)

isCompactLatex

public boolean isCompactLatex()

setCompactLatex

public void setCompactLatex(boolean compactLatex)

getPaperType

public java.lang.String getPaperType()

setPaperType

public void setPaperType(java.lang.String paperType)

getExtraPackages

public java.lang.String getExtraPackages()

setExtraPackages

public void setExtraPackages(java.lang.String extraPackages)

getLatexHeader

public java.lang.String getLatexHeader()

setLatexHeader

public void setLatexHeader(java.lang.String latexHeader)

isPdfHyperlinks

public boolean isPdfHyperlinks()

setPdfHyperlinks

public void setPdfHyperlinks(boolean pdfHyperlinks)

isUsePdflatex

public boolean isUsePdflatex()

setUsePdflatex

public void setUsePdflatex(boolean usePdflatex)

isLatexBatchmode

public boolean isLatexBatchmode()

setLatexBatchmode

public void setLatexBatchmode(boolean latexBatchmode)

isLatexHideIndices

public boolean isLatexHideIndices()

setLatexHideIndices

public void setLatexHideIndices(boolean latexHideIndices)

isGenerateRtf

public boolean isGenerateRtf()

setGenerateRtf

public void setGenerateRtf(boolean generateRtf)

getRtfOutput

public java.lang.String getRtfOutput()

setRtfOutput

public void setRtfOutput(java.lang.String rtfOutput)

isCompactRtf

public boolean isCompactRtf()

setCompactRtf

public void setCompactRtf(boolean compactRtf)

isRtfHyperlinks

public boolean isRtfHyperlinks()

setRtfHyperlinks

public void setRtfHyperlinks(boolean rtfHyperlinks)

getRtfStylesheetFile

public java.lang.String getRtfStylesheetFile()

setRtfStylesheetFile

public void setRtfStylesheetFile(java.lang.String rtfStylesheetFile)

getRtfExtensionsFile

public java.lang.String getRtfExtensionsFile()

setRtfExtensionsFile

public void setRtfExtensionsFile(java.lang.String rtfExtensionsFile)

isGenerateMan

public boolean isGenerateMan()

setGenerateMan

public void setGenerateMan(boolean generateMan)

getManOutput

public java.lang.String getManOutput()

setManOutput

public void setManOutput(java.lang.String manOutput)

getManExtension

public java.lang.String getManExtension()

setManExtension

public void setManExtension(java.lang.String manExtension)

isManLinks

public boolean isManLinks()

setManLinks

public void setManLinks(boolean manLinks)

isGenerateXml

public boolean isGenerateXml()

setGenerateXml

public void setGenerateXml(boolean generateXml)

getXmlOutput

public java.lang.String getXmlOutput()

setXmlOutput

public void setXmlOutput(java.lang.String xmlOutput)

getXmlSchema

public java.lang.String getXmlSchema()

setXmlSchema

public void setXmlSchema(java.lang.String xmlSchema)

getXmlDtd

public java.lang.String getXmlDtd()

setXmlDtd

public void setXmlDtd(java.lang.String xmlDtd)

isXmlProgramlisting

public boolean isXmlProgramlisting()

setXmlProgramlisting

public void setXmlProgramlisting(boolean xmlProgramlisting)

isGenerateAutogenDef

public boolean isGenerateAutogenDef()

setGenerateAutogenDef

public void setGenerateAutogenDef(boolean generateAutogenDef)

isGeneratePerlmod

public boolean isGeneratePerlmod()

setGeneratePerlmod

public void setGeneratePerlmod(boolean generatePerlmod)

isPerlmodLatex

public boolean isPerlmodLatex()

setPerlmodLatex

public void setPerlmodLatex(boolean perlmodLatex)

isPerlmodPretty

public boolean isPerlmodPretty()

setPerlmodPretty

public void setPerlmodPretty(boolean perlmodPretty)

getPerlmodMakevarPrefix

public java.lang.String getPerlmodMakevarPrefix()

setPerlmodMakevarPrefix

public void setPerlmodMakevarPrefix(java.lang.String perlmodMakevarPrefix)

isEnablePreprocessing

public boolean isEnablePreprocessing()

setEnablePreprocessing

public void setEnablePreprocessing(boolean enablePreprocessing)

isMacroExpansion

public boolean isMacroExpansion()

setMacroExpansion

public void setMacroExpansion(boolean macroExpansion)

isExpandOnlyPredef

public boolean isExpandOnlyPredef()

setExpandOnlyPredef

public void setExpandOnlyPredef(boolean expandOnlyPredef)

isSearchIncludes

public boolean isSearchIncludes()

setSearchIncludes

public void setSearchIncludes(boolean searchIncludes)

getIncludePath

public java.lang.String getIncludePath()

setIncludePath

public void setIncludePath(java.lang.String includePath)

getIncludeFilePatterns

public java.lang.String getIncludeFilePatterns()

setIncludeFilePatterns

public void setIncludeFilePatterns(java.lang.String includeFilePatterns)

getPredefined

public java.lang.String getPredefined()

setPredefined

public void setPredefined(java.lang.String predefined)

getExpandAsDefined

public java.lang.String getExpandAsDefined()

setExpandAsDefined

public void setExpandAsDefined(java.lang.String expandAsDefined)

isSkipFunctionMacros

public boolean isSkipFunctionMacros()

setSkipFunctionMacros

public void setSkipFunctionMacros(boolean skipFunctionMacros)

getTagfiles

public java.lang.String getTagfiles()

setTagfiles

public void setTagfiles(java.lang.String tagfiles)

getGenerateTagfile

public java.lang.String getGenerateTagfile()

setGenerateTagfile

public void setGenerateTagfile(java.lang.String generateTagfile)

isAllexternals

public boolean isAllexternals()

setAllexternals

public void setAllexternals(boolean allexternals)

isExternalGroups

public boolean isExternalGroups()

setExternalGroups

public void setExternalGroups(boolean externalGroups)

getPerlPath

public java.lang.String getPerlPath()

setPerlPath

public void setPerlPath(java.lang.String perlPath)

isClassDiagrams

public boolean isClassDiagrams()

setClassDiagrams

public void setClassDiagrams(boolean classDiagrams)

getMscgenPath

public java.lang.String getMscgenPath()

setMscgenPath

public void setMscgenPath(java.lang.String mscgenPath)

isHideUndocRelations

public boolean isHideUndocRelations()

setHideUndocRelations

public void setHideUndocRelations(boolean hideUndocRelations)

isHaveDot

public boolean isHaveDot()

setHaveDot

public void setHaveDot(boolean haveDot)

getDotFontname

public java.lang.String getDotFontname()

setDotFontname

public void setDotFontname(java.lang.String dotFontname)

getDotFontsize

public java.lang.Integer getDotFontsize()

setDotFontsize

public void setDotFontsize(java.lang.Integer dotFontsize)

getDotFontpath

public java.lang.String getDotFontpath()

setDotFontpath

public void setDotFontpath(java.lang.String dotFontpath)

isClassGraph

public boolean isClassGraph()

setClassGraph

public void setClassGraph(boolean classGraph)

isCollaborationGraph

public boolean isCollaborationGraph()

setCollaborationGraph

public void setCollaborationGraph(boolean collaborationGraph)

isGroupGraphs

public boolean isGroupGraphs()

setGroupGraphs

public void setGroupGraphs(boolean groupGraphs)

isUmlLook

public boolean isUmlLook()

setUmlLook

public void setUmlLook(boolean umlLook)

isTemplateRelations

public boolean isTemplateRelations()

setTemplateRelations

public void setTemplateRelations(boolean templateRelations)

isIncludeGraph

public boolean isIncludeGraph()

setIncludeGraph

public void setIncludeGraph(boolean includeGraph)

isIncludedByGraph

public boolean isIncludedByGraph()

setIncludedByGraph

public void setIncludedByGraph(boolean includedByGraph)

isCallGraph

public boolean isCallGraph()

setCallGraph

public void setCallGraph(boolean callGraph)

isCallerGraph

public boolean isCallerGraph()

setCallerGraph

public void setCallerGraph(boolean callerGraph)

isGraphicalHierarchy

public boolean isGraphicalHierarchy()

setGraphicalHierarchy

public void setGraphicalHierarchy(boolean graphicalHierarchy)

isDirectoryGraph

public boolean isDirectoryGraph()

setDirectoryGraph

public void setDirectoryGraph(boolean directoryGraph)

getDotImageFormat

public java.lang.String getDotImageFormat()

setDotImageFormat

public void setDotImageFormat(java.lang.String dotImageFormat)

getDotPath

public java.lang.String getDotPath()

setDotPath

public void setDotPath(java.lang.String dotPath)

getDotfileDirs

public java.lang.String getDotfileDirs()

setDotfileDirs

public void setDotfileDirs(java.lang.String dotfileDirs)

getDotGraphMaxNodes

public java.lang.Integer getDotGraphMaxNodes()

setDotGraphMaxNodes

public void setDotGraphMaxNodes(java.lang.Integer dotGraphMaxNodes)

getMaxDotGraphDepth

public java.lang.Integer getMaxDotGraphDepth()

setMaxDotGraphDepth

public void setMaxDotGraphDepth(java.lang.Integer maxDotGraphDepth)

isDotTransparent

public boolean isDotTransparent()

setDotTransparent

public void setDotTransparent(boolean dotTransparent)

isDotMultiTargets

public boolean isDotMultiTargets()

setDotMultiTargets

public void setDotMultiTargets(boolean dotMultiTargets)

isGenerateLegend

public boolean isGenerateLegend()

setGenerateLegend

public void setGenerateLegend(boolean generateLegend)

isDotCleanup

public boolean isDotCleanup()

setDotCleanup

public void setDotCleanup(boolean dotCleanup)

isSearchengine

public boolean isSearchengine()

setSearchengine

public void setSearchengine(boolean searchengine)