# This file provides additionnal properties to the items of a doxyfile.
#
# eclox

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

DOXYFILE_ENCODING.text = Doxyfile Encoding
DOXYFILE_ENCODING.group = Project
DOXYFILE_ENCODING.type = text
DOXYFILE_ENCODING.note = <p>This tag specifies the encoding used for all characters in the config file that follow.</p><p>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.</p>

PROJECT_NAME.text = Project Name
PROJECT_NAME.group = Project
PROJECT_NAME.type = text
PROJECT_NAME.note = The PROJECT_NAME tag is a single word (or a sequence of words surrounded by quotes) that should identify the project.

PROJECT_NUMBER.text = Project Number
PROJECT_NUMBER.group = Project
PROJECT_NUMBER.type = text
PROJECT_NUMBER.note = 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.

OUTPUT_DIRECTORY.text = Output Directory
OUTPUT_DIRECTORY.group = Project
OUTPUT_DIRECTORY.type = directory
OUTPUT_DIRECTORY.note = <p>The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) base path where the generated documentation will be put.</p><p>If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used.</p>

CREATE_SUBDIRS.text = Create Subdirectories
CREATE_SUBDIRS.group = Project
CREATE_SUBDIRS.type = boolean
CREATE_SUBDIRS.note = <p>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.</p><p>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.</p>

OUTPUT_LANGUAGE.text = Output Language
OUTPUT_LANGUAGE.group = Project
OUTPUT_LANGUAGE.type = text
OUTPUT_LANGUAGE.note = <p>The OUTPUT_LANGUAGE tag is used to specify the language in which all documentation generated by doxygen is written.</p><p>Doxygen will use this information to generate all constant output in the proper language. The default language is English, other supported languages are: Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.</p>

USE_WINDOWS_ENCODING.text = Use Windows Encoding
USE_WINDOWS_ENCODING.group = Project
USE_WINDOWS_ENCODING.type = boolean
USE_WINDOWS_ENCODING.note = <p>This tag can be used to specify the encoding used in the generated output.</p><p>The encoding is not always determined by the language that is chosen, but also whether or not the output is meant for Windows or non-Windows users. In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES forces the Windows encoding (this is the default for the Windows binary), whereas setting the tag to NO uses a Unix-style encoding (the default for all platforms other than Windows).</p>

BRIEF_MEMBER_DESC.text = Brief Member Description
BRIEF_MEMBER_DESC.group = Project
BRIEF_MEMBER_DESC.type = boolean
BRIEF_MEMBER_DESC.note = 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.

REPEAT_BRIEF.text = Repeat Brief Description
REPEAT_BRIEF.group = Project
REPEAT_BRIEF.type = boolean
REPEAT_BRIEF.note = <p>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.</p><p>Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be completely suppressed.</p>

ABBREVIATE_BRIEF.text = Abbreviate Brief Description
ABBREVIATE_BRIEF.group = Project
ABBREVIATE_BRIEF.note = <p>This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings.</p><p>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.</p><p>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"</p>

ALWAYS_DETAILED_SEC.text = Always Detailed Section
ALWAYS_DETAILED_SEC.group = Project
ALWAYS_DETAILED_SEC.type = boolean
ALWAYS_DETAILED_SEC.note = 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.

INLINE_INHERITED_MEMB.text = Inline Inherited Members
INLINE_INHERITED_MEMB.group = Project
INLINE_INHERITED_MEMB.type = boolean
INLINE_INHERITED_MEMB.note = <p>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.</p><p>Constructors, destructors and assignment operators of the base classes will not be shown.</p>

FULL_PATH_NAMES.text = Full Path Names
FULL_PATH_NAMES.group = Project
FULL_PATH_NAMES.type = boolean
FULL_PATH_NAMES.note = 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.

STRIP_FROM_PATH.text = Strip From Path
STRIP_FROM_PATH.group = Project
STRIP_FROM_PATH.note = <p>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.</p><p>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.</p>

STRIP_FROM_INC_PATH.text = Strip From Include Path
STRIP_FROM_INC_PATH.group = Project
STRIP_FROM_INC_PATH.note = <p>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.</p><p>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.</p>

SHORT_NAMES.text = Short Names
SHORT_NAMES.group = Project
SHORT_NAMES.type = boolean
SHORT_NAMES.note = 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.

JAVADOC_AUTOBRIEF.text = JavaDoc Autobrief
JAVADOC_AUTOBRIEF.group = Project
JAVADOC_AUTOBRIEF.type = boolean
JAVADOC_AUTOBRIEF.note = 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 the Qt-style comments (thus requiring an explicit @brief command for a brief description.

QT_AUTOBRIEF.text = QT Autobrief
QT_AUTOBRIEF.group = Project
QT_AUTOBRIEF.type = boolean
QT_AUTOBRIEF.note = 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.)

MULTILINE_CPP_IS_BRIEF.text = Multiline C++ is Brief
MULTILINE_CPP_IS_BRIEF.group = Project
MULTILINE_CPP_IS_BRIEF.type = boolean
MULTILINE_CPP_IS_BRIEF.note = <p>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.</p><p>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.</p>

DETAILS_AT_TOP.text = Details at Top
DETAILS_AT_TOP.group = Project
DETAILS_AT_TOP.type = boolean
DETAILS_AT_TOP.note = If the DETAILS_AT_TOP tag is set to YES then Doxygen will output the detailed description near the top, like JavaDoc.If set to NO, the detailed description appears after the member documentation.

INHERIT_DOCS.text = Inherit Documentations
INHERIT_DOCS.group = Project
INHERIT_DOCS.type = boolean
INHERIT_DOCS.note = 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.

DISTRIBUTE_GROUP_DOC.text = Distribute Group Documentation
DISTRIBUTE_GROUP_DOC.group = Project
DISTRIBUTE_GROUP_DOC.type = boolean
DISTRIBUTE_GROUP_DOC.note = 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.

SEPARATE_MEMBER_PAGES.text = Separate Member Pages
SEPARATE_MEMBER_PAGES.group = Project
SEPARATE_MEMBER_PAGES.type = boolean
SEPARATE_MEMBER_PAGES.note = 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.

TAB_SIZE.text = Tabulation Size
TAB_SIZE.group = Project
TAB_SIZE.note = 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.text = Aliases
ALIASES.group = Project
ALIASES.type = text list
ALIASES.note = <p>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".</p><p>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.</p>

OPTIMIZE_OUTPUT_FOR_C.text = Optimize Ouput for C
OPTIMIZE_OUTPUT_FOR_C.group = Project
OPTIMIZE_OUTPUT_FOR_C.type = boolean
OPTIMIZE_OUTPUT_FOR_C.note = <p>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.</p><p>For instance, some of the names that are used will be different. The list of all members will be omitted, etc.</p>

OPTIMIZE_OUTPUT_JAVA.text = Optimize Output Java
OPTIMIZE_OUTPUT_JAVA.group = Project
OPTIMIZE_OUTPUT_JAVA.type = boolean
OPTIMIZE_OUTPUT_JAVA.note = <p>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.</p><p>For instance, namespaces will be presented as packages, qualified scopes will look different, etc.</p>

BUILTIN_STL_SUPPORT.text = Built-in STL Support
BUILTIN_STL_SUPPORT.group = Project
BUILTIN_STL_SUPPORT.type = boolean
BUILTIN_STL_SUPPORT.note = <p>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) {}).</p><p>This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate.</p>

CPP_CLI_SUPPORT.text = C++/CLI Support
CPP_CLI_SUPPORT.group = Project
CPP_CLI_SUPPORT.type = boolean
CPP_CLI_SUPPORT.note = If you use Microsoft's C++/CLI language, you should set this option to YES to enable parsing support.

DISTRIBUTE_GROUP_DOC.text = Distribute Group Documentation
DISTRIBUTE_GROUP_DOC.group = Project
DISTRIBUTE_GROUP_DOC.type = boolean
DISTRIBUTE_GROUP_DOC.note = <p>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.</p><p>By default all members of a group must be documented explicitly.</p>

SUBGROUPING.text = Subgrouping
SUBGROUPING.group = Project
SUBGROUPING.type = boolean
SUBGROUPING.note = <p>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.</p><p>Alternatively, this can be done per class using the @nosubgrouping command.</p>

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

EXTRACT_ALL.text = Extract All
EXTRACT_ALL.group = Build
EXTRACT_ALL.type = boolean
EXTRACT_ALL.note = <p>If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in documentation are documented, even if no documentation was available.</p><p>Private class members and static file members will be hidden unless the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES.</p>

EXTRACT_PRIVATE.text = Extract Private
EXTRACT_PRIVATE.group = Build
EXTRACT_PRIVATE.type = boolean
EXTRACT_PRIVATE.note = If the EXTRACT_PRIVATE tag is set to YES all private members of a class will be included in the documentation.

EXTRACT_STATIC.text = Extract Static
EXTRACT_STATIC.group = Build
EXTRACT_STATIC.type = boolean
EXTRACT_STATIC.note = If the EXTRACT_STATIC tag is set to YES all static members of a file will be included in the documentation.

EXTRACT_LOCAL_CLASSES.text = Extract Local Classes
EXTRACT_LOCAL_CLASSES.group = Build
EXTRACT_LOCAL_CLASSES.type = boolean
EXTRACT_LOCAL_CLASSES.note = 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.

EXTRACT_LOCAL_METHODS.text = Extract Local Methods
EXTRACT_LOCAL_METHODS.group = Build
EXTRACT_LOCAL_METHODS.type = boolean
EXTRACT_LOCAL_METHODS.note = 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.

EXTRACT_ANON_NSPACES.text = Extract Anonymous Namespaces
EXTRACT_ANON_NSPACES.group = Build
EXTRACT_ANON_NSPACES.type = boolean
EXTRACT_ANON_NSPACES.note = <p>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.</p><p>By default anonymous namespace are hidden.</p>

HIDE_UNDOC_MEMBERS.text = Hide Undocumented Members
HIDE_UNDOC_MEMBERS.group = Build
HIDE_UNDOC_MEMBERS.type = boolean
HIDE_UNDOC_MEMBERS.note = <p>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.</p><p>This option has no effect if EXTRACT_ALL is enabled.</p>

HIDE_UNDOC_CLASSES.text = Hide Undocumented Classes
HIDE_UNDOC_CLASSES.group = Build
HIDE_UNDOC_CLASSES.type = boolean
HIDE_UNDOC_CLASSES.note = <p>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.</p><p>This option has no effect if EXTRACT_ALL is enabled.</p>

HIDE_FRIEND_COMPOUNDS.text = Hide Friend Compounds
HIDE_FRIEND_COMPOUNDS.group = Build
HIDE_FRIEND_COMPOUNDS.type = boolean
HIDE_FRIEND_COMPOUNDS.note = 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.

HIDE_IN_BODY_DOCS.text = Hide in Body Documentations
HIDE_IN_BODY_DOCS.group = Build
HIDE_IN_BODY_DOCS.type = boolean
HIDE_IN_BODY_DOCS.note = 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.

INTERNAL_DOCS.text = Internal Documentations
INTERNAL_DOCS.group = Build
INTERNAL_DOCS.type = boolean
INTERNAL_DOCS.note = 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.

CASE_SENSE_NAMES.text = Case Sense Names
CASE_SENSE_NAMES.group = Build
CASE_SENSE_NAMES.type = boolean
CASE_SENSE_NAMES.note = <p>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.</p><p>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.</p>

HIDE_SCOPE_NAMES.text = Hide Scope Names
HIDE_SCOPE_NAMES.group = Build
HIDE_SCOPE_NAMES.type = boolean
HIDE_SCOPE_NAMES.note = 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.

SHOW_INCLUDE_FILES.text = Show Include Files
SHOW_INCLUDE_FILES.group = Build
SHOW_INCLUDE_FILES.type = boolean
SHOW_INCLUDE_FILES.note = 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.

INLINE_INFO.text = Inline Info
INLINE_INFO.group = Build
INLINE_INFO.type = boolean
INLINE_INFO.note = If the INLINE_INFO tag is set to YES (the default) then a tag [inline] is inserted in the documentation for inline members.

SORT_MEMBER_DOCS.text = Sort Member Documentations
SORT_MEMBER_DOCS.group = Build
SORT_MEMBER_DOCS.type = boolean
SORT_MEMBER_DOCS.note = 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.

SORT_BRIEF_DOCS.text = Sort Brief Documentations
SORT_BRIEF_DOCS.group = Build
SORT_BRIEF_DOCS.type = boolean
SORT_BRIEF_DOCS.note = 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.

SORT_BY_SCOPE_NAME.text = Sort by Scope Name
SORT_BY_SCOPE_NAME.group = Build
SORT_BY_SCOPE_NAME.type = boolean
SORT_BY_SCOPE_NAME.note = <p>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.</p><p>Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.</p><p>Note: This option applies only to the class list, not to the alphabetical list.</p>

GENERATE_TODOLIST.text = Generate Todo List
GENERATE_TODOLIST.group = Build
GENERATE_TODOLIST.type = boolean
GENERATE_TODOLIST.note = 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.

GENERATE_TESTLIST.text = Generate Test List
GENERATE_TESTLIST.group = Build
GENERATE_TESTLIST.type = boolean
GENERATE_TESTLIST.note = 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.

GENERATE_BUGLIST.text = Generate Bug List
GENERATE_BUGLIST.group = Build
GENERATE_BUGLIST.type = boolean
GENERATE_BUGLIST.note = 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.

GENERATE_DEPRECATEDLIST.text = Generate Deprecated List
GENERATE_DEPRECATEDLIST.group = Build
GENERATE_DEPRECATEDLIST.type = boolean
GENERATE_DEPRECATEDLIST.note = 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.

ENABLED_SECTIONS.text = Enabled Sections
ENABLED_SECTIONS.group = Build
ENABLED_SECTIONS.type = text list
ENABLED_SECTIONS.note = The ENABLED_SECTIONS tag can be used to enable conditional documentation sections, marked by @if sectionname ... @endif.

MAX_INITIALIZER_LINES.text = Maximum Initializer Lines
MAX_INITIALIZER_LINES.group = Build
MAX_INITIALIZER_LINES.note = <p>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.</p><p>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.</p>

SHOW_USED_FILES.text = Show Used Files
SHOW_USED_FILES.group = Build
SHOW_USED_FILES.type = boolean
SHOW_USED_FILES.note = 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.

SHOW_DIRECTORIES.text = Show Directories
SHOW_DIRECTORIES.group = Build
SHOW_DIRECTORIES.type = boolean
SHOW_DIRECTORIES.note = 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.

FILE_VERSION_FILTER.text = File Version Filter
FILE_VERSION_FILTER.group = Build
FILE_VERSION_FILTER.type = file
FILE_VERSION_FILTER.note = <p>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).</p><p>Doxygen will invoke the program by executing (via popen()) the command &lt;command&gt; &lt;input-file&gt;, where &lt;command&gt; is the value of the FILE_VERSION_FILTER tag, and &lt;input-file&gt; 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.</p>

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

QUIET.text = Quiet
QUIET.group = Messages
QUIET.type = boolean
QUIET.note = 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.text = Warnings
WARNINGS.group = Messages
WARNINGS.type = boolean
WARNINGS.note = 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.

WARN_IF_UNDOCUMENTED.text = Warn if Undocumented
WARN_IF_UNDOCUMENTED.group = Messages
WARN_IF_UNDOCUMENTED.type = boolean
WARN_IF_UNDOCUMENTED.note = 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.

WARN_IF_DOC_ERROR.text = Warn if Documentation Error
WARN_IF_DOC_ERROR.group = Messages
WARN_IF_DOC_ERROR.type = boolean
WARN_IF_DOC_ERROR.note = 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.

WARN_NO_PARAMDOC.text = Warn for undocumented function parameters
WARN_NO_PARAMDOC.group = Messages
WARN_NO_PARAMDOC.type = boolean
WARN_NO_PARAMDOC.note = 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.

WARN_FORMAT.text = Warn Format
WARN_FORMAT.group = Messages
WARN_FORMAT.type = text
WARN_FORMAT.note = 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.

WARN_LOGFILE.text = Warn Logfile
WARN_LOGFILE.group = Messages
WARN_LOGFILE.type = file
WARN_LOGFILE.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

INPUT.text = Input
INPUT.group = Inputs
INPUT.type = path list
INPUT.note = 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.

INPUT_ENCODING.text = Input Encoding
INPUT_ENCODING.group = Inputs
INPUT_ENCODING.type = text
INPUT_ENCODING.note = <p>This tag can be used to specify the character encoding of the source files that doxygen parses.</p><p>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.</p>

FILE_PATTERNS.text = File Patterns
FILE_PATTERNS.group = Inputs
FILE_PATTERNS.type = text list
FILE_PATTERNS.note = <p>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.</p><p>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</p>

RECURSIVE.text = Recursive
RECURSIVE.group = Inputs
RECURSIVE.type = boolean
RECURSIVE.note = 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.text = Exclude
EXCLUDE.group = Inputs
EXCLUDE.type = path list
EXCLUDE.note = 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.

EXCLUDE_SYMLINKS.text = Exclude Symlinks
EXCLUDE_SYMLINKS.group = Inputs
EXCLUDE_SYMLINKS.type = boolean
EXCLUDE_SYMLINKS.note = 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.

EXCLUDE_SYMBOLS.text = Exclude Symbols
EXCLUDE_SYMBOLS.group = Inputs
EXCLUDE_SYMBOLS.type = text list
EXCLUDE_SYMBOLS.note = <p>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.</p><p>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</p>

EXCLUDE_PATTERNS.text = Exclude Patterns
EXCLUDE_PATTERNS.group = Inputs
EXCLUDE_PATTERNS.type = text list
EXCLUDE_PATTERNS.note = 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.

EXAMPLE_PATH.text = Example Path
EXAMPLE_PATH.group = Inputs
EXAMPLE_PATH.type = path list
EXAMPLE_PATH.note = 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).

EXAMPLE_PATTERNS.text = Example Patterns
EXAMPLE_PATTERNS.group = Inputs
EXAMPLE_PATTERNS.type = text list
EXAMPLE_PATTERNS.note = 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.

EXAMPLE_RECURSIVE.text = Example Recursive
EXAMPLE_RECURSIVE.group = Inputs
EXAMPLE_RECURSIVE.type = boolean
EXAMPLE_RECURSIVE.note = 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.

IMAGE_PATH.text = Image Path
IMAGE_PATH.group = Inputs
IMAGE_PATH.type = path list
IMAGE_PATH.note = 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).

INPUT_FILTER.text = Input Filter
INPUT_FILTER.group = Inputs
INPUT_FILTER.type = file
INPUT_FILTER.note = <p>The INPUT_FILTER tag can be used to specify a program that doxygen should invoke to filter for each input file.</p><p>Doxygen will invoke the filter program by executing (via popen()) the command &lt;filter&gt; &lt;input-file&gt;, where &lt;filter&gt; is the value of the INPUT_FILTER tag, and &lt;input-file&gt; is the name of an input file. Doxygen will then use the output that the filter program writes to standard output.</p><p>If FILTER_PATTERNS is specified, this tag will be ignored.</p>

FILTER_PATTERNS.text = Filter Patterns
FILTER_PATTERNS.group = Inputs
FILTER_PATTERNS.type = text list
FILTER_PATTERNS.note = <p>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.</p><p>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.</p><p>If FILTER_PATTERNS is empty, INPUT_FILTER is applied to all files.</p>

FILTER_SOURCE_FILES.text = Filter Source Files
FILTER_SOURCE_FILES.group = Inputs
FILTER_SOURCE_FILES.type = boolean
FILTER_SOURCE_FILES.note = 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).

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

SOURCE_BROWSER.text = Source Browser
SOURCE_BROWSER.group = Source Browsing
SOURCE_BROWSER.type = boolean
SOURCE_BROWSER.note = <p>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.</p><p>Note: To get rid of all source code in the generated output, make sure also VERBATIM_HEADERS is set to NO.</p>

INLINE_SOURCES.text = Inline Sources
INLINE_SOURCES.group = Source Browsing
INLINE_SOURCES.type = boolean
INLINE_SOURCES.note = Setting the INLINE_SOURCES tag to YES will include the body of functions and classes directly in the documentation.

STRIP_CODE_COMMENTS.text = Strip Code Comments
STRIP_CODE_COMMENTS.group = Source Browsing
STRIP_CODE_COMMENTS.type = boolean
STRIP_CODE_COMMENTS.note = 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.

REFERENCED_BY_RELATION.text = Referenced by Relation
REFERENCED_BY_RELATION.group = Source Browsing
REFERENCED_BY_RELATION.type = boolean
REFERENCED_BY_RELATION.note = If the REFERENCED_BY_RELATION tag is set to YES (the default) then for each documented function all documented functions referencing it will be listed.

REFERENCES_RELATION.text = References Relation
REFERENCES_RELATION.group = Source Browsing
REFERENCES_RELATION.type = boolean
REFERENCES_RELATION.note = If the REFERENCES_RELATION tag is set to YES (the default) then for each documented function all documented entities called/used by that function will be listed.

REFERENCES_LINK_SOURCE.text = Reference Link Source
REFERENCES_LINK_SOURCE.group = Source Browsing
REFERENCES_LINK_SOURCE.type = boolean
REFERENCES_LINK_SOURCE.note = 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.

USE_HTAGS.text = Use htags
USE_HTAGS.group = Source Browsing
USE_HTAGS.type = boolean
USE_HTAGS.note = <p>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.</p><p>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.</p>

VERBATIM_HEADERS.text = Verbatim Headers
VERBATIM_HEADERS.group = Source Browsing
VERBATIM_HEADERS.type = boolean
VERBATIM_HEADERS.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

ALPHABETICAL_INDEX.text = Alphabetical Index
ALPHABETICAL_INDEX.group = Alphabetical Class Index
ALPHABETICAL_INDEX.type = boolean
ALPHABETICAL_INDEX.note = 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.

COLS_IN_ALPHA_INDEX.text = Columns in Alphabetical Index
COLS_IN_ALPHA_INDEX.group = Alphabetical Class Index
COLS_IN_ALPHA_INDEX.note = 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])

IGNORE_PREFIX.text = Ignore Prefix
IGNORE_PREFIX.group = Alphabetical Class Index
IGNORE_PREFIX.type = text list
IGNORE_PREFIX.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

GENERATE_HTML.text = Generate HTML
GENERATE_HTML.group = HTML Output
GENERATE_HTML.type = boolean
GENERATE_HTML.note = If the GENERATE_HTML tag is set to YES (the default) Doxygen will generate HTML output.

HTML_OUTPUT.text = HTML Output
HTML_OUTPUT.group = HTML Output
HTML_OUTPUT.type = directory
HTML_OUTPUT.note = 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.

HTML_FILE_EXTENSION.text = HTML File Extension
HTML_FILE_EXTENSION.group = HTML Output
HTML_FILE_EXTENSION.note = 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.

HTML_HEADER.text = HTML Header
HTML_HEADER.group = HTML Output
HTML_HEADER.type = file
HTML_HEADER.note = 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.

HTML_FOOTER.text = HTML Footer
HTML_FOOTER.group = HTML Output
HTML_FOOTER.type = file
HTML_FOOTER.note = 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.

HTML_STYLESHEET.text = HTML Stylesheet
HTML_STYLESHEET.group = HTML Output
HTML_STYLESHEET.type = file
HTML_STYLESHEET.note = <p>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.</p><p>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!</p>

HTML_ALIGN_MEMBERS.text = HTML Align Members
HTML_ALIGN_MEMBERS.group = HTML Output
HTML_ALIGN_MEMBERS.type = boolean
HTML_ALIGN_MEMBERS.note = 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.

GENERATE_HTMLHELP.text = Generate HTML Help
GENERATE_HTMLHELP.group = HTML Output
GENERATE_HTMLHELP.type = boolean
GENERATE_HTMLHELP.note = 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 compressed HTML help file (.chm) of the generated HTML documentation.

HTML_DYNAMIC_SECTIONS.text = HTML Dynamic Sections
HTML_DYNAMIC_SECTIONS.group = HTML Output
HTML_DYNAMIC_SECTIONS.type = boolean
HTML_DYNAMIC_SECTIONS.note = <p>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.</p><p>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).</p>

CHM_FILE.text = CHM File
CHM_FILE.group = HTML Output
CHM_FILE.type = file
CHM_FILE.note = 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.

HHC_LOCATION.text = HHC Location
HHC_LOCATION.group = HTML Output
HHC_LOCATION.type = file
HHC_LOCATION.note = 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.

GENERATE_CHI.text = Generate CHI
GENERATE_CHI.group = HTML Output
GENERATE_CHI.type = boolean
GENERATE_CHI.note = 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).

BINARY_TOC.text = Binary TOC
BINARY_TOC.group = HTML Output
BINARY_TOC.type = boolean
BINARY_TOC.note = 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.

TOC_EXPAND.text = TOC Expand
TOC_EXPAND.group = HTML Output
TOC_EXPAND.type = boolean
TOC_EXPAND.note = 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.

DISABLE_INDEX.text = Disable Index
DISABLE_INDEX.group = HTML Output
DISABLE_INDEX.type = boolean
DISABLE_INDEX.note = 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.

ENUM_VALUES_PER_LINE.text = Enum Values per Line
ENUM_VALUES_PER_LINE.group = HTML Output
ENUM_VALUES_PER_LINE.note = 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.

GENERATE_TREEVIEW.text = Generate Tree View
GENERATE_TREEVIEW.group = HTML Output
GENERATE_TREEVIEW.type = boolean
GENERATE_TREEVIEW.note = <p>If the GENERATE_TREEVIEW tag is set to YES, a side panel will begenerated containing a tree-like index structure (just like the one that is generated for HTML Help).</p><p>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.</p>

TREEVIEW_WIDTH.text = Tree View Width
TREEVIEW_WIDTH.group = HTML Output
TREEVIEW_WIDTH.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

GENERATE_LATEX.text = Generate LaTeX
GENERATE_LATEX.group = LaTeX output
GENERATE_LATEX.type = boolean
GENERATE_LATEX.note = If the GENERATE_LATEX tag is set to YES (the default) Doxygen will generate Latex output.

LATEX_OUTPUT.text = LaTeX Output
LATEX_OUTPUT.group = LaTeX output
LATEX_OUTPUT.type = directory
LATEX_OUTPUT.note = 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.

LATEX_CMD_NAME.text = LaTeX Command Name
LATEX_CMD_NAME.group = LaTeX output
LATEX_CMD_NAME.note = 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.

MAKEINDEX_CMD_NAME.text = makeindex Command Name
MAKEINDEX_CMD_NAME.group = LaTeX output
MAKEINDEX_CMD_NAME.note = 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.

COMPACT_LATEX.text = Compact LaTeX
COMPACT_LATEX.group = LaTeX output
COMPACT_LATEX.type = boolean
COMPACT_LATEX.note = 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.

PAPER_TYPE.text = Paper Type
PAPER_TYPE.group = LaTeX output
PAPER_TYPE.note = 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.

EXTRA_PACKAGES.text = Extra Packages
EXTRA_PACKAGES.group = LaTeX output
EXTRA_PACKAGES.note = The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX packages that should be included in the LaTeX output.

LATEX_HEADER.text = LaTeX Header
LATEX_HEADER.group = LaTeX output
LATEX_HEADER.type = file
LATEX_HEADER.note = 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!

PDF_HYPERLINKS.text = PDF Hyperlinks
PDF_HYPERLINKS.group = LaTeX output
PDF_HYPERLINKS.type = boolean
PDF_HYPERLINKS.note = 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.

USE_PDFLATEX.text = Use pdflatex
USE_PDFLATEX.group = LaTeX output
USE_PDFLATEX.type = boolean
USE_PDFLATEX.note = 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.

LATEX_BATCHMODE.text = LaTeX Batch Mode
LATEX_BATCHMODE.group = LaTeX output
LATEX_BATCHMODE.type = boolean
LATEX_BATCHMODE.note = 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.

LATEX_HIDE_INDICES.text = LaTeX Hide Indices
LATEX_HIDE_INDICES.group = LaTeX output
LATEX_HIDE_INDICES.type = boolean
LATEX_HIDE_INDICES.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

GENERATE_RTF.text = Generate RTF
GENERATE_RTF.group = RTF Output
GENERATE_RTF.type = boolean
GENERATE_RTF.note = 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.

RTF_OUTPUT.text = RTF Output
RTF_OUTPUT.group = RTF Output
RTF_OUTPUT.type = directory
RTF_OUTPUT.note = 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.

COMPACT_RTF.text = Compact RTF
COMPACT_RTF.group = RTF Output
COMPACT_RTF.type = boolean
COMPACT_RTF.note = 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.

RTF_HYPERLINKS.text = RTF Hyperlinks
RTF_HYPERLINKS.group = RTF Output
RTF_HYPERLINKS.type = boolean
RTF_HYPERLINKS.note = <p>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.</p><p>Note: wordpad (write) and others do not support links.</p>

RTF_STYLESHEET_FILE.text = RTF Stylesheet File
RTF_STYLESHEET_FILE.group = RTF Output
RTF_STYLESHEET_FILE.note = 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.

RTF_EXTENSIONS_FILE.text = RTF Extensions File
RTF_EXTENSIONS_FILE.group = RTF Output
RTF_EXTENSIONS_FILE.note = Set optional variables used in the generation of an rtf document. Syntax is similar to doxygen's config file.

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

GENERATE_MAN.text = Generate man
GENERATE_MAN.group = man Output
GENERATE_MAN.type = boolean
GENERATE_MAN.note = If the GENERATE_MAN tag is set to YES (the default) Doxygen will generate man pages.

MAN_OUTPUT.text = man Output
MAN_OUTPUT.group = man Output
MAN_OUTPUT.type = directory
MAN_OUTPUT.note = 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.

MAN_EXTENSION.text = man Extension
MAN_EXTENSION.group = man Output
MAN_EXTENSION.note = The MAN_EXTENSION tag determines the extension that is added to the generated man pages (default is the subroutine's section .3)

MAN_LINKS.text = man Links
MAN_LINKS.group = man Output
MAN_LINKS.type = boolean
MAN_LINKS.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------

GENERATE_XML.text = Generate XML
GENERATE_XML.group = XML Output
GENERATE_XML.type = boolean
GENERATE_XML.note = 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.

XML_OUTPUT.text = XML Output
XML_OUTPUT.group = XML Output
XML_OUTPUT.type = directory
XML_OUTPUT.note = 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.

XML_SCHEMA.text = XML Schema
XML_SCHEMA.group = XML Output
XML_SCHEMA.type = file
XML_SCHEMA.note = 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.

XML_DTD.text = XML DTD
XML_DTD.group = XML Output
XML_DTD.type = file
XML_DTD.note = 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.

XML_PROGRAMLISTING.text = XML Program Listing
XML_PROGRAMLISTING.group = XML Output
XML_PROGRAMLISTING.type = boolean
XML_PROGRAMLISTING.note = 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.

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF.text = Generate Autogen Definition
GENERATE_AUTOGEN_DEF.type = boolean
GENERATE_AUTOGEN_DEF.note = 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.

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

GENERATE_PERLMOD.text = Generate Perl Module
GENERATE_PERLMOD.group = Perl Module Output
GENERATE_PERLMOD.type = boolean
GENERATE_PERLMOD.note = 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.

PERLMOD_LATEX.text = Perl Module LaTeX
PERLMOD_LATEX.group = Perl Module Output
PERLMOD_LATEX.type = boolean
PERLMOD_LATEX.note = 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.

PERLMOD_PRETTY.text = Perl Module Pretty
PERLMOD_PRETTY.group = Perl Module Output
PERLMOD_PRETTY.type = boolean
PERLMOD_PRETTY.note = 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.

PERLMOD_MAKEVAR_PREFIX.text = Perl Module MakeVar Prefix
PERLMOD_MAKEVAR_PREFIX.group = Perl Module Output
PERLMOD_MAKEVAR_PREFIX.note = 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.

#---------------------------------------------------------------------------
# Configuration options related to the preprocessor   
#---------------------------------------------------------------------------

ENABLE_PREPROCESSING.text = Enable Preprocessing
ENABLE_PREPROCESSING.group = Preprocessing
ENABLE_PREPROCESSING.type = boolean
ENABLE_PREPROCESSING.note = 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.

MACRO_EXPANSION.text = Macro Expansion
MACRO_EXPANSION.group = Preprocessing
MACRO_EXPANSION.type = boolean
MACRO_EXPANSION.note = 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.

EXPAND_ONLY_PREDEF.text = Expand Only Predefined
EXPAND_ONLY_PREDEF.group = Preprocessing
EXPAND_ONLY_PREDEF.type = boolean
EXPAND_ONLY_PREDEF.note = 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.

SEARCH_INCLUDES.text = Search Includes
SEARCH_INCLUDES.group = Preprocessing
SEARCH_INCLUDES.type = boolean
SEARCH_INCLUDES.note = 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.

INCLUDE_PATH.text = Include Path
INCLUDE_PATH.group = Preprocessing
INCLUDE_PATH.type = directory list
INCLUDE_PATH.note = 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.

INCLUDE_FILE_PATTERNS.text = Include File Patterns
INCLUDE_FILE_PATTERNS.group = Preprocessing
INCLUDE_FILE_PATTERNS.type = text list
INCLUDE_FILE_PATTERNS.note = 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.text = Predefined
PREDEFINED.group = Preprocessing
PREDEFINED.type = text list
PREDEFINED.note = <p>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).</p><p>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.</p>

EXPAND_AS_DEFINED.text = Expand as Defined
EXPAND_AS_DEFINED.group = Preprocessing
EXPAND_AS_DEFINED.type = text list
EXPAND_AS_DEFINED.note = 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.

SKIP_FUNCTION_MACROS.text = Skip Function Macros
SKIP_FUNCTION_MACROS.group = Preprocessing
SKIP_FUNCTION_MACROS.type = boolean
SKIP_FUNCTION_MACROS.note = 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.

#---------------------------------------------------------------------------
# Configuration::additions related to external references   
#---------------------------------------------------------------------------

TAGFILES.text = Tag Files
TAGFILES.group = External References
TAGFILES.type = text list
TAGFILES.note = <p>The TAGFILES option can be used to specify one or more tagfiles.</p><p>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: <br/>TAGFILES = file1 file2 ...</p><p>Adding location for the tag files is done as follows: <br/>TAGFILES = file1=loc1 "file2 = loc2" ... <br/>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.</p><p>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.</p>

GENERATE_TAGFILE.text = Generate Tag Files
GENERATE_TAGFILE.group = External References
GENERATE_TAGFILE.type = file
GENERATE_TAGFILE.note = 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.text = All Externals
ALLEXTERNALS.group = External References
ALLEXTERNALS.type = boolean
ALLEXTERNALS.note = 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.

EXTERNAL_GROUPS.text = External Groups
EXTERNAL_GROUPS.group = External References
EXTERNAL_GROUPS.type = boolean
EXTERNAL_GROUPS.note = 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.

PERL_PATH.text = Perl Path
PERL_PATH.group = External References
PERL_PATH.type = file
PERL_PATH.note = The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `which perl').

#---------------------------------------------------------------------------
# Configuration options related to the dot tool   
#---------------------------------------------------------------------------

CLASS_DIAGRAMS.text = Class Diagrams
CLASS_DIAGRAMS.group = dot Tool
CLASS_DIAGRAMS.type = boolean
CLASS_DIAGRAMS.note = <p>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.</p><p>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.</p>

MSCGEN_PATH.text = mscgen Path
MSCGEN_PATH.group = dot Tool
MSCGEN_PATH.type = directory
MSCGEN_PATH.note = <p>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.</p><p>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.</p>

HIDE_UNDOC_RELATIONS.text = Hide Undocumented Relations
HIDE_UNDOC_RELATIONS.group = dot Tool
HIDE_UNDOC_RELATIONS.type = boolean
HIDE_UNDOC_RELATIONS.note = 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.

HAVE_DOT.text = Have DOT
HAVE_DOT.group = dot Tool
HAVE_DOT.type = boolean
HAVE_DOT.note = 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&amp;T and Lucent Bell Labs. The other options in this section have no effect if this option is set to NO (the default)

CLASS_GRAPH.text = Class Graph
CLASS_GRAPH.group = dot Tool
CLASS_GRAPH.type = boolean
CLASS_GRAPH.note = 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.

COLLABORATION_GRAPH.text = Collaboration Graph
COLLABORATION_GRAPH.group = dot Tool
COLLABORATION_GRAPH.type = boolean
COLLABORATION_GRAPH.note = 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.

GROUP_GRAPHS.text = Groups Graphs
GROUP_GRAPHS.group = dot Tool
GROUP_GRAPHS.type = boolean
GROUP_GRAPHS.note = 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.

UML_LOOK.text = UML Look
UML_LOOK.group = dot Tool
UML_LOOK.type = boolean
UML_LOOK.note = 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.

TEMPLATE_RELATIONS.text = Template Relations
TEMPLATE_RELATIONS.group = dot Tool
TEMPLATE_RELATIONS.type = boolean
TEMPLATE_RELATIONS.note = If set to YES, the inheritance and collaboration graphs will show the relations between templates and their instances.

INCLUDE_GRAPH.text = Include Graph
INCLUDE_GRAPH.group = dot Tool
INCLUDE_GRAPH.type = boolean
INCLUDE_GRAPH.note = 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.

INCLUDED_BY_GRAPH.text = Included-by Graph
INCLUDED_BY_GRAPH.group = dot Tool
INCLUDED_BY_GRAPH.type = boolean
INCLUDED_BY_GRAPH.note = 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.

CALL_GRAPH.text = Call Graph
CALL_GRAPH.group = dot Tool
CALL_GRAPH.type = boolean
CALL_GRAPH.note = <p>If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a call dependency graph for every global function or class method.</p><p>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.</p>

CALLER_GRAPH.text = Caller Graph
CALLER_GRAPH.group = dot Tool
CALLER_GRAPH.type = boolean
CALLER_GRAPH.note = <p>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.</p><p>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.</p>

GRAPHICAL_HIERARCHY.text = Graphical Hierarchy
GRAPHICAL_HIERARCHY.group = dot Tool
GRAPHICAL_HIERARCHY.type = boolean
GRAPHICAL_HIERARCHY.note = 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.

DIRECTORY_GRAPH.text = Directory Graph
DIRECTORY_GRAPH.group = dot Tool
DIRECTORY_GRAPH.type = boolean
DIRECTORY_GRAPH.note = 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.

DOT_IMAGE_FORMAT.text = DOT Image Format
DOT_IMAGE_FORMAT.group = dot Tool
DOT_IMAGE_FORMAT.type = text
DOT_IMAGE_FORMAT.note = 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.

DOT_PATH.text = DOT Path
DOT_PATH.group = dot Tool
DOT_PATH.type = file
DOT_PATH.note = 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 on the path.

DOTFILE_DIRS.text = DOT Files Directories
DOTFILE_DIRS.group = dot Tool
DOTFILE_DIRS.type = directory list
DOTFILE_DIRS.note = 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).

MAX_DOT_GRAPH_WIDTH.text = Maximum DOT Graph Width
MAX_DOT_GRAPH_WIDTH.group = dot Tool
MAX_DOT_GRAPH_WIDTH.note = <p>The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width (in pixels) of the graphs generated by dot.</p><p>If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.</p>

MAX_DOT_GRAPH_HEIGHT.text = Maximum DOT Graph Height
MAX_DOT_GRAPH_HEIGHT.group = dot Tool
MAX_DOT_GRAPH_HEIGHT.note = <p>The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height (in pixels) of the graphs generated by dot.</p><p>If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.</p>

MAX_DOT_GRAPH_DEPTH.text = Maximum DOT Graph Depth
MAX_DOT_GRAPH_DEPTH.group = dot Tool
MAX_DOT_GRAPH_DEPTH.note = <p>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.</p><p>Note that setting this option to 1 or 2 may greatly reduce the computation time needed for large code bases.</p><p>Also note that a graph may be further truncated if the graph's image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), the graph is not depth-constrained.</p>

DOT_GRAPH_MAX_NODES.text = DOT Graph Max Nodes
DOT_GRAPH_MAX_NODES.group = dot Tool
DOT_GRAPH_MAX_NODES.type = text
DOT_GRAPH_MAX_NODES.note = <p>The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes that will be shown in the graph.</p><p>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 will always show the root nodes and its direct children regardless of this setting.</p>

DOT_TRANSPARENT.text = DOT Transparent
DOT_TRANSPARENT.group = dot Tool
DOT_TRANSPARENT.type = boolean
DOT_TRANSPARENT.note = <p>Set the DOT_TRANSPARENT tag to YES to generate images with a transparent background. This is disabled by default, which results in a white background.</p><p>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).</p>

DOT_MULTI_TARGETS.text = DOT Multi Targets
DOT_MULTI_TARGETS.group = dot Tool
DOT_MULTI_TARGETS.type = boolean
DOT_MULTI_TARGETS.note = <p>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).</p><p>This makes dot run faster, but since only newer versions of dot (&gt;1.8.10) support this, this feature is disabled by default.</p>

GENERATE_LEGEND.text = Generate Legend
GENERATE_LEGEND.group = dot Tool
GENERATE_LEGEND.type = boolean
GENERATE_LEGEND.note = 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.

DOT_CLEANUP.text = DOT Clean-up
DOT_CLEANUP.group = dot Tool
DOT_CLEANUP.type = boolean
DOT_CLEANUP.note = 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.

#---------------------------------------------------------------------------
# Configuration::additions related to the search engine   
#---------------------------------------------------------------------------

SEARCHENGINE.text = Search Engine
SEARCHENGINE.type = boolean
SEARCHENGINE.note = 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.
