src/config.xml

   1 <doxygenconfig>
   2   <header>
   3     <docs doxywizard='0' doxyfile='0'>
   4       <![CDATA[
   5 /*
   6  *
   7  *
   8  *
   9  * Copyright (C) 1997-2014 by Dimitri van Heesch.
  10  *
  11  * Permission to use, copy, modify, and distribute this software and its
  12  * documentation under the terms of the GNU General Public License is hereby
  13  * granted. No representations are made about the suitability of this software
  14  * for any purpose. It is provided "as is" without express or implied warranty.
  15  * See the GNU General Public License for more details.
  16  *
  17  * Documents produced by Doxygen are derivative works derived from the
  18  * input used in their production; they are not affected by this license.
  19  *
  20  */
  21 /*! \page config Configuration
  22
  23 \tableofcontents
  24 \section config_format Format
  25
  26 A configuration file is a free-form ASCII text file with a structure
  27 that is similar to that of a \c Makefile, with the default name \c Doxyfile. It is
  28 parsed by \c doxygen. The file may contain tabs and newlines for
  29 formatting purposes. The statements in the file are case-sensitive.
  30 Comments may be placed anywhere within the file (except within quotes).
  31 Comments beginning with two hash characters (\c \#\#) are kept when updating
  32 the configuration file and are placed in front of the TAG are in front of.
  33 Comments beginning with two hash characters (\c \#\#) at the end of the
  34 configuration file are also kept and placed at the end of the file.
  35 Comments begin with the hash character (\c \#) and ends at the end of the line.
  36
  37 The file essentially consists of a list of assignment statements.
  38 Each statement consists of a \c TAG_NAME written in capitals,
  39 followed by the equal sign (<code>=</code>) and one or more values. If the same tag
  40 is assigned more than once, the last assignment overwrites any earlier
  41 assignment. For tags that take a list as their argument,
  42 the <code>+=</code> operator can be used instead of <code>=</code> to append
  43 new values to the list. Values are sequences of non-blanks. If the value should
  44 contain one or more blanks it must be surrounded by quotes (<code>&quot;...&quot;</code>).
  45 Multiple lines can be concatenated by inserting a backslash (\c \\)
  46 as the last character of a line. Environment variables can be expanded
  47 using the pattern <code>\$(ENV_VARIABLE_NAME)</code>.
  48
  49 You can also include part of a configuration file from another configuration
  50 file using a <code>\@INCLUDE</code> tag as follows:
  51 \verbatim
  52 @INCLUDE = config_file_name
  53 \endverbatim
  54 The include file is searched in the current working directory. You can
  55 also specify a list of directories that should be searched before looking
  56 in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag
  57 with these paths before the <code>\@INCLUDE</code> tag, e.g.:
  58 \verbatim
  59 @INCLUDE_PATH = my_config_dir
  60 \endverbatim
  61
  62 The configuration options can be divided into several categories.
  63 Below is an alphabetical index of the tags that are recognized
  64 followed by the descriptions of the tags grouped by category.
  65 ]]>
  66     </docs>
  67     <docs doxywizard='0' documentation='0'>
  68       <![CDATA[
  69 This file describes the settings to be used by the documentation system
  70 doxygen (www.doxygen.org) for a project.
  71 <br>
  72 All text after a double hash (##) is considered a comment and is placed
  73 in front of the TAG it is preceding.<br>
  74 All text after a single hash (#) is considered a comment and will be ignored.
  75 The format is:
  76 \verbatim
  77       TAG = value [value, ...]
  78 \endverbatim
  79 For lists, items can also be appended using:
  80 \verbatim
  81       TAG += value [value, ...]
  82 \endverbatim
  83 Values that contain spaces should be placed between quotes (\" \").
  84 ]]>
  85     </docs>
  86   </header>
  87   <footer>
  88     <docs doxywizard='0' doxyfile='0'>
  89       <![CDATA[
  90 \section config_examples Examples
  91
  92 Suppose you have a simple project consisting of two files: a source file
  93 \c example.cc and a header file \c example.h.
  94 Then a minimal configuration file is as simple as:
  95 \verbatim
  96 INPUT            = example.cc example.h
  97 \endverbatim
  98
  99 Assuming the example makes use of Qt classes and \c perl is located
 100 in <code>/usr/bin</code>, a more realistic configuration file would be:
 101 \verbatim
 102 PROJECT_NAME     = Example
 103 INPUT            = example.cc example.h
 104 WARNINGS         = YES
 105 TAGFILES         = qt.tag
 106 PERL_PATH        = /usr/local/bin/perl
 107 SEARCHENGINE     = NO
 108 \endverbatim
 109
 110 To generate the documentation for the
 111 <a href="http://www.stack.nl/~dimitri/qdbttabular/index.html">QdbtTabular</a> package
 112 I have used the following configuration file:
 113 \verbatim
 114 PROJECT_NAME     = QdbtTabular
 115 OUTPUT_DIRECTORY = html
 116 WARNINGS         = YES
 117 INPUT            = examples/examples.doc src
 118 FILE_PATTERNS    = *.cc *.h
 119 INCLUDE_PATH     = examples
 120 TAGFILES         = qt.tag
 121 PERL_PATH        = /usr/bin/perl
 122 SEARCHENGINE     = YES
 123 \endverbatim
 124
 125 To regenerate the Qt-1.44 documentation from the sources, you could use the
 126 following config file:
 127 \verbatim
 128 PROJECT_NAME         = Qt
 129 OUTPUT_DIRECTORY     = qt_docs
 130 HIDE_UNDOC_MEMBERS   = YES
 131 HIDE_UNDOC_CLASSES   = YES
 132 ENABLE_PREPROCESSING = YES
 133 MACRO_EXPANSION      = YES
 134 EXPAND_ONLY_PREDEF   = YES
 135 SEARCH_INCLUDES      = YES
 136 FULL_PATH_NAMES      = YES
 137 STRIP_FROM_PATH      = $(QTDIR)/
 138 PREDEFINED           = USE_TEMPLATECLASS Q_EXPORT= \
 139                        QArrayT:=QArray \
 140                        QListT:=QList \
 141                        QDictT:=QDict \
 142                        QQueueT:=QQueue \
 143                        QVectorT:=QVector \
 144                        QPtrDictT:=QPtrDict \
 145                        QIntDictT:=QIntDict \
 146                        QStackT:=QStack \
 147                        QDictIteratorT:=QDictIterator \
 148                        QListIteratorT:=QListIterator \
 149                        QCacheT:=QCache \
 150                        QCacheIteratorT:=QCacheIterator \
 151                        QIntCacheT:=QIntCache \
 152                        QIntCacheIteratorT:=QIntCacheIterator \
 153                        QIntDictIteratorT:=QIntDictIterator \
 154                        QPtrDictIteratorT:=QPtrDictIterator
 155 INPUT                = $(QTDIR)/doc \
 156                        $(QTDIR)/src/widgets \
 157                        $(QTDIR)/src/kernel \
 158                        $(QTDIR)/src/dialogs \
 159                        $(QTDIR)/src/tools
 160 FILE_PATTERNS        = *.cpp *.h q*.doc
 161 INCLUDE_PATH         = $(QTDIR)/include
 162 RECURSIVE            = YES
 163 \endverbatim
 164
 165 For the Qt-2.1 sources I recommend to use the following settings:
 166 \verbatim
 167 PROJECT_NAME          = Qt
 168 PROJECT_NUMBER        = 2.1
 169 HIDE_UNDOC_MEMBERS    = YES
 170 HIDE_UNDOC_CLASSES    = YES
 171 SOURCE_BROWSER        = YES
 172 INPUT                 = $(QTDIR)/src
 173 FILE_PATTERNS         = *.cpp *.h q*.doc
 174 RECURSIVE             = YES
 175 EXCLUDE_PATTERNS      = *codec.cpp moc_* */compat/* */3rdparty/*
 176 ALPHABETICAL_INDEX    = YES
 177 COLS_IN_ALPHA_INDEX   = 3
 178 IGNORE_PREFIX         = Q
 179 ENABLE_PREPROCESSING  = YES
 180 MACRO_EXPANSION       = YES
 181 INCLUDE_PATH          = $(QTDIR)/include
 182 PREDEFINED            = Q_PROPERTY(x)= \
 183                         Q_OVERRIDE(x)= \
 184                         Q_EXPORT= \
 185                         Q_ENUMS(x)= \
 186                         "QT_STATIC_CONST=static const " \
 187                         _WS_X11_ \
 188                         INCLUDE_MENUITEM_DEF
 189 EXPAND_ONLY_PREDEF    = YES
 190 EXPAND_AS_DEFINED     = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
 191                         Q_VARIANT_AS
 192 \endverbatim
 193
 194 Here doxygen's preprocessor is used to substitute some
 195 macro names that are normally substituted by the C preprocessor,
 196 but without doing full macro expansion.
 197
 198
 199 \htmlonly
 200 Go to the <a href="commands.html">next</a> section or return to the
 201  <a href="index.html">index</a>.
 202 \endhtmlonly
 203
 204 */
 205 ]]>
 206     </docs>
 207   </footer>
 208
 209   <group name='Project' docs='Project related configuration options'>
 210     <option type='string' id='DOXYFILE_ENCODING' format='string' defval='UTF-8'>
 211       <docs>
 212 <![CDATA[
 213  This tag specifies the encoding used for all characters in the config file that
 214  follow. The default is UTF-8 which is also the encoding used for all text before
 215  the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into
 216  \c libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
 217  possible encodings.
 218 ]]>
 219       </docs>
 220     </option>
 221     <option type='string' id='PROJECT_NAME' format='string' defval='My Project'>
 222       <docs>
 223 <![CDATA[
 224  The \c PROJECT_NAME tag is a single word (or a sequence of words
 225  surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the
 226  documentation is generated. This name is used in the title of most
 227  generated pages and in a few other places.
 228 ]]>
 229       </docs>
 230     </option>
 231     <option type='string' id='PROJECT_NUMBER' format='string' defval=''>
 232       <docs>
 233 <![CDATA[
 234  The \c PROJECT_NUMBER tag can be used to enter a project or revision number.
 235  This could be handy for archiving the generated documentation or
 236  if some version control system is used.
 237 ]]>
 238       </docs>
 239     </option>
 240     <option type='string' id='PROJECT_BRIEF' format='string' defval=''>
 241       <docs>
 242 <![CDATA[
 243  Using the \c PROJECT_BRIEF tag one can provide an optional one line description
 244  for a project that appears at the top of each page and should give viewer
 245  a quick idea about the purpose of the project. Keep the description short.
 246 ]]>
 247       </docs>
 248     </option>
 249
 250     <option type='string' id='PROJECT_LOGO' format='image' defval=''>
 251       <docs>
 252 <![CDATA[
 253  With the \c PROJECT_LOGO tag one can specify an logo or icon that is
 254  included in the documentation. The maximum height of the logo should not
 255  exceed 55 pixels and the maximum width should not exceed 200 pixels.
 256  Doxygen will copy the logo to the output directory.
 257 ]]>
 258       </docs>
 259     </option>
 260     <option type='string' id='OUTPUT_DIRECTORY' format='dir' defval=''>
 261       <docs>
 262 <![CDATA[
 263  The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 264  path into which the generated documentation will be written.
 265  If a relative path is entered, it will be relative to the location
 266  where doxygen was started. If left blank the current directory will be used.
 267 ]]>
 268       </docs>
 269     </option>
 270     <option type='bool' id='CREATE_SUBDIRS' defval='0'>
 271       <docs>
 272 <![CDATA[
 273  If the \c CREATE_SUBDIRS tag is set to \c YES, then doxygen will create
 274  4096 sub-directories (in 2 levels) under the output directory of each output
 275  format and will distribute the generated files over these directories.
 276  Enabling this option can be useful when feeding doxygen a huge amount of source
 277  files, where putting all generated files in the same directory would otherwise
 278  causes performance problems for the file system.
 279 ]]>
 280       </docs>
 281     </option>
 282     <option type='bool' id='ALLOW_UNICODE_NAMES' defval='0'>
 283       <docs>
 284 <![CDATA[
 285  If the \c ALLOW_UNICODE_NAMES tag is set to \c YES,
 286  doxygen will allow non-ASCII characters to appear in the names of generated files.
 287  If set to \c NO, non-ASCII characters will be escaped, for example _xE3_x81_x84
 288  will be used for Unicode U+3044.
 289 ]]>
 290       </docs>
 291     </option>
 292     <option type='enum' id='OUTPUT_LANGUAGE' defval='English'>
 293       <docs>
 294 <![CDATA[
 295  The \c OUTPUT_LANGUAGE tag is used to specify the language in which all
 296  documentation generated by doxygen is written. Doxygen will use this
 297  information to generate all constant output in the proper language.
 298 ]]>
 299       </docs>
 300       <value name='Afrikaans'/>
 301       <value name='Arabic'/>
 302       <value name='Armenian'/>
 303       <value name='Brazilian'/>
 304       <value name='Catalan'/>
 305       <value name='Chinese'/>
 306       <value name='Chinese-Traditional'/>
 307       <value name='Croatian'/>
 308       <value name='Czech'/>
 309       <value name='Danish'/>
 310       <value name='Dutch'/>
 311       <value name='English' desc='(United States)'/>
 312       <value name='Esperanto'/>
 313       <value name='Farsi' desc='(Persian)'/>
 314       <value name='Finnish'/>
 315       <value name='French'/>
 316       <value name='German'/>
 317       <value name='Greek'/>
 318       <value name='Hungarian'/>
 319       <value name='Indonesian'/>
 320       <value name='Italian'/>
 321       <value name='Japanese'/>
 322       <value name='Japanese-en' desc='(Japanese with English messages)'/>
 323       <value name='Korean'/>
 324       <value name='Korean-en' desc='(Korean with English messages)'/>
 325       <value name='Latvian'/>
 326       <value name='Lithuanian'/>
 327       <value name='Macedonian'/>
 328       <value name='Norwegian'/>
 329       <value name='Persian' desc='(Farsi)'/>
 330       <value name='Polish'/>
 331       <value name='Portuguese'/>
 332       <value name='Romanian'/>
 333       <value name='Russian'/>
 334       <value name='Serbian'/>
 335       <value name='Serbian-Cyrillic'/>
 336       <value name='Slovak'/>
 337       <value name='Slovene'/>
 338       <value name='Spanish'/>
 339       <value name='Swedish'/>
 340       <value name='Turkish'/>
 341       <value name='Ukrainian'/>
 342       <value name='Vietnamese'/>
 343     </option>
 344     <option type='bool' id='BRIEF_MEMBER_DESC' defval='1'>
 345       <docs>
 346 <![CDATA[
 347  If the \c BRIEF_MEMBER_DESC tag is set to \c YES doxygen will
 348  include brief member descriptions after the members that are listed in
 349  the file and class documentation (similar to \c Javadoc).
 350  Set to \c NO to disable this.
 351 ]]>
 352       </docs>
 353     </option>
 354     <option type='bool' id='REPEAT_BRIEF' defval='1'>
 355       <docs>
 356 <![CDATA[
 357  If the \c REPEAT_BRIEF tag is set to \c YES doxygen will
 358  prepend the brief description of a member or function before the detailed
 359  description
 360  <br>Note:
 361  If both \ref cfg_hide_undoc_members "HIDE_UNDOC_MEMBERS" and
 362  \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the
 363  brief descriptions will be completely suppressed.
 364 ]]>
 365       </docs>
 366     </option>
 367     <option type='list' id='ABBREVIATE_BRIEF' format='string'>
 368       <docs>
 369 <![CDATA[
 370  This tag implements a quasi-intelligent brief description abbreviator
 371  that is used to form the text in various listings. Each string
 372  in this list, if found as the leading text of the brief description, will be
 373  stripped from the text and the result, after processing the whole list, is used
 374  as the annotated text. Otherwise, the brief description is used as-is. If left
 375  blank, the following values are used (`$name` is automatically replaced with the
 376  name of the entity):
 377 ]]>
 378       </docs>
 379       <value name='The $name class'/>
 380       <value name='The $name widget'/>
 381       <value name='The $name file'/>
 382       <value name='is'/>
 383       <value name='provides'/>
 384       <value name='specifies'/>
 385       <value name='contains'/>
 386       <value name='represents'/>
 387       <value name='a'/>
 388       <value name='an'/>
 389       <value name='the'/>
 390     </option>
 391     <option type='bool' id='ALWAYS_DETAILED_SEC' defval='0'>
 392       <docs>
 393 <![CDATA[
 394  If the \c ALWAYS_DETAILED_SEC and \ref cfg_repeat_brief "REPEAT_BRIEF" tags
 395  are both set to \c YES then
 396  doxygen will generate a detailed section even if there is only a brief
 397  description.
 398 ]]>
 399       </docs>
 400     </option>
 401     <option type='bool' id='INLINE_INHERITED_MEMB' defval='0'>
 402       <docs>
 403 <![CDATA[
 404  If the \c INLINE_INHERITED_MEMB tag is set to \c YES, doxygen will show all inherited
 405  members of a class in the documentation of that class as if those members were
 406  ordinary class members. Constructors, destructors and assignment operators of
 407  the base classes will not be shown.
 408 ]]>
 409       </docs>
 410     </option>
 411     <option type='bool' id='FULL_PATH_NAMES' defval='1'>
 412       <docs>
 413 <![CDATA[
 414  If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full
 415  path before files name in the file list and in the header files. If set
 416  to \c NO the shortest path that makes the file name unique will be used
 417 ]]>
 418       </docs>
 419     </option>
 420     <option type='list' id='STRIP_FROM_PATH' format='string' depends='FULL_PATH_NAMES'>
 421       <docs>
 422 <![CDATA[
 423  The \c STRIP_FROM_PATH tag
 424  can be used to strip a user-defined part of the path. Stripping is
 425  only done if one of the specified strings matches the left-hand part of the
 426  path. The tag can be used to show relative paths in the file list.
 427  If left blank the directory from which doxygen is run is used as the
 428  path to strip.
 429  <br>Note that you can specify absolute paths here, but also
 430  relative paths, which will be relative from the directory where doxygen is
 431  started.
 432 ]]>
 433       </docs>
 434       <value name=''/>
 435     </option>
 436     <option type='list' id='STRIP_FROM_INC_PATH' format='string'>
 437       <docs>
 438 <![CDATA[
 439  The \c STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 440  the path mentioned in the documentation of a class, which tells
 441  the reader which header file to include in order to use a class.
 442  If left blank only the name of the header file containing the class
 443  definition is used. Otherwise one should specify the list of include paths that
 444  are normally passed to the compiler using the `-I` flag.
 445 ]]>
 446       </docs>
 447     </option>
 448     <option type='bool' id='SHORT_NAMES' defval='0'>
 449       <docs>
 450 <![CDATA[
 451  If the \c SHORT_NAMES tag is set to \c YES, doxygen will generate much shorter
 452  (but less readable) file names. This can be useful is your file systems
 453  doesn't support long names like on DOS, Mac, or CD-ROM.
 454 ]]>
 455       </docs>
 456     </option>
 457     <option type='bool' id='JAVADOC_AUTOBRIEF' defval='0'>
 458       <docs>
 459 <![CDATA[
 460   If the \c JAVADOC_AUTOBRIEF tag is set to \c YES then doxygen
 461   will interpret the first line (until the first dot) of a Javadoc-style
 462   comment as the brief description. If set to \c NO, the
 463   Javadoc-style will behave just like regular Qt-style comments
 464   (thus requiring an explicit \ref cmdbrief "\@brief" command for a brief description.)
 465 ]]>
 466       </docs>
 467     </option>
 468     <option type='bool' id='QT_AUTOBRIEF' defval='0'>
 469       <docs>
 470 <![CDATA[
 471   If the \c QT_AUTOBRIEF tag is set to \c YES then doxygen
 472   will interpret the first line (until the first dot) of a Qt-style
 473   comment as the brief description. If set to \c NO, the
 474   Qt-style will behave just like regular Qt-style comments (thus
 475   requiring an explicit \ref cmdbrief "\\brief" command for a brief description.)
 476 ]]>
 477       </docs>
 478     </option>
 479     <option type='bool' id='MULTILINE_CPP_IS_BRIEF' defval='0'>
 480       <docs>
 481 <![CDATA[
 482   The \c MULTILINE_CPP_IS_BRIEF tag can be set to \c YES to make doxygen
 483   treat a multi-line C++ special comment block (i.e. a block of \c //! or \c ///
 484   comments) as a brief description. This used to be the default behavior.
 485   The new default is to treat a multi-line C++ comment block as a detailed
 486   description. Set this tag to \c YES if you prefer the old behavior instead.
 487   <br>Note that setting this tag to \c YES also means that rational rose comments
 488   are not recognized any more.
 489 ]]>
 490       </docs>
 491     </option>
 492     <option type='bool' id='INHERIT_DOCS' defval='1'>
 493       <docs>
 494 <![CDATA[
 495  If the \c INHERIT_DOCS tag is set to \c YES then an undocumented
 496  member inherits the documentation from any documented member that it
 497  re-implements.
 498 ]]>
 499       </docs>
 500     </option>
 501     <option type='bool' id='SEPARATE_MEMBER_PAGES' defval='0'>
 502       <docs>
 503 <![CDATA[
 504  If the \c SEPARATE_MEMBER_PAGES tag is set to \c YES, then doxygen will produce
 505  a new page for each member. If set to \c NO, the documentation of a member will
 506  be part of the file/class/namespace that contains it.
 507 ]]>
 508       </docs>
 509     </option>
 510     <option type='int' id='TAB_SIZE' minval='1' maxval='16' defval='4'>
 511       <docs>
 512 <![CDATA[
 513  The \c TAB_SIZE tag can be used to set the number of spaces in a tab.
 514  Doxygen uses this value to replace tabs by spaces in code fragments.
 515 ]]>
 516       </docs>
 517     </option>
 518     <option type='list' id='ALIASES' format='string'>
 519       <docs>
 520 <![CDATA[
 521  This tag can be used to specify a number of aliases that act
 522  as commands in the documentation. An alias has the form:
 523 \verbatim
 524  name=value
 525 \endverbatim
 526  For example adding
 527 \verbatim
 528  "sideeffect=@par Side Effects:\n"
 529 \endverbatim
 530  will allow you to
 531  put the command \c \\sideeffect (or \c \@sideeffect) in the documentation, which
 532  will result in a user-defined paragraph with heading "Side Effects:".
 533  You can put \ref cmdn "\\n"'s in the value part of an alias to insert newlines.
 534 ]]>
 535       </docs>
 536     </option>
 537     <option type='list' id='TCL_SUBST' format='string'>
 538       <docs>
 539 <![CDATA[
 540  This tag can be used to specify a number of word-keyword mappings (TCL only).
 541  A mapping has the form <code>"name=value"</code>. For example adding
 542  <code>"class=itcl::class"</code> will allow you to use the command class in the
 543  <code>itcl::class</code> meaning.
 544 ]]>
 545       </docs>
 546     </option>
 547     <option type='bool' id='OPTIMIZE_OUTPUT_FOR_C' defval='0'>
 548       <docs>
 549 <![CDATA[
 550  Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists
 551  of C sources only. Doxygen will then generate output that is more tailored
 552  for C. For instance, some of the names that are used will be different.
 553  The list of all members will be omitted, etc.
 554 ]]>
 555       </docs>
 556     </option>
 557     <option type='bool' id='OPTIMIZE_OUTPUT_JAVA' defval='0'>
 558       <docs>
 559 <![CDATA[
 560  Set the \c OPTIMIZE_OUTPUT_JAVA tag to \c YES if your project consists of Java or
 561  Python sources only. Doxygen will then generate output that is more tailored
 562  for that language. For instance, namespaces will be presented as packages,
 563  qualified scopes will look different, etc.
 564 ]]>
 565       </docs>
 566     </option>
 567     <option type='bool' id='OPTIMIZE_FOR_FORTRAN' defval='0'>
 568       <docs>
 569 <![CDATA[
 570  Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran
 571  sources. Doxygen will then generate output that is tailored for Fortran.
 572 ]]>
 573       </docs>
 574     </option>
 575     <option type='bool' id='OPTIMIZE_OUTPUT_VHDL' defval='0'>
 576       <docs>
 577 <![CDATA[
 578  Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL
 579  sources. Doxygen will then generate output that is tailored for VHDL.
 580 ]]>
 581       </docs>
 582     </option>
 583     <option type='list' id='EXTENSION_MAPPING' format='string'>
 584       <docs>
 585 <![CDATA[
 586  Doxygen selects the parser to use depending on the extension of the files it parses.
 587  With this tag you can assign which parser to use for a given extension.
 588  Doxygen has a built-in mapping, but you can override or extend it using this tag.
 589  The format is <code>ext=language</code>, where \c ext is a file extension, and language is one of
 590  the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
 591  Objective-C, Python, Fortran (fixed format Fortran: FortranFixed,
 592  free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In
 593  the later case the parser tries to guess whether the code is fixed or free
 594  formatted code, this is the default for Fortran type files), VHDL.
 595
 596  For instance to make doxygen treat
 597  <code>.inc</code> files as Fortran files (default is PHP), and <code>.f</code> files as C (default is Fortran),
 598  use: `inc=Fortran f=C`.
 599
 600  <br>Note For files without extension you can use `no_extension` as a placeholder.
 601  <br>Note that for custom extensions you also need to set \ref cfg_file_patterns "FILE_PATTERNS" otherwise the
 602  files are not read by doxygen.
 603 ]]>
 604       </docs>
 605     </option>
 606     <option type='bool' id='MARKDOWN_SUPPORT' defval='1'>
 607       <docs>
 608 <![CDATA[
 609  If the \c MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all
 610  comments according to the Markdown format, which allows for more readable
 611  documentation. See http://daringfireball.net/projects/markdown/ for details.
 612  The output of markdown processing is further processed by doxygen, so you
 613  can mix doxygen, HTML, and XML commands with Markdown formatting.
 614  Disable only in case of backward compatibilities issues.
 615 ]]>
 616       </docs>
 617     </option>
 618     <option type='bool' id='AUTOLINK_SUPPORT' defval='1'>
 619       <docs>
 620 <![CDATA[
 621  When enabled doxygen tries to link words that correspond to documented classes,
 622  or namespaces to their corresponding documentation. Such a link can be
 623  prevented in individual cases by by putting a \c % sign in front of the word or
 624  globally by setting \c AUTOLINK_SUPPORT to \c NO.
 625 ]]>
 626       </docs>
 627     </option>
 628     <option type='bool' id='BUILTIN_STL_SUPPORT' defval='0'>
 629       <docs>
 630 <![CDATA[
 631  If you use STL classes (i.e. `std::string`, `std::vector`, etc.) but do not want to
 632  include (a tag file for) the STL sources as input, then you should
 633  set this tag to \c YES in order to let doxygen match functions declarations and
 634  definitions whose arguments contain STL classes (e.g. `func(std::string`); versus
 635  `func(std::string) {}`). This also make the inheritance and collaboration
 636  diagrams that involve STL classes more complete and accurate.
 637 ]]>
 638       </docs>
 639     </option>
 640     <option type='bool' id='CPP_CLI_SUPPORT' defval='0'>
 641       <docs>
 642 <![CDATA[
 643  If you use Microsoft's C++/CLI language, you should set this option to \c YES to
 644  enable parsing support.
 645 ]]>
 646       </docs>
 647     </option>
 648     <option type='bool' id='SIP_SUPPORT' defval='0'>
 649       <docs>
 650 <![CDATA[
 651  Set the \c SIP_SUPPORT tag to \c YES if your project consists
 652  of <a href="http://www.riverbankcomputing.co.uk/software/sip/intro">sip</a> sources only.
 653  Doxygen will parse them like normal C++ but will assume all classes use public
 654  instead of private inheritance when no explicit protection keyword is present.
 655 ]]>
 656       </docs>
 657     </option>
 658     <option type='bool' id='IDL_PROPERTY_SUPPORT' defval='1'>
 659       <docs>
 660 <![CDATA[
 661  For Microsoft's IDL there are \c propget and \c propput attributes to indicate getter
 662  and setter methods for a property. Setting this option to \c YES
 663  will make doxygen to replace the get and set methods by a property in the
 664  documentation. This will only work if the methods are indeed getting or
 665  setting a simple type. If this is not the case, or you want to show the
 666  methods anyway, you should set this option to \c NO.
 667 ]]>
 668       </docs>
 669     </option>
 670     <option type='bool' id='DISTRIBUTE_GROUP_DOC' defval='0'>
 671       <docs>
 672 <![CDATA[
 673  If member grouping is used in the documentation and the \c DISTRIBUTE_GROUP_DOC
 674  tag is set to \c YES, then doxygen will reuse the documentation of the first
 675  member in the group (if any) for the other members of the group. By default
 676  all members of a group must be documented explicitly.
 677 ]]>
 678       </docs>
 679     </option>
 680     <option type='bool' id='SUBGROUPING' defval='1'>
 681       <docs>
 682 <![CDATA[
 683  Set the \c SUBGROUPING tag to \c YES to allow class member groups of
 684  the same type (for instance a group of public functions) to be put as a
 685  subgroup of that type (e.g. under the Public Functions section). Set it to
 686  \c NO to prevent subgrouping. Alternatively, this can be done per class using
 687  the \ref cmdnosubgrouping "\\nosubgrouping" command.
 688 ]]>
 689       </docs>
 690     </option>
 691     <option type='bool' id='INLINE_GROUPED_CLASSES' defval='0'>
 692       <docs>
 693 <![CDATA[
 694  When the \c INLINE_GROUPED_CLASSES tag is set to \c YES, classes, structs and
 695  unions are shown inside the group in which they are included
 696  (e.g. using \ref cmdingroup "\\ingroup") instead of on a separate page (for HTML and Man pages)
 697  or section (for \f$\mbox{\LaTeX}\f$ and RTF).
 698  <br>Note that this feature does not work in
 699  combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES".
 700 ]]>
 701       </docs>
 702     </option>
 703     <option type='bool' id='INLINE_SIMPLE_STRUCTS' defval='0'>
 704       <docs>
 705 <![CDATA[
 706  When the \c INLINE_SIMPLE_STRUCTS tag is set to \c YES, structs, classes, and
 707  unions with only public data fields or simple typedef fields will be shown
 708  inline in the documentation of the scope in which they are defined (i.e. file,
 709  namespace, or group documentation), provided this scope is documented. If set
 710  to \c NO, structs, classes, and unions are shown on a separate
 711  page (for HTML and Man pages) or section (for \f$\mbox{\LaTeX}\f$ and RTF).
 712 ]]>
 713       </docs>
 714     </option>
 715     <option type='bool' id='TYPEDEF_HIDES_STRUCT' defval='0'>
 716       <docs>
 717 <![CDATA[
 718  When \c TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or enum
 719  is documented as struct, union, or enum with the name of the typedef. So
 720  <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct
 721  with name \c TypeT. When disabled the typedef will appear as a member of a file,
 722  namespace, or class. And the struct will be named \c TypeS. This can typically
 723  be useful for C code in case the coding convention dictates that all compound
 724  types are typedef'ed and only the typedef is referenced, never the tag name.
 725 ]]>
 726       </docs>
 727     </option>
 728     <option type='int' id='LOOKUP_CACHE_SIZE' minval='0' maxval='9' defval='0'>
 729       <!-- be carefull when changing these formulas as they are hard coded in the conversion script -->
 730       <docs>
 731 <![CDATA[
 732  The size of the symbol lookup cache can be
 733  set using \c LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
 734  their name and scope. Since this can be an expensive process and often the
 735  same symbol appears multiple times in the code, doxygen keeps a cache of
 736  pre-resolved symbols. If the cache is too small doxygen will become slower.
 737  If the cache is too large, memory is wasted. The cache size is given by this
 738  formula: \f$2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0,
 739  corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.
 740  At the end of a run doxygen will report the cache usage and suggest the
 741  optimal cache size from a speed point of view.
 742 ]]>
 743       </docs>
 744     </option>
 745   </group>
 746   <group name='Build' docs='Build related configuration options'>
 747     <option type='bool' id='EXTRACT_ALL' defval='0'>
 748       <docs>
 749 <![CDATA[
 750  If the \c EXTRACT_ALL tag is set to \c YES doxygen will assume all
 751  entities in documentation are documented, even if no documentation was
 752  available. Private class members and static file members will be hidden
 753  unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively
 754  \ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES.
 755
 756  \note This will also disable the warnings about undocumented members
 757  that are normally produced when \ref cfg_warnings "WARNINGS" is
 758  set to \c YES.
 759 ]]>
 760       </docs>
 761     </option>
 762     <option type='bool' id='EXTRACT_PRIVATE' defval='0'>
 763       <docs>
 764 <![CDATA[
 765  If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a
 766  class will be included in the documentation.
 767 ]]>
 768       </docs>
 769     </option>
 770     <option type='bool' id='EXTRACT_PACKAGE' defval='0'>
 771       <docs>
 772 <![CDATA[
 773  If the \c EXTRACT_PACKAGE tag is set to \c YES all members with package
 774  or internal scope will be included in the documentation.
 775 ]]>
 776       </docs>
 777     </option>
 778     <option type='bool' id='EXTRACT_STATIC' defval='0'>
 779       <docs>
 780 <![CDATA[
 781  If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file
 782  will be included in the documentation.
 783 ]]>
 784       </docs>
 785     </option>
 786     <option type='bool' id='EXTRACT_LOCAL_CLASSES' defval='1'>
 787       <docs>
 788 <![CDATA[
 789  If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES classes (and structs)
 790  defined locally in source files will be included in the documentation.
 791  If set to \c NO only classes defined in header files are included. Does not
 792  have any effect for Java sources.
 793 ]]>
 794       </docs>
 795     </option>
 796     <option type='bool' id='EXTRACT_LOCAL_METHODS' defval='0'>
 797       <docs>
 798 <![CDATA[
 799  This flag is only useful for Objective-C code. When set to \c YES local
 800  methods, which are defined in the implementation section but not in
 801  the interface are included in the documentation.
 802  If set to \c NO only methods in the interface are included.
 803 ]]>
 804       </docs>
 805     </option>
 806     <option type='bool' id='EXTRACT_ANON_NSPACES' defval='0'>
 807       <docs>
 808 <![CDATA[
 809  If this flag is set to \c YES, the members of anonymous namespaces will be extracted
 810  and appear in the documentation as a namespace called 'anonymous_namespace{file}',
 811  where file will be replaced with the base name of the file that contains the anonymous
 812  namespace. By default anonymous namespace are hidden.
 813 ]]>
 814       </docs>
 815     </option>
 816     <option type='bool' id='HIDE_UNDOC_MEMBERS' defval='0'>
 817       <docs>
 818 <![CDATA[
 819  If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all
 820  undocumented members inside documented classes or files.
 821  If set to \c NO these members will be included in the
 822  various overviews, but no documentation section is generated.
 823  This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
 824 ]]>
 825       </docs>
 826     </option>
 827     <option type='bool' id='HIDE_UNDOC_CLASSES' defval='0'>
 828       <docs>
 829 <![CDATA[
 830  If the \c HIDE_UNDOC_CLASSES tag is set to \c YES, doxygen will hide all
 831  undocumented classes that are normally visible in the class hierarchy.
 832  If set to \c NO these classes will be included in the
 833  various overviews.
 834  This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
 835 ]]>
 836       </docs>
 837     </option>
 838     <option type='bool' id='HIDE_FRIEND_COMPOUNDS' defval='0'>
 839       <docs>
 840 <![CDATA[
 841  If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, doxygen will hide all
 842  friend (class|struct|union) declarations.
 843  If set to \c NO these declarations will be included in the
 844  documentation.
 845 ]]>
 846       </docs>
 847     </option>
 848     <option type='bool' id='HIDE_IN_BODY_DOCS' defval='0'>
 849       <docs>
 850 <![CDATA[
 851  If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, doxygen will hide any
 852  documentation blocks found inside the body of a function.
 853  If set to \c NO these blocks will be appended to the
 854  function's detailed documentation block.
 855 ]]>
 856       </docs>
 857     </option>
 858     <option type='bool' id='INTERNAL_DOCS' defval='0'>
 859       <docs>
 860 <![CDATA[
 861  The \c INTERNAL_DOCS tag determines if documentation
 862  that is typed after a \ref cmdinternal "\\internal" command is included. If the tag is set
 863  to \c NO then the documentation will be excluded.
 864  Set it to \c YES to include the internal documentation.
 865 ]]>
 866       </docs>
 867     </option>
 868     <option type='bool' id='CASE_SENSE_NAMES' defval='0' altdefval='portable_fileSystemIsCaseSensitive()'>
 869       <docs>
 870 <![CDATA[
 871  If the \c CASE_SENSE_NAMES tag is set to \c NO then doxygen
 872  will only generate file names in lower-case letters. If set to
 873  \c YES upper-case letters are also allowed. This is useful if you have
 874  classes or files whose names only differ in case and if your file system
 875  supports case sensitive file names. Windows and Mac users are advised to set this
 876  option to \c NO.
 877 ]]>
 878       </docs>
 879     </option>
 880     <option type='bool' id='HIDE_SCOPE_NAMES' defval='0'>
 881       <docs>
 882 <![CDATA[
 883  If the \c HIDE_SCOPE_NAMES tag is set to \c NO then doxygen
 884  will show members with their full class and namespace scopes in the
 885  documentation. If set to \c YES the scope will be hidden.
 886 ]]>
 887       </docs>
 888     </option>
 889     <option type='bool' id='SHOW_INCLUDE_FILES' defval='1'>
 890       <docs>
 891 <![CDATA[
 892  If the \c SHOW_INCLUDE_FILES tag is set to \c YES then doxygen
 893  will put a list of the files that are included by a file in the documentation
 894  of that file.
 895 ]]>
 896       </docs>
 897     </option>
 898     <option type='bool' id='SHOW_GROUPED_MEMB_INC' defval='0'>
 899       <docs>
 900 <![CDATA[
 901  If the SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
 902  will add for each grouped member an include statement to the documentation,
 903  telling the reader which file to include in order to use the member.
 904 ]]>
 905       </docs>
 906     </option>
 907     <option type='bool' id='FORCE_LOCAL_INCLUDES' defval='0'>
 908       <docs>
 909 <![CDATA[
 910  If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then doxygen
 911  will list include files with double quotes in the documentation
 912  rather than with sharp brackets.
 913 ]]>
 914       </docs>
 915     </option>
 916     <option type='bool' id='INLINE_INFO' defval='1'>
 917       <docs>
 918 <![CDATA[
 919  If the \c INLINE_INFO tag is set to \c YES then a tag [inline]
 920  is inserted in the documentation for inline members.
 921 ]]>
 922       </docs>
 923     </option>
 924     <option type='bool' id='SORT_MEMBER_DOCS' defval='1'>
 925       <docs>
 926 <![CDATA[
 927  If the \c SORT_MEMBER_DOCS tag is set to \c YES then doxygen
 928  will sort the (detailed) documentation of file and class members
 929  alphabetically by member name. If set to \c NO the members will appear in
 930  declaration order.
 931 ]]>
 932       </docs>
 933     </option>
 934     <option type='bool' id='SORT_BRIEF_DOCS' defval='0'>
 935       <docs>
 936 <![CDATA[
 937  If the \c SORT_BRIEF_DOCS tag is set to \c YES then doxygen will sort the
 938  brief descriptions of file, namespace and class members alphabetically
 939  by member name. If set to \c NO the members will appear in
 940  declaration order. Note that this will also influence the order of the
 941  classes in the class list.
 942 ]]>
 943       </docs>
 944     </option>
 945     <option type='bool' id='SORT_MEMBERS_CTORS_1ST' defval='0'>
 946       <docs>
 947 <![CDATA[
 948  If the \c SORT_MEMBERS_CTORS_1ST tag is set to \c YES then doxygen
 949  will sort the (brief and detailed) documentation of class members so that
 950  constructors and destructors are listed first. If set to \c NO
 951  the constructors will appear in the respective orders defined by
 952  \ref cfg_sort_brief_docs "SORT_BRIEF_DOCS" and \ref cfg_sort_member_docs "SORT_MEMBER_DOCS".
 953  \note If \ref cfg_sort_brief_docs "SORT_BRIEF_DOCS" is set to \c NO this option is ignored for
 954        sorting brief member documentation.
 955  \note If \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" is set to \c NO this option is ignored for
 956        sorting detailed member documentation.
 957 ]]>
 958       </docs>
 959     </option>
 960     <option type='bool' id='SORT_GROUP_NAMES' defval='0'>
 961       <docs>
 962 <![CDATA[
 963  If the \c SORT_GROUP_NAMES tag is set to \c YES then doxygen will sort the
 964  hierarchy of group names into alphabetical order. If set to \c NO
 965  the group names will appear in their defined order.
 966 ]]>
 967       </docs>
 968     </option>
 969     <option type='bool' id='SORT_BY_SCOPE_NAME' defval='0'>
 970       <docs>
 971 <![CDATA[
 972  If the \c SORT_BY_SCOPE_NAME tag is set to \c YES, the class list will be
 973  sorted by fully-qualified names, including namespaces. If set to
 974  \c NO, the class list will be sorted only by class name,
 975  not including the namespace part.
 976  \note This option is not very useful if \ref cfg_hide_scope_names "HIDE_SCOPE_NAMES" is set to \c YES.
 977  \note This option applies only to the class list, not to the
 978        alphabetical list.
 979 ]]>
 980       </docs>
 981     </option>
 982     <option type='bool' id='STRICT_PROTO_MATCHING' defval='0'>
 983       <docs>
 984 <![CDATA[
 985  If the \c STRICT_PROTO_MATCHING option is enabled and doxygen fails to
 986  do proper type resolution of all parameters of a function it will reject a
 987  match between the prototype and the implementation of a member function even
 988  if there is only one candidate or it is obvious which candidate to choose
 989  by doing a simple string match. By disabling \c STRICT_PROTO_MATCHING doxygen
 990  will still accept a match between prototype and implementation in such cases.
 991 ]]>
 992       </docs>
 993     </option>
 994     <option type='bool' id='GENERATE_TODOLIST' defval='1'>
 995       <docs>
 996 <![CDATA[
 997  The \c GENERATE_TODOLIST tag can be used to enable (\c YES) or
 998  disable (\c NO) the todo list. This list is created by
 999  putting \ref cmdtodo "\\todo" commands in the documentation.
1000 ]]>
1001       </docs>
1002     </option>
1003     <option type='bool' id='GENERATE_TESTLIST' defval='1'>
1004       <docs>
1005 <![CDATA[
1006  The \c GENERATE_TESTLIST tag can be used to enable (\c YES) or
1007  disable (\c NO) the test list. This list is created by
1008  putting \ref cmdtest "\\test" commands in the documentation.
1009 ]]>
1010       </docs>
1011     </option>
1012     <option type='bool' id='GENERATE_BUGLIST' defval='1'>
1013       <docs>
1014 <![CDATA[
1015  The \c GENERATE_BUGLIST tag can be used to enable (\c YES) or
1016  disable (\c NO) the bug list. This list is created by
1017  putting \ref cmdbug "\\bug" commands in the documentation.
1018 ]]>
1019       </docs>
1020     </option>
1021     <option type='bool' id='GENERATE_DEPRECATEDLIST' defval='1'>
1022       <docs>
1023 <![CDATA[
1024  The \c GENERATE_DEPRECATEDLIST tag can be used to enable (\c YES) or
1025  disable (\c NO) the deprecated list. This list is created by
1026  putting \ref cmddeprecated "\\deprecated"
1027  commands in the documentation.
1028 ]]>
1029       </docs>
1030     </option>
1031     <option type='list' id='ENABLED_SECTIONS' format='string'>
1032       <docs>
1033 <![CDATA[
1034  The \c ENABLED_SECTIONS tag can be used to enable conditional
1035  documentation sections, marked by \ref cmdif "\\if" \<section_label\> ...
1036  \ref cmdendif "\\endif" and \ref cmdcond "\\cond" \<section_label\> ...
1037  \ref cmdendcond "\\endcond" blocks.
1038 ]]>
1039       </docs>
1040     </option>
1041     <option type='int' id='MAX_INITIALIZER_LINES' minval='0' maxval='10000' defval='30'>
1042       <docs>
1043 <![CDATA[
1044  The \c MAX_INITIALIZER_LINES tag determines the maximum number of lines
1045  that the initial value of a variable or macro / define can have for it to appear in
1046  the documentation. If the initializer
1047  consists of more lines than specified here it will be hidden. Use a value
1048  of 0 to hide initializers completely. The appearance of the value of
1049  individual variables and macros / defines can be controlled using \ref cmdshowinitializer "\\showinitializer"
1050  or \ref cmdhideinitializer "\\hideinitializer" command in the documentation regardless of this setting.
1051 ]]>
1052       </docs>
1053     </option>
1054     <option type='bool' id='SHOW_USED_FILES' defval='1'>
1055       <docs>
1056 <![CDATA[
1057  Set the \c SHOW_USED_FILES tag to \c NO to disable the list of files generated
1058  at the bottom of the documentation of classes and structs. If set to \c YES the
1059  list will mention the files that were used to generate the documentation.
1060 ]]>
1061       </docs>
1062     </option>
1063     <option type='bool' id='SHOW_FILES' defval='1'>
1064       <docs>
1065 <![CDATA[
1066  Set the \c SHOW_FILES tag to \c NO to disable the generation of the Files page.
1067  This will remove the Files entry from the Quick Index and from the
1068  Folder Tree View (if specified).
1069 ]]>
1070       </docs>
1071     </option>
1072     <option type='bool' id='SHOW_NAMESPACES' defval='1'>
1073       <docs>
1074 <![CDATA[
1075  Set the \c SHOW_NAMESPACES tag to \c NO to disable the generation of the
1076  Namespaces page. This will remove the Namespaces entry from the Quick Index
1077  and from the Folder Tree View (if specified).
1078 ]]>
1079       </docs>
1080     </option>
1081     <option type='string' id='FILE_VERSION_FILTER' format='file' defval=''>
1082       <docs>
1083 <![CDATA[
1084  The \c FILE_VERSION_FILTER tag can be used to specify a program or script that
1085  doxygen should invoke to get the current version for each file (typically from the
1086  version control system). Doxygen will invoke the program by executing (via
1087  <code>popen()</code>) the command <code>command input-file</code>, where \c command is
1088  the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name
1089  of an input file provided by doxygen.
1090  Whatever the program writes to standard output is used as the file version.
1091 ]]>
1092       </docs>
1093       <docs doxywizard='0' doxyfile='0'>
1094 <![CDATA[
1095 Example of using a shell script as a filter for Unix:
1096 \verbatim
1097  FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
1098 \endverbatim
1099 <br>
1100 Example shell script for CVS:
1101 \verbatim
1102 #!/bin/sh
1103 cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
1104 \endverbatim
1105 <br>
1106 Example shell script for Subversion:
1107 \verbatim
1108 #!/bin/sh
1109 svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'
1110 \endverbatim
1111 <br>
1112 Example filter for ClearCase:
1113 \verbatim
1114 FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
1115 \endverbatim
1116 ]]>
1117       </docs>
1118       <docs documentation='0'>
1119 <![CDATA[
1120  For an example see the documentation.
1121 ]]>
1122       </docs>
1123     </option>
1124     <option type='string' id='LAYOUT_FILE' format='file' defval=''>
1125       <docs>
1126 <![CDATA[
1127  The \c LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
1128  doxygen. The layout file controls the global structure of the generated output files
1129  in an output format independent way. To create the layout file that represents
1130  doxygen's defaults, run doxygen with the `-l` option. You can optionally specify a
1131  file name after the option, if omitted \c DoxygenLayout.xml will be used as the name
1132  of the layout file.
1133  <br>Note that if you run doxygen from a directory containing
1134  a file called \c DoxygenLayout.xml, doxygen will parse it automatically even if
1135  the \c LAYOUT_FILE tag is left empty.
1136 ]]>
1137       </docs>
1138     </option>
1139     <option type='list' id='CITE_BIB_FILES' format='file'>
1140       <docs>
1141 <![CDATA[
1142  The \c CITE_BIB_FILES tag can be used to specify one or more \c bib files
1143  containing the reference definitions. This must be a list of <code>.bib</code> files. The
1144  <code>.bib</code> extension is automatically appended if omitted. This requires the
1145  \c bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeX for
1146  more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled
1147  using \ref cfg_latex_bib_style "LATEX_BIB_STYLE".
1148  To use this
1149  feature you need \c bibtex and \c perl available in the search path. Do not use
1150  file names with spaces, \c bibtex cannot handle them.
1151  See also \ref cmdcite "\\cite" for info how to create references.
1152 ]]>
1153       </docs>
1154     </option>
1155   </group>
1156   <group name='Messages' docs='Configuration options related to warning and progress messages'>
1157     <option type='bool' id='QUIET' defval='0'>
1158       <docs>
1159 <![CDATA[
1160  The \c QUIET tag can be used to turn on/off the messages that are generated
1161  to standard output by doxygen. If \c QUIET is set to \c YES this implies that the messages are off.
1162 ]]>
1163       </docs>
1164     </option>
1165     <option type='bool' id='WARNINGS' defval='1'>
1166       <docs>
1167 <![CDATA[
1168  The \c WARNINGS tag can be used to turn on/off the warning messages that are
1169  generated to standard error (\c stderr) by doxygen. If \c WARNINGS is set to
1170  \c YES this implies that the warnings are on.
1171 <br>
1172  \b Tip: Turn warnings on while writing the documentation.
1173 ]]>
1174       </docs>
1175     </option>
1176     <option type='bool' id='WARN_IF_UNDOCUMENTED' defval='1'>
1177       <docs>
1178 <![CDATA[
1179  If the \c WARN_IF_UNDOCUMENTED tag is set to \c YES, then doxygen will generate warnings
1180  for undocumented members. If \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES then this flag will
1181  automatically be disabled.
1182 ]]>
1183       </docs>
1184     </option>
1185     <option type='bool' id='WARN_IF_DOC_ERROR' defval='1'>
1186       <docs>
1187 <![CDATA[
1188  If the \c WARN_IF_DOC_ERROR tag is set to \c YES, doxygen will generate warnings for
1189  potential errors in the documentation, such as not documenting some
1190  parameters in a documented function, or documenting parameters that
1191  don't exist or using markup commands wrongly.
1192 ]]>
1193       </docs>
1194     </option>
1195     <option type='bool' id='WARN_NO_PARAMDOC' defval='0'>
1196       <docs>
1197 <![CDATA[
1198  This \c WARN_NO_PARAMDOC option can be enabled to get warnings for
1199  functions that are documented, but have no documentation for their parameters
1200  or return value. If set to \c NO doxygen will only warn about
1201  wrong or incomplete parameter documentation, but not about the absence of
1202  documentation.
1203 ]]>
1204       </docs>
1205     </option>
1206     <option type='string' id='WARN_FORMAT' format='string' defval='$file:$line: $text'>
1207       <docs>
1208 <![CDATA[
1209  The \c WARN_FORMAT tag determines the format of the warning messages that
1210  doxygen can produce. The string should contain the <code>\$file</code>,
1211  <code>\$line</code>, and <code>\$text</code>
1212  tags, which will be replaced by the file and line number from which the
1213  warning originated and the warning text.
1214  Optionally the format may contain
1215  <code>$version</code>, which will be replaced by the version of the file (if it could
1216  be obtained via \ref cfg_file_version_filter "FILE_VERSION_FILTER")
1217 ]]>
1218       </docs>
1219     </option>
1220     <option type='string' id='WARN_LOGFILE' format='file' defval=''>
1221       <docs>
1222 <![CDATA[
1223  The \c WARN_LOGFILE tag can be used to specify a file to which warning
1224  and error messages should be written. If left blank the output is written
1225  to standard error (`stderr`).
1226 ]]>
1227       </docs>
1228     </option>
1229   </group>
1230   <group name='Input' docs='Configuration options related to the input files'>
1231     <option type='list' id='INPUT' format='filedir'>
1232       <docs>
1233 <![CDATA[
1234  The \c INPUT tag is used to specify the files and/or directories that contain
1235  documented source files. You may enter file names like
1236  \c myfile.cpp or directories like \c /usr/src/myproject.
1237  Separate the files or directories with spaces.
1238
1239  \note If this tag is empty the current directory is searched.
1240 ]]>
1241       </docs>
1242       <value name=''/>
1243     </option>
1244     <option type='string' id='INPUT_ENCODING' format='string' defval='UTF-8'>
1245       <docs>
1246 <![CDATA[
1247  This tag can be used to specify the character encoding of the source files that
1248  doxygen parses. Internally doxygen uses the UTF-8 encoding.
1249  Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding.
1250  See <a href="http://www.gnu.org/software/libiconv">the libiconv documentation</a> for
1251  the list of possible encodings.
1252 ]]>
1253       </docs>
1254     </option>
1255     <option type='list' id='FILE_PATTERNS' format='string'>
1256       <docs>
1257 <![CDATA[
1258  If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the
1259  \c FILE_PATTERNS tag to specify one or more wildcard patterns
1260  (like `*.cpp` and `*.h`) to filter out the source-files
1261  in the directories. If left blank the following patterns are tested:
1262 ]]>
1263       </docs>
1264       <value name='*.c'/>
1265       <value name='*.cc'/>
1266       <value name='*.cxx'/>
1267       <value name='*.cpp'/>
1268       <value name='*.c++'/>
1269       <value name='*.java'/>
1270       <value name='*.ii'/>
1271       <value name='*.ixx'/>
1272       <value name='*.ipp'/>
1273       <value name='*.i++'/>
1274       <value name='*.inl'/>
1275       <value name='*.idl'/>
1276       <value name='*.ddl'/>
1277       <value name='*.odl'/>
1278       <value name='*.h'/>
1279       <value name='*.hh'/>
1280       <value name='*.hxx'/>
1281       <value name='*.hpp'/>
1282       <value name='*.h++'/>
1283       <value name='*.cs'/>
1284       <value name='*.d'/>
1285       <value name='*.php'/>
1286       <value name='*.php4'/>
1287       <value name='*.php5'/>
1288       <value name='*.phtml'/>
1289       <value name='*.inc'/>
1290       <value name='*.m'/>
1291       <value name='*.markdown'/>
1292       <value name='*.md'/>
1293       <value name='*.mm'/>
1294       <value name='*.dox'/>
1295       <value name='*.py'/>
1296       <value name='*.f90'/>
1297       <value name='*.f'/>
1298       <value name='*.for'/>
1299       <value name='*.tcl'/>
1300       <value name='*.vhd'/>
1301       <value name='*.vhdl'/>
1302       <value name='*.ucf'/>
1303       <value name='*.qsf'/>
1304       <value name='*.as'/>
1305       <value name='*.js'/>
1306     </option>
1307     <option type='bool' id='RECURSIVE' defval='0'>
1308       <docs>
1309 <![CDATA[
1310  The \c RECURSIVE tag can be used to specify whether or not subdirectories
1311  should be searched for input files as well.
1312 ]]>
1313       </docs>
1314     </option>
1315     <option type='list' id='EXCLUDE' format='filedir'>
1316       <docs>
1317 <![CDATA[
1318  The \c EXCLUDE tag can be used to specify files and/or directories that should be
1319  excluded from the \ref cfg_input "INPUT" source files. This way you can easily exclude a
1320  subdirectory from a directory tree whose root is specified with the \ref cfg_input "INPUT" tag.
1321  <br>Note that relative paths are relative to the directory from which doxygen is run.
1322 ]]>
1323       </docs>
1324     </option>
1325     <option type='bool' id='EXCLUDE_SYMLINKS' defval='0'>
1326       <docs>
1327 <![CDATA[
1328  The \c EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories
1329  that are symbolic links (a Unix file system feature) are excluded from the input.
1330 ]]>
1331       </docs>
1332     </option>
1333     <option type='list' id='EXCLUDE_PATTERNS' format='string'>
1334       <docs>
1335 <![CDATA[
1336  If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the
1337  \c EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1338  certain files from those directories.
1339  <br>Note that the wildcards are matched
1340  against the file with absolute path, so to exclude all test directories
1341  for example use the pattern `*``/test/``*`
1342 ]]>
1343       </docs>
1344     </option>
1345     <option type='list' id='EXCLUDE_SYMBOLS' format='string'>
1346       <docs>
1347 <![CDATA[
1348  The \c EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1349  (namespaces, classes, functions, etc.) that should be excluded from the
1350  output. The symbol name can be a fully qualified name, a word, or if the
1351  wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`,
1352  `AClass::ANamespace`, `ANamespace::*Test`
1353  <br>Note that the wildcards are matched against the file with absolute path,
1354  so to exclude all test directories use the pattern
1355  `*``/test/``*`
1356 ]]>
1357       </docs>
1358     </option>
1359     <option type='list' id='EXAMPLE_PATH' format='filedir'>
1360       <docs>
1361 <![CDATA[
1362  The \c EXAMPLE_PATH tag can be used to specify one or more files or
1363  directories that contain example code fragments that are included (see
1364  the \ref cmdinclude "\\include" command).
1365 ]]>
1366       </docs>
1367     </option>
1368     <option type='list' id='EXAMPLE_PATTERNS' format='string'>
1369       <docs>
1370 <![CDATA[
1371  If the value of the \ref cfg_example_path "EXAMPLE_PATH" tag contains directories,
1372  you can use the
1373  \c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like `*.cpp`
1374  and `*.h`) to filter out the source-files in the directories. If left
1375  blank all files are included.
1376 ]]>
1377       </docs>
1378       <value name='*' show_docu='NO'/>
1379     </option>
1380     <option type='bool' id='EXAMPLE_RECURSIVE' defval='0'>
1381       <docs>
1382 <![CDATA[
1383  If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be
1384  searched for input files to be used with the \ref cmdinclude "\\include" or
1385  \ref cmddontinclude "\\dontinclude"
1386  commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag.
1387 ]]>
1388       </docs>
1389     </option>
1390     <option type='list' id='IMAGE_PATH' format='filedir'>
1391       <docs>
1392 <![CDATA[
1393  The \c IMAGE_PATH tag can be used to specify one or more files or
1394  directories that contain images that are to be included in the
1395  documentation (see the \ref cmdimage "\\image" command).
1396 ]]>
1397       </docs>
1398     </option>
1399     <option type='string' id='INPUT_FILTER' format='file' defval=''>
1400       <docs>
1401 <![CDATA[
1402  The \c INPUT_FILTER tag can be used to specify a program that doxygen should
1403  invoke to filter for each input file. Doxygen will invoke the filter program
1404  by executing (via <code>popen()</code>) the command:
1405  <br>
1406    <code>\<filter\> \<input-file\></code>
1407  <br>
1408  where <code>\<filter\></code>
1409  is the value of the \c INPUT_FILTER tag, and <code>\<input-file\></code> is the name of an
1410  input file. Doxygen will then use the output that the filter program writes
1411  to standard output.  If \ref cfg_filter_patterns "FILTER_PATTERNS" is specified, this tag will be ignored.
1412  <br>Note that the filter must not add or remove lines; it is applied before the
1413  code is scanned, but not when the output code is generated. If lines are added
1414  or removed, the anchors will not be placed correctly.
1415 ]]>
1416       </docs>
1417     </option>
1418     <option type='list' id='FILTER_PATTERNS' format='string'>
1419       <docs>
1420 <![CDATA[
1421  The \c FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1422  basis. Doxygen will compare the file name with each pattern and apply the
1423  filter if there is a match. The filters are a list of the form:
1424  pattern=filter (like `*.cpp=my_cpp_filter`). See \ref cfg_input_filter "INPUT_FILTER" for further
1425  information on how filters are used. If the \c FILTER_PATTERNS tag is empty or if
1426  none of the patterns match the file name, \ref cfg_input_filter "INPUT_FILTER" is
1427  applied.
1428 ]]>
1429       </docs>
1430     </option>
1431     <option type='bool' id='FILTER_SOURCE_FILES' defval='0'>
1432       <docs>
1433 <![CDATA[
1434  If the \c FILTER_SOURCE_FILES tag is set to \c YES, the input filter (if set using
1435  \ref cfg_input_filter "INPUT_FILTER" ) will also be used to filter the input
1436  files that are used for producing the source files to browse
1437  (i.e. when \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES).
1438 ]]>
1439       </docs>
1440     </option>
1441     <option type='list' id='FILTER_SOURCE_PATTERNS' format='string' depends='FILTER_SOURCE_FILES'>
1442       <docs>
1443 <![CDATA[
1444  The \c FILTER_SOURCE_PATTERNS tag can be used to specify source filters per
1445  file pattern. A pattern will override the setting
1446  for \ref cfg_filter_patterns "FILTER_PATTERN" (if any)
1447  and it is also possible to disable source filtering for a specific pattern
1448  using `*.ext=` (so without naming a filter).
1449 ]]>
1450       </docs>
1451     </option>
1452     <option type='string' id='USE_MDFILE_AS_MAINPAGE' format='string' defval=''>
1453       <docs>
1454 <![CDATA[
1455  If the \c USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1456  is part of the input, its contents will be placed on the main page (`index.html`).
1457  This can be useful if you have a project on for instance GitHub and want to reuse
1458  the introduction page also for the doxygen output.
1459 ]]>
1460       </docs>
1461     </option>
1462   </group>
1463   <group name='Source_Browser' docs='Configuration options related to source browsing'>
1464     <option type='bool' id='SOURCE_BROWSER' defval='0'>
1465       <docs>
1466 <![CDATA[
1467  If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will
1468  be generated. Documented entities will be cross-referenced with these sources.
1469  <br>Note: To get rid of all source code in the generated output, make sure that also
1470  \ref cfg_verbatim_headers "VERBATIM_HEADERS" is set to \c NO.
1471 ]]>
1472       </docs>
1473     </option>
1474     <option type='bool' id='INLINE_SOURCES' defval='0'>
1475       <docs>
1476 <![CDATA[
1477  Setting the \c INLINE_SOURCES tag to \c YES will include the body
1478  of functions, classes and enums directly into the documentation.
1479 ]]>
1480       </docs>
1481     </option>
1482     <option type='bool' id='STRIP_CODE_COMMENTS' defval='1'>
1483       <docs>
1484 <![CDATA[
1485  Setting the \c STRIP_CODE_COMMENTS tag to \c YES will instruct
1486  doxygen to hide any special comment blocks from generated source code
1487  fragments. Normal C, C++ and Fortran comments will always remain visible.
1488 ]]>
1489       </docs>
1490     </option>
1491     <option type='bool' id='REFERENCED_BY_RELATION' defval='0'>
1492       <docs>
1493 <![CDATA[
1494  If the \c REFERENCED_BY_RELATION tag is set to \c YES
1495  then for each documented function all documented
1496  functions referencing it will be listed.
1497 ]]>
1498       </docs>
1499     </option>
1500     <option type='bool' id='REFERENCES_RELATION' defval='0'>
1501       <docs>
1502 <![CDATA[
1503  If the \c REFERENCES_RELATION tag is set to \c YES
1504  then for each documented function all documented entities
1505  called/used by that function will be listed.
1506 ]]>
1507       </docs>
1508     </option>
1509     <option type='bool' id='REFERENCES_LINK_SOURCE' defval='1'>
1510       <docs>
1511 <![CDATA[
1512  If the \c REFERENCES_LINK_SOURCE tag is set to \c YES
1513  and \ref cfg_source_browser "SOURCE_BROWSER" tag is set to \c YES, then the hyperlinks from
1514  functions in \ref cfg_references_relation "REFERENCES_RELATION" and
1515  \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" lists will
1516  link to the source code.  Otherwise they will link to the documentation.
1517 ]]>
1518       </docs>
1519     </option>
1520     <option type='bool' id='SOURCE_TOOLTIPS' defval='1' depends='SOURCE_BROWSER'>
1521       <docs>
1522 <![CDATA[
1523 If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1524 source code will show a tooltip with additional information such as prototype,
1525 brief description and links to the definition and documentation. Since this will
1526 make the HTML file larger and loading of large files a bit slower, you can opt
1527 to disable this feature.
1528 ]]>
1529       </docs>
1530     </option>
1531     <option type='bool' id='USE_HTAGS' defval='0' depends='SOURCE_BROWSER'>
1532       <docs>
1533 <![CDATA[
1534  If the \c USE_HTAGS tag is set to \c YES then the references to source code
1535  will point to the HTML generated by the \c htags(1) tool instead of doxygen
1536  built-in source browser. The \c htags tool is part of GNU's global source
1537  tagging system (see http://www.gnu.org/software/global/global.html). You
1538  will need version 4.8.6 or higher.
1539 <br>
1540  To use it do the following:
1541  -# Install the latest version of \c global
1542  -# Enable \ref cfg_source_browser "SOURCE_BROWSER" and \c USE_HTAGS in the config file
1543  -# Make sure the \ref cfg_input "INPUT" points to the root of the source tree
1544  -# Run \c doxygen as normal
1545 <br>
1546  Doxygen will invoke \c htags (and that will in turn invoke \c gtags), so these tools
1547  must be available from the command line (i.e. in the search path).
1548 <br>
1549  The result: instead of the source browser generated by doxygen, the links to
1550  source code will now point to the output of \c htags.
1551 ]]>
1552       </docs>
1553     </option>
1554
1555     <option type='bool' id='VERBATIM_HEADERS' defval='1'>
1556       <docs>
1557 <![CDATA[
1558   If the \c VERBATIM_HEADERS tag is set the \c YES then doxygen
1559   will generate a verbatim copy of the header file for each class for
1560   which an include is specified. Set to \c NO to disable this.
1561   \sa Section \ref cmdclass "\\class".
1562 ]]>
1563       </docs>
1564     </option>
1565     <option type='bool' id='CLANG_ASSISTED_PARSING' setting='USE_LIBCLANG' defval='0'>
1566       <docs>
1567 <![CDATA[
1568   If the \c CLANG_ASSISTED_PARSING tag is set to \c YES, then doxygen will use the
1569   <a href="http://clang.llvm.org/">clang parser</a> for more accurate parsing
1570   at the cost of reduced performance. This can be particularly helpful with
1571   template rich C++ code for which doxygen's built-in parser lacks the
1572   necessary type information.
1573
1574   @note The availability of this option depends on whether or not doxygen
1575   was compiled with the `--with-libclang` option.
1576 ]]>
1577       </docs>
1578     </option>
1579     <option type='list' id='CLANG_OPTIONS' format='string' setting='USE_LIBCLANG' depends='CLANG_ASSISTED_PARSING'>
1580       <docs>
1581 <![CDATA[
1582  If clang assisted parsing is enabled you can provide the compiler with command
1583  line options that you would normally use when invoking the compiler. Note that
1584  the include paths will already be set by doxygen for the files and directories
1585  specified with \ref cfg_input "INPUT" and \ref cfg_include_path "INCLUDE_PATH".
1586 ]]>
1587       </docs>
1588     </option>
1589   </group>
1590   <group name='Index' docs='Configuration options related to the alphabetical class index'>
1591     <option type='bool' id='ALPHABETICAL_INDEX' defval='1'>
1592       <docs>
1593 <![CDATA[
1594  If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index
1595  of all compounds will be generated. Enable this if the project contains
1596  a lot of classes, structs, unions or interfaces.
1597 ]]>
1598       </docs>
1599     </option>
1600     <option type='int' id='COLS_IN_ALPHA_INDEX' minval='1' maxval='20' defval='5' depends='ALPHABETICAL_INDEX'>
1601       <docs>
1602 <![CDATA[
1603  The \c COLS_IN_ALPHA_INDEX tag can be
1604  used to specify the number of columns in which the alphabetical index list will be split.
1605 ]]>
1606       </docs>
1607     </option>
1608     <option type='list' id='IGNORE_PREFIX' format='string' depends='ALPHABETICAL_INDEX'>
1609       <docs>
1610 <![CDATA[
1611  In case all classes in a project start with a common prefix, all classes will
1612  be put under the same header in the alphabetical index.
1613  The \c IGNORE_PREFIX tag can be used to specify a prefix
1614  (or a list of prefixes) that should be ignored while generating the index headers.
1615 ]]>
1616       </docs>
1617     </option>
1618   </group>
1619   <group name='HTML' docs='Configuration options related to the HTML output'>
1620     <option type='bool' id='GENERATE_HTML' defval='1'>
1621       <docs>
1622 <![CDATA[
1623  If the \c GENERATE_HTML tag is set to \c YES doxygen will
1624  generate HTML output
1625 ]]>
1626       </docs>
1627     </option>
1628     <option type='string' id='HTML_OUTPUT' format='dir' defval='html' depends='GENERATE_HTML'>
1629       <docs>
1630 <![CDATA[
1631  The \c HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1632  If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
1633  put in front of it.
1634 ]]>
1635       </docs>
1636     </option>
1637     <option type='string' id='HTML_FILE_EXTENSION' format='string' defval='.html' depends='GENERATE_HTML'>
1638       <docs>
1639 <![CDATA[
1640  The \c HTML_FILE_EXTENSION tag can be used to specify the file extension for
1641  each generated HTML page (for example: <code>.htm, .php, .asp</code>).
1642 ]]>
1643       </docs>
1644     </option>
1645     <option type='string' id='HTML_HEADER' format='file' defval='' depends='GENERATE_HTML'>
1646       <docs>
1647 <![CDATA[
1648  The \c HTML_HEADER tag can be used to specify a user-defined HTML
1649  header file for each generated HTML page.
1650  If the tag is left blank doxygen will generate a
1651  standard header.
1652 <br>
1653  To get valid HTML the header file that
1654  includes any scripts and style sheets that doxygen
1655  needs, which is dependent on the configuration options used (e.g. the
1656  setting \ref cfg_generate_treeview "GENERATE_TREEVIEW").
1657  It is highly recommended to start with a default header using
1658 \verbatim
1659 doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
1660 \endverbatim
1661  and then modify the file \c new_header.html.
1662
1663  See also section \ref doxygen_usage for information on how to generate
1664  the default header that doxygen normally uses.
1665
1666  @note The header is subject to change so you typically
1667  have to regenerate the default header when upgrading to a newer version of
1668  doxygen.
1669 ]]>
1670       </docs>
1671       <docs doxywizard='0' doxyfile='0'>
1672 <![CDATA[
1673  The following markers have a special meaning inside the header and footer:
1674  <dl>
1675  <dt><code>\$title</code><dd>will be replaced with the title of the page.
1676  <dt><code>\$datetime</code><dd>will be replaced with current the date and time.
1677  <dt><code>\$date</code><dd>will be replaced with the current date.
1678  <dt><code>\$year</code><dd>will be replaces with the current year.
1679  <dt><code>\$doxygenversion</code><dd>will be replaced with the version of doxygen
1680  <dt><code>\$projectname</code><dd>will be replaced with the name of
1681             the project (see \ref cfg_project_name "PROJECT_NAME")
1682  <dt><code>\$projectnumber</code><dd>will be replaced with the project number
1683             (see \ref cfg_project_number "PROJECT_NUMBER")
1684  <dt><code>\$projectbrief</code><dd>will be replaced with the project brief
1685             description (see \ref cfg_project_brief "PROJECT_BRIEF")
1686  <dt><code>\$projectlogo</code><dd>will be replaced with the project logo
1687             (see \ref cfg_project_logo "PROJECT_LOGO")
1688  <dt><code>\$treeview</code><dd>will be replaced with links to
1689             the javascript and style sheets needed for the navigation tree
1690             (or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW"
1691             is disabled).
1692  <dt><code>\$search</code><dd>will be replaced with a links to
1693             the javascript and style sheets needed for the search engine
1694             (or an empty string when \ref cfg_searchengine "SEARCHENGINE"
1695             is disabled).
1696  <dt><code>\$mathjax</code><dd>will be replaced with a links to
1697             the javascript and style sheets needed for the MathJax feature
1698             (or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled).
1699  <dt><code>\$relpath^</code><dd>
1700  If \ref cfg_create_subdirs "CREATE_SUBDIRS" is enabled, the command <code>\$relpath^</code> can be
1701  used to produce a relative path to the root of the HTML output directory,
1702  e.g. use <code>\$relpath^doxygen.css</code>, to refer to the standard style sheet.
1703  </dl>
1704
1705  To cope with differences in the layout of the header and footer that depend on
1706  configuration settings, the header can also contain special blocks that
1707  will be copied to the output or skipped depending on the configuration.
1708  Such blocks have the following form:
1709 \verbatim
1710  <!--BEGIN BLOCKNAME-->
1711  Some context copied when condition BLOCKNAME holds
1712  <!--END BLOCKNAME-->
1713  <!--BEGIN !BLOCKNAME-->
1714  Some context copied when condition BLOCKNAME does not hold
1715  <!--END !BLOCKNAME-->
1716 \endverbatim
1717  The following block names are supported:
1718  <dl>
1719  <dt><code>DISABLE_INDEX</code><dd>Content within this block is copied to the output
1720      when the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled).
1721  <dt><code>GENERATE_TREEVIEW</code><dd>Content within this block is copied to the output
1722      when the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled.
1723  <dt><code>SEARCHENGINE</code><dd>Content within this block is copied to the output
1724      when the \ref cfg_searchengine "SEARCHENGINE" option is enabled.
1725  <dt><code>PROJECT_NAME</code><dd>Content within the block is copied to the output
1726       when the \ref cfg_project_name "PROJECT_NAME" option is not empty.
1727  <dt><code>PROJECT_NUMBER</code><dd>Content within the block is copied to the output
1728       when the \ref cfg_project_number "PROJECT_NUMBER" option is not empty.
1729  <dt><code>PROJECT_BRIEF</code><dd>Content within the block is copied to the output
1730       when the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty.
1731  <dt><code>PROJECT_LOGO</code><dd>Content within the block is copied to the output
1732       when the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.
1733  <dt><code>TITLEAREA</code><dd>Content within this block is copied to the output
1734      when a title is visible at the top of each page. This is the case
1735      if either \ref cfg_project_name "PROJECT_NAME",
1736      \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO"
1737      is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and
1738      \ref cfg_searchengine "SEARCHENGINE" are enabled.
1739  </dl>
1740 ]]>
1741       </docs>
1742       <docs documentation='0'>
1743 <![CDATA[
1744  For a description of the possible markers and block names see the documentation.
1745 ]]>
1746       </docs>
1747     </option>
1748
1749     <option type='string' id='HTML_FOOTER' format='file' defval='' depends='GENERATE_HTML'>
1750       <docs>
1751 <![CDATA[
1752  The \c HTML_FOOTER tag can be used to specify a user-defined HTML footer for
1753  each generated HTML page.
1754  If the tag is left blank doxygen will generate a standard footer.
1755
1756  See \ref cfg_html_header "HTML_HEADER" for more information on
1757  how to generate a default footer and what special commands can be
1758  used inside the footer.
1759
1760  See also section \ref doxygen_usage for information on how to generate
1761  the default footer that doxygen normally uses.
1762 ]]>
1763       </docs>
1764     </option>
1765     <option type='string' id='HTML_STYLESHEET' format='file' defval='' depends='GENERATE_HTML'>
1766       <docs>
1767 <![CDATA[
1768  The \c HTML_STYLESHEET tag can be used to specify a user-defined cascading
1769  style sheet that is used by each HTML page. It can be used to
1770  fine-tune the look of the HTML output. If left blank doxygen
1771  will generate a default style sheet.
1772
1773  See also section \ref doxygen_usage for information on how to generate
1774  the style sheet that doxygen normally uses.
1775
1776  \note It is recommended to use
1777  \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" instead of this tag,
1778  as it is more robust and
1779  this tag (<code>HTML_STYLESHEET</code>) will in the future become obsolete.
1780 ]]>
1781       </docs>
1782     </option>
1783     <option type='string' id='HTML_EXTRA_STYLESHEET' format='file' defval='' depends='GENERATE_HTML'>
1784       <docs>
1785 <![CDATA[
1786  The \c HTML_EXTRA_STYLESHEET tag can be used to specify an additional
1787  user-defined cascading style sheet that is included after the standard
1788  style sheets created by doxygen. Using this option one can overrule
1789  certain style aspects. This is preferred over using \ref cfg_html_stylesheet "HTML_STYLESHEET"
1790  since it does not replace the standard style sheet and is therefor more
1791  robust against future updates. Doxygen will copy the style sheet file to
1792  the output directory.
1793 ]]>
1794       </docs>
1795       <docs doxywizard='0' doxyfile='0'>
1796 <![CDATA[
1797  Here is an example stylesheet that gives the contents area a fixed width:
1798 \verbatim
1799 body {
1800         background-color: #CCC;
1801         color: black;
1802         margin: 0;
1803 }
1804
1805 div.contents {
1806         margin-bottom: 10px;
1807         padding: 12px;
1808         margin-left: auto;
1809         margin-right: auto;
1810         width: 960px;
1811         background-color: white;
1812         border-radius: 8px;
1813 }
1814
1815 #titlearea {
1816         background-color: white;
1817 }
1818
1819 hr.footer {
1820         display: none;
1821 }
1822
1823 .footer {
1824         background-color: #AAA;
1825 }
1826 \endverbatim
1827 ]]>
1828       </docs>
1829       <docs documentation='0'>
1830 <![CDATA[
1831  For an example see the documentation.
1832 ]]>
1833       </docs>
1834     </option>
1835     <option type='list' id='HTML_EXTRA_FILES' format='file' depends='GENERATE_HTML'>
1836       <docs>
1837 <![CDATA[
1838  The \c HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1839  other source files which should be copied to the HTML output directory. Note
1840  that these files will be copied to the base HTML output directory. Use the
1841  <code>$relpath^</code> marker in the \ref cfg_html_header "HTML_HEADER" and/or
1842  \ref cfg_html_footer "HTML_FOOTER" files to load these
1843  files. In the \ref cfg_html_stylesheet "HTML_STYLESHEET" file, use the file name only. Also note that
1844  the files will be copied as-is; there are no commands or markers available.
1845 ]]>
1846       </docs>
1847     </option>
1848     <option type='int' id='HTML_COLORSTYLE_HUE' minval='0' maxval='359' defval='220' depends='GENERATE_HTML'>
1849       <docs>
1850 <![CDATA[
1851  The \c HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1852  Doxygen will adjust the colors in the stylesheet and background images
1853  according to this color. Hue is specified as an angle on a colorwheel,
1854  see http://en.wikipedia.org/wiki/Hue for more information.
1855  For instance the value 0 represents red, 60 is yellow, 120 is green,
1856  180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1857 ]]>
1858       </docs>
1859     </option>
1860     <option type='int' id='HTML_COLORSTYLE_SAT' minval='0' maxval='255' defval='100' depends='GENERATE_HTML'>
1861       <docs>
1862 <![CDATA[
1863  The \c HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1864  the colors in the HTML output. For a value of 0 the output will use
1865  grayscales only. A value of 255 will produce the most vivid colors.
1866 ]]>
1867       </docs>
1868     </option>
1869     <option type='int' id='HTML_COLORSTYLE_GAMMA' minval='40' maxval='240' defval='80' depends='GENERATE_HTML'>
1870       <docs>
1871 <![CDATA[
1872  The \c HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1873  the luminance component of the colors in the HTML output. Values below
1874  100 gradually make the output lighter, whereas values above 100 make
1875  the output darker. The value divided by 100 is the actual gamma applied,
1876  so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1877  and 100 does not change the gamma.
1878 ]]>
1879       </docs>
1880     </option>
1881     <option type='bool' id='HTML_TIMESTAMP' defval='1' depends='GENERATE_HTML'>
1882       <docs>
1883 <![CDATA[
1884  If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of
1885  each generated HTML page will contain the date and time when the page
1886  was generated. Setting this to \c NO can help when comparing the output of
1887  multiple runs.
1888 ]]>
1889       </docs>
1890     </option>
1891     <option type='bool' id='HTML_DYNAMIC_SECTIONS' defval='0' depends='GENERATE_HTML'>
1892       <docs>
1893 <![CDATA[
1894  If the \c HTML_DYNAMIC_SECTIONS tag is set to \c YES then the generated HTML
1895  documentation will contain sections that can be hidden and shown after the
1896  page has loaded.
1897 ]]>
1898       </docs>
1899     </option>
1900     <option type='int' id='HTML_INDEX_NUM_ENTRIES' minval='0' maxval='9999' defval='100' depends='GENERATE_HTML'>
1901       <docs>
1902 <![CDATA[
1903  With \c HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1904  entries shown in the various tree structured indices initially; the user
1905  can expand and collapse entries dynamically later on. Doxygen will expand
1906  the tree to such a level that at most the specified number of entries are
1907  visible (unless a fully collapsed tree already exceeds this amount).
1908  So setting the number of entries 1 will produce a full collapsed tree by
1909  default. 0 is a special value representing an infinite number of entries
1910  and will result in a full expanded tree by default.
1911 ]]>
1912       </docs>
1913     </option>
1914     <option type='bool' id='GENERATE_DOCSET' defval='0' depends='GENERATE_HTML'>
1915       <docs>
1916 <![CDATA[
1917  If the \c GENERATE_DOCSET tag is set to \c YES, additional index files
1918  will be generated that can be used as input for
1919  <a href="http://developer.apple.com/tools/xcode/">Apple's Xcode 3
1920  integrated development environment</a>, introduced with OSX 10.5 (Leopard).
1921  To create a documentation set, doxygen will generate a Makefile in the
1922  HTML output directory. Running \c make will produce the docset in that
1923  directory and running <code>make install</code> will install the docset in
1924  <code>~/Library/Developer/Shared/Documentation/DocSets</code>
1925  so that Xcode will find it at startup. See
1926  http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
1927  more information.
1928 ]]>
1929       </docs>
1930     </option>
1931     <option type='string' id='DOCSET_FEEDNAME' format='string' defval='Doxygen generated docs' depends='GENERATE_DOCSET'>
1932       <docs>
1933 <![CDATA[
1934  This tag determines the name of the docset
1935  feed. A documentation feed provides an umbrella under which multiple
1936  documentation sets from a single provider (such as a company or product suite)
1937  can be grouped.
1938 ]]>
1939       </docs>
1940     </option>
1941     <option type='string' id='DOCSET_BUNDLE_ID' format='string' defval='org.doxygen.Project' depends='GENERATE_DOCSET'>
1942       <docs>
1943 <![CDATA[
1944  This tag specifies a string that
1945  should uniquely identify the documentation set bundle. This should be a
1946  reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet</code>.
1947  Doxygen will append <code>.docset</code> to the name.
1948 ]]>
1949       </docs>
1950     </option>
1951     <option type='string' id='DOCSET_PUBLISHER_ID' format='string' defval='org.doxygen.Publisher' depends='GENERATE_DOCSET'>
1952       <docs>
1953 <![CDATA[
1954 The \c DOCSET_PUBLISHER_ID
1955 tag specifies a string that should uniquely identify
1956 the documentation publisher. This should be a reverse domain-name style
1957 string, e.g. <code>com.mycompany.MyDocSet.documentation</code>.
1958 ]]>
1959       </docs>
1960     </option>
1961     <option type='string' id='DOCSET_PUBLISHER_NAME' format='string' defval='Publisher' depends='GENERATE_DOCSET'>
1962       <docs>
1963 <![CDATA[
1964 The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1965 ]]>
1966       </docs>
1967     </option>
1968     <option type='bool' id='GENERATE_HTMLHELP' defval='0' depends='GENERATE_HTML'>
1969       <docs>
1970 <![CDATA[
1971  If the \c GENERATE_HTMLHELP tag is set to \c YES then
1972  doxygen generates three additional HTML index files:
1973  \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
1974  project file that can be read by
1975  <a href="http://www.microsoft.com/en-us/download/details.aspx?id=21138">
1976  Microsoft's HTML Help Workshop</a>
1977  on Windows.
1978 <br>
1979  The HTML Help Workshop contains a compiler that can convert all HTML output
1980  generated by doxygen into a single compiled HTML file (`.chm`). Compiled
1981  HTML files are now used as the Windows 98 help format, and will replace
1982  the old Windows help format (`.hlp`) on all Windows platforms in the future.
1983  Compressed HTML files also contain an index, a table of contents,
1984  and you can search for words in the documentation.
1985  The HTML workshop also contains a viewer for compressed HTML files.
1986 ]]>
1987       </docs>
1988     </option>
1989     <option type='string' id='CHM_FILE' format='file' defval='' depends='GENERATE_HTMLHELP'>
1990       <docs>
1991 <![CDATA[
1992   The \c CHM_FILE tag can
1993   be used to specify the file name of the resulting `.chm` file. You
1994   can add a path in front of the file if the result should not be
1995   written to the html output directory.
1996 ]]>
1997       </docs>
1998     </option>
1999     <option type='string' id='HHC_LOCATION' format='file' defval='' depends='GENERATE_HTMLHELP' abspath='1'>
2000       <docs>
2001 <![CDATA[
2002   The \c HHC_LOCATION tag can
2003   be used to specify the location (absolute path including file name) of
2004   the HTML help compiler (\c hhc.exe). If non-empty doxygen will try to run
2005   the HTML help compiler on the generated \c index.hhp.
2006 ]]>
2007       </docs>
2008     </option>
2009     <option type='bool' id='GENERATE_CHI' defval='0' depends='GENERATE_HTMLHELP'>
2010       <docs>
2011 <![CDATA[
2012  The \c GENERATE_CHI flag
2013  controls if a separate `.chi` index file is generated (\c YES) or that
2014  it should be included in the master `.chm` file (\c NO).
2015 ]]>
2016       </docs>
2017     </option>
2018     <option type='string' id='CHM_INDEX_ENCODING' format='string' defval='' depends='GENERATE_HTMLHELP'>
2019       <docs>
2020 <![CDATA[
2021  The \c CHM_INDEX_ENCODING
2022  is used to encode HtmlHelp index (\c hhk), content (\c hhc) and project file
2023  content.
2024 ]]>
2025       </docs>
2026     </option>
2027     <option type='bool' id='BINARY_TOC' defval='0' depends='GENERATE_HTMLHELP'>
2028       <docs>
2029 <![CDATA[
2030  The \c BINARY_TOC flag
2031  controls whether a binary table of contents is generated (\c YES) or a
2032  normal table of contents (\c NO) in the `.chm` file. Furthermore it enables
2033  the `Previous` and `Next` buttons.
2034 ]]>
2035       </docs>
2036     </option>
2037     <option type='bool' id='TOC_EXPAND' defval='0' depends='GENERATE_HTMLHELP'>
2038       <docs>
2039 <![CDATA[
2040  The \c TOC_EXPAND flag can be set to \c YES to add extra items for
2041  group members to the table of contents of the HTML help documentation
2042  and to the tree view.
2043 ]]>
2044       </docs>
2045     </option>
2046     <option type='bool' id='GENERATE_QHP' defval='0' depends='GENERATE_HTML'>
2047       <docs>
2048 <![CDATA[
2049  If the \c GENERATE_QHP tag is set to \c YES and both \ref cfg_qhp_namespace "QHP_NAMESPACE"
2050  and \ref cfg_qhp_virtual_folder "QHP_VIRTUAL_FOLDER" are set, an additional index file will
2051  be generated that can be used as input for Qt's qhelpgenerator
2052  to generate a Qt Compressed Help (`.qch`) of the generated HTML
2053  documentation.
2054 ]]>
2055       </docs>
2056     </option>
2057     <option type='string' id='QCH_FILE' format='file' defval='' depends='GENERATE_QHP'>
2058       <docs>
2059 <![CDATA[
2060  If the \ref cfg_qhg_location "QHG_LOCATION" tag is specified, the \c QCH_FILE tag can
2061  be used to specify the file name of the resulting `.qch` file.
2062  The path specified is relative to the HTML output folder.
2063 ]]>
2064       </docs>
2065     </option>
2066     <option type='string' id='QHP_NAMESPACE' format='string' defval='org.doxygen.Project' depends='GENERATE_QHP'>
2067       <docs>
2068 <![CDATA[
2069  The \c QHP_NAMESPACE tag specifies the namespace to use when generating
2070  Qt Help Project output. For more information please see
2071  <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
2072 ]]>
2073       </docs>
2074     </option>
2075     <option type='string' id='QHP_VIRTUAL_FOLDER' format='string' defval='doc' depends='GENERATE_QHP'>
2076       <docs>
2077 <![CDATA[
2078  The \c QHP_VIRTUAL_FOLDER tag specifies the namespace to use when
2079  generating Qt Help Project output. For more information please see
2080  <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
2081 ]]>
2082       </docs>
2083     </option>
2084     <option type='string' id='QHP_CUST_FILTER_NAME' format='string' defval='' depends='GENERATE_QHP'>
2085       <docs>
2086 <![CDATA[
2087   If the \c QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom filter to add. For more information please see
2088   <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
2089 ]]>
2090       </docs>
2091     </option>
2092     <option type='string' id='QHP_CUST_FILTER_ATTRS' format='string' defval='' depends='GENERATE_QHP'>
2093       <docs>
2094 <![CDATA[
2095   The \c QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the custom filter to add.
2096   For more information please see
2097   <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
2098 ]]>
2099       </docs>
2100     </option>
2101     <option type='string' id='QHP_SECT_FILTER_ATTRS' format='string' defval='' depends='GENERATE_QHP'>
2102       <docs>
2103 <![CDATA[
2104   The \c QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches.
2105   <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
2106 ]]>
2107       </docs>
2108     </option>
2109     <option type='string' id='QHG_LOCATION' format='file' defval='' depends='GENERATE_QHP'>
2110       <docs>
2111 <![CDATA[
2112  The \c QHG_LOCATION tag can be used to specify the location of Qt's qhelpgenerator.
2113  If non-empty doxygen will try to run qhelpgenerator on the generated `.qhp` file.
2114 ]]>
2115       </docs>
2116     </option>
2117     <option type='bool' id='GENERATE_ECLIPSEHELP' defval='0' depends='GENERATE_HTML'>
2118       <docs>
2119 <![CDATA[
2120  If the \c GENERATE_ECLIPSEHELP tag is set to \c YES, additional index files
2121  will be generated, together with the HTML files, they form an `Eclipse` help
2122  plugin.
2123
2124  To install this plugin and make it available under the help contents
2125  menu in `Eclipse`, the contents of the directory containing the HTML and XML
2126  files needs to be copied into the plugins directory of eclipse. The name of
2127  the directory within the plugins directory should be the same as
2128  the \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID" value.
2129
2130  After copying `Eclipse` needs to be restarted before the help appears.
2131 ]]>
2132       </docs>
2133     </option>
2134     <option type='string' id='ECLIPSE_DOC_ID' format='string' defval='org.doxygen.Project' depends='GENERATE_ECLIPSEHELP'>
2135       <docs>
2136 <![CDATA[
2137  A unique identifier for the `Eclipse` help plugin. When installing the plugin
2138  the directory name containing the HTML and XML files should also have
2139  this name. Each documentation set should have its own identifier.
2140 ]]>
2141       </docs>
2142     </option>
2143     <option type='bool' id='DISABLE_INDEX' defval='0' depends='GENERATE_HTML'>
2144       <docs>
2145 <![CDATA[
2146  If you want full control over the layout of the generated HTML pages it
2147  might be necessary to disable the index and replace it with your own.
2148  The \c DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at
2149  top of each HTML page. A value of \c NO enables the index and the
2150  value \c YES disables it. Since the tabs in the index contain the same
2151  information as the navigation tree, you can set this option to \c YES if
2152  you also set \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES.
2153 ]]>
2154       </docs>
2155     </option>
2156     <option type='bool' id='GENERATE_TREEVIEW' defval='0' depends='GENERATE_HTML'>
2157       <docs>
2158 <![CDATA[
2159  The \c GENERATE_TREEVIEW tag is used to specify whether a tree-like index
2160  structure should be generated to display hierarchical information.
2161  If the tag value is set to \c YES, a side panel will be generated
2162  containing a tree-like index structure (just like the one that
2163  is generated for HTML Help). For this to work a browser that supports
2164  JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
2165  Windows users are probably better off using the HTML help feature.
2166
2167  Via custom stylesheets (see \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET")
2168  one can further \ref doxygen_finetune "fine-tune" the look of the index.
2169  As an example, the default style sheet generated by doxygen has an
2170  example that shows how to put an image at the root of the tree instead of
2171  the \ref cfg_project_name "PROJECT_NAME".
2172
2173  Since the tree basically has the same information as the tab index, you could
2174  consider setting \ref cfg_disable_index "DISABLE_INDEX" to \c YES when
2175  enabling this option.
2176 ]]>
2177       </docs>
2178     </option>
2179
2180     <option type='int' id='ENUM_VALUES_PER_LINE' minval='0' maxval='20' defval='4' depends='GENERATE_HTML'>
2181       <docs>
2182 <![CDATA[
2183  The \c ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
2184  that doxygen will group on one line in the generated HTML documentation.
2185  <br>Note that a value of 0 will completely suppress the enum values from
2186  appearing in the overview section.
2187 ]]>
2188       </docs>
2189     </option>
2190     <option type='int' id='TREEVIEW_WIDTH' minval='0' maxval='1500' defval='250' depends='GENERATE_HTML'>
2191       <docs>
2192 <![CDATA[
2193  If the treeview is enabled (see \ref cfg_generate_treeview "GENERATE_TREEVIEW") then this tag can be
2194  used to set the initial width (in pixels) of the frame in which the tree
2195  is shown.
2196 ]]>
2197       </docs>
2198     </option>
2199     <option type='bool' id='EXT_LINKS_IN_WINDOW' defval='0' depends='GENERATE_HTML'>
2200       <docs>
2201 <![CDATA[
2202  When the \c EXT_LINKS_IN_WINDOW option is set to \c YES doxygen will open
2203  links to external symbols imported via tag files in a separate window.
2204 ]]>
2205       </docs>
2206     </option>
2207     <option type='int' id='FORMULA_FONTSIZE' minval='8' maxval='50' defval='10' depends='GENERATE_HTML'>
2208       <docs>
2209 <![CDATA[
2210  Use this tag to change the font size of \f$\mbox{\LaTeX}\f$ formulas included
2211  as images in the HTML documentation.
2212  When you change the font size after a successful doxygen run you need
2213  to manually remove any `form_*.png` images from the HTML
2214  output directory to force them to be regenerated.
2215 ]]>
2216       </docs>
2217     </option>
2218     <option type='bool' id='FORMULA_TRANSPARENT' defval='1' depends='GENERATE_HTML'>
2219       <docs>
2220 <![CDATA[
2221  Use the \c FORMULA_TRANPARENT tag to determine whether or not the images
2222  generated for formulas are transparent PNGs. Transparent PNGs are
2223  not supported properly for IE 6.0, but are supported on all modern browsers.
2224  <br>Note that when changing this option you need to delete any `form_*.png` files
2225  in the HTML output directory before the changes have effect.
2226 ]]>
2227       </docs>
2228     </option>
2229     <option type='bool' id='USE_MATHJAX' defval='0' depends='GENERATE_HTML'>
2230       <docs>
2231 <![CDATA[
2232  Enable the \c USE_MATHJAX option to render \f$\mbox{\LaTeX}\f$ formulas using MathJax
2233  (see http://www.mathjax.org) which uses client side Javascript for the
2234  rendering instead of using prerendered bitmaps. Use this if you do not
2235  have \f$\mbox{\LaTeX}\f$ installed or if you want to formulas look prettier in the HTML
2236  output. When enabled you may also need to install MathJax separately and
2237  configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH"
2238  option.
2239 ]]>
2240       </docs>
2241     </option>
2242     <option type='enum' id='MATHJAX_FORMAT' defval='HTML-CSS' depends='USE_MATHJAX'>
2243       <docs>
2244 <![CDATA[
2245  When MathJax is enabled you can set the default output format to be used for
2246  the MathJax output.
2247  See <a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a>
2248  for more details.
2249 ]]>
2250       </docs>
2251       <value name="HTML-CSS" desc="(which is slower, but has the best compatibility)"/>
2252       <value name="NativeMML" desc="(i.e. MathML)"/>
2253       <value name="SVG"/>
2254     </option>
2255     <option type='string' id='MATHJAX_RELPATH' format='string' defval='http://cdn.mathjax.org/mathjax/latest' depends='USE_MATHJAX'>
2256       <docs>
2257 <![CDATA[
2258  When MathJax is enabled you need to specify the location relative to the
2259  HTML output directory using the \c MATHJAX_RELPATH option. The destination
2260  directory should contain the `MathJax.js` script. For instance, if the \c mathjax
2261  directory is located at the same level as the HTML output directory, then
2262  \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to
2263  the MathJax Content Delivery Network so you can quickly see the result without
2264  installing MathJax.  However, it is strongly recommended to install a local
2265  copy of MathJax from http://www.mathjax.org before deployment.
2266 ]]>
2267       </docs>
2268     </option>
2269     <option type='list' id='MATHJAX_EXTENSIONS' format='string' depends='USE_MATHJAX'>
2270       <docs>
2271 <![CDATA[
2272  The \c MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax extension
2273  names that should be enabled during MathJax rendering. For example
2274 \verbatim
2275 MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols
2276 \endverbatim
2277 ]]>
2278       </docs>
2279     </option>
2280     <option type='string' id='MATHJAX_CODEFILE' format='string' depends='USE_MATHJAX'>
2281       <docs>
2282 <![CDATA[
2283  The \c MATHJAX_CODEFILE tag can be used to specify a file with javascript
2284  pieces of code that will be used on startup of the MathJax code.
2285  See
2286 <a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a>
2287  for more details.
2288 ]]>
2289       </docs>
2290       <docs doxywizard='0' doxyfile='0'>
2291 <![CDATA[
2292  As an example to disable the "Math Renderer" menu item in the "Math
2293  Settings" menu of MathJax:
2294 \verbatim
2295 MATHJAX_CODEFILE = disableRenderer.js
2296 \endverbatim
2297   with in the file <code>disableRenderer.js</code>:
2298 \verbatim
2299   MathJax.Hub.Config({
2300    menuSettings: {
2301     showRenderer: false,
2302    }
2303   });
2304 \endverbatim
2305 ]]>
2306       </docs>
2307       <docs documentation='0'>
2308 <![CDATA[
2309  For an example see the documentation.
2310 ]]>
2311       </docs>
2312     </option>
2313     <option type='bool' id='SEARCHENGINE' defval='1' depends='GENERATE_HTML'>
2314       <docs>
2315 <![CDATA[
2316  When the \c SEARCHENGINE tag is enabled doxygen will generate a search box
2317  for the HTML output. The underlying search engine uses javascript
2318  and DHTML and should work on any modern browser. Note that when using
2319  HTML help (\ref cfg_generate_htmlhelp "GENERATE_HTMLHELP"),
2320  Qt help (\ref cfg_generate_qhp "GENERATE_QHP"), or docsets
2321  (\ref cfg_generate_docset "GENERATE_DOCSET") there is already a search
2322  function so this one should typically be disabled. For large projects
2323  the javascript based search engine can be slow, then enabling
2324  \ref cfg_server_based_search "SERVER_BASED_SEARCH" may provide a
2325  better solution.
2326
2327  It is possible to search using the keyboard;
2328  to jump to the search box use <code>\<access key\> + S</code> (what the <code>\<access key\></code> is
2329  depends on the OS and browser, but it is typically <code>\<CTRL\></code>, <code>\<ALT\></code>/<code>\<option\></code>, or both).
2330  Inside the search box use the <code>\<cursor down key\></code> to jump into the search
2331  results window, the results can be navigated using the <code>\<cursor keys\></code>.
2332  Press <code>\<Enter\></code> to select an item or <code>\<escape\></code> to cancel the search. The
2333  filter options can be selected when the cursor is inside the search box
2334  by pressing <code>\<Shift\>+\<cursor down\></code>. Also here use the <code>\<cursor keys\></code> to
2335  select a filter and <code>\<Enter\></code> or <code>\<escape\></code> to activate or cancel the filter option.
2336 ]]>
2337       </docs>
2338     </option>
2339     <option type='bool' id='SERVER_BASED_SEARCH' defval='0' depends='SEARCHENGINE'>
2340       <docs>
2341 <![CDATA[
2342 When the \c SERVER_BASED_SEARCH tag is enabled the search engine will be
2343 implemented using a web server instead of a web client using Javascript.
2344
2345 There are two flavors of web server based searching depending on the
2346 \ref cfg_external_search "EXTERNAL_SEARCH" setting. When disabled,
2347 doxygen will generate a PHP script for searching and an index file used
2348 by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is
2349 enabled the indexing and searching needs to be provided by external tools.
2350 See the section \ref extsearch for details.
2351 ]]>
2352       </docs>
2353     </option>
2354     <option type='bool' id='EXTERNAL_SEARCH' defval='0' depends='SEARCHENGINE'>
2355       <docs>
2356 <![CDATA[
2357  When \c EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
2358  script for searching. Instead the search results are written to an XML file
2359  which needs to be processed by an external indexer. Doxygen will invoke an
2360  external search engine pointed to by the
2361  \ref cfg_searchengine_url "SEARCHENGINE_URL" option to obtain
2362  the search results.
2363  <br>Doxygen ships with an example indexer (\c doxyindexer) and
2364  search engine (<code>doxysearch.cgi</code>) which are based on the open source search
2365  engine library <a href="http://xapian.org/">Xapian</a>.
2366  <br>See the section \ref extsearch for details.
2367 ]]>
2368       </docs>
2369     </option>
2370     <option type='string' id='SEARCHENGINE_URL' format='string' defval='' depends='SEARCHENGINE'>
2371       <docs>
2372 <![CDATA[
2373  The \c SEARCHENGINE_URL should point to a search engine hosted by a web server
2374  which will return the search results when \ref cfg_external_search "EXTERNAL_SEARCH"
2375  is enabled.
2376  <br>Doxygen ships with an example indexer (\c doxyindexer) and
2377  search engine (<code>doxysearch.cgi</code>) which are based on the open source search
2378  engine library <a href="http://xapian.org/">Xapian</a>.
2379  See the section \ref extsearch for details.
2380 ]]>
2381       </docs>
2382     </option>
2383     <option type='string' id='SEARCHDATA_FILE' format='file' defval='searchdata.xml' depends='SEARCHENGINE'>
2384       <docs>
2385 <![CDATA[
2386 When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
2387 \ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the unindexed
2388 search data is written to a file for indexing by an external tool. With the
2389 \c SEARCHDATA_FILE tag the name of this file can be specified.
2390 ]]>
2391       </docs>
2392     </option>
2393     <option type='string' id='EXTERNAL_SEARCH_ID' format='string' defval='' depends='SEARCHENGINE'>
2394       <docs>
2395 <![CDATA[
2396 When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
2397 \ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the
2398 \c EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
2399 useful in combination with \ref cfg_extra_search_mappings "EXTRA_SEARCH_MAPPINGS"
2400 to search through multiple projects and redirect the results back to the right project.
2401 ]]>
2402       </docs>
2403     </option>
2404     <option type='list' id='EXTRA_SEARCH_MAPPINGS' format='string' depends='SEARCHENGINE'>
2405       <docs>
2406 <![CDATA[
2407  The \c EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
2408  projects other than the one defined by this configuration file, but that are
2409  all added to the same external search index. Each project needs to have a
2410  unique id set via \ref cfg_external_search_id "EXTERNAL_SEARCH_ID".
2411  The search mapping then maps the id of to a relative location where the
2412  documentation can be found.
2413
2414  The format is:
2415 \verbatim
2416 EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
2417 \endverbatim
2418 ]]>
2419       </docs>
2420     </option>
2421   </group>
2422   <group name='LaTeX' docs='Configuration options related to the LaTeX output'>
2423     <option type='bool' id='GENERATE_LATEX' defval='1'>
2424       <docs>
2425 <![CDATA[
2426  If the \c GENERATE_LATEX tag is set to \c YES doxygen will
2427  generate \f$\mbox{\LaTeX}\f$ output.
2428 ]]>
2429       </docs>
2430     </option>
2431     <option type='string' id='LATEX_OUTPUT' format='dir' defval='latex' depends='GENERATE_LATEX'>
2432       <docs>
2433 <![CDATA[
2434  The \c LATEX_OUTPUT tag is used to specify where the \f$\mbox{\LaTeX}\f$
2435  docs will be put.
2436  If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
2437  put in front of it.
2438 ]]>
2439       </docs>
2440     </option>
2441     <option type='string' id='LATEX_CMD_NAME' format='file' defval='latex' depends='GENERATE_LATEX'>
2442       <docs>
2443 <![CDATA[
2444  The \c LATEX_CMD_NAME tag can be used to specify the \f$\mbox{\LaTeX}\f$ command name to be invoked.
2445  <br>Note that when enabling \ref cfg_use_pdflatex "USE_PDFLATEX" this option is only used for
2446  generating bitmaps for formulas in the HTML output, but not in the
2447  \c Makefile that is written to the output directory.
2448 ]]>
2449       </docs>
2450     </option>
2451     <option type='string' id='MAKEINDEX_CMD_NAME' format='file' defval='makeindex' depends='GENERATE_LATEX'>
2452       <docs>
2453 <![CDATA[
2454  The \c MAKEINDEX_CMD_NAME tag can be used to specify the command name to
2455  generate index for \f$\mbox{\LaTeX}\f$.
2456 ]]>
2457       </docs>
2458     </option>
2459     <option type='bool' id='COMPACT_LATEX' defval='0' depends='GENERATE_LATEX'>
2460       <docs>
2461 <![CDATA[
2462  If the \c COMPACT_LATEX tag is set to \c YES doxygen generates more compact
2463  \f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to
2464  save some trees in general.
2465 ]]>
2466       </docs>
2467     </option>
2468     <option type='enum' id='PAPER_TYPE' defval='a4' depends='GENERATE_LATEX'>
2469       <docs>
2470 <![CDATA[
2471  The \c PAPER_TYPE tag can be used to set the paper type that is used
2472  by the printer.
2473 ]]>
2474       </docs>
2475       <value name='a4' desc='(210 x 297 mm)'/>
2476       <value name='letter' desc='(8.5 x 11 inches)'/>
2477       <value name='legal' desc='(8.5 x 14 inches)'/>
2478       <value name='executive' desc='(7.25 x 10.5 inches)'/>
2479     </option>
2480     <option type='list' id='EXTRA_PACKAGES' format='string' depends='GENERATE_LATEX'>
2481       <docs>
2482 <![CDATA[
2483  The \c EXTRA_PACKAGES tag can be used to specify one or more \f$\mbox{\LaTeX}\f$
2484  package names that should be included in the \f$\mbox{\LaTeX}\f$ output.
2485  To get the times font for instance you can specify
2486 \verbatim
2487 EXTRA_PACKAGES=times
2488 \endverbatim
2489  If left blank no extra packages will be included.
2490 ]]>
2491       </docs>
2492     </option>
2493     <option type='string' id='LATEX_HEADER' format='file' defval='' depends='GENERATE_LATEX'>
2494       <docs>
2495 <![CDATA[
2496  The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$
2497  header for the generated \f$\mbox{\LaTeX}\f$ document.
2498  The header should contain everything until the first chapter.
2499
2500  If it is left blank doxygen will generate a
2501  standard header. See section \ref doxygen_usage for information on how to
2502  let doxygen write the default header to a separate file.
2503
2504  <br>Note: Only use a user-defined header if you know what you are doing!
2505
2506  The following commands have a special meaning inside the header:
2507  <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>,
2508  <code>\$doxygenversion</code>, <code>\$projectname</code>,
2509  <code>\$projectnumber</code>.
2510  Doxygen will replace them by respectively
2511  the title of the page, the current date and time, only the current date,
2512  the version number of doxygen, the project name (see \ref cfg_project_name "PROJECT_NAME"), or the
2513  project number (see \ref cfg_project_number "PROJECT_NUMBER").
2514 ]]>
2515       </docs>
2516     </option>
2517     <option type='string' id='LATEX_FOOTER' format='file' defval='' depends='GENERATE_LATEX'>
2518       <docs>
2519 <![CDATA[
2520  The \c LATEX_FOOTER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ footer for
2521  the generated \f$\mbox{\LaTeX}\f$ document. The footer should contain everything after
2522  the last chapter. If it is left blank doxygen will generate a
2523  standard footer.
2524
2525  <br>Note: Only use a user-defined footer if you know what you are doing!
2526 ]]>
2527       </docs>
2528     </option>
2529     <option type='list' id='LATEX_EXTRA_FILES' format='file' depends='GENERATE_LATEX'>
2530       <docs>
2531 <![CDATA[
2532  The \c LATEX_EXTRA_FILES tag can be used to specify one or more extra images
2533  or other source files which should be copied to the \ref cfg_latex_output "LATEX_OUTPUT"
2534  output directory.
2535  Note that the files will be copied as-is; there are no commands or markers
2536  available.
2537 ]]>
2538       </docs>
2539     </option>
2540     <option type='bool' id='PDF_HYPERLINKS' defval='1' depends='GENERATE_LATEX'>
2541       <docs>
2542 <![CDATA[
2543  If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that
2544  is generated is prepared for conversion to PDF (using \c ps2pdf or \c pdflatex).
2545  The PDF file will
2546  contain links (just like the HTML output) instead of page references.
2547  This makes the output suitable for online browsing using a PDF viewer.
2548 ]]>
2549       </docs>
2550     </option>
2551     <option type='bool' id='USE_PDFLATEX' defval='1' depends='GENERATE_LATEX'>
2552       <docs>
2553 <![CDATA[
2554  If the \c LATEX_PDFLATEX tag is set to \c YES, doxygen will use
2555  \c pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$
2556  files.  Set this option to \c YES to get a higher quality PDF documentation.
2557 ]]>
2558       </docs>
2559     </option>
2560     <option type='bool' id='LATEX_BATCHMODE' defval='0' depends='GENERATE_LATEX'>
2561       <docs>
2562 <![CDATA[
2563  If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \c \\batchmode
2564  command to the generated \f$\mbox{\LaTeX}\f$ files. This will
2565  instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of
2566  asking the user for help. This option is also used when generating formulas
2567  in HTML.
2568 ]]>
2569       </docs>
2570     </option>
2571     <option type='bool' id='LATEX_HIDE_INDICES' defval='0' depends='GENERATE_LATEX'>
2572       <docs>
2573 <![CDATA[
2574  If the \c LATEX_HIDE_INDICES tag is set to \c YES then doxygen will not
2575  include the index chapters (such as File Index, Compound Index, etc.)
2576  in the output.
2577 ]]>
2578       </docs>
2579     </option>
2580     <option type='bool' id='LATEX_SOURCE_CODE' defval='0' depends='GENERATE_LATEX'>
2581       <docs>
2582 <![CDATA[
2583  If the \c LATEX_SOURCE_CODE tag is set to \c YES then doxygen will include
2584  source code with syntax highlighting in the \f$\mbox{\LaTeX}\f$ output.
2585  <br>Note that which sources are shown also depends on other settings
2586  such as \ref cfg_source_browser "SOURCE_BROWSER".
2587 ]]>
2588       </docs>
2589     </option>
2590     <option type='string' id='LATEX_BIB_STYLE' format='string' defval='plain' depends='GENERATE_LATEX'>
2591       <docs>
2592 <![CDATA[
2593  The \c LATEX_BIB_STYLE tag can be used to specify the style to use for the
2594  bibliography, e.g. \c plainnat, or \c ieeetr.
2595  See http://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite"
2596  for more info.
2597 ]]>
2598       </docs>
2599     </option>
2600   </group>
2601   <group name='RTF' docs='Configuration options related to the RTF output'>
2602     <option type='bool' id='GENERATE_RTF' defval='0'>
2603       <docs>
2604 <![CDATA[
2605  If the \c GENERATE_RTF tag is set to \c YES doxygen will generate RTF output.
2606  The RTF output is optimized for Word 97 and may not look too pretty with
2607  other RTF readers/editors.
2608 ]]>
2609       </docs>
2610     </option>
2611     <option type='string' id='RTF_OUTPUT' format='dir' defval='rtf' depends='GENERATE_RTF'>
2612       <docs>
2613 <![CDATA[
2614  The \c RTF_OUTPUT tag is used to specify where the RTF docs will be put.
2615  If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
2616  put in front of it.
2617 ]]>
2618       </docs>
2619     </option>
2620     <option type='bool' id='COMPACT_RTF' defval='0' depends='GENERATE_RTF'>
2621       <docs>
2622 <![CDATA[
2623  If the \c COMPACT_RTF tag is set to \c YES doxygen generates more compact
2624  RTF documents. This may be useful for small projects and may help to
2625  save some trees in general.
2626 ]]>
2627       </docs>
2628     </option>
2629     <option type='bool' id='RTF_HYPERLINKS' defval='0' depends='GENERATE_RTF'>
2630       <docs>
2631 <![CDATA[
2632  If the \c RTF_HYPERLINKS tag is set to \c YES, the RTF that is generated
2633  will contain hyperlink fields. The RTF file will
2634  contain links (just like the HTML output) instead of page references.
2635  This makes the output suitable for online browsing using Word or some other
2636  Word compatible readers that support those fields.
2637
2638  <br>Note: WordPad (write) and others do not support links.
2639 ]]>
2640       </docs>
2641     </option>
2642     <option type='string' id='RTF_STYLESHEET_FILE' format='file' defval='' depends='GENERATE_RTF'>
2643       <docs>
2644 <![CDATA[
2645  Load stylesheet definitions from file. Syntax is similar to doxygen's
2646  config file, i.e. a series of assignments. You only have to provide
2647  replacements, missing definitions are set to their default value.
2648 <br>
2649  See also section \ref doxygen_usage for information on how to generate
2650  the default style sheet that doxygen normally uses.
2651
2652 ]]>
2653       </docs>
2654     </option>
2655     <option type='string' id='RTF_EXTENSIONS_FILE' format='file' defval='' depends='GENERATE_RTF'>
2656       <docs>
2657 <![CDATA[
2658  Set optional variables used in the generation of an RTF document.
2659  Syntax is similar to doxygen's config file.
2660  A template extensions file can be generated using
2661  <code>doxygen -e rtf extensionFile</code>.
2662 ]]>
2663       </docs>
2664     </option>
2665   </group>
2666   <group name='Man' docs='Configuration options related to the man page output'>
2667     <option type='bool' id='GENERATE_MAN' defval='0'>
2668       <docs>
2669 <![CDATA[
2670  If the \c GENERATE_MAN tag is set to \c YES doxygen will
2671  generate man pages for classes and files.
2672 ]]>
2673       </docs>
2674     </option>
2675     <option type='string' id='MAN_OUTPUT' format='dir' defval='man' depends='GENERATE_MAN'>
2676       <docs>
2677 <![CDATA[
2678  The \c MAN_OUTPUT tag is used to specify where the man pages will be put.
2679  If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
2680  put in front of it.
2681  A directory \c man3 will be created inside the directory specified by
2682  \c MAN_OUTPUT.
2683 ]]>
2684       </docs>
2685     </option>
2686     <option type='string' id='MAN_EXTENSION' format='string' defval='.3' depends='GENERATE_MAN'>
2687       <docs>
2688 <![CDATA[
2689  The \c MAN_EXTENSION tag determines the extension that is added to
2690  the generated man pages. In case
2691  the manual section does not start with a number, the number 3 is prepended.
2692  The dot (.) at the beginning of the \c MAN_EXTENSION tag is optional.
2693 ]]>
2694       </docs>
2695     </option>
2696     <option type='string' id='MAN_SUBDIR' format='string' defval='' depends='GENERATE_MAN'>
2697       <docs>
2698 <![CDATA[
2699  The \c MAN_SUBDIR tag determines the name of the directory created within \c MAN_OUTPUT
2700  in which the man pages are placed. If defaults to man followed by \c MAN_EXTENSION
2701  with the initial . removed.
2702 ]]>
2703       </docs>
2704     </option>
2705     <option type='bool' id='MAN_LINKS' defval='0' depends='GENERATE_MAN'>
2706       <docs>
2707 <![CDATA[
2708  If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output,
2709  then it will generate one additional man file for each entity documented in
2710  the real man page(s). These additional files only source the real man page,
2711  but without them the \c man command would be unable to find the correct page.
2712 ]]>
2713       </docs>
2714     </option>
2715   </group>
2716   <group name='XML' docs='Configuration options related to the XML output'>
2717     <option type='bool' id='GENERATE_XML' defval='0'>
2718       <docs>
2719 <![CDATA[
2720  If the \c GENERATE_XML tag is set to \c YES doxygen will
2721  generate an XML file that captures the structure of
2722  the code including all documentation.
2723 ]]>
2724       </docs>
2725     </option>
2726     <option type='string' id='XML_OUTPUT' format='dir' defval='xml' depends='GENERATE_XML'>
2727       <docs>
2728 <![CDATA[
2729  The \c XML_OUTPUT tag is used to specify where the XML pages will be put.
2730  If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
2731  put in front of it.
2732 ]]>
2733       </docs>
2734     </option>
2735     <option type='bool' id='XML_PROGRAMLISTING' defval='1' depends='GENERATE_XML'>
2736       <docs>
2737 <![CDATA[
2738  If the \c XML_PROGRAMLISTING tag is set to \c YES doxygen will
2739  dump the program listings (including syntax highlighting
2740  and cross-referencing information) to the XML output. Note that
2741  enabling this will significantly increase the size of the XML output.
2742 ]]>
2743       </docs>
2744     </option>
2745   </group>
2746   <group name='Docbook' docs='Configuration options related to the DOCBOOK output'>
2747     <option type='bool' id='GENERATE_DOCBOOK' defval='0'>
2748       <docs>
2749 <![CDATA[
2750 If the \c GENERATE_DOCBOOK tag is set to \c YES doxygen will generate Docbook files
2751 that can be used to generate PDF.
2752 ]]>
2753       </docs>
2754     </option>
2755     <option type='string' id='DOCBOOK_OUTPUT' format='dir' defval='docbook' depends='GENERATE_DOCBOOK'>
2756       <docs>
2757 <![CDATA[
2758 The \c DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2759 If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in
2760 front of it.
2761 ]]>
2762       </docs>
2763     </option>
2764   </group>
2765   <group name='AutoGen' docs='Configuration options for the AutoGen Definitions output'>
2766     <option type='bool' id='GENERATE_AUTOGEN_DEF' defval='0'>
2767       <docs>
2768 <![CDATA[
2769  If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES doxygen will
2770  generate an AutoGen Definitions (see http://autogen.sf.net) file
2771  that captures the structure of the code including all
2772  documentation. Note that this feature is still experimental
2773  and incomplete at the moment.
2774 ]]>
2775       </docs>
2776     </option>
2777   </group>
2778 <!--
2779   <group name='Sqlite3' docs='Configuration options related to Sqlite3 output'>
2780     <option type='bool' id='GENERATE_SQLITE3' defval='0'>
2781       <docs>
2782 <![CDATA[
2783 If the \c GENERATE_SQLITE3 tag is set to \c YES doxygen will generate a
2784 \c Sqlite3 database with symbols found by doxygen stored in tables.
2785 ]]>
2786       </docs>
2787     </option>
2788     <option type='string' id='SQLITE3_OUTPUT' format='dir' defval='sqlite3' depends='GENERATE_SQLITE3'>
2789       <docs>
2790 <![CDATA[
2791 The \c SQLITE3_OUTPUT tag is used to specify where the \c Sqlite3 database will be put.
2792 If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
2793 put in front of it.
2794 ]]>
2795       </docs>
2796     </option>
2797
2798   </group>
2799 -->
2800   <group name='PerlMod' docs='Configuration options related to the Perl module output'>
2801     <option type='bool' id='GENERATE_PERLMOD' defval='0'>
2802       <docs>
2803 <![CDATA[
2804  If the \c GENERATE_PERLMOD tag is set to \c YES doxygen will
2805  generate a Perl module file that captures the structure of
2806  the code including all documentation.
2807  <br>Note that this
2808  feature is still experimental and incomplete at the
2809  moment.
2810 ]]>
2811       </docs>
2812     </option>
2813     <option type='bool' id='PERLMOD_LATEX' defval='0' depends='GENERATE_PERLMOD'>
2814       <docs>
2815 <![CDATA[
2816  If the \c PERLMOD_LATEX tag is set to \c YES doxygen will generate
2817  the necessary \c Makefile rules, \c Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able
2818  to generate PDF and DVI output from the Perl module output.
2819 ]]>
2820       </docs>
2821     </option>
2822     <option type='bool' id='PERLMOD_PRETTY' defval='1' depends='GENERATE_PERLMOD'>
2823       <docs>
2824 <![CDATA[
2825  If the \c PERLMOD_PRETTY tag is set to \c YES the Perl module output will be
2826  nicely formatted so it can be parsed by a human reader.  This is useful
2827  if you want to understand what is going on. On the other hand, if this
2828  tag is set to \c NO the size of the Perl module output will be much smaller
2829  and Perl will parse it just the same.
2830 ]]>
2831       </docs>
2832     </option>
2833     <option type='string' id='PERLMOD_MAKEVAR_PREFIX' format='string' defval='' depends='GENERATE_PERLMOD'>
2834       <docs>
2835 <![CDATA[
2836  The names of the make variables in the generated `doxyrules.make` file
2837  are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX.
2838  This is useful so different `doxyrules.make` files included by the same
2839  `Makefile` don't overwrite each other's variables.
2840 ]]>
2841       </docs>
2842     </option>
2843   </group>
2844   <group name='Preprocessor' docs='Configuration options related to the preprocessor'>
2845     <option type='bool' id='ENABLE_PREPROCESSING' defval='1'>
2846       <docs>
2847 <![CDATA[
2848  If the \c ENABLE_PREPROCESSING tag is set to \c YES doxygen will
2849  evaluate all C-preprocessor directives found in the sources and include
2850  files.
2851 ]]>
2852       </docs>
2853     </option>
2854     <option type='bool' id='MACRO_EXPANSION' defval='0' depends='ENABLE_PREPROCESSING'>
2855       <docs>
2856 <![CDATA[
2857  If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro
2858  names in the source code. If set to \c NO only conditional
2859  compilation will be performed. Macro expansion can be done in a controlled
2860  way by setting \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" to \c YES.
2861 ]]>
2862       </docs>
2863     </option>
2864     <option type='bool' id='EXPAND_ONLY_PREDEF' defval='0' depends='ENABLE_PREPROCESSING'>
2865       <docs>
2866 <![CDATA[
2867  If the \c EXPAND_ONLY_PREDEF and \ref cfg_macro_expansion "MACRO_EXPANSION" tags are both set to \c YES
2868  then the macro expansion is limited to the macros specified with the
2869  \ref cfg_predefined "PREDEFINED" and \ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tags.
2870 ]]>
2871       </docs>
2872     </option>
2873     <option type='bool' id='SEARCH_INCLUDES' defval='1' depends='ENABLE_PREPROCESSING'>
2874       <docs>
2875 <![CDATA[
2876  If the \c SEARCH_INCLUDES tag is set to \c YES the includes files
2877  in the \ref cfg_include_path "INCLUDE_PATH" will be searched if a \c \#include is found.
2878 ]]>
2879       </docs>
2880     </option>
2881     <option type='list' id='INCLUDE_PATH' format='dir' depends='SEARCH_INCLUDES'>
2882       <docs>
2883 <![CDATA[
2884  The \c INCLUDE_PATH tag can be used to specify one or more directories that
2885  contain include files that are not input files but should be processed by
2886  the preprocessor.
2887 ]]>
2888       </docs>
2889     </option>
2890     <option type='list' id='INCLUDE_FILE_PATTERNS' format='string' depends='ENABLE_PREPROCESSING'>
2891       <docs>
2892 <![CDATA[
2893  You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2894  patterns (like `*.h` and `*.hpp`) to filter out the header-files in the
2895  directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will
2896  be used.
2897 ]]>
2898       </docs>
2899     </option>
2900     <option type='list' id='PREDEFINED' format='string' depends='ENABLE_PREPROCESSING'>
2901       <docs>
2902 <![CDATA[
2903  The \c PREDEFINED tag can be used to specify one or more macro names that
2904  are defined before the preprocessor is started (similar to the `-D` option of
2905  e.g. \c gcc). The argument of the tag is a list of macros of the form:
2906  <code>name</code> or <code>name=definition</code> (no spaces).
2907  If the definition and the \c "=" are omitted,  \c "=1" is assumed. To prevent
2908  a macro definition from being undefined via \c \#undef or recursively expanded
2909  use the <code>:=</code> operator instead of the \c = operator.
2910 ]]>
2911       </docs>
2912     </option>
2913     <option type='list' id='EXPAND_AS_DEFINED' format='string' depends='ENABLE_PREPROCESSING'>
2914       <docs>
2915 <![CDATA[
2916  If the \ref cfg_macro_expansion "MACRO_EXPANSION" and
2917  \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" tags are set to \c YES then
2918  this tag can be used to specify a list of macro names that should be expanded.
2919  The macro definition that is found in the sources will be used.
2920  Use the \ref cfg_predefined "PREDEFINED" tag if you want to use a different macro definition that
2921  overrules the definition found in the source code.
2922 ]]>
2923       </docs>
2924     </option>
2925     <option type='bool' id='SKIP_FUNCTION_MACROS' defval='1' depends='ENABLE_PREPROCESSING'>
2926       <docs>
2927 <![CDATA[
2928  If the \c SKIP_FUNCTION_MACROS tag is set to \c YES then
2929  doxygen's preprocessor will remove all references to function-like macros that are alone
2930  on a line, have an all uppercase name, and do not end with a semicolon.
2931  Such function macros are typically
2932  used for boiler-plate code, and will confuse the parser if not removed.
2933 ]]>
2934       </docs>
2935     </option>
2936   </group>
2937   <group name='External' docs='Configuration options related to external references'>
2938     <option type='list' id='TAGFILES' format='file'>
2939       <docs>
2940 <![CDATA[
2941  The \c TAGFILES tag can be used to specify one or more tag files.
2942
2943 For each
2944 tag file the location of the external documentation should be added. The
2945 format of a tag file without this location is as follows:
2946 \verbatim
2947   TAGFILES = file1 file2 ...
2948 \endverbatim
2949 Adding location for the tag files is done as follows:
2950 \verbatim
2951   TAGFILES = file1=loc1 "file2 = loc2" ...
2952 \endverbatim
2953 where `loc1` and `loc2` can be relative or absolute paths or URLs.
2954  See the section \ref external for more information about the use of tag files.
2955
2956  \note
2957   Each tag file must have a unique name
2958   (where the name does \e NOT include the path).
2959   If a tag file is not located in the directory in which doxygen
2960   is run, you must also specify the path to the tagfile here.
2961 ]]>
2962       </docs>
2963     </option>
2964     <option type='string' id='GENERATE_TAGFILE' format='file' defval=''>
2965       <docs>
2966 <![CDATA[
2967  When a file name is specified after \c GENERATE_TAGFILE, doxygen will create
2968  a tag file that is based on the input files it reads.
2969  See section \ref external for more information about the usage of
2970  tag files.
2971 ]]>
2972       </docs>
2973     </option>
2974     <option type='bool' id='ALLEXTERNALS' defval='0'>
2975       <docs>
2976 <![CDATA[
2977  If the \c ALLEXTERNALS tag is set to \c YES all external class will be listed
2978  in the class index. If set to \c NO only the inherited external classes
2979  will be listed.
2980 ]]>
2981       </docs>
2982     </option>
2983     <option type='bool' id='EXTERNAL_GROUPS' defval='1'>
2984       <docs>
2985 <![CDATA[
2986  If the \c EXTERNAL_GROUPS tag is set to \c YES all external groups will be listed
2987  in the modules index. If set to \c NO, only the current project's groups will
2988  be listed.
2989 ]]>
2990       </docs>
2991     </option>
2992     <option type='bool' id='EXTERNAL_PAGES' defval='1'>
2993       <docs>
2994 <![CDATA[
2995  If the \c EXTERNAL_PAGES tag is set to \c YES all external pages will be listed
2996  in the related pages index. If set to \c NO, only the current project's
2997  pages will be listed.
2998 ]]>
2999       </docs>
3000     </option>
3001     <option type='string' id='PERL_PATH' format='file' defval='/usr/bin/perl' abspath='1'>
3002       <docs>
3003 <![CDATA[
3004  The \c PERL_PATH should be the absolute path and name of the perl script
3005  interpreter (i.e. the result of `'which perl'`).
3006 ]]>
3007       </docs>
3008     </option>
3009   </group>
3010   <group name='Dot' docs='Configuration options related to the dot tool'>
3011     <option type='bool' id='CLASS_DIAGRAMS' defval='1'>
3012       <docs>
3013 <![CDATA[
3014  If the \c CLASS_DIAGRAMS tag is set to \c YES doxygen will
3015  generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or
3016  super classes. Setting the tag to \c NO turns the diagrams off. Note that
3017  this option also works with \ref cfg_have_dot "HAVE_DOT" disabled, but it is recommended to
3018  install and use \c dot, since it yields more powerful graphs.
3019 ]]>
3020       </docs>
3021     </option>
3022     <option type='string' id='MSCGEN_PATH' format='dir' defval=''>
3023       <docs>
3024 <![CDATA[
3025  You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc"
3026  command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">mscgen tool</a>) to
3027  produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to
3028  specify the directory where the \c mscgen tool resides. If left empty the tool is assumed to
3029  be found in the default search path.
3030 ]]>
3031       </docs>
3032     </option>
3033     <option type='string' id='DIA_PATH' format='dir' defval=''>
3034       <docs>
3035 <![CDATA[
3036 You can include diagrams made with dia in doxygen documentation. Doxygen will then run
3037 dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows
3038 you to specify the directory where the dia binary resides. If left empty dia is assumed
3039 to be found in the default search path.
3040 ]]>
3041       </docs>
3042     </option>
3043     <option type='bool' id='HIDE_UNDOC_RELATIONS' defval='1'>
3044       <docs>
3045 <![CDATA[
3046  If set to \c YES, the inheritance and collaboration graphs will hide
3047  inheritance and usage relations if the target is undocumented
3048  or is not a class.
3049 ]]>
3050       </docs>
3051     </option>
3052     <option type='bool' id='HAVE_DOT' defval='0'>
3053       <docs>
3054 <![CDATA[
3055  If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the \c dot tool is
3056  available from the \c path. This tool is part of
3057  <a href="http://www.graphviz.org/">Graphviz</a>, a graph
3058  visualization toolkit from AT\&T and Lucent Bell Labs. The other options in
3059  this section have no effect if this option is set to \c NO
3060 ]]>
3061       </docs>
3062     </option>
3063     <option type='int' id='DOT_NUM_THREADS' defval='0' minval='0' maxval='32' depends='HAVE_DOT'>
3064       <docs>
3065 <![CDATA[
3066  The \c DOT_NUM_THREADS specifies the number of \c dot invocations doxygen is
3067  allowed to run in parallel. When set to \c 0 doxygen will
3068  base this on the number of processors available in the system. You can set it
3069  explicitly to a value larger than 0 to get control over the balance
3070  between CPU load and processing speed.
3071 ]]>
3072       </docs>
3073     </option>
3074     <option type='string' id='DOT_FONTNAME' format='string' defval='Helvetica' depends='HAVE_DOT'>
3075       <docs>
3076 <![CDATA[
3077  When you want a differently looking font n the dot files that doxygen generates
3078  you can specify the font name
3079  using \c DOT_FONTNAME. You need to make sure dot is able to find the font,
3080  which can be done by putting it in a standard location or by setting the
3081  \c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the
3082  directory containing the font.
3083 ]]>
3084       </docs>
3085     </option>
3086     <option type='int' id='DOT_FONTSIZE' minval='4' maxval='24' defval='10' depends='HAVE_DOT'>
3087       <docs>
3088 <![CDATA[
3089  The \c DOT_FONTSIZE tag can be used to set the size (in points) of the font of dot graphs.
3090 ]]>
3091       </docs>
3092     </option>
3093     <option type='string' id='DOT_FONTPATH' format='dir' defval='' depends='HAVE_DOT'>
3094       <docs>
3095 <![CDATA[
3096  By default doxygen will tell \c dot to use the default font as specified with \ref cfg_dot_fontname "DOT_FONTNAME".
3097  If you specify a
3098  different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot
3099  can find it using this tag.
3100 ]]>
3101       </docs>
3102     </option>
3103     <option type='bool' id='CLASS_GRAPH' defval='1' depends='HAVE_DOT'>
3104       <docs>
3105 <![CDATA[
3106  If the \c CLASS_GRAPH tag is set to \c YES then doxygen
3107  will generate a graph for each documented class showing the direct and
3108  indirect inheritance relations. Setting this tag to \c YES will force
3109  the \ref cfg_class_diagrams "CLASS_DIAGRAMS" tag to \c NO.
3110 ]]>
3111       </docs>
3112     </option>
3113     <option type='bool' id='COLLABORATION_GRAPH' defval='1' depends='HAVE_DOT'>
3114       <docs>
3115 <![CDATA[
3116  If the \c COLLABORATION_GRAPH tag is set to \c YES then doxygen
3117  will generate a graph for each documented class showing the direct and
3118  indirect implementation dependencies (inheritance, containment, and
3119  class references variables) of the class with other documented classes.
3120 ]]>
3121       </docs>
3122     </option>
3123     <option type='bool' id='GROUP_GRAPHS' defval='1' depends='HAVE_DOT'>
3124       <docs>
3125 <![CDATA[
3126  If the \c GROUP_GRAPHS tag is set to \c YES then doxygen
3127  will generate a graph for groups, showing the direct groups dependencies.
3128 ]]>
3129       </docs>
3130     </option>
3131     <option type='bool' id='UML_LOOK' defval='0' depends='HAVE_DOT'>
3132       <docs>
3133 <![CDATA[
3134  If the \c UML_LOOK tag is set to \c YES doxygen will generate inheritance and
3135  collaboration diagrams in a style similar to the OMG's Unified Modeling
3136  Language.
3137 ]]>
3138       </docs>
3139     </option>
3140     <option type='int' id='UML_LIMIT_NUM_FIELDS' defval='10' minval='0' maxval='100' depends='HAVE_DOT'>
3141       <docs>
3142 <![CDATA[
3143  If the \ref cfg_uml_look "UML_LOOK" tag is enabled, the fields and methods are shown inside
3144  the class node. If there are many fields or methods and many nodes the
3145  graph may become too big to be useful. The \c UML_LIMIT_NUM_FIELDS
3146  threshold limits the number of items for each type to make the size more
3147  manageable. Set this to 0 for no limit. Note that the threshold may be
3148  exceeded by 50% before the limit is enforced. So when you set the threshold
3149  to 10, up to 15 fields may appear, but if the number exceeds 15, the
3150  total amount of fields shown is limited to 10.
3151 ]]>
3152       </docs>
3153     </option>
3154     <option type='bool' id='TEMPLATE_RELATIONS' defval='0' depends='HAVE_DOT'>
3155       <docs>
3156 <![CDATA[
3157  If the \c TEMPLATE_RELATIONS tag is set to \c YES then
3158  the inheritance and collaboration graphs will show the relations between templates and their instances.
3159 ]]>
3160       </docs>
3161     </option>
3162     <option type='bool' id='INCLUDE_GRAPH' defval='1' depends='HAVE_DOT'>
3163       <docs>
3164 <![CDATA[
3165  If the \c INCLUDE_GRAPH, \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" and
3166  \ref cfg_search_includes "SEARCH_INCLUDES"
3167  tags are set to \c YES then doxygen will generate a graph for each documented file
3168  showing the direct and indirect include dependencies of the file with other
3169  documented files.
3170 ]]>
3171       </docs>
3172     </option>
3173     <option type='bool' id='INCLUDED_BY_GRAPH' defval='1' depends='HAVE_DOT'>
3174       <docs>
3175 <![CDATA[
3176  If the \c INCLUDED_BY_GRAPH, \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" and
3177  \ref cfg_search_includes "SEARCH_INCLUDES"
3178  tags are set to \c YES then doxygen will generate a graph for each documented file
3179  showing the direct and indirect include dependencies of the file with other
3180  documented files.
3181 ]]>
3182       </docs>
3183     </option>
3184     <option type='bool' id='CALL_GRAPH' defval='0' depends='HAVE_DOT'>
3185       <docs>
3186 <![CDATA[
3187  If the \c CALL_GRAPH tag is set to \c YES then doxygen will
3188  generate a call dependency graph for every global function or class method.
3189  <br>Note that enabling this option will significantly increase the time of a run.
3190  So in most cases it will be better to enable call graphs for selected
3191  functions only using the \ref cmdcallgraph "\\callgraph" command.
3192 ]]>
3193       </docs>
3194     </option>
3195     <option type='bool' id='CALLER_GRAPH' defval='0' depends='HAVE_DOT'>
3196       <docs>
3197 <![CDATA[
3198  If the \c CALLER_GRAPH tag is set to \c YES then doxygen will
3199  generate a caller dependency graph for every global function or class method.
3200  <br>Note that enabling this option will significantly increase the time of a run.
3201  So in most cases it will be better to enable caller graphs for selected
3202  functions only using the \ref cmdcallergraph "\\callergraph" command.
3203 ]]>
3204       </docs>
3205     </option>
3206     <option type='bool' id='GRAPHICAL_HIERARCHY' defval='1' depends='HAVE_DOT'>
3207       <docs>
3208 <![CDATA[
3209  If the \c GRAPHICAL_HIERARCHY tag is set to \c YES then
3210  doxygen will graphical hierarchy of all classes instead of a textual one.
3211 ]]>
3212       </docs>
3213     </option>
3214     <option type='bool' id='DIRECTORY_GRAPH' defval='1' depends='HAVE_DOT'>
3215       <docs>
3216 <![CDATA[
3217  If the \c DIRECTORY_GRAPH tag is set
3218  to \c YES then doxygen will show the dependencies a directory has on other directories
3219  in a graphical way. The dependency relations are determined by the \c \#include
3220  relations between the files in the directories.
3221 ]]>
3222       </docs>
3223     </option>
3224     <option type='enum' id='DOT_IMAGE_FORMAT' defval='png' depends='HAVE_DOT'>
3225       <docs>
3226 <![CDATA[
3227  The \c DOT_IMAGE_FORMAT tag can be used to set the image format of the images
3228  generated by \c dot.
3229  \note If you choose \c svg you need to set
3230  \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files
3231  visible in IE 9+ (other browsers do not have this requirement).
3232 ]]>
3233       </docs>
3234       <value name='png'/>
3235       <value name='jpg'/>
3236       <value name='gif'/>
3237       <value name='svg'/>
3238     </option>
3239     <option type='bool' id='INTERACTIVE_SVG' defval='0' depends='HAVE_DOT'>
3240       <docs>
3241 <![CDATA[
3242  If \ref cfg_dot_image_format "DOT_IMAGE_FORMAT" is set to \c svg, then this option can be set to \c YES to
3243  enable generation of interactive SVG images that allow zooming and panning.
3244  <br>Note that this requires a modern browser other than Internet Explorer.
3245  Tested and working are Firefox, Chrome, Safari, and Opera.
3246  \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order
3247  to make the SVG files visible. Older versions of IE do not have SVG support.
3248 ]]>
3249       </docs>
3250     </option>
3251     <option type='string' id='DOT_PATH' format='dir' defval='' depends='HAVE_DOT'>
3252       <docs>
3253 <![CDATA[
3254  The \c DOT_PATH tag can be used to specify the path where the \c dot tool can be found.
3255  If left blank, it is assumed the \c dot tool can be found in the \c path.
3256 ]]>
3257       </docs>
3258     </option>
3259     <option type='list' id='DOTFILE_DIRS' format='dir' depends='HAVE_DOT'>
3260       <docs>
3261 <![CDATA[
3262  The \c DOTFILE_DIRS tag can be used to specify one or more directories that
3263  contain dot files that are included in the documentation (see the
3264  \ref cmddotfile "\\dotfile" command).
3265 ]]>
3266       </docs>
3267     </option>
3268     <option type='list' id='MSCFILE_DIRS' format='dir'>
3269       <docs>
3270 <![CDATA[
3271  The \c MSCFILE_DIRS tag can be used to specify one or more directories that
3272  contain msc files that are included in the documentation (see the
3273  \ref cmdmscfile "\\mscfile" command).
3274 ]]>
3275       </docs>
3276     </option>
3277     <option type='list' id='DIAFILE_DIRS' format='dir'>
3278       <docs>
3279 <![CDATA[
3280  The \c DIAFILE_DIRS tag can be used to specify one or more directories that
3281  contain dia files that are included in the documentation (see the
3282  \ref cmdmscfile "\\diafile" command).
3283 ]]>
3284       </docs>
3285     </option>
3286     <option type='int' id='DOT_GRAPH_MAX_NODES' minval='0' maxval='10000' defval='50' depends='HAVE_DOT'>
3287       <docs>
3288 <![CDATA[
3289  The \c DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
3290  nodes that will be shown in the graph. If the number of nodes in a graph
3291  becomes larger than this value, doxygen will truncate the graph, which is
3292  visualized by representing a node as a red box. Note that doxygen if the number
3293  of direct children of the root node in a graph is already larger than
3294  \c DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
3295  that the size of a graph can be further restricted by \ref cfg_max_dot_graph_depth "MAX_DOT_GRAPH_DEPTH".
3296 ]]>
3297       </docs>
3298     </option>
3299     <option type='int' id='MAX_DOT_GRAPH_DEPTH' minval='0' maxval='1000' defval='0' depends='HAVE_DOT'>
3300       <docs>
3301 <![CDATA[
3302  The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
3303  graphs generated by \c dot. A depth value of 3 means that only nodes reachable
3304  from the root by following a path via at most 3 edges will be shown. Nodes
3305  that lay further from the root node will be omitted. Note that setting this
3306  option to 1 or 2 may greatly reduce the computation time needed for large
3307  code bases. Also note that the size of a graph can be further restricted by
3308  \ref cfg_dot_graph_max_nodes "DOT_GRAPH_MAX_NODES". Using a depth of 0 means no depth restriction.
3309 ]]>
3310       </docs>
3311     </option>
3312     <option type='bool' id='DOT_TRANSPARENT' defval='0' depends='HAVE_DOT'>
3313       <docs>
3314 <![CDATA[
3315  Set the \c DOT_TRANSPARENT tag to \c YES to generate images with a transparent
3316  background. This is disabled by default, because dot on Windows does not
3317  seem to support this out of the box.
3318  <br>
3319  Warning: Depending on the platform used,
3320  enabling this option may lead to badly anti-aliased labels on the edges of
3321  a graph (i.e. they become hard to read).
3322 ]]>
3323       </docs>
3324     </option>
3325     <option type='bool' id='DOT_MULTI_TARGETS' defval='0' depends='HAVE_DOT'>
3326       <docs>
3327 <![CDATA[
3328  Set the \c DOT_MULTI_TARGETS tag to \c YES allow dot to generate multiple output
3329  files in one run (i.e. multiple -o and -T options on the command line). This
3330  makes \c dot run faster, but since only newer versions of \c dot (>1.8.10)
3331  support this, this feature is disabled by default.
3332 ]]>
3333       </docs>
3334     </option>
3335     <option type='bool' id='GENERATE_LEGEND' defval='1' depends='HAVE_DOT'>
3336       <docs>
3337 <![CDATA[
3338  If the \c GENERATE_LEGEND tag is set to \c YES doxygen will
3339  generate a legend page explaining the meaning of the various boxes and
3340  arrows in the dot generated graphs.
3341 ]]>
3342       </docs>
3343     </option>
3344     <option type='bool' id='DOT_CLEANUP' defval='1' depends='HAVE_DOT'>
3345       <docs>
3346 <![CDATA[
3347 If the \c DOT_CLEANUP tag is set to \c YES doxygen will
3348 remove the intermediate dot files that are used to generate the various graphs.
3349 ]]>
3350       </docs>
3351     </option>
3352
3353     <option type='obsolete' id='USE_WINDOWS_ENCODING'/>
3354     <option type='obsolete' id='DETAILS_AT_TOP'/>
3355     <option type='obsolete' id='QTHELP_FILE'/>
3356     <option type='obsolete' id='QTHELP_CONFIG'/>
3357     <option type='obsolete' id='DOXYGEN2QTHELP_LOC'/>
3358     <option type='obsolete' id='MAX_DOT_GRAPH_WIDTH'/>
3359     <option type='obsolete' id='MAX_DOT_GRAPH_HEIGHT'/>
3360     <option type='obsolete' id='CGI_NAME'/>
3361     <option type='obsolete' id='CGI_URL'/>
3362     <option type='obsolete' id='DOC_URL'/>
3363     <option type='obsolete' id='DOC_ABSPATH'/>
3364     <option type='obsolete' id='BIN_ABSPATH'/>
3365     <option type='obsolete' id='EXT_DOC_PATHS'/>
3366     <option type='obsolete' id='USE_INLINE_TREES'/>
3367     <option type='obsolete' id='SHOW_DIRECTORIES'/>
3368     <option type='obsolete' id='HTML_ALIGN_MEMBERS'/>
3369     <option type='obsolete' id='SYMBOL_CACHE_SIZE'/>
3370     <option type='obsolete' id='XML_SCHEMA'/>
3371     <option type='obsolete' id='XML_DTD'/>
3372   </group>
3373 </doxygenconfig>