Warning, /frameworks/syntax-highlighting/autotests/reference/Doxyfile.example.ref is written in an unsupported language. File is not indexed.
0001 <Comment># Doxyfile 1.8.11</Comment><br/> 0002 <Error></Error><br/> 0003 <Comment># This file describes the settings to be used by the documentation system</Comment><br/> 0004 <Comment># doxygen (www.doxygen.org) for a project.</Comment><br/> 0005 <Comment>#</Comment><br/> 0006 <Comment># All text after a double hash (##) is considered a comment and is placed in</Comment><br/> 0007 <Comment># front of the TAG it is preceding.</Comment><br/> 0008 <Comment>#</Comment><br/> 0009 <Comment># All text after a single hash (#) is considered a comment and will be ignored.</Comment><br/> 0010 <Comment># The format is:</Comment><br/> 0011 <Comment># TAG = value [value, ...]</Comment><br/> 0012 <Comment># For lists, items can also be appended using:</Comment><br/> 0013 <Comment># TAG += value [value, ...]</Comment><br/> 0014 <Comment># Values that contain spaces should be placed between quotes (\" \").</Comment><br/> 0015 <Error></Error><br/> 0016 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0017 <Comment># Project related configuration options</Comment><br/> 0018 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0019 <Error></Error><br/> 0020 <Comment># This tag specifies the encoding used for all characters in the config file</Comment><br/> 0021 <Comment># that follow. The default is UTF-8 which is also the encoding used for all text</Comment><br/> 0022 <Comment># before the first occurrence of this tag. Doxygen uses libiconv (or the iconv</Comment><br/> 0023 <Comment># built into libc) for the transcoding. See http://www.gnu.org/software/libiconv</Comment><br/> 0024 <Comment># for the list of possible encodings.</Comment><br/> 0025 <Comment># The default value is: UTF-8.</Comment><br/> 0026 <Error></Error><br/> 0027 <Keyword>DOXYFILE_ENCODING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> UTF-8</UntypedValue><br/> 0028 <Error></Error><br/> 0029 <Comment># The </Comment><KeywordInComment>PROJECT_NAME</KeywordInComment><Comment> tag is a single word (or a sequence of words surrounded by</Comment><br/> 0030 <Comment># double-quotes, unless you are using Doxywizard) that should identify the</Comment><br/> 0031 <Comment># project for which the documentation is generated. This name is used in the</Comment><br/> 0032 <Comment># title of most generated pages and in a few other places.</Comment><br/> 0033 <Comment># The default value is: My Project.</Comment><br/> 0034 <Error></Error><br/> 0035 <Keyword>PROJECT_NAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> "My Project"</UntypedValue><br/> 0036 <Error></Error><br/> 0037 <Comment># The </Comment><KeywordInComment>PROJECT_NUMBER</KeywordInComment><Comment> tag can be used to enter a project or revision number. This</Comment><br/> 0038 <Comment># could be handy for archiving the generated documentation or if some version</Comment><br/> 0039 <Comment># control system is used.</Comment><br/> 0040 <Error></Error><br/> 0041 <Keyword>PROJECT_NUMBER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0042 <Error></Error><br/> 0043 <Comment># Using the </Comment><KeywordInComment>PROJECT_BRIEF</KeywordInComment><Comment> tag one can provide an optional one line description</Comment><br/> 0044 <Comment># for a project that appears at the top of each page and should give viewer a</Comment><br/> 0045 <Comment># quick idea about the purpose of the project. Keep the description short.</Comment><br/> 0046 <Error></Error><br/> 0047 <Keyword>PROJECT_BRIEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0048 <Error></Error><br/> 0049 <Comment># With the </Comment><KeywordInComment>PROJECT_LOGO</KeywordInComment><Comment> tag one can specify a logo or an icon that is included</Comment><br/> 0050 <Comment># in the documentation. The maximum height of the logo should not exceed 55</Comment><br/> 0051 <Comment># pixels and the maximum width should not exceed 200 pixels. Doxygen will copy</Comment><br/> 0052 <Comment># the logo to the output directory.</Comment><br/> 0053 <Error></Error><br/> 0054 <Keyword>PROJECT_LOGO</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0055 <Error></Error><br/> 0056 <Comment># The </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> tag is used to specify the (relative or absolute) path</Comment><br/> 0057 <Comment># into which the generated documentation will be written. If a relative path is</Comment><br/> 0058 <Comment># entered, it will be relative to the location where doxygen was started. If</Comment><br/> 0059 <Comment># left blank the current directory will be used.</Comment><br/> 0060 <Error></Error><br/> 0061 <Keyword>OUTPUT_DIRECTORY</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0062 <Error></Error><br/> 0063 <Comment># If the </Comment><KeywordInComment>CREATE_SUBDIRS</KeywordInComment><Comment> tag is set to YES then doxygen will create 4096 sub-</Comment><br/> 0064 <Comment># directories (in 2 levels) under the output directory of each output format and</Comment><br/> 0065 <Comment># will distribute the generated files over these directories. Enabling this</Comment><br/> 0066 <Comment># option can be useful when feeding doxygen a huge amount of source files, where</Comment><br/> 0067 <Comment># putting all generated files in the same directory would otherwise causes</Comment><br/> 0068 <Comment># performance problems for the file system.</Comment><br/> 0069 <Comment># The default value is: NO.</Comment><br/> 0070 <Error></Error><br/> 0071 <Keyword>CREATE_SUBDIRS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0072 <Error></Error><br/> 0073 <Comment># If the </Comment><KeywordInComment>ALLOW_UNICODE_NAMES</KeywordInComment><Comment> tag is set to YES, doxygen will allow non-ASCII</Comment><br/> 0074 <Comment># characters to appear in the names of generated files. If set to NO, non-ASCII</Comment><br/> 0075 <Comment># characters will be escaped, for example _xE3_x81_x84 will be used for Unicode</Comment><br/> 0076 <Comment># U+3044.</Comment><br/> 0077 <Comment># The default value is: NO.</Comment><br/> 0078 <Error></Error><br/> 0079 <Keyword>ALLOW_UNICODE_NAMES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0080 <Error></Error><br/> 0081 <Comment># The </Comment><KeywordInComment>OUTPUT_LANGUAGE</KeywordInComment><Comment> tag is used to specify the language in which all</Comment><br/> 0082 <Comment># documentation generated by doxygen is written. Doxygen will use this</Comment><br/> 0083 <Comment># information to generate all constant output in the proper language.</Comment><br/> 0084 <Comment># Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,</Comment><br/> 0085 <Comment># Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),</Comment><br/> 0086 <Comment># Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,</Comment><br/> 0087 <Comment># Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),</Comment><br/> 0088 <Comment># Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,</Comment><br/> 0089 <Comment># Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,</Comment><br/> 0090 <Comment># Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,</Comment><br/> 0091 <Comment># Ukrainian and Vietnamese.</Comment><br/> 0092 <Comment># The default value is: English.</Comment><br/> 0093 <Error></Error><br/> 0094 <Keyword>OUTPUT_LANGUAGE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> English</UntypedValue><br/> 0095 <Error></Error><br/> 0096 <Comment># If the </Comment><KeywordInComment>BRIEF_MEMBER_DESC</KeywordInComment><Comment> tag is set to YES, doxygen will include brief member</Comment><br/> 0097 <Comment># descriptions after the members that are listed in the file and class</Comment><br/> 0098 <Comment># documentation (similar to Javadoc). Set to NO to disable this.</Comment><br/> 0099 <Comment># The default value is: YES.</Comment><br/> 0100 <Error></Error><br/> 0101 <Keyword>BRIEF_MEMBER_DESC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0102 <Error></Error><br/> 0103 <Comment># If the </Comment><KeywordInComment>REPEAT_BRIEF</KeywordInComment><Comment> tag is set to YES, doxygen will prepend the brief</Comment><br/> 0104 <Comment># description of a member or function before the detailed description</Comment><br/> 0105 <Comment>#</Comment><br/> 0106 <Comment># Note: If both </Comment><KeywordInComment>HIDE_UNDOC_MEMBERS</KeywordInComment><Comment> and </Comment><KeywordInComment>BRIEF_MEMBER_DESC</KeywordInComment><Comment> are set to NO, the</Comment><br/> 0107 <Comment># brief descriptions will be completely suppressed.</Comment><br/> 0108 <Comment># The default value is: YES.</Comment><br/> 0109 <Error></Error><br/> 0110 <Keyword>REPEAT_BRIEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0111 <Error></Error><br/> 0112 <Comment># This tag implements a quasi-intelligent brief description abbreviator that is</Comment><br/> 0113 <Comment># used to form the text in various listings. Each string in this list, if found</Comment><br/> 0114 <Comment># as the leading text of the brief description, will be stripped from the text</Comment><br/> 0115 <Comment># and the result, after processing the whole list, is used as the annotated</Comment><br/> 0116 <Comment># text. Otherwise, the brief description is used as-is. If left blank, the</Comment><br/> 0117 <Comment># following values are used ($name is automatically replaced with the name of</Comment><br/> 0118 <Comment># the entity):The $name class, The $name widget, The $name file, is, provides,</Comment><br/> 0119 <Comment># specifies, contains, represents, a, an and the.</Comment><br/> 0120 <Error></Error><br/> 0121 <Keyword>ABBREVIATE_BRIEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0122 <Error></Error><br/> 0123 <Comment># If the </Comment><KeywordInComment>ALWAYS_DETAILED_SEC</KeywordInComment><Comment> and </Comment><KeywordInComment>REPEAT_BRIEF</KeywordInComment><Comment> tags are both set to YES then</Comment><br/> 0124 <Comment># doxygen will generate a detailed section even if there is only a brief</Comment><br/> 0125 <Comment># description.</Comment><br/> 0126 <Comment># The default value is: NO.</Comment><br/> 0127 <Error></Error><br/> 0128 <Keyword>ALWAYS_DETAILED_SEC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0129 <Error></Error><br/> 0130 <Comment># If the </Comment><KeywordInComment>INLINE_INHERITED_MEMB</KeywordInComment><Comment> tag is set to YES, doxygen will show all</Comment><br/> 0131 <Comment># inherited members of a class in the documentation of that class as if those</Comment><br/> 0132 <Comment># members were ordinary class members. Constructors, destructors and assignment</Comment><br/> 0133 <Comment># operators of the base classes will not be shown.</Comment><br/> 0134 <Comment># The default value is: NO.</Comment><br/> 0135 <Error></Error><br/> 0136 <Keyword>INLINE_INHERITED_MEMB</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0137 <Error></Error><br/> 0138 <Comment># If the </Comment><KeywordInComment>FULL_PATH_NAMES</KeywordInComment><Comment> tag is set to YES, doxygen will prepend the full path</Comment><br/> 0139 <Comment># before files name in the file list and in the header files. If set to NO the</Comment><br/> 0140 <Comment># shortest path that makes the file name unique will be used</Comment><br/> 0141 <Comment># The default value is: YES.</Comment><br/> 0142 <Error></Error><br/> 0143 <Keyword>FULL_PATH_NAMES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0144 <Error></Error><br/> 0145 <Comment># The </Comment><KeywordInComment>STRIP_FROM_PATH</KeywordInComment><Comment> tag can be used to strip a user-defined part of the path.</Comment><br/> 0146 <Comment># Stripping is only done if one of the specified strings matches the left-hand</Comment><br/> 0147 <Comment># part of the path. The tag can be used to show relative paths in the file list.</Comment><br/> 0148 <Comment># If left blank the directory from which doxygen is run is used as the path to</Comment><br/> 0149 <Comment># strip.</Comment><br/> 0150 <Comment>#</Comment><br/> 0151 <Comment># Note that you can specify absolute paths here, but also relative paths, which</Comment><br/> 0152 <Comment># will be relative from the directory where doxygen is started.</Comment><br/> 0153 <Comment># This tag requires that the tag </Comment><KeywordInComment>FULL_PATH_NAMES</KeywordInComment><Comment> is set to YES.</Comment><br/> 0154 <Error></Error><br/> 0155 <Keyword>STRIP_FROM_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0156 <Error></Error><br/> 0157 <Comment># The </Comment><KeywordInComment>STRIP_FROM_INC_PATH</KeywordInComment><Comment> tag can be used to strip a user-defined part of the</Comment><br/> 0158 <Comment># path mentioned in the documentation of a class, which tells the reader which</Comment><br/> 0159 <Comment># header file to include in order to use a class. If left blank only the name of</Comment><br/> 0160 <Comment># the header file containing the class definition is used. Otherwise one should</Comment><br/> 0161 <Comment># specify the list of include paths that are normally passed to the compiler</Comment><br/> 0162 <Comment># using the -I flag.</Comment><br/> 0163 <Error></Error><br/> 0164 <Keyword>STRIP_FROM_INC_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0165 <Error></Error><br/> 0166 <Comment># If the </Comment><KeywordInComment>SHORT_NAMES</KeywordInComment><Comment> tag is set to YES, doxygen will generate much shorter (but</Comment><br/> 0167 <Comment># less readable) file names. This can be useful is your file systems doesn't</Comment><br/> 0168 <Comment># support long names like on DOS, Mac, or CD-ROM.</Comment><br/> 0169 <Comment># The default value is: NO.</Comment><br/> 0170 <Error></Error><br/> 0171 <Keyword>SHORT_NAMES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0172 <Error></Error><br/> 0173 <Comment># If the </Comment><KeywordInComment>JAVADOC_AUTOBRIEF</KeywordInComment><Comment> tag is set to YES then doxygen will interpret the</Comment><br/> 0174 <Comment># first line (until the first dot) of a Javadoc-style comment as the brief</Comment><br/> 0175 <Comment># description. If set to NO, the Javadoc-style will behave just like regular Qt-</Comment><br/> 0176 <Comment># style comments (thus requiring an explicit @brief command for a brief</Comment><br/> 0177 <Comment># description.)</Comment><br/> 0178 <Comment># The default value is: NO.</Comment><br/> 0179 <Error></Error><br/> 0180 <Keyword>JAVADOC_AUTOBRIEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0181 <Error></Error><br/> 0182 <Comment># If the </Comment><KeywordInComment>QT_AUTOBRIEF</KeywordInComment><Comment> tag is set to YES then doxygen will interpret the first</Comment><br/> 0183 <Comment># line (until the first dot) of a Qt-style comment as the brief description. If</Comment><br/> 0184 <Comment># set to NO, the Qt-style will behave just like regular Qt-style comments (thus</Comment><br/> 0185 <Comment># requiring an explicit \brief command for a brief description.)</Comment><br/> 0186 <Comment># The default value is: NO.</Comment><br/> 0187 <Error></Error><br/> 0188 <Keyword>QT_AUTOBRIEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0189 <Error></Error><br/> 0190 <Comment># The </Comment><KeywordInComment>MULTILINE_CPP_IS_BRIEF</KeywordInComment><Comment> tag can be set to YES to make doxygen treat a</Comment><br/> 0191 <Comment># multi-line C++ special comment block (i.e. a block of //! or /// comments) as</Comment><br/> 0192 <Comment># a brief description. This used to be the default behavior. The new default is</Comment><br/> 0193 <Comment># to treat a multi-line C++ comment block as a detailed description. Set this</Comment><br/> 0194 <Comment># tag to YES if you prefer the old behavior instead.</Comment><br/> 0195 <Comment>#</Comment><br/> 0196 <Comment># Note that setting this tag to YES also means that rational rose comments are</Comment><br/> 0197 <Comment># not recognized any more.</Comment><br/> 0198 <Comment># The default value is: NO.</Comment><br/> 0199 <Error></Error><br/> 0200 <Keyword>MULTILINE_CPP_IS_BRIEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0201 <Error></Error><br/> 0202 <Comment># If the </Comment><KeywordInComment>INHERIT_DOCS</KeywordInComment><Comment> tag is set to YES then an undocumented member inherits the</Comment><br/> 0203 <Comment># documentation from any documented member that it re-implements.</Comment><br/> 0204 <Comment># The default value is: YES.</Comment><br/> 0205 <Error></Error><br/> 0206 <Keyword>INHERIT_DOCS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0207 <Error></Error><br/> 0208 <Comment># If the </Comment><KeywordInComment>SEPARATE_MEMBER_PAGES</KeywordInComment><Comment> tag is set to YES then doxygen will produce a new</Comment><br/> 0209 <Comment># page for each member. If set to NO, the documentation of a member will be part</Comment><br/> 0210 <Comment># of the file/class/namespace that contains it.</Comment><br/> 0211 <Comment># The default value is: NO.</Comment><br/> 0212 <Error></Error><br/> 0213 <Keyword>SEPARATE_MEMBER_PAGES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0214 <Error></Error><br/> 0215 <Comment># The </Comment><KeywordInComment>TAB_SIZE</KeywordInComment><Comment> tag can be used to set the number of spaces in a tab. Doxygen</Comment><br/> 0216 <Comment># uses this value to replace tabs by spaces in code fragments.</Comment><br/> 0217 <Comment># Minimum value: 1, maximum value: 16, default value: 4.</Comment><br/> 0218 <Error></Error><br/> 0219 <Keyword>TAB_SIZE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 4</UntypedValue><br/> 0220 <Error></Error><br/> 0221 <Comment># This tag can be used to specify a number of </Comment><KeywordInComment>aliases</KeywordInComment><Comment> that act as commands in</Comment><br/> 0222 <Comment># the documentation. An alias has the form:</Comment><br/> 0223 <Comment># name=value</Comment><br/> 0224 <Comment># For example adding</Comment><br/> 0225 <Comment># "sideeffect=@par Side Effects:\n"</Comment><br/> 0226 <Comment># will allow you to put the command \sideeffect (or @sideeffect) in the</Comment><br/> 0227 <Comment># documentation, which will result in a user-defined paragraph with heading</Comment><br/> 0228 <Comment># "Side Effects:". You can put \n's in the value part of an alias to insert</Comment><br/> 0229 <Comment># newlines.</Comment><br/> 0230 <Error></Error><br/> 0231 <Keyword>ALIASES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0232 <Error></Error><br/> 0233 <Comment># This tag can be used to specify a number of word-keyword mappings (TCL only).</Comment><br/> 0234 <Comment># A mapping has the form "name=value". For example adding "class=itcl::class"</Comment><br/> 0235 <Comment># will allow you to use the command class in the itcl::class meaning.</Comment><br/> 0236 <Error></Error><br/> 0237 <Keyword>TCL_SUBST</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0238 <Error></Error><br/> 0239 <Comment># Set the </Comment><KeywordInComment>OPTIMIZE_OUTPUT_FOR_C</KeywordInComment><Comment> tag to YES if your project consists of C sources</Comment><br/> 0240 <Comment># only. Doxygen will then generate output that is more tailored for C. For</Comment><br/> 0241 <Comment># instance, some of the names that are used will be different. The list of all</Comment><br/> 0242 <Comment># members will be omitted, etc.</Comment><br/> 0243 <Comment># The default value is: NO.</Comment><br/> 0244 <Error></Error><br/> 0245 <Keyword>OPTIMIZE_OUTPUT_FOR_C</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0246 <Error></Error><br/> 0247 <Comment># Set the </Comment><KeywordInComment>OPTIMIZE_OUTPUT_JAVA</KeywordInComment><Comment> tag to YES if your project consists of Java or</Comment><br/> 0248 <Comment># Python sources only. Doxygen will then generate output that is more tailored</Comment><br/> 0249 <Comment># for that language. For instance, namespaces will be presented as packages,</Comment><br/> 0250 <Comment># qualified scopes will look different, etc.</Comment><br/> 0251 <Comment># The default value is: NO.</Comment><br/> 0252 <Error></Error><br/> 0253 <Keyword>OPTIMIZE_OUTPUT_JAVA</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0254 <Error></Error><br/> 0255 <Comment># Set the </Comment><KeywordInComment>OPTIMIZE_FOR_FORTRAN</KeywordInComment><Comment> tag to YES if your project consists of Fortran</Comment><br/> 0256 <Comment># sources. Doxygen will then generate output that is tailored for Fortran.</Comment><br/> 0257 <Comment># The default value is: NO.</Comment><br/> 0258 <Error></Error><br/> 0259 <Keyword>OPTIMIZE_FOR_FORTRAN</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0260 <Error></Error><br/> 0261 <Comment># Set the </Comment><KeywordInComment>OPTIMIZE_OUTPUT_VHDL</KeywordInComment><Comment> tag to YES if your project consists of VHDL</Comment><br/> 0262 <Comment># sources. Doxygen will then generate output that is tailored for VHDL.</Comment><br/> 0263 <Comment># The default value is: NO.</Comment><br/> 0264 <Error></Error><br/> 0265 <Keyword>OPTIMIZE_OUTPUT_VHDL</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0266 <Error></Error><br/> 0267 <Comment># Doxygen selects the parser to use depending on the extension of the files it</Comment><br/> 0268 <Comment># parses. With this tag you can assign which parser to use for a given</Comment><br/> 0269 <Comment># extension. Doxygen has a built-in mapping, but you can override or extend it</Comment><br/> 0270 <Comment># using this tag. The format is ext=language, where ext is a file extension, and</Comment><br/> 0271 <Comment># language is one of the parsers supported by doxygen: IDL, Java, Javascript,</Comment><br/> 0272 <Comment># C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:</Comment><br/> 0273 <Comment># FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:</Comment><br/> 0274 <Comment># Fortran. In the later case the parser tries to guess whether the code is fixed</Comment><br/> 0275 <Comment># or free formatted code, this is the default for Fortran type files), VHDL. For</Comment><br/> 0276 <Comment># instance to make doxygen treat .inc files as Fortran files (default is PHP),</Comment><br/> 0277 <Comment># and .f files as C (default is Fortran), use: inc=Fortran f=C.</Comment><br/> 0278 <Comment>#</Comment><br/> 0279 <Comment># Note: For files without extension you can use no_extension as a placeholder.</Comment><br/> 0280 <Comment>#</Comment><br/> 0281 <Comment># Note that for custom extensions you also need to set </Comment><KeywordInComment>FILE_PATTERNS</KeywordInComment><Comment> otherwise</Comment><br/> 0282 <Comment># the files are not read by doxygen.</Comment><br/> 0283 <Error></Error><br/> 0284 <Keyword>EXTENSION_MAPPING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0285 <Error></Error><br/> 0286 <Comment># If the </Comment><KeywordInComment>MARKDOWN_SUPPORT</KeywordInComment><Comment> tag is enabled then doxygen pre-processes all comments</Comment><br/> 0287 <Comment># according to the Markdown format, which allows for more readable</Comment><br/> 0288 <Comment># documentation. See http://daringfireball.net/projects/markdown/ for details.</Comment><br/> 0289 <Comment># The output of markdown processing is further processed by doxygen, so you can</Comment><br/> 0290 <Comment># mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in</Comment><br/> 0291 <Comment># case of backward compatibilities issues.</Comment><br/> 0292 <Comment># The default value is: YES.</Comment><br/> 0293 <Error></Error><br/> 0294 <Keyword>MARKDOWN_SUPPORT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0295 <Error></Error><br/> 0296 <Comment># When enabled doxygen tries to link words that correspond to documented</Comment><br/> 0297 <Comment># classes, or namespaces to their corresponding documentation. Such a link can</Comment><br/> 0298 <Comment># be prevented in individual cases by putting a % sign in front of the word or</Comment><br/> 0299 <Comment># globally by setting </Comment><KeywordInComment>AUTOLINK_SUPPORT</KeywordInComment><Comment> to NO.</Comment><br/> 0300 <Comment># The default value is: YES.</Comment><br/> 0301 <Error></Error><br/> 0302 <Keyword>AUTOLINK_SUPPORT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0303 <Error></Error><br/> 0304 <Comment># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want</Comment><br/> 0305 <Comment># to include (a tag file for) the STL sources as </Comment><KeywordInComment>input</KeywordInComment><Comment>, then you should set this</Comment><br/> 0306 <Comment># tag to YES in order to let doxygen match functions declarations and</Comment><br/> 0307 <Comment># definitions whose arguments contain STL classes (e.g. func(std::string);</Comment><br/> 0308 <Comment># versus func(std::string) {}). This also make the inheritance and collaboration</Comment><br/> 0309 <Comment># diagrams that involve STL classes more complete and accurate.</Comment><br/> 0310 <Comment># The default value is: NO.</Comment><br/> 0311 <Error></Error><br/> 0312 <Keyword>BUILTIN_STL_SUPPORT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0313 <Error></Error><br/> 0314 <Comment># If you use Microsoft's C++/CLI language, you should set this option to YES to</Comment><br/> 0315 <Comment># enable parsing support.</Comment><br/> 0316 <Comment># The default value is: NO.</Comment><br/> 0317 <Error></Error><br/> 0318 <Keyword>CPP_CLI_SUPPORT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0319 <Error></Error><br/> 0320 <Comment># Set the </Comment><KeywordInComment>SIP_SUPPORT</KeywordInComment><Comment> tag to YES if your project consists of sip (see:</Comment><br/> 0321 <Comment># http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen</Comment><br/> 0322 <Comment># will parse them like normal C++ but will assume all classes use public instead</Comment><br/> 0323 <Comment># of private inheritance when no explicit protection keyword is present.</Comment><br/> 0324 <Comment># The default value is: NO.</Comment><br/> 0325 <Error></Error><br/> 0326 <Keyword>SIP_SUPPORT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0327 <Error></Error><br/> 0328 <Comment># For Microsoft's IDL there are propget and propput attributes to indicate</Comment><br/> 0329 <Comment># getter and setter methods for a property. Setting this option to YES will make</Comment><br/> 0330 <Comment># doxygen to replace the get and set methods by a property in the documentation.</Comment><br/> 0331 <Comment># This will only work if the methods are indeed getting or setting a simple</Comment><br/> 0332 <Comment># type. If this is not the case, or you want to show the methods anyway, you</Comment><br/> 0333 <Comment># should set this option to NO.</Comment><br/> 0334 <Comment># The default value is: YES.</Comment><br/> 0335 <Error></Error><br/> 0336 <Keyword>IDL_PROPERTY_SUPPORT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0337 <Error></Error><br/> 0338 <Comment># If member grouping is used in the documentation and the </Comment><KeywordInComment>DISTRIBUTE_GROUP_DOC</KeywordInComment><br/> 0339 <Comment># tag is set to YES then doxygen will reuse the documentation of the first</Comment><br/> 0340 <Comment># member in the group (if any) for the other members of the group. By default</Comment><br/> 0341 <Comment># all members of a group must be documented explicitly.</Comment><br/> 0342 <Comment># The default value is: NO.</Comment><br/> 0343 <Error></Error><br/> 0344 <Keyword>DISTRIBUTE_GROUP_DOC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0345 <Error></Error><br/> 0346 <Comment># If one adds a struct or class to a group and this option is enabled, then also</Comment><br/> 0347 <Comment># any nested class or struct is added to the same group. By default this option</Comment><br/> 0348 <Comment># is disabled and one has to add nested compounds explicitly via \ingroup.</Comment><br/> 0349 <Comment># The default value is: NO.</Comment><br/> 0350 <Error></Error><br/> 0351 <Keyword>GROUP_NESTED_COMPOUNDS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0352 <Error></Error><br/> 0353 <Comment># Set the </Comment><KeywordInComment>SUBGROUPING</KeywordInComment><Comment> tag to YES to allow class member groups of the same type</Comment><br/> 0354 <Comment># (for instance a group of public functions) to be put as a subgroup of that</Comment><br/> 0355 <Comment># type (e.g. under the Public Functions section). Set it to NO to prevent</Comment><br/> 0356 <Comment># </Comment><KeywordInComment>subgrouping</KeywordInComment><Comment>. Alternatively, this can be done per class using the</Comment><br/> 0357 <Comment># \nosubgrouping command.</Comment><br/> 0358 <Comment># The default value is: YES.</Comment><br/> 0359 <Error></Error><br/> 0360 <Keyword>SUBGROUPING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0361 <Error></Error><br/> 0362 <Comment># When the </Comment><KeywordInComment>INLINE_GROUPED_CLASSES</KeywordInComment><Comment> tag is set to YES, classes, structs and unions</Comment><br/> 0363 <Comment># are shown inside the group in which they are included (e.g. using \ingroup)</Comment><br/> 0364 <Comment># instead of on a separate page (for HTML and Man pages) or section (for LaTeX</Comment><br/> 0365 <Comment># and RTF).</Comment><br/> 0366 <Comment>#</Comment><br/> 0367 <Comment># Note that this feature does not work in combination with</Comment><br/> 0368 <Comment># </Comment><KeywordInComment>SEPARATE_MEMBER_PAGES</KeywordInComment><Comment>.</Comment><br/> 0369 <Comment># The default value is: NO.</Comment><br/> 0370 <Error></Error><br/> 0371 <Keyword>INLINE_GROUPED_CLASSES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0372 <Error></Error><br/> 0373 <Comment># When the </Comment><KeywordInComment>INLINE_SIMPLE_STRUCTS</KeywordInComment><Comment> tag is set to YES, structs, classes, and unions</Comment><br/> 0374 <Comment># with only public data fields or simple typedef fields will be shown inline in</Comment><br/> 0375 <Comment># the documentation of the scope in which they are defined (i.e. file,</Comment><br/> 0376 <Comment># namespace, or group documentation), provided this scope is documented. If set</Comment><br/> 0377 <Comment># to NO, structs, classes, and unions are shown on a separate page (for HTML and</Comment><br/> 0378 <Comment># Man pages) or section (for LaTeX and RTF).</Comment><br/> 0379 <Comment># The default value is: NO.</Comment><br/> 0380 <Error></Error><br/> 0381 <Keyword>INLINE_SIMPLE_STRUCTS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0382 <Error></Error><br/> 0383 <Comment># When </Comment><KeywordInComment>TYPEDEF_HIDES_STRUCT</KeywordInComment><Comment> tag is enabled, a typedef of a struct, union, or</Comment><br/> 0384 <Comment># enum is documented as struct, union, or enum with the name of the typedef. So</Comment><br/> 0385 <Comment># typedef struct TypeS {} TypeT, will appear in the documentation as a struct</Comment><br/> 0386 <Comment># with name TypeT. When disabled the typedef will appear as a member of a file,</Comment><br/> 0387 <Comment># namespace, or class. And the struct will be named TypeS. This can typically be</Comment><br/> 0388 <Comment># useful for C code in case the coding convention dictates that all compound</Comment><br/> 0389 <Comment># types are typedef'ed and only the typedef is referenced, never the tag name.</Comment><br/> 0390 <Comment># The default value is: NO.</Comment><br/> 0391 <Error></Error><br/> 0392 <Keyword>TYPEDEF_HIDES_STRUCT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0393 <Error></Error><br/> 0394 <Comment># The size of the symbol lookup cache can be set using </Comment><KeywordInComment>LOOKUP_CACHE_SIZE</KeywordInComment><Comment>. This</Comment><br/> 0395 <Comment># cache is used to resolve symbols given their name and scope. Since this can be</Comment><br/> 0396 <Comment># an expensive process and often the same symbol appears multiple times in the</Comment><br/> 0397 <Comment># code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small</Comment><br/> 0398 <Comment># doxygen will become slower. If the cache is too large, memory is wasted. The</Comment><br/> 0399 <Comment># cache size is given by this formula: 2^(16+</Comment><KeywordInComment>LOOKUP_CACHE_SIZE</KeywordInComment><Comment>). The valid range</Comment><br/> 0400 <Comment># is 0..9, the default is 0, corresponding to a cache size of 2^16=65536</Comment><br/> 0401 <Comment># symbols. At the end of a run doxygen will report the cache usage and suggest</Comment><br/> 0402 <Comment># the optimal cache size from a speed point of view.</Comment><br/> 0403 <Comment># Minimum value: 0, maximum value: 9, default value: 0.</Comment><br/> 0404 <Error></Error><br/> 0405 <Keyword>LOOKUP_CACHE_SIZE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 0</UntypedValue><br/> 0406 <Error></Error><br/> 0407 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0408 <Comment># Build related configuration options</Comment><br/> 0409 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0410 <Error></Error><br/> 0411 <Comment># If the </Comment><KeywordInComment>EXTRACT_ALL</KeywordInComment><Comment> tag is set to YES, doxygen will assume all entities in</Comment><br/> 0412 <Comment># documentation are documented, even if no documentation was available. Private</Comment><br/> 0413 <Comment># class members and static file members will be hidden unless the</Comment><br/> 0414 <Comment># </Comment><KeywordInComment>EXTRACT_PRIVATE</KeywordInComment><Comment> respectively </Comment><KeywordInComment>EXTRACT_STATIC</KeywordInComment><Comment> tags are set to YES.</Comment><br/> 0415 <Comment># Note: This will also disable the </Comment><KeywordInComment>warnings</KeywordInComment><Comment> about undocumented members that are</Comment><br/> 0416 <Comment># normally produced when </Comment><KeywordInComment>WARNINGS</KeywordInComment><Comment> is set to YES.</Comment><br/> 0417 <Comment># The default value is: NO.</Comment><br/> 0418 <Error></Error><br/> 0419 <Keyword>EXTRACT_ALL</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0420 <Error></Error><br/> 0421 <Comment># If the </Comment><KeywordInComment>EXTRACT_PRIVATE</KeywordInComment><Comment> tag is set to YES, all private members of a class will</Comment><br/> 0422 <Comment># be included in the documentation.</Comment><br/> 0423 <Comment># The default value is: NO.</Comment><br/> 0424 <Error></Error><br/> 0425 <Keyword>EXTRACT_PRIVATE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0426 <Error></Error><br/> 0427 <Comment># If the </Comment><KeywordInComment>EXTRACT_PACKAGE</KeywordInComment><Comment> tag is set to YES, all members with package or internal</Comment><br/> 0428 <Comment># scope will be included in the documentation.</Comment><br/> 0429 <Comment># The default value is: NO.</Comment><br/> 0430 <Error></Error><br/> 0431 <Keyword>EXTRACT_PACKAGE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0432 <Error></Error><br/> 0433 <Comment># If the </Comment><KeywordInComment>EXTRACT_STATIC</KeywordInComment><Comment> tag is set to YES, all static members of a file will be</Comment><br/> 0434 <Comment># included in the documentation.</Comment><br/> 0435 <Comment># The default value is: NO.</Comment><br/> 0436 <Error></Error><br/> 0437 <Keyword>EXTRACT_STATIC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0438 <Error></Error><br/> 0439 <Comment># If the </Comment><KeywordInComment>EXTRACT_LOCAL_CLASSES</KeywordInComment><Comment> tag is set to YES, classes (and structs) defined</Comment><br/> 0440 <Comment># locally in source files will be included in the documentation. If set to NO,</Comment><br/> 0441 <Comment># only classes defined in header files are included. Does not have any effect</Comment><br/> 0442 <Comment># for Java sources.</Comment><br/> 0443 <Comment># The default value is: YES.</Comment><br/> 0444 <Error></Error><br/> 0445 <Keyword>EXTRACT_LOCAL_CLASSES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0446 <Error></Error><br/> 0447 <Comment># This flag is only useful for Objective-C code. If set to YES, local methods,</Comment><br/> 0448 <Comment># which are defined in the implementation section but not in the interface are</Comment><br/> 0449 <Comment># included in the documentation. If set to NO, only methods in the interface are</Comment><br/> 0450 <Comment># included.</Comment><br/> 0451 <Comment># The default value is: NO.</Comment><br/> 0452 <Error></Error><br/> 0453 <Keyword>EXTRACT_LOCAL_METHODS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0454 <Error></Error><br/> 0455 <Comment># If this flag is set to YES, the members of anonymous namespaces will be</Comment><br/> 0456 <Comment># extracted and appear in the documentation as a namespace called</Comment><br/> 0457 <Comment># 'anonymous_namespace{file}', where file will be replaced with the base name of</Comment><br/> 0458 <Comment># the file that contains the anonymous namespace. By default anonymous namespace</Comment><br/> 0459 <Comment># are hidden.</Comment><br/> 0460 <Comment># The default value is: NO.</Comment><br/> 0461 <Error></Error><br/> 0462 <Keyword>EXTRACT_ANON_NSPACES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0463 <Error></Error><br/> 0464 <Comment># If the </Comment><KeywordInComment>HIDE_UNDOC_MEMBERS</KeywordInComment><Comment> tag is set to YES, doxygen will hide all</Comment><br/> 0465 <Comment># undocumented members inside documented classes or files. If set to NO these</Comment><br/> 0466 <Comment># members will be included in the various overviews, but no documentation</Comment><br/> 0467 <Comment># section is generated. This option has no effect if </Comment><KeywordInComment>EXTRACT_ALL</KeywordInComment><Comment> is enabled.</Comment><br/> 0468 <Comment># The default value is: NO.</Comment><br/> 0469 <Error></Error><br/> 0470 <Keyword>HIDE_UNDOC_MEMBERS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0471 <Error></Error><br/> 0472 <Comment># If the </Comment><KeywordInComment>HIDE_UNDOC_CLASSES</KeywordInComment><Comment> tag is set to YES, doxygen will hide all</Comment><br/> 0473 <Comment># undocumented classes that are normally visible in the class hierarchy. If set</Comment><br/> 0474 <Comment># to NO, these classes will be included in the various overviews. This option</Comment><br/> 0475 <Comment># has no effect if </Comment><KeywordInComment>EXTRACT_ALL</KeywordInComment><Comment> is enabled.</Comment><br/> 0476 <Comment># The default value is: NO.</Comment><br/> 0477 <Error></Error><br/> 0478 <Keyword>HIDE_UNDOC_CLASSES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0479 <Error></Error><br/> 0480 <Comment># If the </Comment><KeywordInComment>HIDE_FRIEND_COMPOUNDS</KeywordInComment><Comment> tag is set to YES, doxygen will hide all friend</Comment><br/> 0481 <Comment># (class|struct|union) declarations. If set to NO, these declarations will be</Comment><br/> 0482 <Comment># included in the documentation.</Comment><br/> 0483 <Comment># The default value is: NO.</Comment><br/> 0484 <Error></Error><br/> 0485 <Keyword>HIDE_FRIEND_COMPOUNDS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0486 <Error></Error><br/> 0487 <Comment># If the </Comment><KeywordInComment>HIDE_IN_BODY_DOCS</KeywordInComment><Comment> tag is set to YES, doxygen will hide any</Comment><br/> 0488 <Comment># documentation blocks found inside the body of a function. If set to NO, these</Comment><br/> 0489 <Comment># blocks will be appended to the function's detailed documentation block.</Comment><br/> 0490 <Comment># The default value is: NO.</Comment><br/> 0491 <Error></Error><br/> 0492 <Keyword>HIDE_IN_BODY_DOCS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0493 <Error></Error><br/> 0494 <Comment># The </Comment><KeywordInComment>INTERNAL_DOCS</KeywordInComment><Comment> tag determines if documentation that is typed after a</Comment><br/> 0495 <Comment># \internal command is included. If the tag is set to NO then the documentation</Comment><br/> 0496 <Comment># will be excluded. Set it to YES to include the internal documentation.</Comment><br/> 0497 <Comment># The default value is: NO.</Comment><br/> 0498 <Error></Error><br/> 0499 <Keyword>INTERNAL_DOCS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0500 <Error></Error><br/> 0501 <Comment># If the </Comment><KeywordInComment>CASE_SENSE_NAMES</KeywordInComment><Comment> tag is set to NO then doxygen will only generate file</Comment><br/> 0502 <Comment># names in lower-case letters. If set to YES, upper-case letters are also</Comment><br/> 0503 <Comment># allowed. This is useful if you have classes or files whose names only differ</Comment><br/> 0504 <Comment># in case and if your file system supports case sensitive file names. Windows</Comment><br/> 0505 <Comment># and Mac users are advised to set this option to NO.</Comment><br/> 0506 <Comment># The default value is: system dependent.</Comment><br/> 0507 <Error></Error><br/> 0508 <Keyword>CASE_SENSE_NAMES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0509 <Error></Error><br/> 0510 <Comment># If the </Comment><KeywordInComment>HIDE_SCOPE_NAMES</KeywordInComment><Comment> tag is set to NO then doxygen will show members with</Comment><br/> 0511 <Comment># their full class and namespace scopes in the documentation. If set to YES, the</Comment><br/> 0512 <Comment># scope will be hidden.</Comment><br/> 0513 <Comment># The default value is: NO.</Comment><br/> 0514 <Error></Error><br/> 0515 <Keyword>HIDE_SCOPE_NAMES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0516 <Error></Error><br/> 0517 <Comment># If the </Comment><KeywordInComment>HIDE_COMPOUND_REFERENCE</KeywordInComment><Comment> tag is set to NO (default) then doxygen will</Comment><br/> 0518 <Comment># append additional text to a page's title, such as Class Reference. If set to</Comment><br/> 0519 <Comment># YES the compound reference will be hidden.</Comment><br/> 0520 <Comment># The default value is: NO.</Comment><br/> 0521 <Error></Error><br/> 0522 <Keyword>HIDE_COMPOUND_REFERENCE</Keyword><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0523 <Error></Error><br/> 0524 <Comment># If the </Comment><KeywordInComment>SHOW_INCLUDE_FILES</KeywordInComment><Comment> tag is set to YES then doxygen will put a list of</Comment><br/> 0525 <Comment># the files that are included by a file in the documentation of that file.</Comment><br/> 0526 <Comment># The default value is: YES.</Comment><br/> 0527 <Error></Error><br/> 0528 <Keyword>SHOW_INCLUDE_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0529 <Error></Error><br/> 0530 <Comment># If the </Comment><KeywordInComment>SHOW_GROUPED_MEMB_INC</KeywordInComment><Comment> tag is set to YES then Doxygen will add for each</Comment><br/> 0531 <Comment># grouped member an include statement to the documentation, telling the reader</Comment><br/> 0532 <Comment># which file to include in order to use the member.</Comment><br/> 0533 <Comment># The default value is: NO.</Comment><br/> 0534 <Error></Error><br/> 0535 <Keyword>SHOW_GROUPED_MEMB_INC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0536 <Error></Error><br/> 0537 <Comment># If the </Comment><KeywordInComment>FORCE_LOCAL_INCLUDES</KeywordInComment><Comment> tag is set to YES then doxygen will list include</Comment><br/> 0538 <Comment># files with double quotes in the documentation rather than with sharp brackets.</Comment><br/> 0539 <Comment># The default value is: NO.</Comment><br/> 0540 <Error></Error><br/> 0541 <Keyword>FORCE_LOCAL_INCLUDES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0542 <Error></Error><br/> 0543 <Comment># If the </Comment><KeywordInComment>INLINE_INFO</KeywordInComment><Comment> tag is set to YES then a tag [inline] is inserted in the</Comment><br/> 0544 <Comment># documentation for inline members.</Comment><br/> 0545 <Comment># The default value is: YES.</Comment><br/> 0546 <Error></Error><br/> 0547 <Keyword>INLINE_INFO</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0548 <Error></Error><br/> 0549 <Comment># If the </Comment><KeywordInComment>SORT_MEMBER_DOCS</KeywordInComment><Comment> tag is set to YES then doxygen will sort the</Comment><br/> 0550 <Comment># (detailed) documentation of file and class members alphabetically by member</Comment><br/> 0551 <Comment># name. If set to NO, the members will appear in declaration order.</Comment><br/> 0552 <Comment># The default value is: YES.</Comment><br/> 0553 <Error></Error><br/> 0554 <Keyword>SORT_MEMBER_DOCS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0555 <Error></Error><br/> 0556 <Comment># If the </Comment><KeywordInComment>SORT_BRIEF_DOCS</KeywordInComment><Comment> tag is set to YES then doxygen will sort the brief</Comment><br/> 0557 <Comment># descriptions of file, namespace and class members alphabetically by member</Comment><br/> 0558 <Comment># name. If set to NO, the members will appear in declaration order. Note that</Comment><br/> 0559 <Comment># this will also influence the order of the classes in the class list.</Comment><br/> 0560 <Comment># The default value is: NO.</Comment><br/> 0561 <Error></Error><br/> 0562 <Keyword>SORT_BRIEF_DOCS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0563 <Error></Error><br/> 0564 <Comment># If the </Comment><KeywordInComment>SORT_MEMBERS_CTORS_1ST</KeywordInComment><Comment> tag is set to YES then doxygen will sort the</Comment><br/> 0565 <Comment># (brief and detailed) documentation of class members so that constructors and</Comment><br/> 0566 <Comment># destructors are listed first. If set to NO the constructors will appear in the</Comment><br/> 0567 <Comment># respective orders defined by </Comment><KeywordInComment>SORT_BRIEF_DOCS</KeywordInComment><Comment> and </Comment><KeywordInComment>SORT_MEMBER_DOCS</KeywordInComment><Comment>.</Comment><br/> 0568 <Comment># Note: If </Comment><KeywordInComment>SORT_BRIEF_DOCS</KeywordInComment><Comment> is set to NO this option is ignored for sorting brief</Comment><br/> 0569 <Comment># member documentation.</Comment><br/> 0570 <Comment># Note: If </Comment><KeywordInComment>SORT_MEMBER_DOCS</KeywordInComment><Comment> is set to NO this option is ignored for sorting</Comment><br/> 0571 <Comment># detailed member documentation.</Comment><br/> 0572 <Comment># The default value is: NO.</Comment><br/> 0573 <Error></Error><br/> 0574 <Keyword>SORT_MEMBERS_CTORS_1ST</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0575 <Error></Error><br/> 0576 <Comment># If the </Comment><KeywordInComment>SORT_GROUP_NAMES</KeywordInComment><Comment> tag is set to YES then doxygen will sort the hierarchy</Comment><br/> 0577 <Comment># of group names into alphabetical order. If set to NO the group names will</Comment><br/> 0578 <Comment># appear in their defined order.</Comment><br/> 0579 <Comment># The default value is: NO.</Comment><br/> 0580 <Error></Error><br/> 0581 <Keyword>SORT_GROUP_NAMES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0582 <Error></Error><br/> 0583 <Comment># If the </Comment><KeywordInComment>SORT_BY_SCOPE_NAME</KeywordInComment><Comment> tag is set to YES, the class list will be sorted by</Comment><br/> 0584 <Comment># fully-qualified names, including namespaces. If set to NO, the class list will</Comment><br/> 0585 <Comment># be sorted only by class name, not including the namespace part.</Comment><br/> 0586 <Comment># Note: This option is not very useful if </Comment><KeywordInComment>HIDE_SCOPE_NAMES</KeywordInComment><Comment> is set to YES.</Comment><br/> 0587 <Comment># Note: This option applies only to the class list, not to the alphabetical</Comment><br/> 0588 <Comment># list.</Comment><br/> 0589 <Comment># The default value is: NO.</Comment><br/> 0590 <Error></Error><br/> 0591 <Keyword>SORT_BY_SCOPE_NAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0592 <Error></Error><br/> 0593 <Comment># If the </Comment><KeywordInComment>STRICT_PROTO_MATCHING</KeywordInComment><Comment> option is enabled and doxygen fails to do proper</Comment><br/> 0594 <Comment># type resolution of all parameters of a function it will reject a match between</Comment><br/> 0595 <Comment># the prototype and the implementation of a member function even if there is</Comment><br/> 0596 <Comment># only one candidate or it is obvious which candidate to choose by doing a</Comment><br/> 0597 <Comment># simple string match. By disabling </Comment><KeywordInComment>STRICT_PROTO_MATCHING</KeywordInComment><Comment> doxygen will still</Comment><br/> 0598 <Comment># accept a match between prototype and implementation in such cases.</Comment><br/> 0599 <Comment># The default value is: NO.</Comment><br/> 0600 <Error></Error><br/> 0601 <Keyword>STRICT_PROTO_MATCHING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0602 <Error></Error><br/> 0603 <Comment># The </Comment><KeywordInComment>GENERATE_TODOLIST</KeywordInComment><Comment> tag can be used to enable (YES) or disable (NO) the todo</Comment><br/> 0604 <Comment># list. This list is created by putting \todo commands in the documentation.</Comment><br/> 0605 <Comment># The default value is: YES.</Comment><br/> 0606 <Error></Error><br/> 0607 <Keyword>GENERATE_TODOLIST</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0608 <Error></Error><br/> 0609 <Comment># The </Comment><KeywordInComment>GENERATE_TESTLIST</KeywordInComment><Comment> tag can be used to enable (YES) or disable (NO) the test</Comment><br/> 0610 <Comment># list. This list is created by putting \test commands in the documentation.</Comment><br/> 0611 <Comment># The default value is: YES.</Comment><br/> 0612 <Error></Error><br/> 0613 <Keyword>GENERATE_TESTLIST</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0614 <Error></Error><br/> 0615 <Comment># The </Comment><KeywordInComment>GENERATE_BUGLIST</KeywordInComment><Comment> tag can be used to enable (YES) or disable (NO) the bug</Comment><br/> 0616 <Comment># list. This list is created by putting \bug commands in the documentation.</Comment><br/> 0617 <Comment># The default value is: YES.</Comment><br/> 0618 <Error></Error><br/> 0619 <Keyword>GENERATE_BUGLIST</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0620 <Error></Error><br/> 0621 <Comment># The </Comment><KeywordInComment>GENERATE_DEPRECATEDLIST</KeywordInComment><Comment> tag can be used to enable (YES) or disable (NO)</Comment><br/> 0622 <Comment># the deprecated list. This list is created by putting \deprecated commands in</Comment><br/> 0623 <Comment># the documentation.</Comment><br/> 0624 <Comment># The default value is: YES.</Comment><br/> 0625 <Error></Error><br/> 0626 <Keyword>GENERATE_DEPRECATEDLIST</Keyword><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0627 <Error></Error><br/> 0628 <Comment># The </Comment><KeywordInComment>ENABLED_SECTIONS</KeywordInComment><Comment> tag can be used to enable conditional documentation</Comment><br/> 0629 <Comment># sections, marked by \if <section_label> ... \endif and \cond <section_label></Comment><br/> 0630 <Comment># ... \endcond blocks.</Comment><br/> 0631 <Error></Error><br/> 0632 <Keyword>ENABLED_SECTIONS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0633 <Error></Error><br/> 0634 <Comment># The </Comment><KeywordInComment>MAX_INITIALIZER_LINES</KeywordInComment><Comment> tag determines the maximum number of lines that the</Comment><br/> 0635 <Comment># initial value of a variable or macro / define can have for it to appear in the</Comment><br/> 0636 <Comment># documentation. If the initializer consists of more lines than specified here</Comment><br/> 0637 <Comment># it will be hidden. Use a value of 0 to hide initializers completely. The</Comment><br/> 0638 <Comment># appearance of the value of individual variables and macros / defines can be</Comment><br/> 0639 <Comment># controlled using \showinitializer or \hideinitializer command in the</Comment><br/> 0640 <Comment># documentation regardless of this setting.</Comment><br/> 0641 <Comment># Minimum value: 0, maximum value: 10000, default value: 30.</Comment><br/> 0642 <Error></Error><br/> 0643 <Keyword>MAX_INITIALIZER_LINES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 30</UntypedValue><br/> 0644 <Error></Error><br/> 0645 <Comment># Set the </Comment><KeywordInComment>SHOW_USED_FILES</KeywordInComment><Comment> tag to NO to disable the list of files generated at</Comment><br/> 0646 <Comment># the bottom of the documentation of classes and structs. If set to YES, the</Comment><br/> 0647 <Comment># list will mention the files that were used to generate the documentation.</Comment><br/> 0648 <Comment># The default value is: YES.</Comment><br/> 0649 <Error></Error><br/> 0650 <Keyword>SHOW_USED_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0651 <Error></Error><br/> 0652 <Comment># Set the </Comment><KeywordInComment>SHOW_FILES</KeywordInComment><Comment> tag to NO to disable the generation of the Files page. This</Comment><br/> 0653 <Comment># will remove the Files entry from the Quick Index and from the Folder Tree View</Comment><br/> 0654 <Comment># (if specified).</Comment><br/> 0655 <Comment># The default value is: YES.</Comment><br/> 0656 <Error></Error><br/> 0657 <Keyword>SHOW_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0658 <Error></Error><br/> 0659 <Comment># Set the </Comment><KeywordInComment>SHOW_NAMESPACES</KeywordInComment><Comment> tag to NO to disable the generation of the Namespaces</Comment><br/> 0660 <Comment># page. This will remove the Namespaces entry from the Quick Index and from the</Comment><br/> 0661 <Comment># Folder Tree View (if specified).</Comment><br/> 0662 <Comment># The default value is: YES.</Comment><br/> 0663 <Error></Error><br/> 0664 <Keyword>SHOW_NAMESPACES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0665 <Error></Error><br/> 0666 <Comment># The </Comment><KeywordInComment>FILE_VERSION_FILTER</KeywordInComment><Comment> tag can be used to specify a program or script that</Comment><br/> 0667 <Comment># doxygen should invoke to get the current version for each file (typically from</Comment><br/> 0668 <Comment># the version control system). Doxygen will invoke the program by executing (via</Comment><br/> 0669 <Comment># popen()) the command command </Comment><KeywordInComment>input</KeywordInComment><Comment>-file, where command is the value of the</Comment><br/> 0670 <Comment># </Comment><KeywordInComment>FILE_VERSION_FILTER</KeywordInComment><Comment> tag, and </Comment><KeywordInComment>input</KeywordInComment><Comment>-file is the name of an </Comment><KeywordInComment>input</KeywordInComment><Comment> file provided</Comment><br/> 0671 <Comment># by doxygen. Whatever the program writes to standard output is used as the file</Comment><br/> 0672 <Comment># version. For an example see the documentation.</Comment><br/> 0673 <Error></Error><br/> 0674 <Keyword>FILE_VERSION_FILTER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0675 <Error></Error><br/> 0676 <Comment># The </Comment><KeywordInComment>LAYOUT_FILE</KeywordInComment><Comment> tag can be used to specify a layout file which will be parsed</Comment><br/> 0677 <Comment># by doxygen. The layout file controls the global structure of the generated</Comment><br/> 0678 <Comment># output files in an output format independent way. To create the layout file</Comment><br/> 0679 <Comment># that represents doxygen's defaults, run doxygen with the -l option. You can</Comment><br/> 0680 <Comment># optionally specify a file name after the option, if omitted DoxygenLayout.xml</Comment><br/> 0681 <Comment># will be used as the name of the layout file.</Comment><br/> 0682 <Comment>#</Comment><br/> 0683 <Comment># Note that if you run doxygen from a directory containing a file called</Comment><br/> 0684 <Comment># DoxygenLayout.xml, doxygen will parse it automatically even if the </Comment><KeywordInComment>LAYOUT_FILE</KeywordInComment><br/> 0685 <Comment># tag is left empty.</Comment><br/> 0686 <Error></Error><br/> 0687 <Keyword>LAYOUT_FILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0688 <Error></Error><br/> 0689 <Comment># The </Comment><KeywordInComment>CITE_BIB_FILES</KeywordInComment><Comment> tag can be used to specify one or more bib files containing</Comment><br/> 0690 <Comment># the reference definitions. This must be a list of .bib files. The .bib</Comment><br/> 0691 <Comment># extension is automatically appended if omitted. This requires the bibtex tool</Comment><br/> 0692 <Comment># to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.</Comment><br/> 0693 <Comment># For LaTeX the style of the bibliography can be controlled using</Comment><br/> 0694 <Comment># </Comment><KeywordInComment>LATEX_BIB_STYLE</KeywordInComment><Comment>. To use this feature you need bibtex and perl available in the</Comment><br/> 0695 <Comment># search path. See also \cite for info how to create references.</Comment><br/> 0696 <Error></Error><br/> 0697 <Keyword>CITE_BIB_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0698 <Error></Error><br/> 0699 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0700 <Comment># Configuration options related to warning and progress messages</Comment><br/> 0701 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0702 <Error></Error><br/> 0703 <Comment># The </Comment><KeywordInComment>QUIET</KeywordInComment><Comment> tag can be used to turn on/off the messages that are generated to</Comment><br/> 0704 <Comment># standard output by doxygen. If </Comment><KeywordInComment>QUIET</KeywordInComment><Comment> is set to YES this implies that the</Comment><br/> 0705 <Comment># messages are off.</Comment><br/> 0706 <Comment># The default value is: NO.</Comment><br/> 0707 <Error></Error><br/> 0708 <Keyword>QUIET</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0709 <Error></Error><br/> 0710 <Comment># The </Comment><KeywordInComment>WARNINGS</KeywordInComment><Comment> tag can be used to turn on/off the warning messages that are</Comment><br/> 0711 <Comment># generated to standard error (stderr) by doxygen. If </Comment><KeywordInComment>WARNINGS</KeywordInComment><Comment> is set to YES</Comment><br/> 0712 <Comment># this implies that the </Comment><KeywordInComment>warnings</KeywordInComment><Comment> are on.</Comment><br/> 0713 <Comment>#</Comment><br/> 0714 <Comment># Tip: Turn </Comment><KeywordInComment>warnings</KeywordInComment><Comment> on while writing the documentation.</Comment><br/> 0715 <Comment># The default value is: YES.</Comment><br/> 0716 <Error></Error><br/> 0717 <Keyword>WARNINGS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0718 <Error></Error><br/> 0719 <Comment># If the </Comment><KeywordInComment>WARN_IF_UNDOCUMENTED</KeywordInComment><Comment> tag is set to YES then doxygen will generate</Comment><br/> 0720 <Comment># </Comment><KeywordInComment>warnings</KeywordInComment><Comment> for undocumented members. If </Comment><KeywordInComment>EXTRACT_ALL</KeywordInComment><Comment> is set to YES then this flag</Comment><br/> 0721 <Comment># will automatically be disabled.</Comment><br/> 0722 <Comment># The default value is: YES.</Comment><br/> 0723 <Error></Error><br/> 0724 <Keyword>WARN_IF_UNDOCUMENTED</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0725 <Error></Error><br/> 0726 <Comment># If the </Comment><KeywordInComment>WARN_IF_DOC_ERROR</KeywordInComment><Comment> tag is set to YES, doxygen will generate </Comment><KeywordInComment>warnings</KeywordInComment><Comment> for</Comment><br/> 0727 <Comment># potential errors in the documentation, such as not documenting some parameters</Comment><br/> 0728 <Comment># in a documented function, or documenting parameters that don't exist or using</Comment><br/> 0729 <Comment># markup commands wrongly.</Comment><br/> 0730 <Comment># The default value is: YES.</Comment><br/> 0731 <Error></Error><br/> 0732 <Keyword>WARN_IF_DOC_ERROR</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0733 <Error></Error><br/> 0734 <Comment># This </Comment><KeywordInComment>WARN_NO_PARAMDOC</KeywordInComment><Comment> option can be enabled to get </Comment><KeywordInComment>warnings</KeywordInComment><Comment> for functions that</Comment><br/> 0735 <Comment># are documented, but have no documentation for their parameters or return</Comment><br/> 0736 <Comment># value. If set to NO, doxygen will only warn about wrong or incomplete</Comment><br/> 0737 <Comment># parameter documentation, but not about the absence of documentation.</Comment><br/> 0738 <Comment># The default value is: NO.</Comment><br/> 0739 <Error></Error><br/> 0740 <Keyword>WARN_NO_PARAMDOC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0741 <Error></Error><br/> 0742 <Comment># If the </Comment><KeywordInComment>WARN_AS_ERROR</KeywordInComment><Comment> tag is set to YES then doxygen will immediately stop when</Comment><br/> 0743 <Comment># a warning is encountered.</Comment><br/> 0744 <Comment># The default value is: NO.</Comment><br/> 0745 <Error></Error><br/> 0746 <Keyword>WARN_AS_ERROR</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0747 <Error></Error><br/> 0748 <Comment># The </Comment><KeywordInComment>WARN_FORMAT</KeywordInComment><Comment> tag determines the format of the warning messages that doxygen</Comment><br/> 0749 <Comment># can produce. The string should contain the $file, $line, and $text tags, which</Comment><br/> 0750 <Comment># will be replaced by the file and line number from which the warning originated</Comment><br/> 0751 <Comment># and the warning text. Optionally the format may contain $version, which will</Comment><br/> 0752 <Comment># be replaced by the version of the file (if it could be obtained via</Comment><br/> 0753 <Comment># </Comment><KeywordInComment>FILE_VERSION_FILTER</KeywordInComment><Comment>)</Comment><br/> 0754 <Comment># The default value is: $file:$line: $text.</Comment><br/> 0755 <Error></Error><br/> 0756 <Keyword>WARN_FORMAT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> "$file:$line: $text"</UntypedValue><br/> 0757 <Error></Error><br/> 0758 <Comment># The </Comment><KeywordInComment>WARN_LOGFILE</KeywordInComment><Comment> tag can be used to specify a file to which warning and error</Comment><br/> 0759 <Comment># messages should be written. If left blank the output is written to standard</Comment><br/> 0760 <Comment># error (stderr).</Comment><br/> 0761 <Error></Error><br/> 0762 <Keyword>WARN_LOGFILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0763 <Error></Error><br/> 0764 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0765 <Comment># Configuration options related to the </Comment><KeywordInComment>input</KeywordInComment><Comment> files</Comment><br/> 0766 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0767 <Error></Error><br/> 0768 <Comment># The </Comment><KeywordInComment>INPUT</KeywordInComment><Comment> tag is used to specify the files and/or directories that contain</Comment><br/> 0769 <Comment># documented source files. You may enter file names like myfile.cpp or</Comment><br/> 0770 <Comment># directories like /usr/src/myproject. Separate the files or directories with</Comment><br/> 0771 <Comment># spaces. See also </Comment><KeywordInComment>FILE_PATTERNS</KeywordInComment><Comment> and </Comment><KeywordInComment>EXTENSION_MAPPING</KeywordInComment><br/> 0772 <Comment># Note: If this tag is empty the current directory is searched.</Comment><br/> 0773 <Error></Error><br/> 0774 <Keyword>INPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0775 <Error></Error><br/> 0776 <Comment># This tag can be used to specify the character encoding of the source files</Comment><br/> 0777 <Comment># that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses</Comment><br/> 0778 <Comment># libiconv (or the iconv built into libc) for the transcoding. See the libiconv</Comment><br/> 0779 <Comment># documentation (see: http://www.gnu.org/software/libiconv) for the list of</Comment><br/> 0780 <Comment># possible encodings.</Comment><br/> 0781 <Comment># The default value is: UTF-8.</Comment><br/> 0782 <Error></Error><br/> 0783 <Keyword>INPUT_ENCODING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> UTF-8</UntypedValue><br/> 0784 <Error></Error><br/> 0785 <Comment># If the value of the </Comment><KeywordInComment>INPUT</KeywordInComment><Comment> tag contains directories, you can use the</Comment><br/> 0786 <Comment># </Comment><KeywordInComment>FILE_PATTERNS</KeywordInComment><Comment> tag to specify one or more wildcard patterns (like *.cpp and</Comment><br/> 0787 <Comment># *.h) to filter out the source-files in the directories.</Comment><br/> 0788 <Comment>#</Comment><br/> 0789 <Comment># Note that for custom extensions or not directly supported extensions you also</Comment><br/> 0790 <Comment># need to set </Comment><KeywordInComment>EXTENSION_MAPPING</KeywordInComment><Comment> for the extension otherwise the files are not</Comment><br/> 0791 <Comment># read by doxygen.</Comment><br/> 0792 <Comment>#</Comment><br/> 0793 <Comment># If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,</Comment><br/> 0794 <Comment># *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,</Comment><br/> 0795 <Comment># *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,</Comment><br/> 0796 <Comment># *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,</Comment><br/> 0797 <Comment># *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.</Comment><br/> 0798 <Error></Error><br/> 0799 <Keyword>FILE_PATTERNS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0800 <Error></Error><br/> 0801 <Comment># The </Comment><KeywordInComment>RECURSIVE</KeywordInComment><Comment> tag can be used to specify whether or not subdirectories should</Comment><br/> 0802 <Comment># be searched for </Comment><KeywordInComment>input</KeywordInComment><Comment> files as well.</Comment><br/> 0803 <Comment># The default value is: NO.</Comment><br/> 0804 <Error></Error><br/> 0805 <Keyword>RECURSIVE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0806 <Error></Error><br/> 0807 <Comment># The </Comment><KeywordInComment>EXCLUDE</KeywordInComment><Comment> tag can be used to specify files and/or directories that should be</Comment><br/> 0808 <Comment># excluded from the </Comment><KeywordInComment>INPUT</KeywordInComment><Comment> source files. This way you can easily </Comment><KeywordInComment>exclude</KeywordInComment><Comment> a</Comment><br/> 0809 <Comment># subdirectory from a directory tree whose root is specified with the </Comment><KeywordInComment>INPUT</KeywordInComment><Comment> tag.</Comment><br/> 0810 <Comment>#</Comment><br/> 0811 <Comment># Note that relative paths are relative to the directory from which doxygen is</Comment><br/> 0812 <Comment># run.</Comment><br/> 0813 <Error></Error><br/> 0814 <Keyword>EXCLUDE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0815 <Error></Error><br/> 0816 <Comment># The </Comment><KeywordInComment>EXCLUDE_SYMLINKS</KeywordInComment><Comment> tag can be used to select whether or not files or</Comment><br/> 0817 <Comment># directories that are symbolic links (a Unix file system feature) are excluded</Comment><br/> 0818 <Comment># from the </Comment><KeywordInComment>input</KeywordInComment><Comment>.</Comment><br/> 0819 <Comment># The default value is: NO.</Comment><br/> 0820 <Error></Error><br/> 0821 <Keyword>EXCLUDE_SYMLINKS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0822 <Error></Error><br/> 0823 <Comment># If the value of the </Comment><KeywordInComment>INPUT</KeywordInComment><Comment> tag contains directories, you can use the</Comment><br/> 0824 <Comment># </Comment><KeywordInComment>EXCLUDE_PATTERNS</KeywordInComment><Comment> tag to specify one or more wildcard patterns to </Comment><KeywordInComment>exclude</KeywordInComment><br/> 0825 <Comment># certain files from those directories.</Comment><br/> 0826 <Comment>#</Comment><br/> 0827 <Comment># Note that the wildcards are matched against the file with absolute path, so to</Comment><br/> 0828 <Comment># </Comment><KeywordInComment>exclude</KeywordInComment><Comment> all test directories for example use the pattern */test/*</Comment><br/> 0829 <Error></Error><br/> 0830 <Keyword>EXCLUDE_PATTERNS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0831 <Error></Error><br/> 0832 <Comment># The </Comment><KeywordInComment>EXCLUDE_SYMBOLS</KeywordInComment><Comment> tag can be used to specify one or more symbol names</Comment><br/> 0833 <Comment># (namespaces, classes, functions, etc.) that should be excluded from the</Comment><br/> 0834 <Comment># output. The symbol name can be a fully qualified name, a word, or if the</Comment><br/> 0835 <Comment># wildcard * is used, a substring. Examples: ANamespace, AClass,</Comment><br/> 0836 <Comment># AClass::ANamespace, ANamespace::*Test</Comment><br/> 0837 <Comment>#</Comment><br/> 0838 <Comment># Note that the wildcards are matched against the file with absolute path, so to</Comment><br/> 0839 <Comment># </Comment><KeywordInComment>exclude</KeywordInComment><Comment> all test directories use the pattern */test/*</Comment><br/> 0840 <Error></Error><br/> 0841 <Keyword>EXCLUDE_SYMBOLS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0842 <Error></Error><br/> 0843 <Comment># The </Comment><KeywordInComment>EXAMPLE_PATH</KeywordInComment><Comment> tag can be used to specify one or more files or directories</Comment><br/> 0844 <Comment># that contain example code fragments that are included (see the \include</Comment><br/> 0845 <Comment># command).</Comment><br/> 0846 <Error></Error><br/> 0847 <Keyword>EXAMPLE_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0848 <Error></Error><br/> 0849 <Comment># If the value of the </Comment><KeywordInComment>EXAMPLE_PATH</KeywordInComment><Comment> tag contains directories, you can use the</Comment><br/> 0850 <Comment># </Comment><KeywordInComment>EXAMPLE_PATTERNS</KeywordInComment><Comment> tag to specify one or more wildcard pattern (like *.cpp and</Comment><br/> 0851 <Comment># *.h) to filter out the source-files in the directories. If left blank all</Comment><br/> 0852 <Comment># files are included.</Comment><br/> 0853 <Error></Error><br/> 0854 <Keyword>EXAMPLE_PATTERNS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0855 <Error></Error><br/> 0856 <Comment># If the </Comment><KeywordInComment>EXAMPLE_RECURSIVE</KeywordInComment><Comment> tag is set to YES then subdirectories will be</Comment><br/> 0857 <Comment># searched for </Comment><KeywordInComment>input</KeywordInComment><Comment> files to be used with the \include or \dontinclude commands</Comment><br/> 0858 <Comment># irrespective of the value of the </Comment><KeywordInComment>RECURSIVE</KeywordInComment><Comment> tag.</Comment><br/> 0859 <Comment># The default value is: NO.</Comment><br/> 0860 <Error></Error><br/> 0861 <Keyword>EXAMPLE_RECURSIVE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0862 <Error></Error><br/> 0863 <Comment># The </Comment><KeywordInComment>IMAGE_PATH</KeywordInComment><Comment> tag can be used to specify one or more files or directories</Comment><br/> 0864 <Comment># that contain images that are to be included in the documentation (see the</Comment><br/> 0865 <Comment># \image command).</Comment><br/> 0866 <Error></Error><br/> 0867 <Keyword>IMAGE_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0868 <Error></Error><br/> 0869 <Comment># The </Comment><KeywordInComment>INPUT_FILTER</KeywordInComment><Comment> tag can be used to specify a program that doxygen should</Comment><br/> 0870 <Comment># invoke to filter for each </Comment><KeywordInComment>input</KeywordInComment><Comment> file. Doxygen will invoke the filter program</Comment><br/> 0871 <Comment># by executing (via popen()) the command:</Comment><br/> 0872 <Comment>#</Comment><br/> 0873 <Comment># <filter> <</Comment><KeywordInComment>input</KeywordInComment><Comment>-file></Comment><br/> 0874 <Comment>#</Comment><br/> 0875 <Comment># where <filter> is the value of the </Comment><KeywordInComment>INPUT_FILTER</KeywordInComment><Comment> tag, and <</Comment><KeywordInComment>input</KeywordInComment><Comment>-file> is the</Comment><br/> 0876 <Comment># name of an </Comment><KeywordInComment>input</KeywordInComment><Comment> file. Doxygen will then use the output that the filter</Comment><br/> 0877 <Comment># program writes to standard output. If </Comment><KeywordInComment>FILTER_PATTERNS</KeywordInComment><Comment> is specified, this tag</Comment><br/> 0878 <Comment># will be ignored.</Comment><br/> 0879 <Comment>#</Comment><br/> 0880 <Comment># Note that the filter must not add or remove lines; it is applied before the</Comment><br/> 0881 <Comment># code is scanned, but not when the output code is generated. If lines are added</Comment><br/> 0882 <Comment># or removed, the anchors will not be placed correctly.</Comment><br/> 0883 <Comment>#</Comment><br/> 0884 <Comment># Note that for custom extensions or not directly supported extensions you also</Comment><br/> 0885 <Comment># need to set </Comment><KeywordInComment>EXTENSION_MAPPING</KeywordInComment><Comment> for the extension otherwise the files are not</Comment><br/> 0886 <Comment># properly processed by doxygen.</Comment><br/> 0887 <Error></Error><br/> 0888 <Keyword>INPUT_FILTER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0889 <Error></Error><br/> 0890 <Comment># The </Comment><KeywordInComment>FILTER_PATTERNS</KeywordInComment><Comment> tag can be used to specify filters on a per file pattern</Comment><br/> 0891 <Comment># basis. Doxygen will compare the file name with each pattern and apply the</Comment><br/> 0892 <Comment># filter if there is a match. The filters are a list of the form: pattern=filter</Comment><br/> 0893 <Comment># (like *.cpp=my_cpp_filter). See </Comment><KeywordInComment>INPUT_FILTER</KeywordInComment><Comment> for further information on how</Comment><br/> 0894 <Comment># filters are used. If the </Comment><KeywordInComment>FILTER_PATTERNS</KeywordInComment><Comment> tag is empty or if none of the</Comment><br/> 0895 <Comment># patterns match the file name, </Comment><KeywordInComment>INPUT_FILTER</KeywordInComment><Comment> is applied.</Comment><br/> 0896 <Comment>#</Comment><br/> 0897 <Comment># Note that for custom extensions or not directly supported extensions you also</Comment><br/> 0898 <Comment># need to set </Comment><KeywordInComment>EXTENSION_MAPPING</KeywordInComment><Comment> for the extension otherwise the files are not</Comment><br/> 0899 <Comment># properly processed by doxygen.</Comment><br/> 0900 <Error></Error><br/> 0901 <Keyword>FILTER_PATTERNS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0902 <Error></Error><br/> 0903 <Comment># If the </Comment><KeywordInComment>FILTER_SOURCE_FILES</KeywordInComment><Comment> tag is set to YES, the </Comment><KeywordInComment>input</KeywordInComment><Comment> filter (if set using</Comment><br/> 0904 <Comment># </Comment><KeywordInComment>INPUT_FILTER</KeywordInComment><Comment>) will also be used to filter the </Comment><KeywordInComment>input</KeywordInComment><Comment> files that are used for</Comment><br/> 0905 <Comment># producing the source files to browse (i.e. when </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment> is set to YES).</Comment><br/> 0906 <Comment># The default value is: NO.</Comment><br/> 0907 <Error></Error><br/> 0908 <Keyword>FILTER_SOURCE_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0909 <Error></Error><br/> 0910 <Comment># The </Comment><KeywordInComment>FILTER_SOURCE_PATTERNS</KeywordInComment><Comment> tag can be used to specify source filters per file</Comment><br/> 0911 <Comment># pattern. A pattern will override the setting for FILTER_PATTERN (if any) and</Comment><br/> 0912 <Comment># it is also possible to disable source filtering for a specific pattern using</Comment><br/> 0913 <Comment># *.ext= (so without naming a filter).</Comment><br/> 0914 <Comment># This tag requires that the tag </Comment><KeywordInComment>FILTER_SOURCE_FILES</KeywordInComment><Comment> is set to YES.</Comment><br/> 0915 <Error></Error><br/> 0916 <Keyword>FILTER_SOURCE_PATTERNS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0917 <Error></Error><br/> 0918 <Comment># If the </Comment><KeywordInComment>USE_MDFILE_AS_MAINPAGE</KeywordInComment><Comment> tag refers to the name of a markdown file that</Comment><br/> 0919 <Comment># is part of the </Comment><KeywordInComment>input</KeywordInComment><Comment>, its contents will be placed on the main page</Comment><br/> 0920 <Comment># (index.html). This can be useful if you have a project on for instance GitHub</Comment><br/> 0921 <Comment># and want to reuse the introduction page also for the doxygen output.</Comment><br/> 0922 <Error></Error><br/> 0923 <Keyword>USE_MDFILE_AS_MAINPAGE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 0924 <Error></Error><br/> 0925 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0926 <Comment># Configuration options related to source browsing</Comment><br/> 0927 <Comment>#---------------------------------------------------------------------------</Comment><br/> 0928 <Error></Error><br/> 0929 <Comment># If the </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment> tag is set to YES then a list of source files will be</Comment><br/> 0930 <Comment># generated. Documented entities will be cross-referenced with these sources.</Comment><br/> 0931 <Comment>#</Comment><br/> 0932 <Comment># Note: To get rid of all source code in the generated output, make sure that</Comment><br/> 0933 <Comment># also </Comment><KeywordInComment>VERBATIM_HEADERS</KeywordInComment><Comment> is set to NO.</Comment><br/> 0934 <Comment># The default value is: NO.</Comment><br/> 0935 <Error></Error><br/> 0936 <Keyword>SOURCE_BROWSER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0937 <Error></Error><br/> 0938 <Comment># Setting the </Comment><KeywordInComment>INLINE_SOURCES</KeywordInComment><Comment> tag to YES will include the body of functions,</Comment><br/> 0939 <Comment># classes and enums directly into the documentation.</Comment><br/> 0940 <Comment># The default value is: NO.</Comment><br/> 0941 <Error></Error><br/> 0942 <Keyword>INLINE_SOURCES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0943 <Error></Error><br/> 0944 <Comment># Setting the </Comment><KeywordInComment>STRIP_CODE_COMMENTS</KeywordInComment><Comment> tag to YES will instruct doxygen to hide any</Comment><br/> 0945 <Comment># special comment blocks from generated source code fragments. Normal C, C++ and</Comment><br/> 0946 <Comment># Fortran comments will always remain visible.</Comment><br/> 0947 <Comment># The default value is: YES.</Comment><br/> 0948 <Error></Error><br/> 0949 <Keyword>STRIP_CODE_COMMENTS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0950 <Error></Error><br/> 0951 <Comment># If the </Comment><KeywordInComment>REFERENCED_BY_RELATION</KeywordInComment><Comment> tag is set to YES then for each documented</Comment><br/> 0952 <Comment># function all documented functions referencing it will be listed.</Comment><br/> 0953 <Comment># The default value is: NO.</Comment><br/> 0954 <Error></Error><br/> 0955 <Keyword>REFERENCED_BY_RELATION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0956 <Error></Error><br/> 0957 <Comment># If the </Comment><KeywordInComment>REFERENCES_RELATION</KeywordInComment><Comment> tag is set to YES then for each documented function</Comment><br/> 0958 <Comment># all documented entities called/used by that function will be listed.</Comment><br/> 0959 <Comment># The default value is: NO.</Comment><br/> 0960 <Error></Error><br/> 0961 <Keyword>REFERENCES_RELATION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 0962 <Error></Error><br/> 0963 <Comment># If the </Comment><KeywordInComment>REFERENCES_LINK_SOURCE</KeywordInComment><Comment> tag is set to YES and </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment> tag is set</Comment><br/> 0964 <Comment># to YES then the hyperlinks from functions in </Comment><KeywordInComment>REFERENCES_RELATION</KeywordInComment><Comment> and</Comment><br/> 0965 <Comment># </Comment><KeywordInComment>REFERENCED_BY_RELATION</KeywordInComment><Comment> lists will link to the source code. Otherwise they will</Comment><br/> 0966 <Comment># link to the documentation.</Comment><br/> 0967 <Comment># The default value is: YES.</Comment><br/> 0968 <Error></Error><br/> 0969 <Keyword>REFERENCES_LINK_SOURCE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0970 <Error></Error><br/> 0971 <Comment># If </Comment><KeywordInComment>SOURCE_TOOLTIPS</KeywordInComment><Comment> is enabled (the default) then hovering a hyperlink in the</Comment><br/> 0972 <Comment># source code will show a tooltip with additional information such as prototype,</Comment><br/> 0973 <Comment># brief description and links to the definition and documentation. Since this</Comment><br/> 0974 <Comment># will make the HTML file larger and loading of large files a bit slower, you</Comment><br/> 0975 <Comment># can opt to disable this feature.</Comment><br/> 0976 <Comment># The default value is: YES.</Comment><br/> 0977 <Comment># This tag requires that the tag </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment> is set to YES.</Comment><br/> 0978 <Error></Error><br/> 0979 <Keyword>SOURCE_TOOLTIPS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 0980 <Error></Error><br/> 0981 <Comment># If the </Comment><KeywordInComment>USE_HTAGS</KeywordInComment><Comment> tag is set to YES then the references to source code will</Comment><br/> 0982 <Comment># point to the HTML generated by the htags(1) tool instead of doxygen built-in</Comment><br/> 0983 <Comment># source browser. The htags tool is part of GNU's global source tagging system</Comment><br/> 0984 <Comment># (see http://www.gnu.org/software/global/global.html). You will need version</Comment><br/> 0985 <Comment># 4.8.6 or higher.</Comment><br/> 0986 <Comment>#</Comment><br/> 0987 <Comment># To use it do the following:</Comment><br/> 0988 <Comment># - Install the latest version of global</Comment><br/> 0989 <Comment># - Enable </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment> and </Comment><KeywordInComment>USE_HTAGS</KeywordInComment><Comment> in the config file</Comment><br/> 0990 <Comment># - Make sure the </Comment><KeywordInComment>INPUT</KeywordInComment><Comment> points to the root of the source tree</Comment><br/> 0991 <Comment># - Run doxygen as normal</Comment><br/> 0992 <Comment>#</Comment><br/> 0993 <Comment># Doxygen will invoke htags (and that will in turn invoke gtags), so these</Comment><br/> 0994 <Comment># tools must be available from the command line (i.e. in the search path).</Comment><br/> 0995 <Comment>#</Comment><br/> 0996 <Comment># The result: instead of the source browser generated by doxygen, the links to</Comment><br/> 0997 <Comment># source code will now point to the output of htags.</Comment><br/> 0998 <Comment># The default value is: NO.</Comment><br/> 0999 <Comment># This tag requires that the tag </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment> is set to YES.</Comment><br/> 1000 <Error></Error><br/> 1001 <Keyword>USE_HTAGS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1002 <Error></Error><br/> 1003 <Comment># If the </Comment><KeywordInComment>VERBATIM_HEADERS</KeywordInComment><Comment> tag is set the YES then doxygen will generate a</Comment><br/> 1004 <Comment># verbatim copy of the header file for each class for which an include is</Comment><br/> 1005 <Comment># specified. Set to NO to disable this.</Comment><br/> 1006 <Comment># See also: Section \class.</Comment><br/> 1007 <Comment># The default value is: YES.</Comment><br/> 1008 <Error></Error><br/> 1009 <Keyword>VERBATIM_HEADERS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1010 <Error></Error><br/> 1011 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1012 <Comment># Configuration options related to the alphabetical class index</Comment><br/> 1013 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1014 <Error></Error><br/> 1015 <Comment># If the </Comment><KeywordInComment>ALPHABETICAL_INDEX</KeywordInComment><Comment> tag is set to YES, an alphabetical index of all</Comment><br/> 1016 <Comment># compounds will be generated. Enable this if the project contains a lot of</Comment><br/> 1017 <Comment># classes, structs, unions or interfaces.</Comment><br/> 1018 <Comment># The default value is: YES.</Comment><br/> 1019 <Error></Error><br/> 1020 <Keyword>ALPHABETICAL_INDEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1021 <Error></Error><br/> 1022 <Comment># The </Comment><KeywordInComment>COLS_IN_ALPHA_INDEX</KeywordInComment><Comment> tag can be used to specify the number of columns in</Comment><br/> 1023 <Comment># which the alphabetical index list will be split.</Comment><br/> 1024 <Comment># Minimum value: 1, maximum value: 20, default value: 5.</Comment><br/> 1025 <Comment># This tag requires that the tag </Comment><KeywordInComment>ALPHABETICAL_INDEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1026 <Error></Error><br/> 1027 <Keyword>COLS_IN_ALPHA_INDEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 5</UntypedValue><br/> 1028 <Error></Error><br/> 1029 <Comment># In case all classes in a project start with a common prefix, all classes will</Comment><br/> 1030 <Comment># be put under the same header in the alphabetical index. The </Comment><KeywordInComment>IGNORE_PREFIX</KeywordInComment><Comment> tag</Comment><br/> 1031 <Comment># can be used to specify a prefix (or a list of prefixes) that should be ignored</Comment><br/> 1032 <Comment># while generating the index headers.</Comment><br/> 1033 <Comment># This tag requires that the tag </Comment><KeywordInComment>ALPHABETICAL_INDEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1034 <Error></Error><br/> 1035 <Keyword>IGNORE_PREFIX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1036 <Error></Error><br/> 1037 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1038 <Comment># Configuration options related to the HTML output</Comment><br/> 1039 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1040 <Error></Error><br/> 1041 <Comment># If the </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> tag is set to YES, doxygen will generate HTML output</Comment><br/> 1042 <Comment># The default value is: YES.</Comment><br/> 1043 <Error></Error><br/> 1044 <Keyword>GENERATE_HTML</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1045 <Error></Error><br/> 1046 <Comment># The </Comment><KeywordInComment>HTML_OUTPUT</KeywordInComment><Comment> tag is used to specify where the HTML docs will be put. If a</Comment><br/> 1047 <Comment># relative path is entered the value of </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> will be put in front of</Comment><br/> 1048 <Comment># it.</Comment><br/> 1049 <Comment># The default directory is: html.</Comment><br/> 1050 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1051 <Error></Error><br/> 1052 <Keyword>HTML_OUTPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> html</UntypedValue><br/> 1053 <Error></Error><br/> 1054 <Comment># The </Comment><KeywordInComment>HTML_FILE_EXTENSION</KeywordInComment><Comment> tag can be used to specify the file extension for each</Comment><br/> 1055 <Comment># generated HTML page (for example: .htm, .php, .asp).</Comment><br/> 1056 <Comment># The default value is: .html.</Comment><br/> 1057 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1058 <Error></Error><br/> 1059 <Keyword>HTML_FILE_EXTENSION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> .html</UntypedValue><br/> 1060 <Error></Error><br/> 1061 <Comment># The </Comment><KeywordInComment>HTML_HEADER</KeywordInComment><Comment> tag can be used to specify a user-defined HTML header file for</Comment><br/> 1062 <Comment># each generated HTML page. If the tag is left blank doxygen will generate a</Comment><br/> 1063 <Comment># standard header.</Comment><br/> 1064 <Comment>#</Comment><br/> 1065 <Comment># To get valid HTML the header file that includes any scripts and style sheets</Comment><br/> 1066 <Comment># that doxygen needs, which is dependent on the configuration options used (e.g.</Comment><br/> 1067 <Comment># the setting </Comment><KeywordInComment>GENERATE_TREEVIEW</KeywordInComment><Comment>). It is highly recommended to start with a</Comment><br/> 1068 <Comment># default header using</Comment><br/> 1069 <Comment># doxygen -w html new_header.html new_footer.html new_stylesheet.css</Comment><br/> 1070 <Comment># YourConfigFile</Comment><br/> 1071 <Comment># and then modify the file new_header.html. See also section "Doxygen usage"</Comment><br/> 1072 <Comment># for information on how to generate the default header that doxygen normally</Comment><br/> 1073 <Comment># uses.</Comment><br/> 1074 <Comment># Note: The header is subject to change so you typically have to regenerate the</Comment><br/> 1075 <Comment># default header when upgrading to a newer version of doxygen. For a description</Comment><br/> 1076 <Comment># of the possible markers and block names see the documentation.</Comment><br/> 1077 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1078 <Error></Error><br/> 1079 <Keyword>HTML_HEADER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1080 <Error></Error><br/> 1081 <Comment># The </Comment><KeywordInComment>HTML_FOOTER</KeywordInComment><Comment> tag can be used to specify a user-defined HTML footer for each</Comment><br/> 1082 <Comment># generated HTML page. If the tag is left blank doxygen will generate a standard</Comment><br/> 1083 <Comment># footer. See </Comment><KeywordInComment>HTML_HEADER</KeywordInComment><Comment> for more information on how to generate a default</Comment><br/> 1084 <Comment># footer and what special commands can be used inside the footer. See also</Comment><br/> 1085 <Comment># section "Doxygen usage" for information on how to generate the default footer</Comment><br/> 1086 <Comment># that doxygen normally uses.</Comment><br/> 1087 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1088 <Error></Error><br/> 1089 <Keyword>HTML_FOOTER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1090 <Error></Error><br/> 1091 <Comment># The </Comment><KeywordInComment>HTML_STYLESHEET</KeywordInComment><Comment> tag can be used to specify a user-defined cascading style</Comment><br/> 1092 <Comment># sheet that is used by each HTML page. It can be used to fine-tune the look of</Comment><br/> 1093 <Comment># the HTML output. If left blank doxygen will generate a default style sheet.</Comment><br/> 1094 <Comment># See also section "Doxygen usage" for information on how to generate the style</Comment><br/> 1095 <Comment># sheet that doxygen normally uses.</Comment><br/> 1096 <Comment># Note: It is recommended to use </Comment><KeywordInComment>HTML_EXTRA_STYLESHEET</KeywordInComment><Comment> instead of this tag, as</Comment><br/> 1097 <Comment># it is more robust and this tag (</Comment><KeywordInComment>HTML_STYLESHEET</KeywordInComment><Comment>) will in the future become</Comment><br/> 1098 <Comment># obsolete.</Comment><br/> 1099 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1100 <Error></Error><br/> 1101 <Keyword>HTML_STYLESHEET</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1102 <Error></Error><br/> 1103 <Comment># The </Comment><KeywordInComment>HTML_EXTRA_STYLESHEET</KeywordInComment><Comment> tag can be used to specify additional user-defined</Comment><br/> 1104 <Comment># cascading style sheets that are included after the standard style sheets</Comment><br/> 1105 <Comment># created by doxygen. Using this option one can overrule certain style aspects.</Comment><br/> 1106 <Comment># This is preferred over using </Comment><KeywordInComment>HTML_STYLESHEET</KeywordInComment><Comment> since it does not replace the</Comment><br/> 1107 <Comment># standard style sheet and is therefore more robust against future updates.</Comment><br/> 1108 <Comment># Doxygen will copy the style sheet files to the output directory.</Comment><br/> 1109 <Comment># Note: The order of the extra style sheet files is of importance (e.g. the last</Comment><br/> 1110 <Comment># style sheet in the list overrules the setting of the previous ones in the</Comment><br/> 1111 <Comment># list). For an example see the documentation.</Comment><br/> 1112 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1113 <Error></Error><br/> 1114 <Keyword>HTML_EXTRA_STYLESHEET</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1115 <Error></Error><br/> 1116 <Comment># The </Comment><KeywordInComment>HTML_EXTRA_FILES</KeywordInComment><Comment> tag can be used to specify one or more extra images or</Comment><br/> 1117 <Comment># other source files which should be copied to the HTML output directory. Note</Comment><br/> 1118 <Comment># that these files will be copied to the base HTML output directory. Use the</Comment><br/> 1119 <Comment># $relpath^ marker in the </Comment><KeywordInComment>HTML_HEADER</KeywordInComment><Comment> and/or </Comment><KeywordInComment>HTML_FOOTER</KeywordInComment><Comment> files to load these</Comment><br/> 1120 <Comment># files. In the </Comment><KeywordInComment>HTML_STYLESHEET</KeywordInComment><Comment> file, use the file name only. Also note that the</Comment><br/> 1121 <Comment># files will be copied as-is; there are no commands or markers available.</Comment><br/> 1122 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1123 <Error></Error><br/> 1124 <Keyword>HTML_EXTRA_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1125 <Error></Error><br/> 1126 <Comment># The </Comment><KeywordInComment>HTML_COLORSTYLE_HUE</KeywordInComment><Comment> tag controls the color of the HTML output. Doxygen</Comment><br/> 1127 <Comment># will adjust the colors in the style sheet and background images according to</Comment><br/> 1128 <Comment># this color. Hue is specified as an angle on a colorwheel, see</Comment><br/> 1129 <Comment># http://en.wikipedia.org/wiki/Hue for more information. For instance the value</Comment><br/> 1130 <Comment># 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300</Comment><br/> 1131 <Comment># purple, and 360 is red again.</Comment><br/> 1132 <Comment># Minimum value: 0, maximum value: 359, default value: 220.</Comment><br/> 1133 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1134 <Error></Error><br/> 1135 <Keyword>HTML_COLORSTYLE_HUE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 220</UntypedValue><br/> 1136 <Error></Error><br/> 1137 <Comment># The </Comment><KeywordInComment>HTML_COLORSTYLE_SAT</KeywordInComment><Comment> tag controls the purity (or saturation) of the colors</Comment><br/> 1138 <Comment># in the HTML output. For a value of 0 the output will use grayscales only. A</Comment><br/> 1139 <Comment># value of 255 will produce the most vivid colors.</Comment><br/> 1140 <Comment># Minimum value: 0, maximum value: 255, default value: 100.</Comment><br/> 1141 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1142 <Error></Error><br/> 1143 <Keyword>HTML_COLORSTYLE_SAT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 100</UntypedValue><br/> 1144 <Error></Error><br/> 1145 <Comment># The </Comment><KeywordInComment>HTML_COLORSTYLE_GAMMA</KeywordInComment><Comment> tag controls the gamma correction applied to the</Comment><br/> 1146 <Comment># luminance component of the colors in the HTML output. Values below 100</Comment><br/> 1147 <Comment># gradually make the output lighter, whereas values above 100 make the output</Comment><br/> 1148 <Comment># darker. The value divided by 100 is the actual gamma applied, so 80 represents</Comment><br/> 1149 <Comment># a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not</Comment><br/> 1150 <Comment># change the gamma.</Comment><br/> 1151 <Comment># Minimum value: 40, maximum value: 240, default value: 80.</Comment><br/> 1152 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1153 <Error></Error><br/> 1154 <Keyword>HTML_COLORSTYLE_GAMMA</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 80</UntypedValue><br/> 1155 <Error></Error><br/> 1156 <Comment># If the </Comment><KeywordInComment>HTML_TIMESTAMP</KeywordInComment><Comment> tag is set to YES then the footer of each generated HTML</Comment><br/> 1157 <Comment># page will contain the date and time when the page was generated. Setting this</Comment><br/> 1158 <Comment># to YES can help to show when doxygen was last run and thus if the</Comment><br/> 1159 <Comment># documentation is up to date.</Comment><br/> 1160 <Comment># The default value is: NO.</Comment><br/> 1161 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1162 <Error></Error><br/> 1163 <Keyword>HTML_TIMESTAMP</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1164 <Error></Error><br/> 1165 <Comment># If the </Comment><KeywordInComment>HTML_DYNAMIC_SECTIONS</KeywordInComment><Comment> tag is set to YES then the generated HTML</Comment><br/> 1166 <Comment># documentation will contain sections that can be hidden and shown after the</Comment><br/> 1167 <Comment># page has loaded.</Comment><br/> 1168 <Comment># The default value is: NO.</Comment><br/> 1169 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1170 <Error></Error><br/> 1171 <Keyword>HTML_DYNAMIC_SECTIONS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1172 <Error></Error><br/> 1173 <Comment># With </Comment><KeywordInComment>HTML_INDEX_NUM_ENTRIES</KeywordInComment><Comment> one can control the preferred number of entries</Comment><br/> 1174 <Comment># shown in the various tree structured indices initially; the user can expand</Comment><br/> 1175 <Comment># and collapse entries dynamically later on. Doxygen will expand the tree to</Comment><br/> 1176 <Comment># such a level that at most the specified number of entries are visible (unless</Comment><br/> 1177 <Comment># a fully collapsed tree already exceeds this amount). So setting the number of</Comment><br/> 1178 <Comment># entries 1 will produce a full collapsed tree by default. 0 is a special value</Comment><br/> 1179 <Comment># representing an infinite number of entries and will result in a full expanded</Comment><br/> 1180 <Comment># tree by default.</Comment><br/> 1181 <Comment># Minimum value: 0, maximum value: 9999, default value: 100.</Comment><br/> 1182 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1183 <Error></Error><br/> 1184 <Keyword>HTML_INDEX_NUM_ENTRIES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 100</UntypedValue><br/> 1185 <Error></Error><br/> 1186 <Comment># If the </Comment><KeywordInComment>GENERATE_DOCSET</KeywordInComment><Comment> tag is set to YES, additional index files will be</Comment><br/> 1187 <Comment># generated that can be used as </Comment><KeywordInComment>input</KeywordInComment><Comment> for Apple's Xcode 3 integrated development</Comment><br/> 1188 <Comment># environment (see: http://developer.apple.com/tools/xcode/), introduced with</Comment><br/> 1189 <Comment># OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a</Comment><br/> 1190 <Comment># Makefile in the HTML output directory. Running make will produce the docset in</Comment><br/> 1191 <Comment># that directory and running make install will install the docset in</Comment><br/> 1192 <Comment># ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at</Comment><br/> 1193 <Comment># startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html</Comment><br/> 1194 <Comment># for more information.</Comment><br/> 1195 <Comment># The default value is: NO.</Comment><br/> 1196 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1197 <Error></Error><br/> 1198 <Keyword>GENERATE_DOCSET</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1199 <Error></Error><br/> 1200 <Comment># This tag determines the name of the docset feed. A documentation feed provides</Comment><br/> 1201 <Comment># an umbrella under which multiple documentation sets from a single provider</Comment><br/> 1202 <Comment># (such as a company or product suite) can be grouped.</Comment><br/> 1203 <Comment># The default value is: Doxygen generated docs.</Comment><br/> 1204 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_DOCSET</KeywordInComment><Comment> is set to YES.</Comment><br/> 1205 <Error></Error><br/> 1206 <Keyword>DOCSET_FEEDNAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> "Doxygen generated docs"</UntypedValue><br/> 1207 <Error></Error><br/> 1208 <Comment># This tag specifies a string that should uniquely identify the documentation</Comment><br/> 1209 <Comment># set bundle. This should be a reverse domain-name style string, e.g.</Comment><br/> 1210 <Comment># com.mycompany.MyDocSet. Doxygen will append .docset to the name.</Comment><br/> 1211 <Comment># The default value is: org.doxygen.Project.</Comment><br/> 1212 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_DOCSET</KeywordInComment><Comment> is set to YES.</Comment><br/> 1213 <Error></Error><br/> 1214 <Keyword>DOCSET_BUNDLE_ID</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> org.doxygen.Project</UntypedValue><br/> 1215 <Error></Error><br/> 1216 <Comment># The </Comment><KeywordInComment>DOCSET_PUBLISHER_ID</KeywordInComment><Comment> tag specifies a string that should uniquely identify</Comment><br/> 1217 <Comment># the documentation publisher. This should be a reverse domain-name style</Comment><br/> 1218 <Comment># string, e.g. com.mycompany.MyDocSet.documentation.</Comment><br/> 1219 <Comment># The default value is: org.doxygen.Publisher.</Comment><br/> 1220 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_DOCSET</KeywordInComment><Comment> is set to YES.</Comment><br/> 1221 <Error></Error><br/> 1222 <Keyword>DOCSET_PUBLISHER_ID</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> org.doxygen.Publisher</UntypedValue><br/> 1223 <Error></Error><br/> 1224 <Comment># The </Comment><KeywordInComment>DOCSET_PUBLISHER_NAME</KeywordInComment><Comment> tag identifies the documentation publisher.</Comment><br/> 1225 <Comment># The default value is: Publisher.</Comment><br/> 1226 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_DOCSET</KeywordInComment><Comment> is set to YES.</Comment><br/> 1227 <Error></Error><br/> 1228 <Keyword>DOCSET_PUBLISHER_NAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> Publisher</UntypedValue><br/> 1229 <Error></Error><br/> 1230 <Comment># If the </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> tag is set to YES then doxygen generates three</Comment><br/> 1231 <Comment># additional HTML index files: index.hhp, index.hhc, and index.hhk. The</Comment><br/> 1232 <Comment># index.hhp is a project file that can be read by Microsoft's HTML Help Workshop</Comment><br/> 1233 <Comment># (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on</Comment><br/> 1234 <Comment># Windows.</Comment><br/> 1235 <Comment>#</Comment><br/> 1236 <Comment># The HTML Help Workshop contains a compiler that can convert all HTML output</Comment><br/> 1237 <Comment># generated by doxygen into a single compiled HTML file (.chm). Compiled HTML</Comment><br/> 1238 <Comment># files are now used as the Windows 98 help format, and will replace the old</Comment><br/> 1239 <Comment># Windows help format (.hlp) on all Windows platforms in the future. Compressed</Comment><br/> 1240 <Comment># HTML files also contain an index, a table of contents, and you can search for</Comment><br/> 1241 <Comment># words in the documentation. The HTML workshop also contains a viewer for</Comment><br/> 1242 <Comment># compressed HTML files.</Comment><br/> 1243 <Comment># The default value is: NO.</Comment><br/> 1244 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1245 <Error></Error><br/> 1246 <Keyword>GENERATE_HTMLHELP</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1247 <Error></Error><br/> 1248 <Comment># The </Comment><KeywordInComment>CHM_FILE</KeywordInComment><Comment> tag can be used to specify the file name of the resulting .chm</Comment><br/> 1249 <Comment># file. You can add a path in front of the file if the result should not be</Comment><br/> 1250 <Comment># written to the html output directory.</Comment><br/> 1251 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1252 <Error></Error><br/> 1253 <Keyword>CHM_FILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1254 <Error></Error><br/> 1255 <Comment># The </Comment><KeywordInComment>HHC_LOCATION</KeywordInComment><Comment> tag can be used to specify the location (absolute path</Comment><br/> 1256 <Comment># including file name) of the HTML help compiler (hhc.exe). If non-empty,</Comment><br/> 1257 <Comment># doxygen will try to run the HTML help compiler on the generated index.hhp.</Comment><br/> 1258 <Comment># The file has to be specified with full path.</Comment><br/> 1259 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1260 <Error></Error><br/> 1261 <Keyword>HHC_LOCATION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1262 <Error></Error><br/> 1263 <Comment># The </Comment><KeywordInComment>GENERATE_CHI</KeywordInComment><Comment> flag controls if a separate .chi index file is generated</Comment><br/> 1264 <Comment># (YES) or that it should be included in the master .chm file (NO).</Comment><br/> 1265 <Comment># The default value is: NO.</Comment><br/> 1266 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1267 <Error></Error><br/> 1268 <Keyword>GENERATE_CHI</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1269 <Error></Error><br/> 1270 <Comment># The </Comment><KeywordInComment>CHM_INDEX_ENCODING</KeywordInComment><Comment> is used to encode HtmlHelp index (hhk), content (hhc)</Comment><br/> 1271 <Comment># and project file content.</Comment><br/> 1272 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1273 <Error></Error><br/> 1274 <Keyword>CHM_INDEX_ENCODING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1275 <Error></Error><br/> 1276 <Comment># The </Comment><KeywordInComment>BINARY_TOC</KeywordInComment><Comment> flag controls whether a binary table of contents is generated</Comment><br/> 1277 <Comment># (YES) or a normal table of contents (NO) in the .chm file. Furthermore it</Comment><br/> 1278 <Comment># enables the Previous and Next buttons.</Comment><br/> 1279 <Comment># The default value is: NO.</Comment><br/> 1280 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1281 <Error></Error><br/> 1282 <Keyword>BINARY_TOC</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1283 <Error></Error><br/> 1284 <Comment># The </Comment><KeywordInComment>TOC_EXPAND</KeywordInComment><Comment> flag can be set to YES to add extra items for group members to</Comment><br/> 1285 <Comment># the table of contents of the HTML help documentation and to the tree view.</Comment><br/> 1286 <Comment># The default value is: NO.</Comment><br/> 1287 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1288 <Error></Error><br/> 1289 <Keyword>TOC_EXPAND</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1290 <Error></Error><br/> 1291 <Comment># If the </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> tag is set to YES and both </Comment><KeywordInComment>QHP_NAMESPACE</KeywordInComment><Comment> and</Comment><br/> 1292 <Comment># </Comment><KeywordInComment>QHP_VIRTUAL_FOLDER</KeywordInComment><Comment> are set, an additional index file will be generated that</Comment><br/> 1293 <Comment># can be used as </Comment><KeywordInComment>input</KeywordInComment><Comment> for Qt's qhelpgenerator to generate a Qt Compressed Help</Comment><br/> 1294 <Comment># (.qch) of the generated HTML documentation.</Comment><br/> 1295 <Comment># The default value is: NO.</Comment><br/> 1296 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1297 <Error></Error><br/> 1298 <Keyword>GENERATE_QHP</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1299 <Error></Error><br/> 1300 <Comment># If the </Comment><KeywordInComment>QHG_LOCATION</KeywordInComment><Comment> tag is specified, the </Comment><KeywordInComment>QCH_FILE</KeywordInComment><Comment> tag can be used to specify</Comment><br/> 1301 <Comment># the file name of the resulting .qch file. The path specified is relative to</Comment><br/> 1302 <Comment># the HTML output folder.</Comment><br/> 1303 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1304 <Error></Error><br/> 1305 <Keyword>QCH_FILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1306 <Error></Error><br/> 1307 <Comment># The </Comment><KeywordInComment>QHP_NAMESPACE</KeywordInComment><Comment> tag specifies the namespace to use when generating Qt Help</Comment><br/> 1308 <Comment># Project output. For more information please see Qt Help Project / Namespace</Comment><br/> 1309 <Comment># (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).</Comment><br/> 1310 <Comment># The default value is: org.doxygen.Project.</Comment><br/> 1311 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1312 <Error></Error><br/> 1313 <Keyword>QHP_NAMESPACE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> org.doxygen.Project</UntypedValue><br/> 1314 <Error></Error><br/> 1315 <Comment># The </Comment><KeywordInComment>QHP_VIRTUAL_FOLDER</KeywordInComment><Comment> tag specifies the namespace to use when generating Qt</Comment><br/> 1316 <Comment># Help Project output. For more information please see Qt Help Project / Virtual</Comment><br/> 1317 <Comment># Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-</Comment><br/> 1318 <Comment># folders).</Comment><br/> 1319 <Comment># The default value is: doc.</Comment><br/> 1320 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1321 <Error></Error><br/> 1322 <Keyword>QHP_VIRTUAL_FOLDER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> doc</UntypedValue><br/> 1323 <Error></Error><br/> 1324 <Comment># If the </Comment><KeywordInComment>QHP_CUST_FILTER_NAME</KeywordInComment><Comment> tag is set, it specifies the name of a custom</Comment><br/> 1325 <Comment># filter to add. For more information please see Qt Help Project / Custom</Comment><br/> 1326 <Comment># Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-</Comment><br/> 1327 <Comment># filters).</Comment><br/> 1328 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1329 <Error></Error><br/> 1330 <Keyword>QHP_CUST_FILTER_NAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1331 <Error></Error><br/> 1332 <Comment># The </Comment><KeywordInComment>QHP_CUST_FILTER_ATTRS</KeywordInComment><Comment> tag specifies the list of the attributes of the</Comment><br/> 1333 <Comment># custom filter to add. For more information please see Qt Help Project / Custom</Comment><br/> 1334 <Comment># Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-</Comment><br/> 1335 <Comment># filters).</Comment><br/> 1336 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1337 <Error></Error><br/> 1338 <Keyword>QHP_CUST_FILTER_ATTRS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1339 <Error></Error><br/> 1340 <Comment># The </Comment><KeywordInComment>QHP_SECT_FILTER_ATTRS</KeywordInComment><Comment> tag specifies the list of the attributes this</Comment><br/> 1341 <Comment># project's filter section matches. Qt Help Project / Filter Attributes (see:</Comment><br/> 1342 <Comment># http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).</Comment><br/> 1343 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1344 <Error></Error><br/> 1345 <Keyword>QHP_SECT_FILTER_ATTRS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1346 <Error></Error><br/> 1347 <Comment># The </Comment><KeywordInComment>QHG_LOCATION</KeywordInComment><Comment> tag can be used to specify the location of Qt's</Comment><br/> 1348 <Comment># qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the</Comment><br/> 1349 <Comment># generated .qhp file.</Comment><br/> 1350 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1351 <Error></Error><br/> 1352 <Keyword>QHG_LOCATION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1353 <Error></Error><br/> 1354 <Comment># If the </Comment><KeywordInComment>GENERATE_ECLIPSEHELP</KeywordInComment><Comment> tag is set to YES, additional index files will be</Comment><br/> 1355 <Comment># generated, together with the HTML files, they form an Eclipse help plugin. To</Comment><br/> 1356 <Comment># install this plugin and make it available under the help contents menu in</Comment><br/> 1357 <Comment># Eclipse, the contents of the directory containing the HTML and XML files needs</Comment><br/> 1358 <Comment># to be copied into the plugins directory of eclipse. The name of the directory</Comment><br/> 1359 <Comment># within the plugins directory should be the same as the </Comment><KeywordInComment>ECLIPSE_DOC_ID</KeywordInComment><Comment> value.</Comment><br/> 1360 <Comment># After copying Eclipse needs to be restarted before the help appears.</Comment><br/> 1361 <Comment># The default value is: NO.</Comment><br/> 1362 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1363 <Error></Error><br/> 1364 <Keyword>GENERATE_ECLIPSEHELP</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1365 <Error></Error><br/> 1366 <Comment># A unique identifier for the Eclipse help plugin. When installing the plugin</Comment><br/> 1367 <Comment># the directory name containing the HTML and XML files should also have this</Comment><br/> 1368 <Comment># name. Each documentation set should have its own identifier.</Comment><br/> 1369 <Comment># The default value is: org.doxygen.Project.</Comment><br/> 1370 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_ECLIPSEHELP</KeywordInComment><Comment> is set to YES.</Comment><br/> 1371 <Error></Error><br/> 1372 <Keyword>ECLIPSE_DOC_ID</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> org.doxygen.Project</UntypedValue><br/> 1373 <Error></Error><br/> 1374 <Comment># If you want full control over the layout of the generated HTML pages it might</Comment><br/> 1375 <Comment># be necessary to disable the index and replace it with your own. The</Comment><br/> 1376 <Comment># </Comment><KeywordInComment>DISABLE_INDEX</KeywordInComment><Comment> tag can be used to turn on/off the condensed index (tabs) at top</Comment><br/> 1377 <Comment># of each HTML page. A value of NO enables the index and the value YES disables</Comment><br/> 1378 <Comment># it. Since the tabs in the index contain the same information as the navigation</Comment><br/> 1379 <Comment># tree, you can set this option to YES if you also set </Comment><KeywordInComment>GENERATE_TREEVIEW</KeywordInComment><Comment> to YES.</Comment><br/> 1380 <Comment># The default value is: NO.</Comment><br/> 1381 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1382 <Error></Error><br/> 1383 <Keyword>DISABLE_INDEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1384 <Error></Error><br/> 1385 <Comment># The </Comment><KeywordInComment>GENERATE_TREEVIEW</KeywordInComment><Comment> tag is used to specify whether a tree-like index</Comment><br/> 1386 <Comment># structure should be generated to display hierarchical information. If the tag</Comment><br/> 1387 <Comment># value is set to YES, a side panel will be generated containing a tree-like</Comment><br/> 1388 <Comment># index structure (just like the one that is generated for HTML Help). For this</Comment><br/> 1389 <Comment># to work a browser that supports JavaScript, DHTML, CSS and frames is required</Comment><br/> 1390 <Comment># (i.e. any modern browser). Windows users are probably better off using the</Comment><br/> 1391 <Comment># HTML help feature. Via custom style sheets (see </Comment><KeywordInComment>HTML_EXTRA_STYLESHEET</KeywordInComment><Comment>) one can</Comment><br/> 1392 <Comment># further fine-tune the look of the index. As an example, the default style</Comment><br/> 1393 <Comment># sheet generated by doxygen has an example that shows how to put an image at</Comment><br/> 1394 <Comment># the root of the tree instead of the </Comment><KeywordInComment>PROJECT_NAME</KeywordInComment><Comment>. Since the tree basically has</Comment><br/> 1395 <Comment># the same information as the tab index, you could consider setting</Comment><br/> 1396 <Comment># </Comment><KeywordInComment>DISABLE_INDEX</KeywordInComment><Comment> to YES when enabling this option.</Comment><br/> 1397 <Comment># The default value is: NO.</Comment><br/> 1398 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1399 <Error></Error><br/> 1400 <Keyword>GENERATE_TREEVIEW</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1401 <Error></Error><br/> 1402 <Comment># The </Comment><KeywordInComment>ENUM_VALUES_PER_LINE</KeywordInComment><Comment> tag can be used to set the number of enum values that</Comment><br/> 1403 <Comment># doxygen will group on one line in the generated HTML documentation.</Comment><br/> 1404 <Comment>#</Comment><br/> 1405 <Comment># Note that a value of 0 will completely suppress the enum values from appearing</Comment><br/> 1406 <Comment># in the overview section.</Comment><br/> 1407 <Comment># Minimum value: 0, maximum value: 20, default value: 4.</Comment><br/> 1408 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1409 <Error></Error><br/> 1410 <Keyword>ENUM_VALUES_PER_LINE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 4</UntypedValue><br/> 1411 <Error></Error><br/> 1412 <Comment># If the treeview is enabled (see </Comment><KeywordInComment>GENERATE_TREEVIEW</KeywordInComment><Comment>) then this tag can be used</Comment><br/> 1413 <Comment># to set the initial width (in pixels) of the frame in which the tree is shown.</Comment><br/> 1414 <Comment># Minimum value: 0, maximum value: 1500, default value: 250.</Comment><br/> 1415 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1416 <Error></Error><br/> 1417 <Keyword>TREEVIEW_WIDTH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 250</UntypedValue><br/> 1418 <Error></Error><br/> 1419 <Comment># If the </Comment><KeywordInComment>EXT_LINKS_IN_WINDOW</KeywordInComment><Comment> option is set to YES, doxygen will open links to</Comment><br/> 1420 <Comment># external symbols imported via tag files in a separate window.</Comment><br/> 1421 <Comment># The default value is: NO.</Comment><br/> 1422 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1423 <Error></Error><br/> 1424 <Keyword>EXT_LINKS_IN_WINDOW</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1425 <Error></Error><br/> 1426 <Comment># Use this tag to change the font size of LaTeX formulas included as images in</Comment><br/> 1427 <Comment># the HTML documentation. When you change the font size after a successful</Comment><br/> 1428 <Comment># doxygen run you need to manually remove any form_*.png images from the HTML</Comment><br/> 1429 <Comment># output directory to force them to be regenerated.</Comment><br/> 1430 <Comment># Minimum value: 8, maximum value: 50, default value: 10.</Comment><br/> 1431 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1432 <Error></Error><br/> 1433 <Keyword>FORMULA_FONTSIZE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 10</UntypedValue><br/> 1434 <Error></Error><br/> 1435 <Comment># Use the FORMULA_TRANPARENT tag to determine whether or not the images</Comment><br/> 1436 <Comment># generated for formulas are transparent PNGs. Transparent PNGs are not</Comment><br/> 1437 <Comment># supported properly for IE 6.0, but are supported on all modern browsers.</Comment><br/> 1438 <Comment>#</Comment><br/> 1439 <Comment># Note that when changing this option you need to delete any form_*.png files in</Comment><br/> 1440 <Comment># the HTML output directory before the changes have effect.</Comment><br/> 1441 <Comment># The default value is: YES.</Comment><br/> 1442 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1443 <Error></Error><br/> 1444 <Keyword>FORMULA_TRANSPARENT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1445 <Error></Error><br/> 1446 <Comment># Enable the </Comment><KeywordInComment>USE_MATHJAX</KeywordInComment><Comment> option to render LaTeX formulas using MathJax (see</Comment><br/> 1447 <Comment># http://www.mathjax.org) which uses client side Javascript for the rendering</Comment><br/> 1448 <Comment># instead of using pre-rendered bitmaps. Use this if you do not have LaTeX</Comment><br/> 1449 <Comment># installed or if you want to formulas look prettier in the HTML output. When</Comment><br/> 1450 <Comment># enabled you may also need to install MathJax separately and configure the path</Comment><br/> 1451 <Comment># to it using the </Comment><KeywordInComment>MATHJAX_RELPATH</KeywordInComment><Comment> option.</Comment><br/> 1452 <Comment># The default value is: NO.</Comment><br/> 1453 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1454 <Error></Error><br/> 1455 <Keyword>USE_MATHJAX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1456 <Error></Error><br/> 1457 <Comment># When MathJax is enabled you can set the default output format to be used for</Comment><br/> 1458 <Comment># the MathJax output. See the MathJax site (see:</Comment><br/> 1459 <Comment># http://docs.mathjax.org/en/latest/output.html) for more details.</Comment><br/> 1460 <Comment># Possible values are: HTML-CSS (which is slower, but has the best</Comment><br/> 1461 <Comment># compatibility), NativeMML (i.e. MathML) and SVG.</Comment><br/> 1462 <Comment># The default value is: HTML-CSS.</Comment><br/> 1463 <Comment># This tag requires that the tag </Comment><KeywordInComment>USE_MATHJAX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1464 <Error></Error><br/> 1465 <Keyword>MATHJAX_FORMAT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> HTML-CSS</UntypedValue><br/> 1466 <Error></Error><br/> 1467 <Comment># When MathJax is enabled you need to specify the location relative to the HTML</Comment><br/> 1468 <Comment># output directory using the </Comment><KeywordInComment>MATHJAX_RELPATH</KeywordInComment><Comment> option. The destination directory</Comment><br/> 1469 <Comment># should contain the MathJax.js script. For instance, if the mathjax directory</Comment><br/> 1470 <Comment># is located at the same level as the HTML output directory, then</Comment><br/> 1471 <Comment># </Comment><KeywordInComment>MATHJAX_RELPATH</KeywordInComment><Comment> should be ../mathjax. The default value points to the MathJax</Comment><br/> 1472 <Comment># Content Delivery Network so you can quickly see the result without installing</Comment><br/> 1473 <Comment># MathJax. However, it is strongly recommended to install a local copy of</Comment><br/> 1474 <Comment># MathJax from http://www.mathjax.org before deployment.</Comment><br/> 1475 <Comment># The default value is: http://cdn.mathjax.org/mathjax/latest.</Comment><br/> 1476 <Comment># This tag requires that the tag </Comment><KeywordInComment>USE_MATHJAX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1477 <Error></Error><br/> 1478 <Keyword>MATHJAX_RELPATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> http://cdn.mathjax.org/mathjax/latest</UntypedValue><br/> 1479 <Error></Error><br/> 1480 <Comment># The </Comment><KeywordInComment>MATHJAX_EXTENSIONS</KeywordInComment><Comment> tag can be used to specify one or more MathJax</Comment><br/> 1481 <Comment># extension names that should be enabled during MathJax rendering. For example</Comment><br/> 1482 <Comment># </Comment><KeywordInComment>MATHJAX_EXTENSIONS</KeywordInComment><Comment> = TeX/AMSmath TeX/AMSsymbols</Comment><br/> 1483 <Comment># This tag requires that the tag </Comment><KeywordInComment>USE_MATHJAX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1484 <Error></Error><br/> 1485 <Keyword>MATHJAX_EXTENSIONS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1486 <Error></Error><br/> 1487 <Comment># The </Comment><KeywordInComment>MATHJAX_CODEFILE</KeywordInComment><Comment> tag can be used to specify a file with javascript pieces</Comment><br/> 1488 <Comment># of code that will be used on startup of the MathJax code. See the MathJax site</Comment><br/> 1489 <Comment># (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an</Comment><br/> 1490 <Comment># example see the documentation.</Comment><br/> 1491 <Comment># This tag requires that the tag </Comment><KeywordInComment>USE_MATHJAX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1492 <Error></Error><br/> 1493 <Keyword>MATHJAX_CODEFILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1494 <Error></Error><br/> 1495 <Comment># When the </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> tag is enabled doxygen will generate a search box for</Comment><br/> 1496 <Comment># the HTML output. The underlying search engine uses javascript and DHTML and</Comment><br/> 1497 <Comment># should work on any modern browser. Note that when using HTML help</Comment><br/> 1498 <Comment># (</Comment><KeywordInComment>GENERATE_HTMLHELP</KeywordInComment><Comment>), Qt help (</Comment><KeywordInComment>GENERATE_QHP</KeywordInComment><Comment>), or docsets (</Comment><KeywordInComment>GENERATE_DOCSET</KeywordInComment><Comment>)</Comment><br/> 1499 <Comment># there is already a search function so this one should typically be disabled.</Comment><br/> 1500 <Comment># For large projects the javascript based search engine can be slow, then</Comment><br/> 1501 <Comment># enabling </Comment><KeywordInComment>SERVER_BASED_SEARCH</KeywordInComment><Comment> may provide a better solution. It is possible to</Comment><br/> 1502 <Comment># search using the keyboard; to jump to the search box use <access key> + S</Comment><br/> 1503 <Comment># (what the <access key> is depends on the OS and browser, but it is typically</Comment><br/> 1504 <Comment># <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down</Comment><br/> 1505 <Comment># key> to jump into the search results window, the results can be navigated</Comment><br/> 1506 <Comment># using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel</Comment><br/> 1507 <Comment># the search. The filter options can be selected when the cursor is inside the</Comment><br/> 1508 <Comment># search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys></Comment><br/> 1509 <Comment># to select a filter and <Enter> or <escape> to activate or cancel the filter</Comment><br/> 1510 <Comment># option.</Comment><br/> 1511 <Comment># The default value is: YES.</Comment><br/> 1512 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_HTML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1513 <Error></Error><br/> 1514 <Keyword>SEARCHENGINE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1515 <Error></Error><br/> 1516 <Comment># When the </Comment><KeywordInComment>SERVER_BASED_SEARCH</KeywordInComment><Comment> tag is enabled the search engine will be</Comment><br/> 1517 <Comment># implemented using a web server instead of a web client using Javascript. There</Comment><br/> 1518 <Comment># are two flavors of web server based searching depending on the </Comment><KeywordInComment>EXTERNAL_SEARCH</KeywordInComment><br/> 1519 <Comment># setting. When disabled, doxygen will generate a PHP script for searching and</Comment><br/> 1520 <Comment># an index file used by the script. When </Comment><KeywordInComment>EXTERNAL_SEARCH</KeywordInComment><Comment> is enabled the indexing</Comment><br/> 1521 <Comment># and searching needs to be provided by external tools. See the section</Comment><br/> 1522 <Comment># "External Indexing and Searching" for details.</Comment><br/> 1523 <Comment># The default value is: NO.</Comment><br/> 1524 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> is set to YES.</Comment><br/> 1525 <Error></Error><br/> 1526 <Keyword>SERVER_BASED_SEARCH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1527 <Error></Error><br/> 1528 <Comment># When </Comment><KeywordInComment>EXTERNAL_SEARCH</KeywordInComment><Comment> tag is enabled doxygen will no longer generate the PHP</Comment><br/> 1529 <Comment># script for searching. Instead the search results are written to an XML file</Comment><br/> 1530 <Comment># which needs to be processed by an external indexer. Doxygen will invoke an</Comment><br/> 1531 <Comment># external search engine pointed to by the </Comment><KeywordInComment>SEARCHENGINE_URL</KeywordInComment><Comment> option to obtain the</Comment><br/> 1532 <Comment># search results.</Comment><br/> 1533 <Comment>#</Comment><br/> 1534 <Comment># Doxygen ships with an example indexer (doxyindexer) and search engine</Comment><br/> 1535 <Comment># (doxysearch.cgi) which are based on the open source search engine library</Comment><br/> 1536 <Comment># Xapian (see: http://xapian.org/).</Comment><br/> 1537 <Comment>#</Comment><br/> 1538 <Comment># See the section "External Indexing and Searching" for details.</Comment><br/> 1539 <Comment># The default value is: NO.</Comment><br/> 1540 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> is set to YES.</Comment><br/> 1541 <Error></Error><br/> 1542 <Keyword>EXTERNAL_SEARCH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1543 <Error></Error><br/> 1544 <Comment># The </Comment><KeywordInComment>SEARCHENGINE_URL</KeywordInComment><Comment> should point to a search engine hosted by a web server</Comment><br/> 1545 <Comment># which will return the search results when </Comment><KeywordInComment>EXTERNAL_SEARCH</KeywordInComment><Comment> is enabled.</Comment><br/> 1546 <Comment>#</Comment><br/> 1547 <Comment># Doxygen ships with an example indexer (doxyindexer) and search engine</Comment><br/> 1548 <Comment># (doxysearch.cgi) which are based on the open source search engine library</Comment><br/> 1549 <Comment># Xapian (see: http://xapian.org/). See the section "External Indexing and</Comment><br/> 1550 <Comment># Searching" for details.</Comment><br/> 1551 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> is set to YES.</Comment><br/> 1552 <Error></Error><br/> 1553 <Keyword>SEARCHENGINE_URL</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1554 <Error></Error><br/> 1555 <Comment># When </Comment><KeywordInComment>SERVER_BASED_SEARCH</KeywordInComment><Comment> and </Comment><KeywordInComment>EXTERNAL_SEARCH</KeywordInComment><Comment> are both enabled the unindexed</Comment><br/> 1556 <Comment># search data is written to a file for indexing by an external tool. With the</Comment><br/> 1557 <Comment># </Comment><KeywordInComment>SEARCHDATA_FILE</KeywordInComment><Comment> tag the name of this file can be specified.</Comment><br/> 1558 <Comment># The default file is: searchdata.xml.</Comment><br/> 1559 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> is set to YES.</Comment><br/> 1560 <Error></Error><br/> 1561 <Keyword>SEARCHDATA_FILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> searchdata.xml</UntypedValue><br/> 1562 <Error></Error><br/> 1563 <Comment># When </Comment><KeywordInComment>SERVER_BASED_SEARCH</KeywordInComment><Comment> and </Comment><KeywordInComment>EXTERNAL_SEARCH</KeywordInComment><Comment> are both enabled the</Comment><br/> 1564 <Comment># </Comment><KeywordInComment>EXTERNAL_SEARCH_ID</KeywordInComment><Comment> tag can be used as an identifier for the project. This is</Comment><br/> 1565 <Comment># useful in combination with </Comment><KeywordInComment>EXTRA_SEARCH_MAPPINGS</KeywordInComment><Comment> to search through multiple</Comment><br/> 1566 <Comment># projects and redirect the results back to the right project.</Comment><br/> 1567 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> is set to YES.</Comment><br/> 1568 <Error></Error><br/> 1569 <Keyword>EXTERNAL_SEARCH_ID</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1570 <Error></Error><br/> 1571 <Comment># The </Comment><KeywordInComment>EXTRA_SEARCH_MAPPINGS</KeywordInComment><Comment> tag can be used to enable searching through doxygen</Comment><br/> 1572 <Comment># projects other than the one defined by this configuration file, but that are</Comment><br/> 1573 <Comment># all added to the same external search index. Each project needs to have a</Comment><br/> 1574 <Comment># unique id set via </Comment><KeywordInComment>EXTERNAL_SEARCH_ID</KeywordInComment><Comment>. The search mapping then maps the id of</Comment><br/> 1575 <Comment># to a relative location where the documentation can be found. The format is:</Comment><br/> 1576 <Comment># </Comment><KeywordInComment>EXTRA_SEARCH_MAPPINGS</KeywordInComment><Comment> = tagname1=loc1 tagname2=loc2 ...</Comment><br/> 1577 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCHENGINE</KeywordInComment><Comment> is set to YES.</Comment><br/> 1578 <Error></Error><br/> 1579 <Keyword>EXTRA_SEARCH_MAPPINGS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1580 <Error></Error><br/> 1581 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1582 <Comment># Configuration options related to the LaTeX output</Comment><br/> 1583 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1584 <Error></Error><br/> 1585 <Comment># If the </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> tag is set to YES, doxygen will generate LaTeX output.</Comment><br/> 1586 <Comment># The default value is: YES.</Comment><br/> 1587 <Error></Error><br/> 1588 <Keyword>GENERATE_LATEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1589 <Error></Error><br/> 1590 <Comment># The </Comment><KeywordInComment>LATEX_OUTPUT</KeywordInComment><Comment> tag is used to specify where the LaTeX docs will be put. If a</Comment><br/> 1591 <Comment># relative path is entered the value of </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> will be put in front of</Comment><br/> 1592 <Comment># it.</Comment><br/> 1593 <Comment># The default directory is: latex.</Comment><br/> 1594 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1595 <Error></Error><br/> 1596 <Keyword>LATEX_OUTPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> latex</UntypedValue><br/> 1597 <Error></Error><br/> 1598 <Comment># The </Comment><KeywordInComment>LATEX_CMD_NAME</KeywordInComment><Comment> tag can be used to specify the LaTeX command name to be</Comment><br/> 1599 <Comment># invoked.</Comment><br/> 1600 <Comment>#</Comment><br/> 1601 <Comment># Note that when enabling </Comment><KeywordInComment>USE_PDFLATEX</KeywordInComment><Comment> this option is only used for generating</Comment><br/> 1602 <Comment># bitmaps for formulas in the HTML output, but not in the Makefile that is</Comment><br/> 1603 <Comment># written to the output directory.</Comment><br/> 1604 <Comment># The default file is: latex.</Comment><br/> 1605 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1606 <Error></Error><br/> 1607 <Keyword>LATEX_CMD_NAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> latex</UntypedValue><br/> 1608 <Error></Error><br/> 1609 <Comment># The </Comment><KeywordInComment>MAKEINDEX_CMD_NAME</KeywordInComment><Comment> tag can be used to specify the command name to generate</Comment><br/> 1610 <Comment># index for LaTeX.</Comment><br/> 1611 <Comment># The default file is: makeindex.</Comment><br/> 1612 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1613 <Error></Error><br/> 1614 <Keyword>MAKEINDEX_CMD_NAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> makeindex</UntypedValue><br/> 1615 <Error></Error><br/> 1616 <Comment># If the </Comment><KeywordInComment>COMPACT_LATEX</KeywordInComment><Comment> tag is set to YES, doxygen generates more compact LaTeX</Comment><br/> 1617 <Comment># documents. This may be useful for small projects and may help to save some</Comment><br/> 1618 <Comment># trees in general.</Comment><br/> 1619 <Comment># The default value is: NO.</Comment><br/> 1620 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1621 <Error></Error><br/> 1622 <Keyword>COMPACT_LATEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1623 <Error></Error><br/> 1624 <Comment># The </Comment><KeywordInComment>PAPER_TYPE</KeywordInComment><Comment> tag can be used to set the paper type that is used by the</Comment><br/> 1625 <Comment># printer.</Comment><br/> 1626 <Comment># Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x</Comment><br/> 1627 <Comment># 14 inches) and executive (7.25 x 10.5 inches).</Comment><br/> 1628 <Comment># The default value is: a4.</Comment><br/> 1629 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1630 <Error></Error><br/> 1631 <Keyword>PAPER_TYPE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> a4</UntypedValue><br/> 1632 <Error></Error><br/> 1633 <Comment># The </Comment><KeywordInComment>EXTRA_PACKAGES</KeywordInComment><Comment> tag can be used to specify one or more LaTeX package names</Comment><br/> 1634 <Comment># that should be included in the LaTeX output. The package can be specified just</Comment><br/> 1635 <Comment># by its name or with the correct syntax as to be used with the LaTeX</Comment><br/> 1636 <Comment># \usepackage command. To get the times font for instance you can specify :</Comment><br/> 1637 <Comment># </Comment><KeywordInComment>EXTRA_PACKAGES</KeywordInComment><Comment>=times or </Comment><KeywordInComment>EXTRA_PACKAGES</KeywordInComment><Comment>={times}</Comment><br/> 1638 <Comment># To use the option intlimits with the amsmath package you can specify:</Comment><br/> 1639 <Comment># </Comment><KeywordInComment>EXTRA_PACKAGES</KeywordInComment><Comment>=[intlimits]{amsmath}</Comment><br/> 1640 <Comment># If left blank no extra packages will be included.</Comment><br/> 1641 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1642 <Error></Error><br/> 1643 <Keyword>EXTRA_PACKAGES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1644 <Error></Error><br/> 1645 <Comment># The </Comment><KeywordInComment>LATEX_HEADER</KeywordInComment><Comment> tag can be used to specify a personal LaTeX header for the</Comment><br/> 1646 <Comment># generated LaTeX document. The header should contain everything until the first</Comment><br/> 1647 <Comment># chapter. If it is left blank doxygen will generate a standard header. See</Comment><br/> 1648 <Comment># section "Doxygen usage" for information on how to let doxygen write the</Comment><br/> 1649 <Comment># default header to a separate file.</Comment><br/> 1650 <Comment>#</Comment><br/> 1651 <Comment># Note: Only use a user-defined header if you know what you are doing! The</Comment><br/> 1652 <Comment># following commands have a special meaning inside the header: $title,</Comment><br/> 1653 <Comment># $datetime, $date, $doxygenversion, $projectname, $projectnumber,</Comment><br/> 1654 <Comment># $projectbrief, $projectlogo. Doxygen will replace $title with the empty</Comment><br/> 1655 <Comment># string, for the replacement values of the other commands the user is referred</Comment><br/> 1656 <Comment># to </Comment><KeywordInComment>HTML_HEADER</KeywordInComment><Comment>.</Comment><br/> 1657 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1658 <Error></Error><br/> 1659 <Keyword>LATEX_HEADER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1660 <Error></Error><br/> 1661 <Comment># The </Comment><KeywordInComment>LATEX_FOOTER</KeywordInComment><Comment> tag can be used to specify a personal LaTeX footer for the</Comment><br/> 1662 <Comment># generated LaTeX document. The footer should contain everything after the last</Comment><br/> 1663 <Comment># chapter. If it is left blank doxygen will generate a standard footer. See</Comment><br/> 1664 <Comment># </Comment><KeywordInComment>LATEX_HEADER</KeywordInComment><Comment> for more information on how to generate a default footer and what</Comment><br/> 1665 <Comment># special commands can be used inside the footer.</Comment><br/> 1666 <Comment>#</Comment><br/> 1667 <Comment># Note: Only use a user-defined footer if you know what you are doing!</Comment><br/> 1668 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1669 <Error></Error><br/> 1670 <Keyword>LATEX_FOOTER</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1671 <Error></Error><br/> 1672 <Comment># The </Comment><KeywordInComment>LATEX_EXTRA_STYLESHEET</KeywordInComment><Comment> tag can be used to specify additional user-defined</Comment><br/> 1673 <Comment># LaTeX style sheets that are included after the standard style sheets created</Comment><br/> 1674 <Comment># by doxygen. Using this option one can overrule certain style aspects. Doxygen</Comment><br/> 1675 <Comment># will copy the style sheet files to the output directory.</Comment><br/> 1676 <Comment># Note: The order of the extra style sheet files is of importance (e.g. the last</Comment><br/> 1677 <Comment># style sheet in the list overrules the setting of the previous ones in the</Comment><br/> 1678 <Comment># list).</Comment><br/> 1679 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1680 <Error></Error><br/> 1681 <Keyword>LATEX_EXTRA_STYLESHEET</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1682 <Error></Error><br/> 1683 <Comment># The </Comment><KeywordInComment>LATEX_EXTRA_FILES</KeywordInComment><Comment> tag can be used to specify one or more extra images or</Comment><br/> 1684 <Comment># other source files which should be copied to the </Comment><KeywordInComment>LATEX_OUTPUT</KeywordInComment><Comment> output</Comment><br/> 1685 <Comment># directory. Note that the files will be copied as-is; there are no commands or</Comment><br/> 1686 <Comment># markers available.</Comment><br/> 1687 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1688 <Error></Error><br/> 1689 <Keyword>LATEX_EXTRA_FILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1690 <Error></Error><br/> 1691 <Comment># If the </Comment><KeywordInComment>PDF_HYPERLINKS</KeywordInComment><Comment> tag is set to YES, the LaTeX that is generated is</Comment><br/> 1692 <Comment># prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will</Comment><br/> 1693 <Comment># contain links (just like the HTML output) instead of page references. This</Comment><br/> 1694 <Comment># makes the output suitable for online browsing using a PDF viewer.</Comment><br/> 1695 <Comment># The default value is: YES.</Comment><br/> 1696 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1697 <Error></Error><br/> 1698 <Keyword>PDF_HYPERLINKS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1699 <Error></Error><br/> 1700 <Comment># If the </Comment><KeywordInComment>USE_PDFLATEX</KeywordInComment><Comment> tag is set to YES, doxygen will use pdflatex to generate</Comment><br/> 1701 <Comment># the PDF file directly from the LaTeX files. Set this option to YES, to get a</Comment><br/> 1702 <Comment># higher quality PDF documentation.</Comment><br/> 1703 <Comment># The default value is: YES.</Comment><br/> 1704 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1705 <Error></Error><br/> 1706 <Keyword>USE_PDFLATEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1707 <Error></Error><br/> 1708 <Comment># If the </Comment><KeywordInComment>LATEX_BATCHMODE</KeywordInComment><Comment> tag is set to YES, doxygen will add the \batchmode</Comment><br/> 1709 <Comment># command to the generated LaTeX files. This will instruct LaTeX to keep running</Comment><br/> 1710 <Comment># if errors occur, instead of asking the user for help. This option is also used</Comment><br/> 1711 <Comment># when generating formulas in HTML.</Comment><br/> 1712 <Comment># The default value is: NO.</Comment><br/> 1713 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1714 <Error></Error><br/> 1715 <Keyword>LATEX_BATCHMODE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1716 <Error></Error><br/> 1717 <Comment># If the </Comment><KeywordInComment>LATEX_HIDE_INDICES</KeywordInComment><Comment> tag is set to YES then doxygen will not include the</Comment><br/> 1718 <Comment># index chapters (such as File Index, Compound Index, etc.) in the output.</Comment><br/> 1719 <Comment># The default value is: NO.</Comment><br/> 1720 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1721 <Error></Error><br/> 1722 <Keyword>LATEX_HIDE_INDICES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1723 <Error></Error><br/> 1724 <Comment># If the </Comment><KeywordInComment>LATEX_SOURCE_CODE</KeywordInComment><Comment> tag is set to YES then doxygen will include source</Comment><br/> 1725 <Comment># code with syntax highlighting in the LaTeX output.</Comment><br/> 1726 <Comment>#</Comment><br/> 1727 <Comment># Note that which sources are shown also depends on other settings such as</Comment><br/> 1728 <Comment># </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment>.</Comment><br/> 1729 <Comment># The default value is: NO.</Comment><br/> 1730 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1731 <Error></Error><br/> 1732 <Keyword>LATEX_SOURCE_CODE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1733 <Error></Error><br/> 1734 <Comment># The </Comment><KeywordInComment>LATEX_BIB_STYLE</KeywordInComment><Comment> tag can be used to specify the style to use for the</Comment><br/> 1735 <Comment># bibliography, e.g. plainnat, or ieeetr. See</Comment><br/> 1736 <Comment># http://en.wikipedia.org/wiki/BibTeX and \cite for more info.</Comment><br/> 1737 <Comment># The default value is: plain.</Comment><br/> 1738 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1739 <Error></Error><br/> 1740 <Keyword>LATEX_BIB_STYLE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> plain</UntypedValue><br/> 1741 <Error></Error><br/> 1742 <Comment># If the </Comment><KeywordInComment>LATEX_TIMESTAMP</KeywordInComment><Comment> tag is set to YES then the footer of each generated</Comment><br/> 1743 <Comment># page will contain the date and time when the page was generated. Setting this</Comment><br/> 1744 <Comment># to NO can help when comparing the output of multiple runs.</Comment><br/> 1745 <Comment># The default value is: NO.</Comment><br/> 1746 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_LATEX</KeywordInComment><Comment> is set to YES.</Comment><br/> 1747 <Error></Error><br/> 1748 <Keyword>LATEX_TIMESTAMP</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1749 <Error></Error><br/> 1750 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1751 <Comment># Configuration options related to the RTF output</Comment><br/> 1752 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1753 <Error></Error><br/> 1754 <Comment># If the </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> tag is set to YES, doxygen will generate RTF output. The</Comment><br/> 1755 <Comment># RTF output is optimized for Word 97 and may not look too pretty with other RTF</Comment><br/> 1756 <Comment># readers/editors.</Comment><br/> 1757 <Comment># The default value is: NO.</Comment><br/> 1758 <Error></Error><br/> 1759 <Keyword>GENERATE_RTF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1760 <Error></Error><br/> 1761 <Comment># The </Comment><KeywordInComment>RTF_OUTPUT</KeywordInComment><Comment> tag is used to specify where the RTF docs will be put. If a</Comment><br/> 1762 <Comment># relative path is entered the value of </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> will be put in front of</Comment><br/> 1763 <Comment># it.</Comment><br/> 1764 <Comment># The default directory is: rtf.</Comment><br/> 1765 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> is set to YES.</Comment><br/> 1766 <Error></Error><br/> 1767 <Keyword>RTF_OUTPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> rtf</UntypedValue><br/> 1768 <Error></Error><br/> 1769 <Comment># If the </Comment><KeywordInComment>COMPACT_RTF</KeywordInComment><Comment> tag is set to YES, doxygen generates more compact RTF</Comment><br/> 1770 <Comment># documents. This may be useful for small projects and may help to save some</Comment><br/> 1771 <Comment># trees in general.</Comment><br/> 1772 <Comment># The default value is: NO.</Comment><br/> 1773 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> is set to YES.</Comment><br/> 1774 <Error></Error><br/> 1775 <Keyword>COMPACT_RTF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1776 <Error></Error><br/> 1777 <Comment># If the </Comment><KeywordInComment>RTF_HYPERLINKS</KeywordInComment><Comment> tag is set to YES, the RTF that is generated will</Comment><br/> 1778 <Comment># contain hyperlink fields. The RTF file will contain links (just like the HTML</Comment><br/> 1779 <Comment># output) instead of page references. This makes the output suitable for online</Comment><br/> 1780 <Comment># browsing using Word or some other Word compatible readers that support those</Comment><br/> 1781 <Comment># fields.</Comment><br/> 1782 <Comment>#</Comment><br/> 1783 <Comment># Note: WordPad (write) and others do not support links.</Comment><br/> 1784 <Comment># The default value is: NO.</Comment><br/> 1785 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> is set to YES.</Comment><br/> 1786 <Error></Error><br/> 1787 <Keyword>RTF_HYPERLINKS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1788 <Error></Error><br/> 1789 <Comment># Load stylesheet definitions from file. Syntax is similar to doxygen's config</Comment><br/> 1790 <Comment># file, i.e. a series of assignments. You only have to provide replacements,</Comment><br/> 1791 <Comment># missing definitions are set to their default value.</Comment><br/> 1792 <Comment>#</Comment><br/> 1793 <Comment># See also section "Doxygen usage" for information on how to generate the</Comment><br/> 1794 <Comment># default style sheet that doxygen normally uses.</Comment><br/> 1795 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> is set to YES.</Comment><br/> 1796 <Error></Error><br/> 1797 <Keyword>RTF_STYLESHEET_FILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1798 <Error></Error><br/> 1799 <Comment># Set optional variables used in the generation of an RTF document. Syntax is</Comment><br/> 1800 <Comment># similar to doxygen's config file. A template extensions file can be generated</Comment><br/> 1801 <Comment># using doxygen -e rtf extensionFile.</Comment><br/> 1802 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> is set to YES.</Comment><br/> 1803 <Error></Error><br/> 1804 <Keyword>RTF_EXTENSIONS_FILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1805 <Error></Error><br/> 1806 <Comment># If the </Comment><KeywordInComment>RTF_SOURCE_CODE</KeywordInComment><Comment> tag is set to YES then doxygen will include source code</Comment><br/> 1807 <Comment># with syntax highlighting in the RTF output.</Comment><br/> 1808 <Comment>#</Comment><br/> 1809 <Comment># Note that which sources are shown also depends on other settings such as</Comment><br/> 1810 <Comment># </Comment><KeywordInComment>SOURCE_BROWSER</KeywordInComment><Comment>.</Comment><br/> 1811 <Comment># The default value is: NO.</Comment><br/> 1812 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_RTF</KeywordInComment><Comment> is set to YES.</Comment><br/> 1813 <Error></Error><br/> 1814 <Keyword>RTF_SOURCE_CODE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1815 <Error></Error><br/> 1816 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1817 <Comment># Configuration options related to the man page output</Comment><br/> 1818 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1819 <Error></Error><br/> 1820 <Comment># If the </Comment><KeywordInComment>GENERATE_MAN</KeywordInComment><Comment> tag is set to YES, doxygen will generate man pages for</Comment><br/> 1821 <Comment># classes and files.</Comment><br/> 1822 <Comment># The default value is: NO.</Comment><br/> 1823 <Error></Error><br/> 1824 <Keyword>GENERATE_MAN</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1825 <Error></Error><br/> 1826 <Comment># The </Comment><KeywordInComment>MAN_OUTPUT</KeywordInComment><Comment> tag is used to specify where the man pages will be put. If a</Comment><br/> 1827 <Comment># relative path is entered the value of </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> will be put in front of</Comment><br/> 1828 <Comment># it. A directory man3 will be created inside the directory specified by</Comment><br/> 1829 <Comment># </Comment><KeywordInComment>MAN_OUTPUT</KeywordInComment><Comment>.</Comment><br/> 1830 <Comment># The default directory is: man.</Comment><br/> 1831 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_MAN</KeywordInComment><Comment> is set to YES.</Comment><br/> 1832 <Error></Error><br/> 1833 <Keyword>MAN_OUTPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> man</UntypedValue><br/> 1834 <Error></Error><br/> 1835 <Comment># The </Comment><KeywordInComment>MAN_EXTENSION</KeywordInComment><Comment> tag determines the extension that is added to the generated</Comment><br/> 1836 <Comment># man pages. In case the manual section does not start with a number, the number</Comment><br/> 1837 <Comment># 3 is prepended. The dot (.) at the beginning of the </Comment><KeywordInComment>MAN_EXTENSION</KeywordInComment><Comment> tag is</Comment><br/> 1838 <Comment># optional.</Comment><br/> 1839 <Comment># The default value is: .3.</Comment><br/> 1840 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_MAN</KeywordInComment><Comment> is set to YES.</Comment><br/> 1841 <Error></Error><br/> 1842 <Keyword>MAN_EXTENSION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> .3</UntypedValue><br/> 1843 <Error></Error><br/> 1844 <Comment># The </Comment><KeywordInComment>MAN_SUBDIR</KeywordInComment><Comment> tag determines the name of the directory created within</Comment><br/> 1845 <Comment># </Comment><KeywordInComment>MAN_OUTPUT</KeywordInComment><Comment> in which the man pages are placed. If defaults to man followed by</Comment><br/> 1846 <Comment># </Comment><KeywordInComment>MAN_EXTENSION</KeywordInComment><Comment> with the initial . removed.</Comment><br/> 1847 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_MAN</KeywordInComment><Comment> is set to YES.</Comment><br/> 1848 <Error></Error><br/> 1849 <Keyword>MAN_SUBDIR</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1850 <Error></Error><br/> 1851 <Comment># If the </Comment><KeywordInComment>MAN_LINKS</KeywordInComment><Comment> tag is set to YES and doxygen generates man output, then it</Comment><br/> 1852 <Comment># will generate one additional man file for each entity documented in the real</Comment><br/> 1853 <Comment># man page(s). These additional files only source the real man page, but without</Comment><br/> 1854 <Comment># them the man command would be unable to find the correct page.</Comment><br/> 1855 <Comment># The default value is: NO.</Comment><br/> 1856 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_MAN</KeywordInComment><Comment> is set to YES.</Comment><br/> 1857 <Error></Error><br/> 1858 <Keyword>MAN_LINKS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1859 <Error></Error><br/> 1860 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1861 <Comment># Configuration options related to the XML output</Comment><br/> 1862 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1863 <Error></Error><br/> 1864 <Comment># If the </Comment><KeywordInComment>GENERATE_XML</KeywordInComment><Comment> tag is set to YES, doxygen will generate an XML file that</Comment><br/> 1865 <Comment># captures the structure of the code including all documentation.</Comment><br/> 1866 <Comment># The default value is: NO.</Comment><br/> 1867 <Error></Error><br/> 1868 <Keyword>GENERATE_XML</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1869 <Error></Error><br/> 1870 <Comment># The </Comment><KeywordInComment>XML_OUTPUT</KeywordInComment><Comment> tag is used to specify where the XML pages will be put. If a</Comment><br/> 1871 <Comment># relative path is entered the value of </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> will be put in front of</Comment><br/> 1872 <Comment># it.</Comment><br/> 1873 <Comment># The default directory is: xml.</Comment><br/> 1874 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_XML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1875 <Error></Error><br/> 1876 <Keyword>XML_OUTPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> xml</UntypedValue><br/> 1877 <Error></Error><br/> 1878 <Comment># If the </Comment><KeywordInComment>XML_PROGRAMLISTING</KeywordInComment><Comment> tag is set to YES, doxygen will dump the program</Comment><br/> 1879 <Comment># listings (including syntax highlighting and cross-referencing information) to</Comment><br/> 1880 <Comment># the XML output. Note that enabling this will significantly increase the size</Comment><br/> 1881 <Comment># of the XML output.</Comment><br/> 1882 <Comment># The default value is: YES.</Comment><br/> 1883 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_XML</KeywordInComment><Comment> is set to YES.</Comment><br/> 1884 <Error></Error><br/> 1885 <Keyword>XML_PROGRAMLISTING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1886 <Error></Error><br/> 1887 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1888 <Comment># Configuration options related to the DOCBOOK output</Comment><br/> 1889 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1890 <Error></Error><br/> 1891 <Comment># If the </Comment><KeywordInComment>GENERATE_DOCBOOK</KeywordInComment><Comment> tag is set to YES, doxygen will generate Docbook files</Comment><br/> 1892 <Comment># that can be used to generate PDF.</Comment><br/> 1893 <Comment># The default value is: NO.</Comment><br/> 1894 <Error></Error><br/> 1895 <Keyword>GENERATE_DOCBOOK</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1896 <Error></Error><br/> 1897 <Comment># The </Comment><KeywordInComment>DOCBOOK_OUTPUT</KeywordInComment><Comment> tag is used to specify where the Docbook pages will be put.</Comment><br/> 1898 <Comment># If a relative path is entered the value of </Comment><KeywordInComment>OUTPUT_DIRECTORY</KeywordInComment><Comment> will be put in</Comment><br/> 1899 <Comment># front of it.</Comment><br/> 1900 <Comment># The default directory is: docbook.</Comment><br/> 1901 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_DOCBOOK</KeywordInComment><Comment> is set to YES.</Comment><br/> 1902 <Error></Error><br/> 1903 <Keyword>DOCBOOK_OUTPUT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> docbook</UntypedValue><br/> 1904 <Error></Error><br/> 1905 <Comment># If the </Comment><KeywordInComment>DOCBOOK_PROGRAMLISTING</KeywordInComment><Comment> tag is set to YES, doxygen will include the</Comment><br/> 1906 <Comment># program listings (including syntax highlighting and cross-referencing</Comment><br/> 1907 <Comment># information) to the DOCBOOK output. Note that enabling this will significantly</Comment><br/> 1908 <Comment># increase the size of the DOCBOOK output.</Comment><br/> 1909 <Comment># The default value is: NO.</Comment><br/> 1910 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_DOCBOOK</KeywordInComment><Comment> is set to YES.</Comment><br/> 1911 <Error></Error><br/> 1912 <Keyword>DOCBOOK_PROGRAMLISTING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1913 <Error></Error><br/> 1914 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1915 <Comment># Configuration options for the AutoGen Definitions output</Comment><br/> 1916 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1917 <Error></Error><br/> 1918 <Comment># If the </Comment><KeywordInComment>GENERATE_AUTOGEN_DEF</KeywordInComment><Comment> tag is set to YES, doxygen will generate an</Comment><br/> 1919 <Comment># AutoGen Definitions (see http://autogen.sf.net) file that captures the</Comment><br/> 1920 <Comment># structure of the code including all documentation. Note that this feature is</Comment><br/> 1921 <Comment># still experimental and incomplete at the moment.</Comment><br/> 1922 <Comment># The default value is: NO.</Comment><br/> 1923 <Error></Error><br/> 1924 <Keyword>GENERATE_AUTOGEN_DEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1925 <Error></Error><br/> 1926 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1927 <Comment># Configuration options related to the Perl module output</Comment><br/> 1928 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1929 <Error></Error><br/> 1930 <Comment># If the </Comment><KeywordInComment>GENERATE_PERLMOD</KeywordInComment><Comment> tag is set to YES, doxygen will generate a Perl module</Comment><br/> 1931 <Comment># file that captures the structure of the code including all documentation.</Comment><br/> 1932 <Comment>#</Comment><br/> 1933 <Comment># Note that this feature is still experimental and incomplete at the moment.</Comment><br/> 1934 <Comment># The default value is: NO.</Comment><br/> 1935 <Error></Error><br/> 1936 <Keyword>GENERATE_PERLMOD</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1937 <Error></Error><br/> 1938 <Comment># If the </Comment><KeywordInComment>PERLMOD_LATEX</KeywordInComment><Comment> tag is set to YES, doxygen will generate the necessary</Comment><br/> 1939 <Comment># Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI</Comment><br/> 1940 <Comment># output from the Perl module output.</Comment><br/> 1941 <Comment># The default value is: NO.</Comment><br/> 1942 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_PERLMOD</KeywordInComment><Comment> is set to YES.</Comment><br/> 1943 <Error></Error><br/> 1944 <Keyword>PERLMOD_LATEX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1945 <Error></Error><br/> 1946 <Comment># If the </Comment><KeywordInComment>PERLMOD_PRETTY</KeywordInComment><Comment> tag is set to YES, the Perl module output will be nicely</Comment><br/> 1947 <Comment># formatted so it can be parsed by a human reader. This is useful if you want to</Comment><br/> 1948 <Comment># understand what is going on. On the other hand, if this tag is set to NO, the</Comment><br/> 1949 <Comment># size of the Perl module output will be much smaller and Perl will parse it</Comment><br/> 1950 <Comment># just the same.</Comment><br/> 1951 <Comment># The default value is: YES.</Comment><br/> 1952 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_PERLMOD</KeywordInComment><Comment> is set to YES.</Comment><br/> 1953 <Error></Error><br/> 1954 <Keyword>PERLMOD_PRETTY</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1955 <Error></Error><br/> 1956 <Comment># The names of the make variables in the generated doxyrules.make file are</Comment><br/> 1957 <Comment># prefixed with the string contained in </Comment><KeywordInComment>PERLMOD_MAKEVAR_PREFIX</KeywordInComment><Comment>. This is useful</Comment><br/> 1958 <Comment># so different doxyrules.make files included by the same Makefile don't</Comment><br/> 1959 <Comment># overwrite each other's variables.</Comment><br/> 1960 <Comment># This tag requires that the tag </Comment><KeywordInComment>GENERATE_PERLMOD</KeywordInComment><Comment> is set to YES.</Comment><br/> 1961 <Error></Error><br/> 1962 <Keyword>PERLMOD_MAKEVAR_PREFIX</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 1963 <Error></Error><br/> 1964 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1965 <Comment># Configuration options related to the preprocessor</Comment><br/> 1966 <Comment>#---------------------------------------------------------------------------</Comment><br/> 1967 <Error></Error><br/> 1968 <Comment># If the </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> tag is set to YES, doxygen will evaluate all</Comment><br/> 1969 <Comment># C-preprocessor directives found in the sources and include files.</Comment><br/> 1970 <Comment># The default value is: YES.</Comment><br/> 1971 <Error></Error><br/> 1972 <Keyword>ENABLE_PREPROCESSING</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1973 <Error></Error><br/> 1974 <Comment># If the </Comment><KeywordInComment>MACRO_EXPANSION</KeywordInComment><Comment> tag is set to YES, doxygen will expand all macro names</Comment><br/> 1975 <Comment># in the source code. If set to NO, only conditional compilation will be</Comment><br/> 1976 <Comment># performed. Macro expansion can be done in a controlled way by setting</Comment><br/> 1977 <Comment># </Comment><KeywordInComment>EXPAND_ONLY_PREDEF</KeywordInComment><Comment> to YES.</Comment><br/> 1978 <Comment># The default value is: NO.</Comment><br/> 1979 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 1980 <Error></Error><br/> 1981 <Keyword>MACRO_EXPANSION</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1982 <Error></Error><br/> 1983 <Comment># If the </Comment><KeywordInComment>EXPAND_ONLY_PREDEF</KeywordInComment><Comment> and </Comment><KeywordInComment>MACRO_EXPANSION</KeywordInComment><Comment> tags are both set to YES then</Comment><br/> 1984 <Comment># the macro expansion is limited to the macros specified with the </Comment><KeywordInComment>PREDEFINED</KeywordInComment><Comment> and</Comment><br/> 1985 <Comment># </Comment><KeywordInComment>EXPAND_AS_DEFINED</KeywordInComment><Comment> tags.</Comment><br/> 1986 <Comment># The default value is: NO.</Comment><br/> 1987 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 1988 <Error></Error><br/> 1989 <Keyword>EXPAND_ONLY_PREDEF</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 1990 <Error></Error><br/> 1991 <Comment># If the </Comment><KeywordInComment>SEARCH_INCLUDES</KeywordInComment><Comment> tag is set to YES, the include files in the</Comment><br/> 1992 <Comment># </Comment><KeywordInComment>INCLUDE_PATH</KeywordInComment><Comment> will be searched if a #include is found.</Comment><br/> 1993 <Comment># The default value is: YES.</Comment><br/> 1994 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 1995 <Error></Error><br/> 1996 <Keyword>SEARCH_INCLUDES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 1997 <Error></Error><br/> 1998 <Comment># The </Comment><KeywordInComment>INCLUDE_PATH</KeywordInComment><Comment> tag can be used to specify one or more directories that</Comment><br/> 1999 <Comment># contain include files that are not </Comment><KeywordInComment>input</KeywordInComment><Comment> files but should be processed by the</Comment><br/> 2000 <Comment># preprocessor.</Comment><br/> 2001 <Comment># This tag requires that the tag </Comment><KeywordInComment>SEARCH_INCLUDES</KeywordInComment><Comment> is set to YES.</Comment><br/> 2002 <Error></Error><br/> 2003 <Keyword>INCLUDE_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2004 <Error></Error><br/> 2005 <Comment># You can use the </Comment><KeywordInComment>INCLUDE_FILE_PATTERNS</KeywordInComment><Comment> tag to specify one or more wildcard</Comment><br/> 2006 <Comment># patterns (like *.h and *.hpp) to filter out the header-files in the</Comment><br/> 2007 <Comment># directories. If left blank, the patterns specified with </Comment><KeywordInComment>FILE_PATTERNS</KeywordInComment><Comment> will be</Comment><br/> 2008 <Comment># used.</Comment><br/> 2009 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 2010 <Error></Error><br/> 2011 <Keyword>INCLUDE_FILE_PATTERNS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2012 <Error></Error><br/> 2013 <Comment># The </Comment><KeywordInComment>PREDEFINED</KeywordInComment><Comment> tag can be used to specify one or more macro names that are</Comment><br/> 2014 <Comment># defined before the preprocessor is started (similar to the -D option of e.g.</Comment><br/> 2015 <Comment># gcc). The argument of the tag is a list of macros of the form: name or</Comment><br/> 2016 <Comment># name=definition (no spaces). If the definition and the "=" are omitted, "=1"</Comment><br/> 2017 <Comment># is assumed. To prevent a macro definition from being undefined via #undef or</Comment><br/> 2018 <Comment># recursively expanded use the := operator instead of the = operator.</Comment><br/> 2019 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 2020 <Error></Error><br/> 2021 <Keyword>PREDEFINED</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2022 <Error></Error><br/> 2023 <Comment># If the </Comment><KeywordInComment>MACRO_EXPANSION</KeywordInComment><Comment> and </Comment><KeywordInComment>EXPAND_ONLY_PREDEF</KeywordInComment><Comment> tags are set to YES then this</Comment><br/> 2024 <Comment># tag can be used to specify a list of macro names that should be expanded. The</Comment><br/> 2025 <Comment># macro definition that is found in the sources will be used. Use the </Comment><KeywordInComment>PREDEFINED</KeywordInComment><br/> 2026 <Comment># tag if you want to use a different macro definition that overrules the</Comment><br/> 2027 <Comment># definition found in the source code.</Comment><br/> 2028 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 2029 <Error></Error><br/> 2030 <Keyword>EXPAND_AS_DEFINED</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2031 <Error></Error><br/> 2032 <Comment># If the </Comment><KeywordInComment>SKIP_FUNCTION_MACROS</KeywordInComment><Comment> tag is set to YES then doxygen's preprocessor will</Comment><br/> 2033 <Comment># remove all references to function-like macros that are alone on a line, have</Comment><br/> 2034 <Comment># an all uppercase name, and do not end with a semicolon. Such function macros</Comment><br/> 2035 <Comment># are typically used for boiler-plate code, and will confuse the parser if not</Comment><br/> 2036 <Comment># removed.</Comment><br/> 2037 <Comment># The default value is: YES.</Comment><br/> 2038 <Comment># This tag requires that the tag </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> is set to YES.</Comment><br/> 2039 <Error></Error><br/> 2040 <Keyword>SKIP_FUNCTION_MACROS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2041 <Error></Error><br/> 2042 <Comment>#---------------------------------------------------------------------------</Comment><br/> 2043 <Comment># Configuration options related to external references</Comment><br/> 2044 <Comment>#---------------------------------------------------------------------------</Comment><br/> 2045 <Error></Error><br/> 2046 <Comment># The </Comment><KeywordInComment>TAGFILES</KeywordInComment><Comment> tag can be used to specify one or more tag files. For each tag</Comment><br/> 2047 <Comment># file the location of the external documentation should be added. The format of</Comment><br/> 2048 <Comment># a tag file without this location is as follows:</Comment><br/> 2049 <Comment># </Comment><KeywordInComment>TAGFILES</KeywordInComment><Comment> = file1 file2 ...</Comment><br/> 2050 <Comment># Adding location for the tag files is done as follows:</Comment><br/> 2051 <Comment># </Comment><KeywordInComment>TAGFILES</KeywordInComment><Comment> = file1=loc1 "file2 = loc2" ...</Comment><br/> 2052 <Comment># where loc1 and loc2 can be relative or absolute paths or URLs. See the</Comment><br/> 2053 <Comment># section "Linking to external documentation" for more information about the use</Comment><br/> 2054 <Comment># of tag files.</Comment><br/> 2055 <Comment># Note: Each tag file must have a unique name (where the name does NOT include</Comment><br/> 2056 <Comment># the path). If a tag file is not located in the directory in which doxygen is</Comment><br/> 2057 <Comment># run, you must also specify the path to the tagfile here.</Comment><br/> 2058 <Error></Error><br/> 2059 <Keyword>TAGFILES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2060 <Error></Error><br/> 2061 <Comment># When a file name is specified after </Comment><KeywordInComment>GENERATE_TAGFILE</KeywordInComment><Comment>, doxygen will create a</Comment><br/> 2062 <Comment># tag file that is based on the </Comment><KeywordInComment>input</KeywordInComment><Comment> files it reads. See section "Linking to</Comment><br/> 2063 <Comment># external documentation" for more information about the usage of tag files.</Comment><br/> 2064 <Error></Error><br/> 2065 <Keyword>GENERATE_TAGFILE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2066 <Error></Error><br/> 2067 <Comment># If the </Comment><KeywordInComment>ALLEXTERNALS</KeywordInComment><Comment> tag is set to YES, all external class will be listed in</Comment><br/> 2068 <Comment># the class index. If set to NO, only the inherited external classes will be</Comment><br/> 2069 <Comment># listed.</Comment><br/> 2070 <Comment># The default value is: NO.</Comment><br/> 2071 <Error></Error><br/> 2072 <Keyword>ALLEXTERNALS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2073 <Error></Error><br/> 2074 <Comment># If the </Comment><KeywordInComment>EXTERNAL_GROUPS</KeywordInComment><Comment> tag is set to YES, all external groups will be listed</Comment><br/> 2075 <Comment># in the modules index. If set to NO, only the current project's groups will be</Comment><br/> 2076 <Comment># listed.</Comment><br/> 2077 <Comment># The default value is: YES.</Comment><br/> 2078 <Error></Error><br/> 2079 <Keyword>EXTERNAL_GROUPS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2080 <Error></Error><br/> 2081 <Comment># If the </Comment><KeywordInComment>EXTERNAL_PAGES</KeywordInComment><Comment> tag is set to YES, all external pages will be listed in</Comment><br/> 2082 <Comment># the related pages index. If set to NO, only the current project's pages will</Comment><br/> 2083 <Comment># be listed.</Comment><br/> 2084 <Comment># The default value is: YES.</Comment><br/> 2085 <Error></Error><br/> 2086 <Keyword>EXTERNAL_PAGES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2087 <Error></Error><br/> 2088 <Comment># The </Comment><KeywordInComment>PERL_PATH</KeywordInComment><Comment> should be the absolute path and name of the perl script</Comment><br/> 2089 <Comment># interpreter (i.e. the result of 'which perl').</Comment><br/> 2090 <Comment># The default file (with absolute path) is: /usr/bin/perl.</Comment><br/> 2091 <Error></Error><br/> 2092 <Keyword>PERL_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> /usr/bin/perl</UntypedValue><br/> 2093 <Error></Error><br/> 2094 <Comment>#---------------------------------------------------------------------------</Comment><br/> 2095 <Comment># Configuration options related to the dot tool</Comment><br/> 2096 <Comment>#---------------------------------------------------------------------------</Comment><br/> 2097 <Error></Error><br/> 2098 <Comment># If the </Comment><KeywordInComment>CLASS_DIAGRAMS</KeywordInComment><Comment> tag is set to YES, doxygen will generate a class diagram</Comment><br/> 2099 <Comment># (in HTML and LaTeX) for classes with base or super classes. Setting the tag to</Comment><br/> 2100 <Comment># NO turns the diagrams off. Note that this option also works with </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><br/> 2101 <Comment># disabled, but it is recommended to install and use dot, since it yields more</Comment><br/> 2102 <Comment># powerful graphs.</Comment><br/> 2103 <Comment># The default value is: YES.</Comment><br/> 2104 <Error></Error><br/> 2105 <Keyword>CLASS_DIAGRAMS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2106 <Error></Error><br/> 2107 <Comment># You can define message sequence charts within doxygen comments using the \msc</Comment><br/> 2108 <Comment># command. Doxygen will then run the mscgen tool (see:</Comment><br/> 2109 <Comment># http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the</Comment><br/> 2110 <Comment># documentation. The </Comment><KeywordInComment>MSCGEN_PATH</KeywordInComment><Comment> tag allows you to specify the directory where</Comment><br/> 2111 <Comment># the mscgen tool resides. If left empty the tool is assumed to be found in the</Comment><br/> 2112 <Comment># default search path.</Comment><br/> 2113 <Error></Error><br/> 2114 <Keyword>MSCGEN_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2115 <Error></Error><br/> 2116 <Comment># You can include diagrams made with dia in doxygen documentation. Doxygen will</Comment><br/> 2117 <Comment># then run dia to produce the diagram and insert it in the documentation. The</Comment><br/> 2118 <Comment># </Comment><KeywordInComment>DIA_PATH</KeywordInComment><Comment> tag allows you to specify the directory where the dia binary resides.</Comment><br/> 2119 <Comment># If left empty dia is assumed to be found in the default search path.</Comment><br/> 2120 <Error></Error><br/> 2121 <Keyword>DIA_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2122 <Error></Error><br/> 2123 <Comment># If set to YES the inheritance and collaboration graphs will hide inheritance</Comment><br/> 2124 <Comment># and usage relations if the target is undocumented or is not a class.</Comment><br/> 2125 <Comment># The default value is: YES.</Comment><br/> 2126 <Error></Error><br/> 2127 <Keyword>HIDE_UNDOC_RELATIONS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2128 <Error></Error><br/> 2129 <Comment># If you set the </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> tag to YES then doxygen will assume the dot tool is</Comment><br/> 2130 <Comment># available from the path. This tool is part of Graphviz (see:</Comment><br/> 2131 <Comment># http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent</Comment><br/> 2132 <Comment># Bell Labs. The other options in this section have no effect if this option is</Comment><br/> 2133 <Comment># set to NO</Comment><br/> 2134 <Comment># The default value is: NO.</Comment><br/> 2135 <Error></Error><br/> 2136 <Keyword>HAVE_DOT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2137 <Error></Error><br/> 2138 <Comment># The </Comment><KeywordInComment>DOT_NUM_THREADS</KeywordInComment><Comment> specifies the number of dot invocations doxygen is allowed</Comment><br/> 2139 <Comment># to run in parallel. When set to 0 doxygen will base this on the number of</Comment><br/> 2140 <Comment># processors available in the system. You can set it explicitly to a value</Comment><br/> 2141 <Comment># larger than 0 to get control over the balance between CPU load and processing</Comment><br/> 2142 <Comment># speed.</Comment><br/> 2143 <Comment># Minimum value: 0, maximum value: 32, default value: 0.</Comment><br/> 2144 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2145 <Error></Error><br/> 2146 <Keyword>DOT_NUM_THREADS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 0</UntypedValue><br/> 2147 <Error></Error><br/> 2148 <Comment># When you want a differently looking font in the dot files that doxygen</Comment><br/> 2149 <Comment># generates you can specify the font name using </Comment><KeywordInComment>DOT_FONTNAME</KeywordInComment><Comment>. You need to make</Comment><br/> 2150 <Comment># sure dot is able to find the font, which can be done by putting it in a</Comment><br/> 2151 <Comment># standard location or by setting the DOTFONTPATH environment variable or by</Comment><br/> 2152 <Comment># setting </Comment><KeywordInComment>DOT_FONTPATH</KeywordInComment><Comment> to the directory containing the font.</Comment><br/> 2153 <Comment># The default value is: Helvetica.</Comment><br/> 2154 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2155 <Error></Error><br/> 2156 <Keyword>DOT_FONTNAME</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> Helvetica</UntypedValue><br/> 2157 <Error></Error><br/> 2158 <Comment># The </Comment><KeywordInComment>DOT_FONTSIZE</KeywordInComment><Comment> tag can be used to set the size (in points) of the font of</Comment><br/> 2159 <Comment># dot graphs.</Comment><br/> 2160 <Comment># Minimum value: 4, maximum value: 24, default value: 10.</Comment><br/> 2161 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2162 <Error></Error><br/> 2163 <Keyword>DOT_FONTSIZE</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 10</UntypedValue><br/> 2164 <Error></Error><br/> 2165 <Comment># By default doxygen will tell dot to use the default font as specified with</Comment><br/> 2166 <Comment># </Comment><KeywordInComment>DOT_FONTNAME</KeywordInComment><Comment>. If you specify a different font using </Comment><KeywordInComment>DOT_FONTNAME</KeywordInComment><Comment> you can set</Comment><br/> 2167 <Comment># the path where dot can find it using this tag.</Comment><br/> 2168 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2169 <Error></Error><br/> 2170 <Keyword>DOT_FONTPATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2171 <Error></Error><br/> 2172 <Comment># If the </Comment><KeywordInComment>CLASS_GRAPH</KeywordInComment><Comment> tag is set to YES then doxygen will generate a graph for</Comment><br/> 2173 <Comment># each documented class showing the direct and indirect inheritance relations.</Comment><br/> 2174 <Comment># Setting this tag to YES will force the </Comment><KeywordInComment>CLASS_DIAGRAMS</KeywordInComment><Comment> tag to NO.</Comment><br/> 2175 <Comment># The default value is: YES.</Comment><br/> 2176 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2177 <Error></Error><br/> 2178 <Keyword>CLASS_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2179 <Error></Error><br/> 2180 <Comment># If the </Comment><KeywordInComment>COLLABORATION_GRAPH</KeywordInComment><Comment> tag is set to YES then doxygen will generate a</Comment><br/> 2181 <Comment># graph for each documented class showing the direct and indirect implementation</Comment><br/> 2182 <Comment># dependencies (inheritance, containment, and class references variables) of the</Comment><br/> 2183 <Comment># class with other documented classes.</Comment><br/> 2184 <Comment># The default value is: YES.</Comment><br/> 2185 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2186 <Error></Error><br/> 2187 <Keyword>COLLABORATION_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2188 <Error></Error><br/> 2189 <Comment># If the </Comment><KeywordInComment>GROUP_GRAPHS</KeywordInComment><Comment> tag is set to YES then doxygen will generate a graph for</Comment><br/> 2190 <Comment># groups, showing the direct groups dependencies.</Comment><br/> 2191 <Comment># The default value is: YES.</Comment><br/> 2192 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2193 <Error></Error><br/> 2194 <Keyword>GROUP_GRAPHS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2195 <Error></Error><br/> 2196 <Comment># If the </Comment><KeywordInComment>UML_LOOK</KeywordInComment><Comment> tag is set to YES, doxygen will generate inheritance and</Comment><br/> 2197 <Comment># collaboration diagrams in a style similar to the OMG's Unified Modeling</Comment><br/> 2198 <Comment># Language.</Comment><br/> 2199 <Comment># The default value is: NO.</Comment><br/> 2200 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2201 <Error></Error><br/> 2202 <Keyword>UML_LOOK</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2203 <Error></Error><br/> 2204 <Comment># If the </Comment><KeywordInComment>UML_LOOK</KeywordInComment><Comment> tag is enabled, the fields and methods are shown inside the</Comment><br/> 2205 <Comment># class node. If there are many fields or methods and many nodes the graph may</Comment><br/> 2206 <Comment># become too big to be useful. The </Comment><KeywordInComment>UML_LIMIT_NUM_FIELDS</KeywordInComment><Comment> threshold limits the</Comment><br/> 2207 <Comment># number of items for each type to make the size more manageable. Set this to 0</Comment><br/> 2208 <Comment># for no limit. Note that the threshold may be exceeded by 50% before the limit</Comment><br/> 2209 <Comment># is enforced. So when you set the threshold to 10, up to 15 fields may appear,</Comment><br/> 2210 <Comment># but if the number exceeds 15, the total amount of fields shown is limited to</Comment><br/> 2211 <Comment># 10.</Comment><br/> 2212 <Comment># Minimum value: 0, maximum value: 100, default value: 10.</Comment><br/> 2213 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2214 <Error></Error><br/> 2215 <Keyword>UML_LIMIT_NUM_FIELDS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 10</UntypedValue><br/> 2216 <Error></Error><br/> 2217 <Comment># If the </Comment><KeywordInComment>TEMPLATE_RELATIONS</KeywordInComment><Comment> tag is set to YES then the inheritance and</Comment><br/> 2218 <Comment># collaboration graphs will show the relations between templates and their</Comment><br/> 2219 <Comment># instances.</Comment><br/> 2220 <Comment># The default value is: NO.</Comment><br/> 2221 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2222 <Error></Error><br/> 2223 <Keyword>TEMPLATE_RELATIONS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2224 <Error></Error><br/> 2225 <Comment># If the </Comment><KeywordInComment>INCLUDE_GRAPH</KeywordInComment><Comment>, </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> and </Comment><KeywordInComment>SEARCH_INCLUDES</KeywordInComment><Comment> tags are set to</Comment><br/> 2226 <Comment># YES then doxygen will generate a graph for each documented file showing the</Comment><br/> 2227 <Comment># direct and indirect include dependencies of the file with other documented</Comment><br/> 2228 <Comment># files.</Comment><br/> 2229 <Comment># The default value is: YES.</Comment><br/> 2230 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2231 <Error></Error><br/> 2232 <Keyword>INCLUDE_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2233 <Error></Error><br/> 2234 <Comment># If the </Comment><KeywordInComment>INCLUDED_BY_GRAPH</KeywordInComment><Comment>, </Comment><KeywordInComment>ENABLE_PREPROCESSING</KeywordInComment><Comment> and </Comment><KeywordInComment>SEARCH_INCLUDES</KeywordInComment><Comment> tags are</Comment><br/> 2235 <Comment># set to YES then doxygen will generate a graph for each documented file showing</Comment><br/> 2236 <Comment># the direct and indirect include dependencies of the file with other documented</Comment><br/> 2237 <Comment># files.</Comment><br/> 2238 <Comment># The default value is: YES.</Comment><br/> 2239 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2240 <Error></Error><br/> 2241 <Keyword>INCLUDED_BY_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2242 <Error></Error><br/> 2243 <Comment># If the </Comment><KeywordInComment>CALL_GRAPH</KeywordInComment><Comment> tag is set to YES then doxygen will generate a call</Comment><br/> 2244 <Comment># dependency graph for every global function or class method.</Comment><br/> 2245 <Comment>#</Comment><br/> 2246 <Comment># Note that enabling this option will significantly increase the time of a run.</Comment><br/> 2247 <Comment># So in most cases it will be better to enable call graphs for selected</Comment><br/> 2248 <Comment># functions only using the \callgraph command. Disabling a call graph can be</Comment><br/> 2249 <Comment># accomplished by means of the command \hidecallgraph.</Comment><br/> 2250 <Comment># The default value is: NO.</Comment><br/> 2251 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2252 <Error></Error><br/> 2253 <Keyword>CALL_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2254 <Error></Error><br/> 2255 <Comment># If the </Comment><KeywordInComment>CALLER_GRAPH</KeywordInComment><Comment> tag is set to YES then doxygen will generate a caller</Comment><br/> 2256 <Comment># dependency graph for every global function or class method.</Comment><br/> 2257 <Comment>#</Comment><br/> 2258 <Comment># Note that enabling this option will significantly increase the time of a run.</Comment><br/> 2259 <Comment># So in most cases it will be better to enable caller graphs for selected</Comment><br/> 2260 <Comment># functions only using the \callergraph command. Disabling a caller graph can be</Comment><br/> 2261 <Comment># accomplished by means of the command \hidecallergraph.</Comment><br/> 2262 <Comment># The default value is: NO.</Comment><br/> 2263 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2264 <Error></Error><br/> 2265 <Keyword>CALLER_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2266 <Error></Error><br/> 2267 <Comment># If the </Comment><KeywordInComment>GRAPHICAL_HIERARCHY</KeywordInComment><Comment> tag is set to YES then doxygen will graphical</Comment><br/> 2268 <Comment># hierarchy of all classes instead of a textual one.</Comment><br/> 2269 <Comment># The default value is: YES.</Comment><br/> 2270 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2271 <Error></Error><br/> 2272 <Keyword>GRAPHICAL_HIERARCHY</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2273 <Error></Error><br/> 2274 <Comment># If the </Comment><KeywordInComment>DIRECTORY_GRAPH</KeywordInComment><Comment> tag is set to YES then doxygen will show the</Comment><br/> 2275 <Comment># dependencies a directory has on other directories in a graphical way. The</Comment><br/> 2276 <Comment># dependency relations are determined by the #include relations between the</Comment><br/> 2277 <Comment># files in the directories.</Comment><br/> 2278 <Comment># The default value is: YES.</Comment><br/> 2279 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2280 <Error></Error><br/> 2281 <Keyword>DIRECTORY_GRAPH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2282 <Error></Error><br/> 2283 <Comment># The </Comment><KeywordInComment>DOT_IMAGE_FORMAT</KeywordInComment><Comment> tag can be used to set the image format of the images</Comment><br/> 2284 <Comment># generated by dot. For an explanation of the image formats see the section</Comment><br/> 2285 <Comment># output formats in the documentation of the dot tool (Graphviz (see:</Comment><br/> 2286 <Comment># http://www.graphviz.org/)).</Comment><br/> 2287 <Comment># Note: If you choose svg you need to set </Comment><KeywordInComment>HTML_FILE_EXTENSION</KeywordInComment><Comment> to xhtml in order</Comment><br/> 2288 <Comment># to make the SVG files visible in IE 9+ (other browsers do not have this</Comment><br/> 2289 <Comment># requirement).</Comment><br/> 2290 <Comment># Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,</Comment><br/> 2291 <Comment># png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and</Comment><br/> 2292 <Comment># png:gdiplus:gdiplus.</Comment><br/> 2293 <Comment># The default value is: png.</Comment><br/> 2294 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2295 <Error></Error><br/> 2296 <Keyword>DOT_IMAGE_FORMAT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> png</UntypedValue><br/> 2297 <Error></Error><br/> 2298 <Comment># If </Comment><KeywordInComment>DOT_IMAGE_FORMAT</KeywordInComment><Comment> is set to svg, then this option can be set to YES to</Comment><br/> 2299 <Comment># enable generation of interactive SVG images that allow zooming and panning.</Comment><br/> 2300 <Comment>#</Comment><br/> 2301 <Comment># Note that this requires a modern browser other than Internet Explorer. Tested</Comment><br/> 2302 <Comment># and working are Firefox, Chrome, Safari, and Opera.</Comment><br/> 2303 <Comment># Note: For IE 9+ you need to set </Comment><KeywordInComment>HTML_FILE_EXTENSION</KeywordInComment><Comment> to xhtml in order to make</Comment><br/> 2304 <Comment># the SVG files visible. Older versions of IE do not have SVG support.</Comment><br/> 2305 <Comment># The default value is: NO.</Comment><br/> 2306 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2307 <Error></Error><br/> 2308 <Keyword>INTERACTIVE_SVG</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2309 <Error></Error><br/> 2310 <Comment># The </Comment><KeywordInComment>DOT_PATH</KeywordInComment><Comment> tag can be used to specify the path where the dot tool can be</Comment><br/> 2311 <Comment># found. If left blank, it is assumed the dot tool can be found in the path.</Comment><br/> 2312 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2313 <Error></Error><br/> 2314 <Keyword>DOT_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2315 <Error></Error><br/> 2316 <Comment># The </Comment><KeywordInComment>DOTFILE_DIRS</KeywordInComment><Comment> tag can be used to specify one or more directories that</Comment><br/> 2317 <Comment># contain dot files that are included in the documentation (see the \dotfile</Comment><br/> 2318 <Comment># command).</Comment><br/> 2319 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2320 <Error></Error><br/> 2321 <Keyword>DOTFILE_DIRS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2322 <Error></Error><br/> 2323 <Comment># The </Comment><KeywordInComment>MSCFILE_DIRS</KeywordInComment><Comment> tag can be used to specify one or more directories that</Comment><br/> 2324 <Comment># contain msc files that are included in the documentation (see the \mscfile</Comment><br/> 2325 <Comment># command).</Comment><br/> 2326 <Error></Error><br/> 2327 <Keyword>MSCFILE_DIRS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2328 <Error></Error><br/> 2329 <Comment># The </Comment><KeywordInComment>DIAFILE_DIRS</KeywordInComment><Comment> tag can be used to specify one or more directories that</Comment><br/> 2330 <Comment># contain dia files that are included in the documentation (see the \diafile</Comment><br/> 2331 <Comment># command).</Comment><br/> 2332 <Error></Error><br/> 2333 <Keyword>DIAFILE_DIRS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2334 <Error></Error><br/> 2335 <Comment># When using plantuml, the </Comment><KeywordInComment>PLANTUML_JAR_PATH</KeywordInComment><Comment> tag should be used to specify the</Comment><br/> 2336 <Comment># path where java can find the plantuml.jar file. If left blank, it is assumed</Comment><br/> 2337 <Comment># PlantUML is not used or called during a preprocessing step. Doxygen will</Comment><br/> 2338 <Comment># generate a warning when it encounters a \startuml command in this case and</Comment><br/> 2339 <Comment># will not generate output for the diagram.</Comment><br/> 2340 <Error></Error><br/> 2341 <Keyword>PLANTUML_JAR_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2342 <Error></Error><br/> 2343 <Comment># When using plantuml, the specified paths are searched for files specified by</Comment><br/> 2344 <Comment># the !include statement in a plantuml block.</Comment><br/> 2345 <Error></Error><br/> 2346 <Keyword>PLANTUML_INCLUDE_PATH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><br/> 2347 <Error></Error><br/> 2348 <Comment># The </Comment><KeywordInComment>DOT_GRAPH_MAX_NODES</KeywordInComment><Comment> tag can be used to set the maximum number of nodes</Comment><br/> 2349 <Comment># that will be shown in the graph. If the number of nodes in a graph becomes</Comment><br/> 2350 <Comment># larger than this value, doxygen will truncate the graph, which is visualized</Comment><br/> 2351 <Comment># by representing a node as a red box. Note that doxygen if the number of direct</Comment><br/> 2352 <Comment># children of the root node in a graph is already larger than</Comment><br/> 2353 <Comment># </Comment><KeywordInComment>DOT_GRAPH_MAX_NODES</KeywordInComment><Comment> then the graph will not be shown at all. Also note that</Comment><br/> 2354 <Comment># the size of a graph can be further restricted by </Comment><KeywordInComment>MAX_DOT_GRAPH_DEPTH</KeywordInComment><Comment>.</Comment><br/> 2355 <Comment># Minimum value: 0, maximum value: 10000, default value: 50.</Comment><br/> 2356 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2357 <Error></Error><br/> 2358 <Keyword>DOT_GRAPH_MAX_NODES</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 50</UntypedValue><br/> 2359 <Error></Error><br/> 2360 <Comment># The </Comment><KeywordInComment>MAX_DOT_GRAPH_DEPTH</KeywordInComment><Comment> tag can be used to set the maximum depth of the graphs</Comment><br/> 2361 <Comment># generated by dot. A depth value of 3 means that only nodes reachable from the</Comment><br/> 2362 <Comment># root by following a path via at most 3 edges will be shown. Nodes that lay</Comment><br/> 2363 <Comment># further from the root node will be omitted. Note that setting this option to 1</Comment><br/> 2364 <Comment># or 2 may greatly reduce the computation time needed for large code bases. Also</Comment><br/> 2365 <Comment># note that the size of a graph can be further restricted by</Comment><br/> 2366 <Comment># </Comment><KeywordInComment>DOT_GRAPH_MAX_NODES</KeywordInComment><Comment>. Using a depth of 0 means no depth restriction.</Comment><br/> 2367 <Comment># Minimum value: 0, maximum value: 1000, default value: 0.</Comment><br/> 2368 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2369 <Error></Error><br/> 2370 <Keyword>MAX_DOT_GRAPH_DEPTH</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> 0</UntypedValue><br/> 2371 <Error></Error><br/> 2372 <Comment># Set the </Comment><KeywordInComment>DOT_TRANSPARENT</KeywordInComment><Comment> tag to YES to generate images with a transparent</Comment><br/> 2373 <Comment># background. This is disabled by default, because dot on Windows does not seem</Comment><br/> 2374 <Comment># to support this out of the box.</Comment><br/> 2375 <Comment>#</Comment><br/> 2376 <Comment># Warning: Depending on the platform used, enabling this option may lead to</Comment><br/> 2377 <Comment># badly anti-aliased labels on the edges of a graph (i.e. they become hard to</Comment><br/> 2378 <Comment># read).</Comment><br/> 2379 <Comment># The default value is: NO.</Comment><br/> 2380 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2381 <Error></Error><br/> 2382 <Keyword>DOT_TRANSPARENT</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2383 <Error></Error><br/> 2384 <Comment># Set the </Comment><KeywordInComment>DOT_MULTI_TARGETS</KeywordInComment><Comment> tag to YES to allow dot to generate multiple output</Comment><br/> 2385 <Comment># files in one run (i.e. multiple -o and -T options on the command line). This</Comment><br/> 2386 <Comment># makes dot run faster, but since only newer versions of dot (>1.8.10) support</Comment><br/> 2387 <Comment># this, this feature is disabled by default.</Comment><br/> 2388 <Comment># The default value is: NO.</Comment><br/> 2389 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2390 <Error></Error><br/> 2391 <Keyword>DOT_MULTI_TARGETS</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueNo>NO</ValueNo><br/> 2392 <Error></Error><br/> 2393 <Comment># If the </Comment><KeywordInComment>GENERATE_LEGEND</KeywordInComment><Comment> tag is set to YES doxygen will generate a legend page</Comment><br/> 2394 <Comment># explaining the meaning of the various boxes and arrows in the dot generated</Comment><br/> 2395 <Comment># graphs.</Comment><br/> 2396 <Comment># The default value is: YES.</Comment><br/> 2397 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2398 <Error></Error><br/> 2399 <Keyword>GENERATE_LEGEND</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/> 2400 <Error></Error><br/> 2401 <Comment># If the </Comment><KeywordInComment>DOT_CLEANUP</KeywordInComment><Comment> tag is set to YES, doxygen will remove the intermediate dot</Comment><br/> 2402 <Comment># files that are used to generate the various graphs.</Comment><br/> 2403 <Comment># The default value is: YES.</Comment><br/> 2404 <Comment># This tag requires that the tag </Comment><KeywordInComment>HAVE_DOT</KeywordInComment><Comment> is set to YES.</Comment><br/> 2405 <Error></Error><br/> 2406 <Keyword>DOT_CLEANUP</Keyword><Normal Text> </Normal Text><Assignment>=</Assignment><UntypedValue> </UntypedValue><ValueYes>YES</ValueYes><br/>