1 <doxygenconfig>

     2   <group name='Project' docs='Project related configuration options'>

     3     <option type='string' id='DOXYFILE_ENCODING' format='string' docs='

     4 This tag specifies the encoding used for all characters in the config file 

     5 that follow. The default is UTF-8 which is also the encoding used for all 

     6 text before the first occurrence of this tag. Doxygen uses libiconv (or the 

     7 iconv built into libc) for the transcoding. See 

     8 http://www.gnu.org/software/libiconv for the list of possible encodings. 

     9 ' defval='UTF-8'/>

    10     <option type='string' id='PROJECT_NAME' format='string' docs='

    11 The PROJECT_NAME tag is a single word (or a sequence of words surrounded 

    12 by quotes) that should identify the project. ' defval=''/>

    13     <option type='string' id='PROJECT_NUMBER' format='string' docs='

    14 The PROJECT_NUMBER tag can be used to enter a project or revision number. 

    15 This could be handy for archiving the generated documentation or 

    16 if some version control system is used. 

    17 ' defval=''/>

    18     <option type='string' id='OUTPUT_DIRECTORY' format='dir' docs='

    19 The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 

    20 base path where the generated documentation will be put. 

    21 If a relative path is entered, it will be relative to the location 

    22 where doxygen was started. If left blank the current directory will be used. 

    23 ' defval=''/>

    24     <option type='bool' id='CREATE_SUBDIRS' docs='

    25 If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 

    26 4096 sub-directories (in 2 levels) under the output directory of each output 

    27 format and will distribute the generated files over these directories. 

    28 Enabling this option can be useful when feeding doxygen a huge amount of 

    29 source files, where putting all generated files in the same directory would 

    30 otherwise cause performance problems for the file system. 

    31 ' defval='0'/>

    32     <option type='enum' id='OUTPUT_LANGUAGE' defval='English' docs='

    33 The OUTPUT_LANGUAGE tag is used to specify the language in which all 

    34 documentation generated by doxygen is written. Doxygen will use this 

    35 information to generate all constant output in the proper language. 

    36 The default language is English, other supported languages are: 

    37 Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 

    38 Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 

    39 Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 

    40 messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 

    41 Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 

    42 Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 

    43 '>

    44       <value name='Afrikaans'/>

    45       <value name='Arabic'/>

    46       <value name='Brazilian'/>

    47       <value name='Catalan'/>

    48       <value name='Chinese'/>

    49       <value name='Chinese-Traditional'/>

    50       <value name='Croatian'/>

    51       <value name='Czech'/>

    52       <value name='Danish'/>

    53       <value name='Dutch'/>

    54       <value name='English'/>

    55       <value name='Esperanto'/>

    56       <value name='Farsi'/>

    57       <value name='Finnish'/>

    58       <value name='French'/>

    59       <value name='German'/>

    60       <value name='Greek'/>

    61       <value name='Hungarian'/>

    62       <value name='Italian'/>

    63       <value name='Japanese'/>

    64       <value name='Japanese-en'/>

    65       <value name='Korean'/>

    66       <value name='Korean-en'/>

    67       <value name='Norwegian'/>

    68       <value name='Macedonian'/>

    69       <value name='Persian'/>

    70       <value name='Polish'/>

    71       <value name='Portuguese'/>

    72       <value name='Romanian'/>

    73       <value name='Russian'/>

    74       <value name='Serbian'/>

    75       <value name='Slovak'/>

    76       <value name='Slovene'/>

    77       <value name='Spanish'/>

    78       <value name='Swedish'/>

    79       <value name='Turkish'/>

    80       <value name='Ukrainian'/>

    81       <value name='Vietnamese'/>

    82     </option>

    83     <option type='bool' id='BRIEF_MEMBER_DESC' docs='

    84 If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 

    85 include brief member descriptions after the members that are listed in 

    86 the file and class documentation (similar to JavaDoc). 

    87 Set to NO to disable this. 

    88 ' defval='1'/>

    89     <option type='bool' id='REPEAT_BRIEF' docs='

    90 If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 

    91 the brief description of a member or function before the detailed description. 

    92 Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 

    93 brief descriptions will be completely suppressed. 

    94 ' defval='1'/>

    95     <option type='list' id='ABBREVIATE_BRIEF' format='string' docs='

    96 This tag implements a quasi-intelligent brief description abbreviator 

    97 that is used to form the text in various listings. Each string 

    98 in this list, if found as the leading text of the brief description, will be 

    99 stripped from the text and the result after processing the whole list, is 

   100 used as the annotated text. Otherwise, the brief description is used as-is. 

   101 If left blank, the following values are used ("$name" is automatically 

   102 replaced with the name of the entity): "The $name class" "The $name widget" 

   103 "The $name file" "is" "provides" "specifies" "contains" 

   104 "represents" "a" "an" "the" 

   105 '>

   106       <value name='The $name class'/>

   107       <value name='The $name widget'/>

   108       <value name='The $name file'/>

   109       <value name='is'/>

   110       <value name='provides'/>

   111       <value name='specifies'/>

   112       <value name='contains'/>

   113       <value name='represents'/>

   114       <value name='a'/>

   115       <value name='an'/>

   116       <value name='the'/>

   117     </option>

   118     <option type='bool' id='ALWAYS_DETAILED_SEC' docs='

   119 If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 

   120 Doxygen will generate a detailed section even if there is only a brief 

   121 description. 

   122 ' defval='0'/>

   123     <option type='bool' id='INLINE_INHERITED_MEMB' docs='

   124 If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 

   125 inherited members of a class in the documentation of that class as if those 

   126 members were ordinary class members. Constructors, destructors and assignment 

   127 operators of the base classes will not be shown. 

   128 ' defval='0'/>

   129     <option type='bool' id='FULL_PATH_NAMES' docs='

   130 If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 

   131 path before files name in the file list and in the header files. If set 

   132 to NO the shortest path that makes the file name unique will be used. 

   133 ' defval='1'/>

   134     <option type='list' id='STRIP_FROM_PATH' format='string' docs='

   135 If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 

   136 can be used to strip a user-defined part of the path. Stripping is 

   137 only done if one of the specified strings matches the left-hand part of 

   138 the path. The tag can be used to show relative paths in the file list. 

   139 If left blank the directory from which doxygen is run is used as the 

   140 path to strip. 

   141 ' depends='FULL_PATH_NAMES'>

   142       <value name=''/>

   143     </option>

   144     <option type='list' id='STRIP_FROM_INC_PATH' format='string' docs='

   145 The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 

   146 the path mentioned in the documentation of a class, which tells 

   147 the reader which header file to include in order to use a class. 

   148 If left blank only the name of the header file containing the class 

   149 definition is used. Otherwise one should specify the include paths that 

   150 are normally passed to the compiler using the -I flag. 

   151 '>

   152     </option>

   153     <option type='bool' id='SHORT_NAMES' docs='

   154 If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 

   155 (but less readable) file names. This can be useful is your file systems 

   156 doesn't support long names like on DOS, Mac, or CD-ROM. 

   157 ' defval='0'/>

   158     <option type='bool' id='JAVADOC_AUTOBRIEF' docs='

   159 If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

   160 will interpret the first line (until the first dot) of a JavaDoc-style 

   161 comment as the brief description. If set to NO, the JavaDoc 

   162 comments will behave just like regular Qt-style comments 

   163 (thus requiring an explicit @brief command for a brief description.) 

   164 ' defval='0'/>

   165     <option type='bool' id='QT_AUTOBRIEF' docs='

   166 If the QT_AUTOBRIEF tag is set to YES then Doxygen will 

   167 interpret the first line (until the first dot) of a Qt-style 

   168 comment as the brief description. If set to NO, the comments 

   169 will behave just like regular Qt-style comments (thus requiring 

   170 an explicit \brief command for a brief description.) 

   171 ' defval='0'/>

   172     <option type='bool' id='MULTILINE_CPP_IS_BRIEF' docs='

   173 The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 

   174 treat a multi-line C++ special comment block (i.e. a block of //! or /// 

   175 comments) as a brief description. This used to be the default behaviour. 

   176 The new default is to treat a multi-line C++ comment block as a detailed 

   177 description. Set this tag to YES if you prefer the old behaviour instead. 

   178 ' defval='0'/>

   179     <option type='bool' id='INHERIT_DOCS' docs='

   180 If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 

   181 member inherits the documentation from any documented member that it 

   182 re-implements. 

   183 ' defval='1'/>

   184     <option type='bool' id='SEPARATE_MEMBER_PAGES' docs='

   185 If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 

   186 a new page for each member. If set to NO, the documentation of a member will 

   187 be part of the file/class/namespace that contains it. 

   188 ' defval='0'/>

   189     <option type='int' id='TAB_SIZE' docs='

   190 The TAB_SIZE tag can be used to set the number of spaces in a tab. 

   191 Doxygen uses this value to replace tabs by spaces in code fragments. 

   192 ' minval='1' maxval='16' defval='8'/>

   193     <option type='list' id='ALIASES' format='string' docs='

   194 This tag can be used to specify a number of aliases that acts 

   195 as commands in the documentation. An alias has the form "name=value". 

   196 For example adding "sideeffect=\par Side Effects:\n" will allow you to 

   197 put the command \sideeffect (or @sideeffect) in the documentation, which 

   198 will result in a user-defined paragraph with heading "Side Effects:". 

   199 You can put \n's in the value part of an alias to insert newlines. 

   200 '>

   201     </option>

   202     <option type='bool' id='OPTIMIZE_OUTPUT_FOR_C' docs='

   203 Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 

   204 sources only. Doxygen will then generate output that is more tailored for C. 

   205 For instance, some of the names that are used will be different. The list 

   206 of all members will be omitted, etc. 

   207 ' defval='0'/>

   208     <option type='bool' id='OPTIMIZE_OUTPUT_JAVA' docs='

   209 Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 

   210 sources only. Doxygen will then generate output that is more tailored for 

   211 Java. For instance, namespaces will be presented as packages, qualified 

   212 scopes will look different, etc. 

   213 ' defval='0'/>

   214     <option type='bool' id='OPTIMIZE_FOR_FORTRAN' docs='

   215 Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 

   216 sources only. Doxygen will then generate output that is more tailored for 

   217 Fortran. 

   218 ' defval='0'/>

   219     <option type='bool' id='OPTIMIZE_OUTPUT_VHDL' docs='

   220 Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 

   221 sources. Doxygen will then generate output that is tailored for 

   222 VHDL. 

   223 ' defval='0'/>

   224     <option type='list' id='EXTENSION_MAPPING' format='string' docs='

   225 Doxygen selects the parser to use depending on the extension of the files it parses. 

   226 With this tag you can assign which parser to use for a given extension. 

   227 Doxygen has a built-in mapping, but you can override or extend it using this tag. 

   228 The format is ext=language, where ext is a file extension, and language is one of 

   229 the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 

   230 Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 

   231 .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 

   232 use: inc=Fortran f=C. Note that for custom extensions you also need to set

   233 FILE_PATTERNS otherwise the files are not read by doxygen.

   234 '>

   235     </option>

   236     <option type='bool' id='BUILTIN_STL_SUPPORT' docs='

   237 If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 

   238 to include (a tag file for) the STL sources as input, then you should 

   239 set this tag to YES in order to let doxygen match functions declarations and 

   240 definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 

   241 func(std::string) {}). This also make the inheritance and collaboration 

   242 diagrams that involve STL classes more complete and accurate. 

   243 ' defval='0'/>

   244     <option type='bool' id='CPP_CLI_SUPPORT' docs='

   245 If you use Microsoft's C++/CLI language, you should set this option to YES to 

   246 enable parsing support. 

   247 ' defval='0'/>

   248     <option type='bool' id='SIP_SUPPORT' docs='

   249 Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 

   250 Doxygen will parse them like normal C++ but will assume all classes use public 

   251 instead of private inheritance when no explicit protection keyword is present. 

   252 ' defval='0'/>

   253     <option type='bool' id='IDL_PROPERTY_SUPPORT' docs='

   254 For Microsoft's IDL there are propget and propput attributes to indicate getter 

   255 and setter methods for a property. Setting this option to YES (the default) 

   256 will make doxygen to replace the get and set methods by a property in the 

   257 documentation. This will only work if the methods are indeed getting or 

   258 setting a simple type. If this is not the case, or you want to show the 

   259 methods anyway, you should set this option to NO. 

   260 ' defval='1'/>

   261     <option type='bool' id='DISTRIBUTE_GROUP_DOC' docs='

   262 If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 

   263 tag is set to YES, then doxygen will reuse the documentation of the first 

   264 member in the group (if any) for the other members of the group. By default 

   265 all members of a group must be documented explicitly. 

   266 ' defval='0'/>

   267     <option type='bool' id='SUBGROUPING' docs='

   268 Set the SUBGROUPING tag to YES (the default) to allow class member groups of 

   269 the same type (for instance a group of public functions) to be put as a 

   270 subgroup of that type (e.g. under the Public Functions section). Set it to 

   271 NO to prevent subgrouping. Alternatively, this can be done per class using 

   272 the \nosubgrouping command. 

   273 ' defval='1'/>

   274     <option type='bool' id='TYPEDEF_HIDES_STRUCT' docs='

   275 When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 

   276 is documented as struct, union, or enum with the name of the typedef. So 

   277 typedef struct TypeS {} TypeT, will appear in the documentation as a struct 

   278 with name TypeT. When disabled the typedef will appear as a member of a file, 

   279 namespace, or class. And the struct will be named TypeS. This can typically 

   280 be useful for C code in case the coding convention dictates that all compound 

   281 types are typedef'ed and only the typedef is referenced, never the tag name. 

   282 ' defval='0'/>

   283     <option type='int' id='SYMBOL_CACHE_SIZE' docs='

   284 The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 

   285 determine which symbols to keep in memory and which to flush to disk. 

   286 When the cache is full, less often used symbols will be written to disk. 

   287 For small to medium size projects (<1000 input files) the default value is 

   288 probably good enough. For larger projects a too small cache size can cause 

   289 doxygen to be busy swapping symbols to and from disk most of the time 

   290 causing a significant performance penality. 

   291 If the system has enough physical memory increasing the cache will improve the 

   292 performance by keeping more symbols in memory. Note that the value works on 

   293 a logarithmic scale so increasing the size by one will rougly double the 

   294 memory usage. The cache size is given by this formula: 

   295 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 

   296 corresponding to a cache size of 2^16 = 65536 symbols 

   297 ' minval='0' maxval='9' defval='0'/>

   298   </group>

   299   <group name='Build' docs='Build related configuration options'>

   300     <option type='bool' id='EXTRACT_ALL' docs='

   301 If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 

   302 documentation are documented, even if no documentation was available. 

   303 Private class members and static file members will be hidden unless 

   304 the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 

   305 ' defval='0'/>

   306     <option type='bool' id='EXTRACT_PRIVATE' docs='

   307 If the EXTRACT_PRIVATE tag is set to YES all private members of a class 

   308 will be included in the documentation. 

   309 ' defval='0'/>

   310     <option type='bool' id='EXTRACT_STATIC' docs='

   311 If the EXTRACT_STATIC tag is set to YES all static members of a file 

   312 will be included in the documentation. 

   313 ' defval='0'/>

   314     <option type='bool' id='EXTRACT_LOCAL_CLASSES' docs='

   315 If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 

   316 defined locally in source files will be included in the documentation. 

   317 If set to NO only classes defined in header files are included. 

   318 ' defval='1'/>

   319     <option type='bool' id='EXTRACT_LOCAL_METHODS' docs='

   320 This flag is only useful for Objective-C code. When set to YES local 

   321 methods, which are defined in the implementation section but not in 

   322 the interface are included in the documentation. 

   323 If set to NO (the default) only methods in the interface are included. 

   324 ' defval='0'/>

   325     <option type='bool' id='EXTRACT_ANON_NSPACES' docs='

   326 If this flag is set to YES, the members of anonymous namespaces will be 

   327 extracted and appear in the documentation as a namespace called 

   328 'anonymous_namespace{file}', where file will be replaced with the base 

   329 name of the file that contains the anonymous namespace. By default 

   330 anonymous namespace are hidden. 

   331 ' defval='0'/>

   332     <option type='bool' id='HIDE_UNDOC_MEMBERS' docs='

   333 If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 

   334 undocumented members of documented classes, files or namespaces. 

   335 If set to NO (the default) these members will be included in the 

   336 various overviews, but no documentation section is generated. 

   337 This option has no effect if EXTRACT_ALL is enabled. 

   338 ' defval='0'/>

   339     <option type='bool' id='HIDE_UNDOC_CLASSES' docs='

   340 If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 

   341 undocumented classes that are normally visible in the class hierarchy. 

   342 If set to NO (the default) these classes will be included in the various 

   343 overviews. This option has no effect if EXTRACT_ALL is enabled. 

   344 ' defval='0'/>

   345     <option type='bool' id='HIDE_FRIEND_COMPOUNDS' docs='

   346 If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 

   347 friend (class|struct|union) declarations. 

   348 If set to NO (the default) these declarations will be included in the 

   349 documentation. 

   350 ' defval='0'/>

   351     <option type='bool' id='HIDE_IN_BODY_DOCS' docs='

   352 If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 

   353 documentation blocks found inside the body of a function. 

   354 If set to NO (the default) these blocks will be appended to the 

   355 function's detailed documentation block. 

   356 ' defval='0'/>

   357     <option type='bool' id='INTERNAL_DOCS' docs='

   358 The INTERNAL_DOCS tag determines if documentation 

   359 that is typed after a \internal command is included. If the tag is set 

   360 to NO (the default) then the documentation will be excluded. 

   361 Set it to YES to include the internal documentation. 

   362 ' defval='0'/>

   363     <option type='bool' id='CASE_SENSE_NAMES' docs='

   364 If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 

   365 file names in lower-case letters. If set to YES upper-case letters are also 

   366 allowed. This is useful if you have classes or files whose names only differ 

   367 in case and if your file system supports case sensitive file names. Windows 

   368 and Mac users are advised to set this option to NO. 

   369 ' defval='0' altdefval='portable_fileSystemIsCaseSensitive()'/>

   370     <option type='bool' id='HIDE_SCOPE_NAMES' docs='

   371 If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 

   372 will show members with their full class and namespace scopes in the 

   373 documentation. If set to YES the scope will be hidden. 

   374 ' defval='0'/>

   375     <option type='bool' id='SHOW_INCLUDE_FILES' docs='

   376 If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 

   377 will put a list of the files that are included by a file in the documentation 

   378 of that file. 

   379 ' defval='1'/>

   380     <option type='bool' id='FORCE_LOCAL_INCLUDES' docs='

   381 If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 

   382 will list include files with double quotes in the documentation 

   383 rather than with sharp brackets.

   384 ' defval='0'/>

   385     <option type='bool' id='INLINE_INFO' docs='

   386 If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 

   387 is inserted in the documentation for inline members. 

   388 ' defval='1'/>

   389     <option type='bool' id='SORT_MEMBER_DOCS' docs='

   390 If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 

   391 will sort the (detailed) documentation of file and class members 

   392 alphabetically by member name. If set to NO the members will appear in 

   393 declaration order. 

   394 ' defval='1'/>

   395     <option type='bool' id='SORT_BRIEF_DOCS' docs='

   396 If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 

   397 brief documentation of file, namespace and class members alphabetically 

   398 by member name. If set to NO (the default) the members will appear in 

   399 declaration order. 

   400 ' defval='0'/>

   401     <option type='bool' id='SORT_MEMBERS_CTORS_1ST' docs='

   402 If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen

   403 will sort the (brief and detailed) documentation of class members so that

   404 constructors and destructors are listed first. If set to NO (the default)

   405 the constructors will appear in the respective orders defined by

   406 SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.

   407 This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO

   408 and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.' defval='0'/>

   409     <option type='bool' id='SORT_GROUP_NAMES' docs='

   410 If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 

   411 hierarchy of group names into alphabetical order. If set to NO (the default) 

   412 the group names will appear in their defined order. 

   413 ' defval='0'/>

   414     <option type='bool' id='SORT_BY_SCOPE_NAME' docs='

   415 If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 

   416 sorted by fully-qualified names, including namespaces. If set to 

   417 NO (the default), the class list will be sorted only by class name, 

   418 not including the namespace part. 

   419 Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 

   420 Note: This option applies only to the class list, not to the 

   421 alphabetical list. 

   422 ' defval='0'/>

   423     <option type='bool' id='GENERATE_TODOLIST' docs='

   424 The GENERATE_TODOLIST tag can be used to enable (YES) or 

   425 disable (NO) the todo list. This list is created by putting \todo 

   426 commands in the documentation. 

   427 ' defval='1'/>

   428     <option type='bool' id='GENERATE_TESTLIST' docs='

   429 The GENERATE_TESTLIST tag can be used to enable (YES) or 

   430 disable (NO) the test list. This list is created by putting \test 

   431 commands in the documentation. 

   432 ' defval='1'/>

   433     <option type='bool' id='GENERATE_BUGLIST' docs='

   434 The GENERATE_BUGLIST tag can be used to enable (YES) or 

   435 disable (NO) the bug list. This list is created by putting \bug 

   436 commands in the documentation. 

   437 ' defval='1'/>

   438     <option type='bool' id='GENERATE_DEPRECATEDLIST' docs='

   439 The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 

   440 disable (NO) the deprecated list. This list is created by putting 

   441 \deprecated commands in the documentation. 

   442 ' defval='1'/>

   443     <option type='list' id='ENABLED_SECTIONS' format='string' docs='

   444 The ENABLED_SECTIONS tag can be used to enable conditional 

   445 documentation sections, marked by \if sectionname ... \endif. 

   446 '>

   447     </option>

   448     <option type='int' id='MAX_INITIALIZER_LINES' docs='

   449 The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

   450 the initial value of a variable or define consists of for it to appear in 

   451 the documentation. If the initializer consists of more lines than specified 

   452 here it will be hidden. Use a value of 0 to hide initializers completely. 

   453 The appearance of the initializer of individual variables and defines in the 

   454 documentation can be controlled using \showinitializer or \hideinitializer 

   455 command in the documentation regardless of this setting. 

   456 ' minval='0' maxval='10000' defval='30'/>

   457     <option type='bool' id='SHOW_USED_FILES' docs='

   458 Set the SHOW_USED_FILES tag to NO to disable the list of files generated 

   459 at the bottom of the documentation of classes and structs. If set to YES the 

   460 list will mention the files that were used to generate the documentation.

   461 ' defval='1'/>

   462     <option type='bool' id='SHOW_DIRECTORIES' docs='

   463 If the sources in your project are distributed over multiple directories 

   464 then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 

   465 in the documentation. The default is NO. 

   466 ' defval='0'/>

   467     <option type='bool' id='SHOW_FILES' docs='

   468 Set the SHOW_FILES tag to NO to disable the generation of the Files page. 

   469 This will remove the Files entry from the Quick Index and from the 

   470 Folder Tree View (if specified). The default is YES. 

   471 ' defval='1'/>

   472     <option type='bool' id='SHOW_NAMESPACES' docs='

   473 Set the SHOW_NAMESPACES tag to NO to disable the generation of the 

   474 Namespaces page.  This will remove the Namespaces entry from the Quick Index 

   475 and from the Folder Tree View (if specified). The default is YES. 

   476 ' defval='1'/>

   477     <option type='string' id='FILE_VERSION_FILTER' format='file' docs='

   478 The FILE_VERSION_FILTER tag can be used to specify a program or script that 

   479 doxygen should invoke to get the current version for each file (typically from 

   480 the version control system). Doxygen will invoke the program by executing (via 

   481 popen()) the command <command> <input-file>, where <command> is the value of 

   482 the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 

   483 provided by doxygen. Whatever the program writes to standard output 

   484 is used as the file version. See the manual for examples. 

   485 ' defval=''/>

   486     <option type='string' id='LAYOUT_FILE' format='file' docs='

   487 The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 

   488 doxygen. The layout file controls the global structure of the generated output files 

   489 in an output format independent way. The create the layout file that represents 

   490 doxygen's defaults, run doxygen with the -l option. You can optionally specify a 

   491 file name after the option, if omitted DoxygenLayout.xml will be used as the name 

   492 of the layout file. 

   493 ' defval=''/>

   494   </group>

   495   <group name='Messages' docs='configuration options related to warning and progress messages'>

   496     <option type='bool' id='QUIET' docs='

   497 The QUIET tag can be used to turn on/off the messages that are generated 

   498 by doxygen. Possible values are YES and NO. If left blank NO is used. 

   499 ' defval='0'/>

   500     <option type='bool' id='WARNINGS' docs='

   501 The WARNINGS tag can be used to turn on/off the warning messages that are 

   502 generated by doxygen. Possible values are YES and NO. If left blank 

   503 NO is used. 

   504 ' defval='1'/>

   505     <option type='bool' id='WARN_IF_UNDOCUMENTED' docs='

   506 If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 

   507 for undocumented members. If EXTRACT_ALL is set to YES then this flag will 

   508 automatically be disabled. 

   509 ' defval='1'/>

   510     <option type='bool' id='WARN_IF_DOC_ERROR' docs='

   511 If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 

   512 potential errors in the documentation, such as not documenting some 

   513 parameters in a documented function, or documenting parameters that 

   514 don't exist or using markup commands wrongly. 

   515 ' defval='1'/>

   516     <option type='bool' id='WARN_NO_PARAMDOC' docs='

   517 This WARN_NO_PARAMDOC option can be abled to get warnings for 

   518 functions that are documented, but have no documentation for their parameters 

   519 or return value. If set to NO (the default) doxygen will only warn about 

   520 wrong or incomplete parameter documentation, but not about the absence of 

   521 documentation. 

   522 ' defval='0'/>

   523     <option type='string' id='WARN_FORMAT' format='string' docs='

   524 The WARN_FORMAT tag determines the format of the warning messages that 

   525 doxygen can produce. The string should contain the $file, $line, and $text 

   526 tags, which will be replaced by the file and line number from which the 

   527 warning originated and the warning text. Optionally the format may contain 

   528 $version, which will be replaced by the version of the file (if it could 

   529 be obtained via FILE_VERSION_FILTER) 

   530 ' defval='$file:$line: $text'/>

   531     <option type='string' id='WARN_LOGFILE' format='file' docs='

   532 The WARN_LOGFILE tag can be used to specify a file to which warning 

   533 and error messages should be written. If left blank the output is written 

   534 to stderr. 

   535 ' defval=''/>

   536   </group>

   537   <group name='Input' docs='configuration options related to the input files'>

   538     <option type='list' id='INPUT' format='filedir' docs='

   539 The INPUT tag can be used to specify the files and/or directories that contain 

   540 documented source files. You may enter file names like "myfile.cpp" or 

   541 directories like "/usr/src/myproject". Separate the files or directories 

   542 with spaces. 

   543 '>

   544       <value name=''/>

   545     </option>

   546     <option type='string' id='INPUT_ENCODING' format='string' docs='

   547 This tag can be used to specify the character encoding of the source files 

   548 that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 

   549 also the default input encoding. Doxygen uses libiconv (or the iconv built 

   550 into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 

   551 the list of possible encodings. 

   552 ' defval='UTF-8'/>

   553     <option type='list' id='FILE_PATTERNS' format='string' docs='

   554 If the value of the INPUT tag contains directories, you can use the 

   555 FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

   556 and *.h) to filter out the source-files in the directories. If left 

   557 blank the following patterns are tested: 

   558 *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 

   559 *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 

   560 '>

   561       <value name='*.c'/>

   562       <value name='*.cc'/>

   563       <value name='*.cxx'/>

   564       <value name='*.cpp'/>

   565       <value name='*.c++'/>

   566       <value name='*.d'/>

   567       <value name='*.java'/>

   568       <value name='*.ii'/>

   569       <value name='*.ixx'/>

   570       <value name='*.ipp'/>

   571       <value name='*.i++'/>

   572       <value name='*.inl'/>

   573       <value name='*.h'/>

   574       <value name='*.hh'/>

   575       <value name='*.hxx'/>

   576       <value name='*.hpp'/>

   577       <value name='*.h++'/>

   578       <value name='*.idl'/>

   579       <value name='*.odl'/>

   580       <value name='*.cs'/>

   581       <value name='*.php'/>

   582       <value name='*.php3'/>

   583       <value name='*.inc'/>

   584       <value name='*.m'/>

   585       <value name='*.mm'/>

   586       <value name='*.dox'/>

   587       <value name='*.py'/>

   588       <value name='*.f90'/>

   589       <value name='*.f'/>

   590       <value name='*.vhd'/>

   591       <value name='*.vhdl'/>

   592     </option>

   593     <option type='bool' id='RECURSIVE' docs='

   594 The RECURSIVE tag can be used to turn specify whether or not subdirectories 

   595 should be searched for input files as well. Possible values are YES and NO. 

   596 If left blank NO is used. 

   597 ' defval='0'/>

   598     <option type='list' id='EXCLUDE' format='filedir' docs='

   599 The EXCLUDE tag can be used to specify files and/or directories that should 

   600 excluded from the INPUT source files. This way you can easily exclude a 

   601 subdirectory from a directory tree whose root is specified with the INPUT tag. 

   602 '>

   603     </option>

   604     <option type='bool' id='EXCLUDE_SYMLINKS' docs='

   605 The EXCLUDE_SYMLINKS tag can be used select whether or not files or 

   606 directories that are symbolic links (a Unix filesystem feature) are excluded 

   607 from the input. 

   608 ' defval='0'/>

   609     <option type='list' id='EXCLUDE_PATTERNS' format='string' docs='

   610 If the value of the INPUT tag contains directories, you can use the 

   611 EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 

   612 certain files from those directories. Note that the wildcards are matched 

   613 against the file with absolute path, so to exclude all test directories 

   614 for example use the pattern */test/* 

   615 '>

   616     </option>

   617     <option type='list' id='EXCLUDE_SYMBOLS' format='string' docs='

   618 The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 

   619 (namespaces, classes, functions, etc.) that should be excluded from the 

   620 output. The symbol name can be a fully qualified name, a word, or if the 

   621 wildcard * is used, a substring. Examples: ANamespace, AClass, 

   622 AClass::ANamespace, ANamespace::*Test 

   623 '>

   624     </option>

   625     <option type='list' id='EXAMPLE_PATH' format='dir' docs='

   626 The EXAMPLE_PATH tag can be used to specify one or more files or 

   627 directories that contain example code fragments that are included (see 

   628 the \include command). 

   629 '>

   630     </option>

   631     <option type='list' id='EXAMPLE_PATTERNS' format='string' docs='

   632 If the value of the EXAMPLE_PATH tag contains directories, you can use the 

   633 EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

   634 and *.h) to filter out the source-files in the directories. If left 

   635 blank all files are included. 

   636 '>

   637       <value name='*'/>

   638     </option>

   639     <option type='bool' id='EXAMPLE_RECURSIVE' docs='

   640 If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 

   641 searched for input files to be used with the \include or \dontinclude 

   642 commands irrespective of the value of the RECURSIVE tag. 

   643 Possible values are YES and NO. If left blank NO is used. 

   644 ' defval='0'/>

   645     <option type='list' id='IMAGE_PATH' format='dir' docs='

   646 The IMAGE_PATH tag can be used to specify one or more files or 

   647 directories that contain image that are included in the documentation (see 

   648 the \image command). 

   649 '>

   650     </option>

   651     <option type='string' id='INPUT_FILTER' format='file' docs='

   652 The INPUT_FILTER tag can be used to specify a program that doxygen should 

   653 invoke to filter for each input file. Doxygen will invoke the filter program 

   654 by executing (via popen()) the command <filter> <input-file>, where <filter> 

   655 is the value of the INPUT_FILTER tag, and <input-file> is the name of an 

   656 input file. Doxygen will then use the output that the filter program writes 

   657 to standard output.  If FILTER_PATTERNS is specified, this tag will be 

   658 ignored. 

   659 ' defval=''/>

   660     <option type='list' id='FILTER_PATTERNS' format='file' docs='

   661 The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 

   662 basis.  Doxygen will compare the file name with each pattern and apply the 

   663 filter if there is a match.  The filters are a list of the form: 

   664 pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 

   665 info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 

   666 is applied to all files. 

   667 '>

   668     </option>

   669     <option type='bool' id='FILTER_SOURCE_FILES' docs='

   670 If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 

   671 INPUT_FILTER) will be used to filter the input files when producing source 

   672 files to browse (i.e. when SOURCE_BROWSER is set to YES). 

   673 ' defval='0'/>

   674   </group>

   675   <group name='Source Browser' docs='configuration options related to source browsing'>

   676     <option type='bool' id='SOURCE_BROWSER' docs='

   677 If the SOURCE_BROWSER tag is set to YES then a list of source files will 

   678 be generated. Documented entities will be cross-referenced with these sources. 

   679 Note: To get rid of all source code in the generated output, make sure also 

   680 VERBATIM_HEADERS is set to NO. 

   681 ' defval='0'/>

   682     <option type='bool' id='INLINE_SOURCES' docs='

   683 Setting the INLINE_SOURCES tag to YES will include the body 

   684 of functions and classes directly in the documentation. 

   685 ' defval='0'/>

   686     <option type='bool' id='STRIP_CODE_COMMENTS' docs='

   687 Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 

   688 doxygen to hide any special comment blocks from generated source code 

   689 fragments. Normal C and C++ comments will always remain visible. 

   690 ' defval='1'/>

   691     <option type='bool' id='REFERENCED_BY_RELATION' docs='

   692 If the REFERENCED_BY_RELATION tag is set to YES 

   693 then for each documented function all documented 

   694 functions referencing it will be listed. 

   695 ' defval='0'/>

   696     <option type='bool' id='REFERENCES_RELATION' docs='

   697 If the REFERENCES_RELATION tag is set to YES 

   698 then for each documented function all documented entities 

   699 called/used by that function will be listed. 

   700 ' defval='0'/>

   701     <option type='bool' id='REFERENCES_LINK_SOURCE' docs='

   702 If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 

   703 and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 

   704 functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 

   705 link to the source code.  Otherwise they will link to the documentation. 

   706 ' defval='1'/>

   707     <option type='bool' id='USE_HTAGS' docs='

   708 If the USE_HTAGS tag is set to YES then the references to source code 

   709 will point to the HTML generated by the htags(1) tool instead of doxygen 

   710 built-in source browser. The htags tool is part of GNU's global source 

   711 tagging system (see http://www.gnu.org/software/global/global.html). You 

   712 will need version 4.8.6 or higher. 

   713 ' defval='0' depends='SOURCE_BROWSER'/>

   714     <option type='bool' id='VERBATIM_HEADERS' docs='

   715 If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 

   716 will generate a verbatim copy of the header file for each class for 

   717 which an include is specified. Set to NO to disable this. 

   718 ' defval='1'/>

   719   </group>

   720   <group name='Index' docs='configuration options related to the alphabetical class index'>

   721     <option type='bool' id='ALPHABETICAL_INDEX' docs='

   722 If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 

   723 of all compounds will be generated. Enable this if the project 

   724 contains a lot of classes, structs, unions or interfaces. 

   725 ' defval='0'/>

   726     <option type='int' id='COLS_IN_ALPHA_INDEX' docs='

   727 If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 

   728 the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 

   729 in which this list will be split (can be a number in the range [1..20]) 

   730 ' minval='1' maxval='20' defval='5'/>

   731     <option type='list' id='IGNORE_PREFIX' format='string' docs='

   732 In case all classes in a project start with a common prefix, all 

   733 classes will be put under the same header in the alphabetical index. 

   734 The IGNORE_PREFIX tag can be used to specify one or more prefixes that 

   735 should be ignored while generating the index headers. 

   736 '>

   737     </option>

   738   </group>

   739   <group name='HTML' docs='configuration options related to the HTML output'>

   740     <option type='bool' id='GENERATE_HTML' docs='

   741 If the GENERATE_HTML tag is set to YES (the default) Doxygen will 

   742 generate HTML output. 

   743 ' defval='1'/>

   744     <option type='string' id='HTML_OUTPUT' format='dir' docs='

   745 The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 

   746 If a relative path is entered the value of OUTPUT_DIRECTORY will be 

   747 put in front of it. If left blank `html' will be used as the default path. 

   748 ' defval='html' depends='GENERATE_HTML'/>

   749     <option type='string' id='HTML_FILE_EXTENSION' format='string' docs='

   750 The HTML_FILE_EXTENSION tag can be used to specify the file extension for 

   751 each generated HTML page (for example: .htm,.php,.asp). If it is left blank 

   752 doxygen will generate files with .html extension. 

   753 ' defval='.html' depends='GENERATE_HTML'/>

   754     <option type='string' id='HTML_HEADER' format='file' docs='

   755 The HTML_HEADER tag can be used to specify a personal HTML header for 

   756 each generated HTML page. If it is left blank doxygen will generate a 

   757 standard header. 

   758 ' defval='' depends='GENERATE_HTML'/>

   759     <option type='string' id='HTML_FOOTER' format='file' docs='

   760 The HTML_FOOTER tag can be used to specify a personal HTML footer for 

   761 each generated HTML page. If it is left blank doxygen will generate a 

   762 standard footer. 

   763 ' defval='' depends='GENERATE_HTML'/>

   764     <option type='string' id='HTML_STYLESHEET' format='file' docs='

   765 The HTML_STYLESHEET tag can be used to specify a user-defined cascading 

   766 style sheet that is used by each HTML page. It can be used to 

   767 fine-tune the look of the HTML output. If the tag is left blank doxygen 

   768 will generate a default style sheet. Note that doxygen will try to copy 

   769 the style sheet file to the HTML output directory, so don't put your own 

   770 stylesheet in the HTML output directory as well, or it will be erased! 

   771 ' defval='' depends='GENERATE_HTML'/>

   772     <option type='bool' id='HTML_TIMESTAMP' docs='

   773 If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 

   774 page will contain the date and time when the page was generated. Setting 

   775 this to NO can help when comparing the output of multiple runs.

   776 ' defval='0' depends='GENERATE_HTML'/>

   777     <option type='bool' id='HTML_ALIGN_MEMBERS' docs='

   778 If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 

   779 files or namespaces will be aligned in HTML using tables. If set to 

   780 NO a bullet list will be used. 

   781 ' defval='1' depends='GENERATE_HTML'/>

   782     <option type='bool' id='HTML_DYNAMIC_SECTIONS' docs='

   783 If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 

   784 documentation will contain sections that can be hidden and shown after the 

   785 page has loaded. For this to work a browser that supports 

   786 JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 

   787 Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 

   788 ' defval='0' depends='GENERATE_HTML'/>

   789     <option type='bool' id='GENERATE_DOCSET' docs='

   790 If the GENERATE_DOCSET tag is set to YES, additional index files 

   791 will be generated that can be used as input for Apple's Xcode 3 

   792 integrated development environment, introduced with OSX 10.5 (Leopard). 

   793 To create a documentation set, doxygen will generate a Makefile in the 

   794 HTML output directory. Running make will produce the docset in that 

   795 directory and running "make install" will install the docset in 

   796 ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 

   797 it at startup. 

   798 See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 

   799 ' defval='0' depends='GENERATE_HTML'/>

   800     <option type='string' id='DOCSET_FEEDNAME' format='string' docs='

   801 When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 

   802 feed. A documentation feed provides an umbrella under which multiple 

   803 documentation sets from a single provider (such as a company or product suite) 

   804 can be grouped. 

   805 ' defval='Doxygen generated docs' depends='GENERATE_DOCSET'/>

   806     <option type='string' id='DOCSET_BUNDLE_ID' format='string' docs='

   807 When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 

   808 should uniquely identify the documentation set bundle. This should be a 

   809 reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 

   810 will append .docset to the name. 

   811 ' defval='org.doxygen.Project' depends='GENERATE_DOCSET'/>

   812     <option type='bool' id='GENERATE_HTMLHELP' docs='

   813 If the GENERATE_HTMLHELP tag is set to YES, additional index files 

   814 will be generated that can be used as input for tools like the 

   815 Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 

   816 of the generated HTML documentation. 

   817 ' defval='0' depends='GENERATE_HTML'/>

   818     <option type='string' id='CHM_FILE' format='file' docs='

   819 If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 

   820 be used to specify the file name of the resulting .chm file. You 

   821 can add a path in front of the file if the result should not be 

   822 written to the html output directory. 

   823 ' defval='' depends='GENERATE_HTMLHELP'/>

   824     <option type='string' id='HHC_LOCATION' format='file' docs='

   825 If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 

   826 be used to specify the location (absolute path including file name) of 

   827 the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 

   828 the HTML help compiler on the generated index.hhp. 

   829 ' defval='' depends='GENERATE_HTMLHELP' abspath='1'/>

   830     <option type='bool' id='GENERATE_CHI' docs='

   831 If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 

   832 controls if a separate .chi index file is generated (YES) or that 

   833 it should be included in the master .chm file (NO). 

   834 ' defval='0' depends='GENERATE_HTMLHELP'/>

   835     <option type='string' id='CHM_INDEX_ENCODING' format='string' docs='

   836 If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 

   837 is used to encode HtmlHelp index (hhk), content (hhc) and project file 

   838 content. 

   839 ' defval='' depends='GENERATE_HTMLHELP'/>

   840     <option type='bool' id='BINARY_TOC' docs='

   841 If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 

   842 controls whether a binary table of contents is generated (YES) or a 

   843 normal table of contents (NO) in the .chm file. 

   844 ' defval='0' depends='GENERATE_HTMLHELP'/>

   845     <option type='bool' id='TOC_EXPAND' docs='

   846 The TOC_EXPAND flag can be set to YES to add extra items for group members 

   847 to the contents of the HTML help documentation and to the tree view. 

   848 ' defval='0' depends='GENERATE_HTMLHELP'/>

   849     <option type='bool' id='GENERATE_QHP' docs='

   850 If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 

   851 are set, an additional index file will be generated that can be used as input for 

   852 Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 

   853 HTML documentation. 

   854 ' defval='0' depends='GENERATE_HTML'/>

   855     <option type='string' id='QCH_FILE' format='file' docs='

   856 If the QHG_LOCATION tag is specified, the QCH_FILE tag can 

   857 be used to specify the file name of the resulting .qch file. 

   858 The path specified is relative to the HTML output folder. 

   859 ' defval='' depends='GENERATE_QHP'/>

   860     <option type='string' id='QHP_NAMESPACE' format='string' docs='

   861 The QHP_NAMESPACE tag specifies the namespace to use when generating 

   862 Qt Help Project output. For more information please see 

   863 http://doc.trolltech.com/qthelpproject.html#namespace 

   864 ' defval='org.doxygen.Project' depends='GENERATE_QHP'/>

   865     <option type='string' id='QHP_VIRTUAL_FOLDER' format='string' docs='

   866 The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 

   867 Qt Help Project output. For more information please see 

   868 http://doc.trolltech.com/qthelpproject.html#virtual-folders 

   869 ' defval='doc' depends='GENERATE_QHP'/>

   870     <option type='string' id='QHP_CUST_FILTER_NAME' format='string' docs='

   871 If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 

   872 For more information please see 

   873 http://doc.trolltech.com/qthelpproject.html#custom-filters 

   874 ' defval='' depends='GENERATE_QHP'/>

   875     <option type='string' id='QHP_CUST_FILTER_ATTRS' format='string' docs='

   876 The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 

   877 <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 

   878 ' defval='' depends='GENERATE_QHP'/>

   879     <option type='string' id='QHP_SECT_FILTER_ATTRS' format='string' docs='

   880 The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 

   881 filter section matches. 

   882 <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 

   883 ' defval='' depends='GENERATE_QHP'/>

   884     <option type='string' id='QHG_LOCATION' format='file' docs='

   885 If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 

   886 be used to specify the location of Qt's qhelpgenerator. 

   887 If non-empty doxygen will try to run qhelpgenerator on the generated 

   888 .qhp file. 

   889 ' defval='' depends='GENERATE_QHP'/>

   890     <option type='bool' id='GENERATE_ECLIPSEHELP' docs='

   891 If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  

   892 will be generated, which together with the HTML files, form an Eclipse help  

   893 plugin. To install this plugin and make it available under the help contents 

   894 menu in Eclipse, the contents of the directory containing the HTML and XML 

   895 files needs to be copied into the plugins directory of eclipse. The name of 

   896 the directory within the plugins directory should be the same as 

   897 the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before

   898 the help appears.

   899 ' defval='0' depends='GENERATE_HTML'/>

   900     <option type='string' id='ECLIPSE_DOC_ID' docs='

   901 A unique identifier for the eclipse help plugin. When installing the plugin 

   902 the directory name containing the HTML and XML files should also have 

   903 this name.

   904 ' defval='org.doxygen.Project' depends='GENERATE_ECLIPSEHELP'/>

   905     <option type='bool' id='DISABLE_INDEX' docs='

   906 The DISABLE_INDEX tag can be used to turn on/off the condensed index at 

   907 top of each HTML page. The value NO (the default) enables the index and 

   908 the value YES disables it. 

   909 ' defval='0' depends='GENERATE_HTML'/>

   910     <option type='int' id='ENUM_VALUES_PER_LINE' docs='

   911 This tag can be used to set the number of enum values (range [1..20]) 

   912 that doxygen will group on one line in the generated HTML documentation. 

   913 ' minval='1' maxval='20' defval='4' depends='GENERATE_HTML'/>

   914     <option type='bool' id='GENERATE_TREEVIEW' defval='0' docs='

   915 The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 

   916 structure should be generated to display hierarchical information. 

   917 If the tag value is set to YES, a side panel will be generated 

   918 containing a tree-like index structure (just like the one that 

   919 is generated for HTML Help). For this to work a browser that supports 

   920 JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 

   921 Windows users are probably better off using the HTML help feature.

   922 ' depends='GENERATE_HTML'/>

   923     <option type='bool' id='USE_INLINE_TREES' defval='0' docs='

   924 By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 

   925 and Class Hierarchy pages using a tree view instead of an ordered list.

   926 ' depends='GENERATE_HTML'/>

   927     <option type='int' id='TREEVIEW_WIDTH' docs='

   928 If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 

   929 used to set the initial width (in pixels) of the frame in which the tree 

   930 is shown. 

   931 ' minval='0' maxval='1500' defval='250' depends='GENERATE_HTML'/>

   932     <option type='int' id='FORMULA_FONTSIZE' docs='

   933 Use this tag to change the font size of Latex formulas included 

   934 as images in the HTML documentation. The default is 10. Note that 

   935 when you change the font size after a successful doxygen run you need 

   936 to manually remove any form_*.png images from the HTML output directory 

   937 to force them to be regenerated. 

   938 ' minval='8' maxval='50' defval='10' depends='GENERATE_HTML'/>

   939     <option type='bool' id='SEARCHENGINE' docs='

   940 When the SEARCHENGINE tag is enabled doxygen will generate a search box

   941 for the HTML output. The underlying search engine uses javascript 

   942 and DHTML and should work on any modern browser. Note that when using

   943 HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets

   944 (GENERATE_DOCSET) there is already a search function so this one should 

   945 typically be disabled. For large projects the javascript based search engine 

   946 can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

   947 ' defval='1' depends='GENERATE_HTML'/>

   948     <option type='bool' id='SERVER_BASED_SEARCH' docs='

   949 When the SERVER_BASED_SEARCH tag is enabled the search engine will be

   950 implemented using a PHP enabled web server instead of at the web client

   951 using Javascript. Doxygen will generate the search PHP script and index 

   952 file to put on the web server. The advantage of the server

   953 based approach is that it scales better to large projects and allows

   954 full text search. The disadvances is that it is more difficult to setup 

   955 and does not have live searching capabilities.

   956 ' defval='0' depends='SEARCHENGINE'/>

   957   </group>

   958   <group name='LaTeX' docs='configuration options related to the LaTeX output'>

   959     <option type='bool' id='GENERATE_LATEX' docs='

   960 If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 

   961 generate Latex output. 

   962 ' defval='1'/>

   963     <option type='string' id='LATEX_OUTPUT' format='dir' docs='

   964 The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 

   965 If a relative path is entered the value of OUTPUT_DIRECTORY will be 

   966 put in front of it. If left blank `latex' will be used as the default path. 

   967 ' defval='latex' depends='GENERATE_LATEX'/>

   968     <option type='string' id='LATEX_CMD_NAME' format='file' docs='

   969 The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 

   970 invoked. If left blank `latex' will be used as the default command name. 

   971 Note that when enabling USE_PDFLATEX this option is only used for 

   972 generating bitmaps for formulas in the HTML output, but not in the 

   973 Makefile that is written to the output directory.

   974 ' defval='latex' depends='GENERATE_LATEX'/>

   975     <option type='string' id='MAKEINDEX_CMD_NAME' format='file' docs='

   976 The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 

   977 generate index for LaTeX. If left blank `makeindex' will be used as the 

   978 default command name. 

   979 ' defval='makeindex' depends='GENERATE_LATEX'/>

   980     <option type='bool' id='COMPACT_LATEX' docs='

   981 If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 

   982 LaTeX documents. This may be useful for small projects and may help to 

   983 save some trees in general. 

   984 ' defval='0' depends='GENERATE_LATEX'/>

   985     <option type='enum' id='PAPER_TYPE' defval='a4wide' docs='

   986 The PAPER_TYPE tag can be used to set the paper type that is used 

   987 by the printer. Possible values are: a4, a4wide, letter, legal and 

   988 executive. If left blank a4wide will be used. 

   989 ' depends='GENERATE_LATEX'>

   990       <value name='a4'/>

   991       <value name='a4wide'/>

   992       <value name='letter'/>

   993       <value name='legal'/>

   994       <value name='executive'/>

   995     </option>

   996     <option type='list' id='EXTRA_PACKAGES' format='string' docs='

   997 The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 

   998 packages that should be included in the LaTeX output. 

   999 ' depends='GENERATE_LATEX'>

  1000     </option>

  1001     <option type='string' id='LATEX_HEADER' format='file' docs='

  1002 The LATEX_HEADER tag can be used to specify a personal LaTeX header for 

  1003 the generated latex document. The header should contain everything until 

  1004 the first chapter. If it is left blank doxygen will generate a 

  1005 standard header. Notice: only use this tag if you know what you are doing! 

  1006 ' defval='' depends='GENERATE_LATEX'/>

  1007     <option type='bool' id='PDF_HYPERLINKS' docs='

  1008 If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 

  1009 is prepared for conversion to pdf (using ps2pdf). The pdf file will 

  1010 contain links (just like the HTML output) instead of page references 

  1011 This makes the output suitable for online browsing using a pdf viewer. 

  1012 ' defval='1' depends='GENERATE_LATEX'/>

  1013     <option type='bool' id='USE_PDFLATEX' docs='

  1014 If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 

  1015 plain latex in the generated Makefile. Set this option to YES to get a 

  1016 higher quality PDF documentation. 

  1017 ' defval='1' depends='GENERATE_LATEX'/>

  1018     <option type='bool' id='LATEX_BATCHMODE' docs='

  1019 If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 

  1020 command to the generated LaTeX files. This will instruct LaTeX to keep 

  1021 running if errors occur, instead of asking the user for help. 

  1022 This option is also used when generating formulas in HTML. 

  1023 ' defval='0' depends='GENERATE_LATEX'/>

  1024     <option type='bool' id='LATEX_HIDE_INDICES' docs='

  1025 If LATEX_HIDE_INDICES is set to YES then doxygen will not 

  1026 include the index chapters (such as File Index, Compound Index, etc.) 

  1027 in the output. 

  1028 ' defval='0' depends='GENERATE_LATEX'/>

  1029     <option type='bool' id='LATEX_SOURCE_CODE' docs='

  1030 If LATEX_SOURCE_CODE is set to YES then doxygen will include

  1031 source code with syntax highlighting in the LaTeX output.

  1032 Note that which sources are shown also depends on other settings

  1033 such as SOURCE_BROWSER.

  1034 ' defval='0' depends='GENERATE_LATEX'/>

  1035   </group>

  1036   <group name='RTF' docs='configuration options related to the RTF output'>

  1037     <option type='bool' id='GENERATE_RTF' docs='

  1038 If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 

  1039 The RTF output is optimized for Word 97 and may not look very pretty with 

  1040 other RTF readers or editors. 

  1041 ' defval='0'/>

  1042     <option type='string' id='RTF_OUTPUT' format='dir' docs='

  1043 The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 

  1044 If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1045 put in front of it. If left blank `rtf' will be used as the default path. 

  1046 ' defval='rtf' depends='GENERATE_RTF'/>

  1047     <option type='bool' id='COMPACT_RTF' docs='

  1048 If the COMPACT_RTF tag is set to YES Doxygen generates more compact 

  1049 RTF documents. This may be useful for small projects and may help to 

  1050 save some trees in general. 

  1051 ' defval='0' depends='GENERATE_RTF'/>

  1052     <option type='bool' id='RTF_HYPERLINKS' docs='

  1053 If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 

  1054 will contain hyperlink fields. The RTF file will 

  1055 contain links (just like the HTML output) instead of page references. 

  1056 This makes the output suitable for online browsing using WORD or other 

  1057 programs which support those fields. 

  1058 Note: wordpad (write) and others do not support links. 

  1059 ' defval='0' depends='GENERATE_RTF'/>

  1060     <option type='string' id='RTF_STYLESHEET_FILE' format='file' docs='

  1061 Load stylesheet definitions from file. Syntax is similar to doxygen's 

  1062 config file, i.e. a series of assignments. You only have to provide 

  1063 replacements, missing definitions are set to their default value. 

  1064 ' defval='' depends='GENERATE_RTF'/>

  1065     <option type='string' id='RTF_EXTENSIONS_FILE' format='file' docs='

  1066 Set optional variables used in the generation of an rtf document. 

  1067 Syntax is similar to doxygen's config file. 

  1068 ' defval='' depends='GENERATE_RTF'/>

  1069   </group>

  1070   <group name='Man' docs='configuration options related to the man page output'>

  1071     <option type='bool' id='GENERATE_MAN' docs='

  1072 If the GENERATE_MAN tag is set to YES (the default) Doxygen will 

  1073 generate man pages 

  1074 ' defval='0'/>

  1075     <option type='string' id='MAN_OUTPUT' format='dir' docs='

  1076 The MAN_OUTPUT tag is used to specify where the man pages will be put. 

  1077 If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1078 put in front of it. If left blank `man' will be used as the default path. 

  1079 ' defval='man' depends='GENERATE_MAN'/>

  1080     <option type='string' id='MAN_EXTENSION' format='string' docs='

  1081 The MAN_EXTENSION tag determines the extension that is added to 

  1082 the generated man pages (default is the subroutine's section .3) 

  1083 ' defval='.3' depends='GENERATE_MAN'/>

  1084     <option type='bool' id='MAN_LINKS' docs='

  1085 If the MAN_LINKS tag is set to YES and Doxygen generates man output, 

  1086 then it will generate one additional man file for each entity 

  1087 documented in the real man page(s). These additional files 

  1088 only source the real man page, but without them the man command 

  1089 would be unable to find the correct page. The default is NO. 

  1090 ' defval='0' depends='GENERATE_MAN'/>

  1091   </group>

  1092   <group name='XML' docs='configuration options related to the XML output'>

  1093     <option type='bool' id='GENERATE_XML' docs='

  1094 If the GENERATE_XML tag is set to YES Doxygen will 

  1095 generate an XML file that captures the structure of 

  1096 the code including all documentation. 

  1097 ' defval='0'/>

  1098     <option type='string' id='XML_OUTPUT' format='dir' docs='

  1099 The XML_OUTPUT tag is used to specify where the XML pages will be put. 

  1100 If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1101 put in front of it. If left blank `xml' will be used as the default path. 

  1102 ' defval='xml' depends='GENERATE_XML'/>

  1103     <option type='string' id='XML_SCHEMA' format='string' docs='

  1104 The XML_SCHEMA tag can be used to specify an XML schema, 

  1105 which can be used by a validating XML parser to check the 

  1106 syntax of the XML files. 

  1107 ' defval='' depends='GENERATE_XML'/>

  1108     <option type='string' id='XML_DTD' format='string' docs='

  1109 The XML_DTD tag can be used to specify an XML DTD, 

  1110 which can be used by a validating XML parser to check the 

  1111 syntax of the XML files. 

  1112 ' defval='' depends='GENERATE_XML'/>

  1113     <option type='bool' id='XML_PROGRAMLISTING' docs='

  1114 If the XML_PROGRAMLISTING tag is set to YES Doxygen will 

  1115 dump the program listings (including syntax highlighting 

  1116 and cross-referencing information) to the XML output. Note that 

  1117 enabling this will significantly increase the size of the XML output. 

  1118 ' defval='1' depends='GENERATE_XML'/>

  1119   </group>

  1120   <group name='DITA' docs='configuration options related to DITA XML output'>

  1121     <option type='bool' id='GENERATE_XML_DITA' docs='

  1122 If the GENERATE_XML_DITA tag is set to YES Doxygen will 

  1123 generate DITA XML files that captures the structure of 

  1124 the code including all documentation. 

  1125 See: http://www.oasis-open.org/committees/dita/

  1126 ' defval='0'/>

  1127     <option type='string' id='XML_DITA_OUTPUT' format='dir' docs='

  1128 The XML_DITA_ OUTPUT tag is used to specify where the DITA XML pages will be put. 

  1129 If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1130 put in front of it. If left blank `dita' will be used as the default path. 

  1131 ' defval='dita' depends='GENERATE_XML_DITA'/>

  1132   </group>

  1133   <group name='DEF' docs='configuration options for the AutoGen Definitions output'>

  1134     <option type='bool' id='GENERATE_AUTOGEN_DEF' docs='