Doxyfile

   1 # Doxyfile 1.6.1
   2
   3 # This file describes the settings to be used by the documentation system
   4 # doxygen (www.doxygen.org) for a project
   5 #
   6 # All text after a hash (#) is considered a comment and will be ignored
   7 # The format is:
   8 #       TAG = value [value, ...]
   9 # For lists items can also be appended using:
  10 #       TAG += value [value, ...]
  11 # Values that contain spaces should be placed between quotes (" ")
  12
  13 #---------------------------------------------------------------------------
  14 # Project related configuration options
  15 #---------------------------------------------------------------------------
  16
  17 # This tag specifies the encoding used for all characters in the config file
  18 # that follow. The default is UTF-8 which is also the encoding used for all
  19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  20 # iconv built into libc) for the transcoding. See
  21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
  22
  23 DOXYFILE_ENCODING      = UTF-8
  24
  25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  26 # by quotes) that should identify the project.
  27
  28 PROJECT_NAME           = SuperTux
  29
  30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  31 # This could be handy for archiving the generated documentation or
  32 # if some version control system is used.
  33
  34 PROJECT_NUMBER         = 0.3.4-GIT
  35
  36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  37 # base path where the generated documentation will be put.
  38 # If a relative path is entered, it will be relative to the location
  39 # where doxygen was started. If left blank the current directory will be used.
  40
  41 OUTPUT_DIRECTORY       = docs/doxygen
  42
  43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  44 # 4096 sub-directories (in 2 levels) under the output directory of each output
  45 # format and will distribute the generated files over these directories.
  46 # Enabling this option can be useful when feeding doxygen a huge amount of
  47 # source files, where putting all generated files in the same directory would
  48 # otherwise cause performance problems for the file system.
  49
  50 CREATE_SUBDIRS         = NO
  51
  52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  53 # documentation generated by doxygen is written. Doxygen will use this
  54 # information to generate all constant output in the proper language.
  55 # The default language is English, other supported languages are:
  56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
  61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  62
  63 OUTPUT_LANGUAGE        = English
  64
  65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  66 # include brief member descriptions after the members that are listed in
  67 # the file and class documentation (similar to JavaDoc).
  68 # Set to NO to disable this.
  69
  70 BRIEF_MEMBER_DESC      = YES
  71
  72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  73 # the brief description of a member or function before the detailed description.
  74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  75 # brief descriptions will be completely suppressed.
  76
  77 REPEAT_BRIEF           = YES
  78
  79 # This tag implements a quasi-intelligent brief description abbreviator
  80 # that is used to form the text in various listings. Each string
  81 # in this list, if found as the leading text of the brief description, will be
  82 # stripped from the text and the result after processing the whole list, is
  83 # used as the annotated text. Otherwise, the brief description is used as-is.
  84 # If left blank, the following values are used ("$name" is automatically
  85 # replaced with the name of the entity): "The $name class" "The $name widget"
  86 # "The $name file" "is" "provides" "specifies" "contains"
  87 # "represents" "a" "an" "the"
  88
  89 ABBREVIATE_BRIEF       = "The $name class" \
  90                          "The $name widget" \
  91                          "The $name file" \
  92                          is \
  93                          provides \
  94                          specifies \
  95                          contains \
  96                          represents \
  97                          a \
  98                          an \
  99                          the
 100
 101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
 102 # Doxygen will generate a detailed section even if there is only a brief
 103 # description.
 104
 105 ALWAYS_DETAILED_SEC    = NO
 106
 107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
 108 # inherited members of a class in the documentation of that class as if those
 109 # members were ordinary class members. Constructors, destructors and assignment
 110 # operators of the base classes will not be shown.
 111
 112 INLINE_INHERITED_MEMB  = NO
 113
 114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
 115 # path before files name in the file list and in the header files. If set
 116 # to NO the shortest path that makes the file name unique will be used.
 117
 118 FULL_PATH_NAMES        = YES
 119
 120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 121 # can be used to strip a user-defined part of the path. Stripping is
 122 # only done if one of the specified strings matches the left-hand part of
 123 # the path. The tag can be used to show relative paths in the file list.
 124 # If left blank the directory from which doxygen is run is used as the
 125 # path to strip.
 126
 127 STRIP_FROM_PATH        =
 128
 129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 130 # the path mentioned in the documentation of a class, which tells
 131 # the reader which header file to include in order to use a class.
 132 # If left blank only the name of the header file containing the class
 133 # definition is used. Otherwise one should specify the include paths that
 134 # are normally passed to the compiler using the -I flag.
 135
 136 STRIP_FROM_INC_PATH    =
 137
 138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
 139 # (but less readable) file names. This can be useful is your file systems
 140 # doesn't support long names like on DOS, Mac, or CD-ROM.
 141
 142 SHORT_NAMES            = NO
 143
 144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
 145 # will interpret the first line (until the first dot) of a JavaDoc-style
 146 # comment as the brief description. If set to NO, the JavaDoc
 147 # comments will behave just like regular Qt-style comments
 148 # (thus requiring an explicit @brief command for a brief description.)
 149
 150 JAVADOC_AUTOBRIEF      = YES
 151
 152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
 153 # interpret the first line (until the first dot) of a Qt-style
 154 # comment as the brief description. If set to NO, the comments
 155 # will behave just like regular Qt-style comments (thus requiring
 156 # an explicit \brief command for a brief description.)
 157
 158 QT_AUTOBRIEF           = NO
 159
 160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
 161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
 162 # comments) as a brief description. This used to be the default behaviour.
 163 # The new default is to treat a multi-line C++ comment block as a detailed
 164 # description. Set this tag to YES if you prefer the old behaviour instead.
 165
 166 MULTILINE_CPP_IS_BRIEF = NO
 167
 168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
 169 # member inherits the documentation from any documented member that it
 170 # re-implements.
 171
 172 INHERIT_DOCS           = YES
 173
 174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
 175 # a new page for each member. If set to NO, the documentation of a member will
 176 # be part of the file/class/namespace that contains it.
 177
 178 SEPARATE_MEMBER_PAGES  = NO
 179
 180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
 181 # Doxygen uses this value to replace tabs by spaces in code fragments.
 182
 183 TAB_SIZE               = 8
 184
 185 # This tag can be used to specify a number of aliases that acts
 186 # as commands in the documentation. An alias has the form "name=value".
 187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
 188 # put the command \sideeffect (or @sideeffect) in the documentation, which
 189 # will result in a user-defined paragraph with heading "Side Effects:".
 190 # You can put \n's in the value part of an alias to insert newlines.
 191
 192 ALIASES                =
 193
 194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
 195 # sources only. Doxygen will then generate output that is more tailored for C.
 196 # For instance, some of the names that are used will be different. The list
 197 # of all members will be omitted, etc.
 198
 199 OPTIMIZE_OUTPUT_FOR_C  = NO
 200
 201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
 202 # sources only. Doxygen will then generate output that is more tailored for
 203 # Java. For instance, namespaces will be presented as packages, qualified
 204 # scopes will look different, etc.
 205
 206 OPTIMIZE_OUTPUT_JAVA   = NO
 207
 208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
 209 # sources only. Doxygen will then generate output that is more tailored for
 210 # Fortran.
 211
 212 OPTIMIZE_FOR_FORTRAN   = NO
 213
 214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
 215 # sources. Doxygen will then generate output that is tailored for
 216 # VHDL.
 217
 218 OPTIMIZE_OUTPUT_VHDL   = NO
 219
 220 # Doxygen selects the parser to use depending on the extension of the files it parses.
 221 # With this tag you can assign which parser to use for a given extension.
 222 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
 223 # The format is ext=language, where ext is a file extension, and language is one of
 224 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
 225 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
 226 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
 227 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
 228
 229 EXTENSION_MAPPING      =
 230
 231 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
 232 # to include (a tag file for) the STL sources as input, then you should
 233 # set this tag to YES in order to let doxygen match functions declarations and
 234 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
 235 # func(std::string) {}). This also make the inheritance and collaboration
 236 # diagrams that involve STL classes more complete and accurate.
 237
 238 BUILTIN_STL_SUPPORT    = YES
 239
 240 # If you use Microsoft's C++/CLI language, you should set this option to YES to
 241 # enable parsing support.
 242
 243 CPP_CLI_SUPPORT        = NO
 244
 245 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
 246 # Doxygen will parse them like normal C++ but will assume all classes use public
 247 # instead of private inheritance when no explicit protection keyword is present.
 248
 249 SIP_SUPPORT            = NO
 250
 251 # For Microsoft's IDL there are propget and propput attributes to indicate getter
 252 # and setter methods for a property. Setting this option to YES (the default)
 253 # will make doxygen to replace the get and set methods by a property in the
 254 # documentation. This will only work if the methods are indeed getting or
 255 # setting a simple type. If this is not the case, or you want to show the
 256 # methods anyway, you should set this option to NO.
 257
 258 IDL_PROPERTY_SUPPORT   = YES
 259
 260 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
 261 # tag is set to YES, then doxygen will reuse the documentation of the first
 262 # member in the group (if any) for the other members of the group. By default
 263 # all members of a group must be documented explicitly.
 264
 265 DISTRIBUTE_GROUP_DOC   = NO
 266
 267 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
 268 # the same type (for instance a group of public functions) to be put as a
 269 # subgroup of that type (e.g. under the Public Functions section). Set it to
 270 # NO to prevent subgrouping. Alternatively, this can be done per class using
 271 # the \nosubgrouping command.
 272
 273 SUBGROUPING            = YES
 274
 275 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
 276 # is documented as struct, union, or enum with the name of the typedef. So
 277 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
 278 # with name TypeT. When disabled the typedef will appear as a member of a file,
 279 # namespace, or class. And the struct will be named TypeS. This can typically
 280 # be useful for C code in case the coding convention dictates that all compound
 281 # types are typedef'ed and only the typedef is referenced, never the tag name.
 282
 283 TYPEDEF_HIDES_STRUCT   = NO
 284
 285 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
 286 # determine which symbols to keep in memory and which to flush to disk.
 287 # When the cache is full, less often used symbols will be written to disk.
 288 # For small to medium size projects (<1000 input files) the default value is
 289 # probably good enough. For larger projects a too small cache size can cause
 290 # doxygen to be busy swapping symbols to and from disk most of the time
 291 # causing a significant performance penality.
 292 # If the system has enough physical memory increasing the cache will improve the
 293 # performance by keeping more symbols in memory. Note that the value works on
 294 # a logarithmic scale so increasing the size by one will rougly double the
 295 # memory usage. The cache size is given by this formula:
 296 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
 297 # corresponding to a cache size of 2^16 = 65536 symbols
 298
 299 SYMBOL_CACHE_SIZE      = 0
 300
 301 #---------------------------------------------------------------------------
 302 # Build related configuration options
 303 #---------------------------------------------------------------------------
 304
 305 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
 306 # documentation are documented, even if no documentation was available.
 307 # Private class members and static file members will be hidden unless
 308 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 309
 310 EXTRACT_ALL            = YES
 311
 312 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
 313 # will be included in the documentation.
 314
 315 EXTRACT_PRIVATE        = YES
 316
 317 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 318 # will be included in the documentation.
 319
 320 EXTRACT_STATIC         = YES
 321
 322 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
 323 # defined locally in source files will be included in the documentation.
 324 # If set to NO only classes defined in header files are included.
 325
 326 EXTRACT_LOCAL_CLASSES  = YES
 327
 328 # This flag is only useful for Objective-C code. When set to YES local
 329 # methods, which are defined in the implementation section but not in
 330 # the interface are included in the documentation.
 331 # If set to NO (the default) only methods in the interface are included.
 332
 333 EXTRACT_LOCAL_METHODS  = NO
 334
 335 # If this flag is set to YES, the members of anonymous namespaces will be
 336 # extracted and appear in the documentation as a namespace called
 337 # 'anonymous_namespace{file}', where file will be replaced with the base
 338 # name of the file that contains the anonymous namespace. By default
 339 # anonymous namespace are hidden.
 340
 341 EXTRACT_ANON_NSPACES   = NO
 342
 343 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
 344 # undocumented members of documented classes, files or namespaces.
 345 # If set to NO (the default) these members will be included in the
 346 # various overviews, but no documentation section is generated.
 347 # This option has no effect if EXTRACT_ALL is enabled.
 348
 349 HIDE_UNDOC_MEMBERS     = NO
 350
 351 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
 352 # undocumented classes that are normally visible in the class hierarchy.
 353 # If set to NO (the default) these classes will be included in the various
 354 # overviews. This option has no effect if EXTRACT_ALL is enabled.
 355
 356 HIDE_UNDOC_CLASSES     = NO
 357
 358 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
 359 # friend (class|struct|union) declarations.
 360 # If set to NO (the default) these declarations will be included in the
 361 # documentation.
 362
 363 HIDE_FRIEND_COMPOUNDS  = NO
 364
 365 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
 366 # documentation blocks found inside the body of a function.
 367 # If set to NO (the default) these blocks will be appended to the
 368 # function's detailed documentation block.
 369
 370 HIDE_IN_BODY_DOCS      = NO
 371
 372 # The INTERNAL_DOCS tag determines if documentation
 373 # that is typed after a \internal command is included. If the tag is set
 374 # to NO (the default) then the documentation will be excluded.
 375 # Set it to YES to include the internal documentation.
 376
 377 INTERNAL_DOCS          = NO
 378
 379 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
 380 # file names in lower-case letters. If set to YES upper-case letters are also
 381 # allowed. This is useful if you have classes or files whose names only differ
 382 # in case and if your file system supports case sensitive file names. Windows
 383 # and Mac users are advised to set this option to NO.
 384
 385 CASE_SENSE_NAMES       = YES
 386
 387 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
 388 # will show members with their full class and namespace scopes in the
 389 # documentation. If set to YES the scope will be hidden.
 390
 391 HIDE_SCOPE_NAMES       = NO
 392
 393 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
 394 # will put a list of the files that are included by a file in the documentation
 395 # of that file.
 396
 397 SHOW_INCLUDE_FILES     = YES
 398
 399 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
 400 # is inserted in the documentation for inline members.
 401
 402 INLINE_INFO            = YES
 403
 404 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
 405 # will sort the (detailed) documentation of file and class members
 406 # alphabetically by member name. If set to NO the members will appear in
 407 # declaration order.
 408
 409 SORT_MEMBER_DOCS       = YES
 410
 411 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
 412 # brief documentation of file, namespace and class members alphabetically
 413 # by member name. If set to NO (the default) the members will appear in
 414 # declaration order.
 415
 416 SORT_BRIEF_DOCS        = NO
 417
 418 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
 419
 420 SORT_MEMBERS_CTORS_1ST = NO
 421
 422 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
 423 # hierarchy of group names into alphabetical order. If set to NO (the default)
 424 # the group names will appear in their defined order.
 425
 426 SORT_GROUP_NAMES       = NO
 427
 428 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
 429 # sorted by fully-qualified names, including namespaces. If set to
 430 # NO (the default), the class list will be sorted only by class name,
 431 # not including the namespace part.
 432 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
 433 # Note: This option applies only to the class list, not to the
 434 # alphabetical list.
 435
 436 SORT_BY_SCOPE_NAME     = NO
 437
 438 # The GENERATE_TODOLIST tag can be used to enable (YES) or
 439 # disable (NO) the todo list. This list is created by putting \todo
 440 # commands in the documentation.
 441
 442 GENERATE_TODOLIST      = YES
 443
 444 # The GENERATE_TESTLIST tag can be used to enable (YES) or
 445 # disable (NO) the test list. This list is created by putting \test
 446 # commands in the documentation.
 447
 448 GENERATE_TESTLIST      = YES
 449
 450 # The GENERATE_BUGLIST tag can be used to enable (YES) or
 451 # disable (NO) the bug list. This list is created by putting \bug
 452 # commands in the documentation.
 453
 454 GENERATE_BUGLIST       = YES
 455
 456 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
 457 # disable (NO) the deprecated list. This list is created by putting
 458 # \deprecated commands in the documentation.
 459
 460 GENERATE_DEPRECATEDLIST= YES
 461
 462 # The ENABLED_SECTIONS tag can be used to enable conditional
 463 # documentation sections, marked by \if sectionname ... \endif.
 464
 465 ENABLED_SECTIONS       =
 466
 467 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
 468 # the initial value of a variable or define consists of for it to appear in
 469 # the documentation. If the initializer consists of more lines than specified
 470 # here it will be hidden. Use a value of 0 to hide initializers completely.
 471 # The appearance of the initializer of individual variables and defines in the
 472 # documentation can be controlled using \showinitializer or \hideinitializer
 473 # command in the documentation regardless of this setting.
 474
 475 MAX_INITIALIZER_LINES  = 30
 476
 477 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
 478 # at the bottom of the documentation of classes and structs. If set to YES the
 479 # list will mention the files that were used to generate the documentation.
 480
 481 SHOW_USED_FILES        = YES
 482
 483 # If the sources in your project are distributed over multiple directories
 484 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
 485 # in the documentation. The default is NO.
 486
 487 SHOW_DIRECTORIES       = NO
 488
 489 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 490 # This will remove the Files entry from the Quick Index and from the
 491 # Folder Tree View (if specified). The default is YES.
 492
 493 SHOW_FILES             = YES
 494
 495 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
 496 # Namespaces page.
 497 # This will remove the Namespaces entry from the Quick Index
 498 # and from the Folder Tree View (if specified). The default is YES.
 499
 500 SHOW_NAMESPACES        = YES
 501
 502 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
 503 # doxygen should invoke to get the current version for each file (typically from
 504 # the version control system). Doxygen will invoke the program by executing (via
 505 # popen()) the command <command> <input-file>, where <command> is the value of
 506 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
 507 # provided by doxygen. Whatever the program writes to standard output
 508 # is used as the file version. See the manual for examples.
 509
 510 FILE_VERSION_FILTER    =
 511
 512 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
 513 # doxygen. The layout file controls the global structure of the generated output files
 514 # in an output format independent way. The create the layout file that represents
 515 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
 516 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
 517 # of the layout file.
 518
 519 LAYOUT_FILE            =
 520
 521 #---------------------------------------------------------------------------
 522 # configuration options related to warning and progress messages
 523 #---------------------------------------------------------------------------
 524
 525 # The QUIET tag can be used to turn on/off the messages that are generated
 526 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 527
 528 QUIET                  = YES
 529
 530 # The WARNINGS tag can be used to turn on/off the warning messages that are
 531 # generated by doxygen. Possible values are YES and NO. If left blank
 532 # NO is used.
 533
 534 WARNINGS               = YES
 535
 536 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
 537 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
 538 # automatically be disabled.
 539
 540 WARN_IF_UNDOCUMENTED   = YES
 541
 542 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
 543 # potential errors in the documentation, such as not documenting some
 544 # parameters in a documented function, or documenting parameters that
 545 # don't exist or using markup commands wrongly.
 546
 547 WARN_IF_DOC_ERROR      = YES
 548
 549 # This WARN_NO_PARAMDOC option can be abled to get warnings for
 550 # functions that are documented, but have no documentation for their parameters
 551 # or return value. If set to NO (the default) doxygen will only warn about
 552 # wrong or incomplete parameter documentation, but not about the absence of
 553 # documentation.
 554
 555 WARN_NO_PARAMDOC       = NO
 556
 557 # The WARN_FORMAT tag determines the format of the warning messages that
 558 # doxygen can produce. The string should contain the $file, $line, and $text
 559 # tags, which will be replaced by the file and line number from which the
 560 # warning originated and the warning text. Optionally the format may contain
 561 # $version, which will be replaced by the version of the file (if it could
 562 # be obtained via FILE_VERSION_FILTER)
 563
 564 WARN_FORMAT            = "$file:$line: $text"
 565
 566 # The WARN_LOGFILE tag can be used to specify a file to which warning
 567 # and error messages should be written. If left blank the output is written
 568 # to stderr.
 569
 570 WARN_LOGFILE           =
 571
 572 #---------------------------------------------------------------------------
 573 # configuration options related to the input files
 574 #---------------------------------------------------------------------------
 575
 576 # The INPUT tag can be used to specify the files and/or directories that contain
 577 # documented source files. You may enter file names like "myfile.cpp" or
 578 # directories like "/usr/src/myproject". Separate the files or directories
 579 # with spaces.
 580
 581 INPUT                  = src/
 582
 583 # This tag can be used to specify the character encoding of the source files
 584 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
 585 # also the default input encoding. Doxygen uses libiconv (or the iconv built
 586 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
 587 # the list of possible encodings.
 588
 589 INPUT_ENCODING         = UTF-8
 590
 591 # If the value of the INPUT tag contains directories, you can use the
 592 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 593 # and *.h) to filter out the source-files in the directories. If left
 594 # blank the following patterns are tested:
 595 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
 596 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
 597
 598 FILE_PATTERNS          = *.cpp \
 599                          *.hpp \
 600                          */*.hpp \
 601                          */*.cpp
 602
 603 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 604 # should be searched for input files as well. Possible values are YES and NO.
 605 # If left blank NO is used.
 606
 607 RECURSIVE              = YES
 608
 609 # The EXCLUDE tag can be used to specify files and/or directories that should
 610 # excluded from the INPUT source files. This way you can easily exclude a
 611 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 612
 613 EXCLUDE                = src/squirrel/
 614
 615 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 616 # directories that are symbolic links (a Unix filesystem feature) are excluded
 617 # from the input.
 618
 619 EXCLUDE_SYMLINKS       = NO
 620
 621 # If the value of the INPUT tag contains directories, you can use the
 622 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 623 # certain files from those directories. Note that the wildcards are matched
 624 # against the file with absolute path, so to exclude all test directories
 625 # for example use the pattern */test/*
 626
 627 EXCLUDE_PATTERNS       =
 628
 629 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 630 # (namespaces, classes, functions, etc.) that should be excluded from the
 631 # output. The symbol name can be a fully qualified name, a word, or if the
 632 # wildcard * is used, a substring. Examples: ANamespace, AClass,
 633 # AClass::ANamespace, ANamespace::*Test
 634
 635 EXCLUDE_SYMBOLS        =
 636
 637 # The EXAMPLE_PATH tag can be used to specify one or more files or
 638 # directories that contain example code fragments that are included (see
 639 # the \include command).
 640
 641 EXAMPLE_PATH           =
 642
 643 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 644 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 645 # and *.h) to filter out the source-files in the directories. If left
 646 # blank all files are included.
 647
 648 EXAMPLE_PATTERNS       = *
 649
 650 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
 651 # searched for input files to be used with the \include or \dontinclude
 652 # commands irrespective of the value of the RECURSIVE tag.
 653 # Possible values are YES and NO. If left blank NO is used.
 654
 655 EXAMPLE_RECURSIVE      = NO
 656
 657 # The IMAGE_PATH tag can be used to specify one or more files or
 658 # directories that contain image that are included in the documentation (see
 659 # the \image command).
 660
 661 IMAGE_PATH             =
 662
 663 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 664 # invoke to filter for each input file. Doxygen will invoke the filter program
 665 # by executing (via popen()) the command <filter> <input-file>, where <filter>
 666 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
 667 # input file. Doxygen will then use the output that the filter program writes
 668 # to standard output.
 669 # If FILTER_PATTERNS is specified, this tag will be
 670 # ignored.
 671
 672 INPUT_FILTER           =
 673
 674 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 675 # basis.
 676 # Doxygen will compare the file name with each pattern and apply the
 677 # filter if there is a match.
 678 # The filters are a list of the form:
 679 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
 680 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
 681 # is applied to all files.
 682
 683 FILTER_PATTERNS        =
 684
 685 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 686 # INPUT_FILTER) will be used to filter the input files when producing source
 687 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
 688
 689 FILTER_SOURCE_FILES    = NO
 690
 691 #---------------------------------------------------------------------------
 692 # configuration options related to source browsing
 693 #---------------------------------------------------------------------------
 694
 695 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 696 # be generated. Documented entities will be cross-referenced with these sources.
 697 # Note: To get rid of all source code in the generated output, make sure also
 698 # VERBATIM_HEADERS is set to NO.
 699
 700 SOURCE_BROWSER         = YES
 701
 702 # Setting the INLINE_SOURCES tag to YES will include the body
 703 # of functions and classes directly in the documentation.
 704
 705 INLINE_SOURCES         = YES
 706
 707 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
 708 # doxygen to hide any special comment blocks from generated source code
 709 # fragments. Normal C and C++ comments will always remain visible.
 710
 711 STRIP_CODE_COMMENTS    = YES
 712
 713 # If the REFERENCED_BY_RELATION tag is set to YES
 714 # then for each documented function all documented
 715 # functions referencing it will be listed.
 716
 717 REFERENCED_BY_RELATION = YES
 718
 719 # If the REFERENCES_RELATION tag is set to YES
 720 # then for each documented function all documented entities
 721 # called/used by that function will be listed.
 722
 723 REFERENCES_RELATION    = YES
 724
 725 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
 726 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
 727 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
 728 # link to the source code.
 729 # Otherwise they will link to the documentation.
 730
 731 REFERENCES_LINK_SOURCE = YES
 732
 733 # If the USE_HTAGS tag is set to YES then the references to source code
 734 # will point to the HTML generated by the htags(1) tool instead of doxygen
 735 # built-in source browser. The htags tool is part of GNU's global source
 736 # tagging system (see http://www.gnu.org/software/global/global.html). You
 737 # will need version 4.8.6 or higher.
 738
 739 USE_HTAGS              = NO
 740
 741 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 742 # will generate a verbatim copy of the header file for each class for
 743 # which an include is specified. Set to NO to disable this.
 744
 745 VERBATIM_HEADERS       = YES
 746
 747 #---------------------------------------------------------------------------
 748 # configuration options related to the alphabetical class index
 749 #---------------------------------------------------------------------------
 750
 751 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
 752 # of all compounds will be generated. Enable this if the project
 753 # contains a lot of classes, structs, unions or interfaces.
 754
 755 ALPHABETICAL_INDEX     = NO
 756
 757 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
 758 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
 759 # in which this list will be split (can be a number in the range [1..20])
 760
 761 COLS_IN_ALPHA_INDEX    = 5
 762
 763 # In case all classes in a project start with a common prefix, all
 764 # classes will be put under the same header in the alphabetical index.
 765 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
 766 # should be ignored while generating the index headers.
 767
 768 IGNORE_PREFIX          =
 769
 770 #---------------------------------------------------------------------------
 771 # configuration options related to the HTML output
 772 #---------------------------------------------------------------------------
 773
 774 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 775 # generate HTML output.
 776
 777 GENERATE_HTML          = YES
 778
 779 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 780 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 781 # put in front of it. If left blank `html' will be used as the default path.
 782
 783 HTML_OUTPUT            = html
 784
 785 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
 786 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
 787 # doxygen will generate files with .html extension.
 788
 789 HTML_FILE_EXTENSION    = .html
 790
 791 # The HTML_HEADER tag can be used to specify a personal HTML header for
 792 # each generated HTML page. If it is left blank doxygen will generate a
 793 # standard header.
 794
 795 HTML_HEADER            =
 796
 797 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 798 # each generated HTML page. If it is left blank doxygen will generate a
 799 # standard footer.
 800
 801 HTML_FOOTER            =
 802
 803 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 804 # style sheet that is used by each HTML page. It can be used to
 805 # fine-tune the look of the HTML output. If the tag is left blank doxygen
 806 # will generate a default style sheet. Note that doxygen will try to copy
 807 # the style sheet file to the HTML output directory, so don't put your own
 808 # stylesheet in the HTML output directory as well, or it will be erased!
 809
 810 HTML_STYLESHEET        =
 811
 812 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 813 # files or namespaces will be aligned in HTML using tables. If set to
 814 # NO a bullet list will be used.
 815
 816 HTML_ALIGN_MEMBERS     = YES
 817
 818 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 819 # documentation will contain sections that can be hidden and shown after the
 820 # page has loaded. For this to work a browser that supports
 821 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
 822 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
 823
 824 HTML_DYNAMIC_SECTIONS  = NO
 825
 826 # If the GENERATE_DOCSET tag is set to YES, additional index files
 827 # will be generated that can be used as input for Apple's Xcode 3
 828 # integrated development environment, introduced with OSX 10.5 (Leopard).
 829 # To create a documentation set, doxygen will generate a Makefile in the
 830 # HTML output directory. Running make will produce the docset in that
 831 # directory and running "make install" will install the docset in
 832 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
 833 # it at startup.
 834 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
 835
 836 GENERATE_DOCSET        = NO
 837
 838 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
 839 # feed. A documentation feed provides an umbrella under which multiple
 840 # documentation sets from a single provider (such as a company or product suite)
 841 # can be grouped.
 842
 843 DOCSET_FEEDNAME        = "Doxygen generated docs"
 844
 845 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
 846 # should uniquely identify the documentation set bundle. This should be a
 847 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
 848 # will append .docset to the name.
 849
 850 DOCSET_BUNDLE_ID       = org.doxygen.Project
 851
 852 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
 853 # will be generated that can be used as input for tools like the
 854 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
 855 # of the generated HTML documentation.
 856
 857 GENERATE_HTMLHELP      = NO
 858
 859 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
 860 # be used to specify the file name of the resulting .chm file. You
 861 # can add a path in front of the file if the result should not be
 862 # written to the html output directory.
 863
 864 CHM_FILE               =
 865
 866 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
 867 # be used to specify the location (absolute path including file name) of
 868 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
 869 # the HTML help compiler on the generated index.hhp.
 870
 871 HHC_LOCATION           =
 872
 873 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
 874 # controls if a separate .chi index file is generated (YES) or that
 875 # it should be included in the master .chm file (NO).
 876
 877 GENERATE_CHI           = NO
 878
 879 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
 880 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
 881 # content.
 882
 883 CHM_INDEX_ENCODING     =
 884
 885 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
 886 # controls whether a binary table of contents is generated (YES) or a
 887 # normal table of contents (NO) in the .chm file.
 888
 889 BINARY_TOC             = NO
 890
 891 # The TOC_EXPAND flag can be set to YES to add extra items for group members
 892 # to the contents of the HTML help documentation and to the tree view.
 893
 894 TOC_EXPAND             = NO
 895
 896 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
 897 # are set, an additional index file will be generated that can be used as input for
 898 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
 899 # HTML documentation.
 900
 901 GENERATE_QHP           = NO
 902
 903 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
 904 # be used to specify the file name of the resulting .qch file.
 905 # The path specified is relative to the HTML output folder.
 906
 907 QCH_FILE               =
 908
 909 # The QHP_NAMESPACE tag specifies the namespace to use when generating
 910 # Qt Help Project output. For more information please see
 911 # http://doc.trolltech.com/qthelpproject.html#namespace
 912
 913 QHP_NAMESPACE          =
 914
 915 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
 916 # Qt Help Project output. For more information please see
 917 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
 918
 919 QHP_VIRTUAL_FOLDER     = doc
 920
 921 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
 922 # For more information please see
 923 # http://doc.trolltech.com/qthelpproject.html#custom-filters
 924
 925 QHP_CUST_FILTER_NAME   =
 926
 927 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
 928 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
 929
 930 QHP_CUST_FILTER_ATTRS  =
 931
 932 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
 933 # filter section matches.
 934 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
 935
 936 QHP_SECT_FILTER_ATTRS  =
 937
 938 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
 939 # be used to specify the location of Qt's qhelpgenerator.
 940 # If non-empty doxygen will try to run qhelpgenerator on the generated
 941 # .qhp file.
 942
 943 QHG_LOCATION           =
 944
 945 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
 946 # top of each HTML page. The value NO (the default) enables the index and
 947 # the value YES disables it.
 948
 949 DISABLE_INDEX          = NO
 950
 951 # This tag can be used to set the number of enum values (range [1..20])
 952 # that doxygen will group on one line in the generated HTML documentation.
 953
 954 ENUM_VALUES_PER_LINE   = 4
 955
 956 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 957 # structure should be generated to display hierarchical information.
 958 # If the tag value is set to YES, a side panel will be generated
 959 # containing a tree-like index structure (just like the one that
 960 # is generated for HTML Help). For this to work a browser that supports
 961 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
 962 # Windows users are probably better off using the HTML help feature.
 963
 964 GENERATE_TREEVIEW      = YES
 965
 966 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
 967 # and Class Hierarchy pages using a tree view instead of an ordered list.
 968
 969 USE_INLINE_TREES       = NO
 970
 971 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
 972 # used to set the initial width (in pixels) of the frame in which the tree
 973 # is shown.
 974
 975 TREEVIEW_WIDTH         = 250
 976
 977 # Use this tag to change the font size of Latex formulas included
 978 # as images in the HTML documentation. The default is 10. Note that
 979 # when you change the font size after a successful doxygen run you need
 980 # to manually remove any form_*.png images from the HTML output directory
 981 # to force them to be regenerated.
 982
 983 FORMULA_FONTSIZE       = 10
 984
 985 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
 986 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
 987 # there is already a search function so this one should typically
 988 # be disabled.
 989
 990 SEARCHENGINE           = NO
 991
 992 #---------------------------------------------------------------------------
 993 # configuration options related to the LaTeX output
 994 #---------------------------------------------------------------------------
 995
 996 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 997 # generate Latex output.
 998
 999 GENERATE_LATEX         = NO
1000
1001 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1002 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1003 # put in front of it. If left blank `latex' will be used as the default path.
1004
1005 LATEX_OUTPUT           = latex
1006
1007 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1008 # invoked. If left blank `latex' will be used as the default command name.
1009
1010 LATEX_CMD_NAME         = latex
1011
1012 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1013 # generate index for LaTeX. If left blank `makeindex' will be used as the
1014 # default command name.
1015
1016 MAKEINDEX_CMD_NAME     = makeindex
1017
1018 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1019 # LaTeX documents. This may be useful for small projects and may help to
1020 # save some trees in general.
1021
1022 COMPACT_LATEX          = NO
1023
1024 # The PAPER_TYPE tag can be used to set the paper type that is used
1025 # by the printer. Possible values are: a4, a4wide, letter, legal and
1026 # executive. If left blank a4wide will be used.
1027
1028 PAPER_TYPE             = a4wide
1029
1030 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1031 # packages that should be included in the LaTeX output.
1032
1033 EXTRA_PACKAGES         =
1034
1035 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1036 # the generated latex document. The header should contain everything until
1037 # the first chapter. If it is left blank doxygen will generate a
1038 # standard header. Notice: only use this tag if you know what you are doing!
1039
1040 LATEX_HEADER           =
1041
1042 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1043 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1044 # contain links (just like the HTML output) instead of page references
1045 # This makes the output suitable for online browsing using a pdf viewer.
1046
1047 PDF_HYPERLINKS         = NO
1048
1049 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1050 # plain latex in the generated Makefile. Set this option to YES to get a
1051 # higher quality PDF documentation.
1052
1053 USE_PDFLATEX           = NO
1054
1055 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1056 # command to the generated LaTeX files. This will instruct LaTeX to keep
1057 # running if errors occur, instead of asking the user for help.
1058 # This option is also used when generating formulas in HTML.
1059
1060 LATEX_BATCHMODE        = NO
1061
1062 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1063 # include the index chapters (such as File Index, Compound Index, etc.)
1064 # in the output.
1065
1066 LATEX_HIDE_INDICES     = NO
1067
1068 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1069
1070 LATEX_SOURCE_CODE      = NO
1071
1072 #---------------------------------------------------------------------------
1073 # configuration options related to the RTF output
1074 #---------------------------------------------------------------------------
1075
1076 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1077 # The RTF output is optimized for Word 97 and may not look very pretty with
1078 # other RTF readers or editors.
1079
1080 GENERATE_RTF           = NO
1081
1082 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1083 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1084 # put in front of it. If left blank `rtf' will be used as the default path.
1085
1086 RTF_OUTPUT             = rtf
1087
1088 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1089 # RTF documents. This may be useful for small projects and may help to
1090 # save some trees in general.
1091
1092 COMPACT_RTF            = NO
1093
1094 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1095 # will contain hyperlink fields. The RTF file will
1096 # contain links (just like the HTML output) instead of page references.
1097 # This makes the output suitable for online browsing using WORD or other
1098 # programs which support those fields.
1099 # Note: wordpad (write) and others do not support links.
1100
1101 RTF_HYPERLINKS         = NO
1102
1103 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1104 # config file, i.e. a series of assignments. You only have to provide
1105 # replacements, missing definitions are set to their default value.
1106
1107 RTF_STYLESHEET_FILE    =
1108
1109 # Set optional variables used in the generation of an rtf document.
1110 # Syntax is similar to doxygen's config file.
1111
1112 RTF_EXTENSIONS_FILE    =
1113
1114 #---------------------------------------------------------------------------
1115 # configuration options related to the man page output
1116 #---------------------------------------------------------------------------
1117
1118 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1119 # generate man pages
1120
1121 GENERATE_MAN           = NO
1122
1123 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1124 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1125 # put in front of it. If left blank `man' will be used as the default path.
1126
1127 MAN_OUTPUT             = man
1128
1129 # The MAN_EXTENSION tag determines the extension that is added to
1130 # the generated man pages (default is the subroutine's section .3)
1131
1132 MAN_EXTENSION          = .3
1133
1134 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1135 # then it will generate one additional man file for each entity
1136 # documented in the real man page(s). These additional files
1137 # only source the real man page, but without them the man command
1138 # would be unable to find the correct page. The default is NO.
1139
1140 MAN_LINKS              = NO
1141
1142 #---------------------------------------------------------------------------
1143 # configuration options related to the XML output
1144 #---------------------------------------------------------------------------
1145
1146 # If the GENERATE_XML tag is set to YES Doxygen will
1147 # generate an XML file that captures the structure of
1148 # the code including all documentation.
1149
1150 GENERATE_XML           = NO
1151
1152 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1153 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1154 # put in front of it. If left blank `xml' will be used as the default path.
1155
1156 XML_OUTPUT             = xml
1157
1158 # The XML_SCHEMA tag can be used to specify an XML schema,
1159 # which can be used by a validating XML parser to check the
1160 # syntax of the XML files.
1161
1162 XML_SCHEMA             =
1163
1164 # The XML_DTD tag can be used to specify an XML DTD,
1165 # which can be used by a validating XML parser to check the
1166 # syntax of the XML files.
1167
1168 XML_DTD                =
1169
1170 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1171 # dump the program listings (including syntax highlighting
1172 # and cross-referencing information) to the XML output. Note that
1173 # enabling this will significantly increase the size of the XML output.
1174
1175 XML_PROGRAMLISTING     = YES
1176
1177 #---------------------------------------------------------------------------
1178 # configuration options for the AutoGen Definitions output
1179 #---------------------------------------------------------------------------
1180
1181 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1182 # generate an AutoGen Definitions (see autogen.sf.net) file
1183 # that captures the structure of the code including all
1184 # documentation. Note that this feature is still experimental
1185 # and incomplete at the moment.
1186
1187 GENERATE_AUTOGEN_DEF   = NO
1188
1189 #---------------------------------------------------------------------------
1190 # configuration options related to the Perl module output
1191 #---------------------------------------------------------------------------
1192
1193 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1194 # generate a Perl module file that captures the structure of
1195 # the code including all documentation. Note that this
1196 # feature is still experimental and incomplete at the
1197 # moment.
1198
1199 GENERATE_PERLMOD       = NO
1200
1201 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1202 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1203 # to generate PDF and DVI output from the Perl module output.
1204
1205 PERLMOD_LATEX          = NO
1206
1207 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1208 # nicely formatted so it can be parsed by a human reader.
1209 # This is useful
1210 # if you want to understand what is going on.
1211 # On the other hand, if this
1212 # tag is set to NO the size of the Perl module output will be much smaller
1213 # and Perl will parse it just the same.
1214
1215 PERLMOD_PRETTY         = YES
1216
1217 # The names of the make variables in the generated doxyrules.make file
1218 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1219 # This is useful so different doxyrules.make files included by the same
1220 # Makefile don't overwrite each other's variables.
1221
1222 PERLMOD_MAKEVAR_PREFIX =
1223
1224 #---------------------------------------------------------------------------
1225 # Configuration options related to the preprocessor
1226 #---------------------------------------------------------------------------
1227
1228 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1229 # evaluate all C-preprocessor directives found in the sources and include
1230 # files.
1231
1232 ENABLE_PREPROCESSING   = YES
1233
1234 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1235 # names in the source code. If set to NO (the default) only conditional
1236 # compilation will be performed. Macro expansion can be done in a controlled
1237 # way by setting EXPAND_ONLY_PREDEF to YES.
1238
1239 MACRO_EXPANSION        = NO
1240
1241 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1242 # then the macro expansion is limited to the macros specified with the
1243 # PREDEFINED and EXPAND_AS_DEFINED tags.
1244
1245 EXPAND_ONLY_PREDEF     = NO
1246
1247 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1248 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1249
1250 SEARCH_INCLUDES        = YES
1251
1252 # The INCLUDE_PATH tag can be used to specify one or more directories that
1253 # contain include files that are not input files but should be processed by
1254 # the preprocessor.
1255
1256 INCLUDE_PATH           =
1257
1258 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1259 # patterns (like *.h and *.hpp) to filter out the header-files in the
1260 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1261 # be used.
1262
1263 INCLUDE_FILE_PATTERNS  =
1264
1265 # The PREDEFINED tag can be used to specify one or more macro names that
1266 # are defined before the preprocessor is started (similar to the -D option of
1267 # gcc). The argument of the tag is a list of macros of the form: name
1268 # or name=definition (no spaces). If the definition and the = are
1269 # omitted =1 is assumed. To prevent a macro definition from being
1270 # undefined via #undef or recursively expanded use the := operator
1271 # instead of the = operator.
1272
1273 PREDEFINED             =
1274
1275 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1276 # this tag can be used to specify a list of macro names that should be expanded.
1277 # The macro definition that is found in the sources will be used.
1278 # Use the PREDEFINED tag if you want to use a different macro definition.
1279
1280 EXPAND_AS_DEFINED      =
1281
1282 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1283 # doxygen's preprocessor will remove all function-like macros that are alone
1284 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1285 # function macros are typically used for boiler-plate code, and will confuse
1286 # the parser if not removed.
1287
1288 SKIP_FUNCTION_MACROS   = YES
1289
1290 #---------------------------------------------------------------------------
1291 # Configuration::additions related to external references
1292 #---------------------------------------------------------------------------
1293
1294 # The TAGFILES option can be used to specify one or more tagfiles.
1295 # Optionally an initial location of the external documentation
1296 # can be added for each tagfile. The format of a tag file without
1297 # this location is as follows:
1298 #
1299 # TAGFILES = file1 file2 ...
1300 # Adding location for the tag files is done as follows:
1301 #
1302 # TAGFILES = file1=loc1 "file2 = loc2" ...
1303 # where "loc1" and "loc2" can be relative or absolute paths or
1304 # URLs. If a location is present for each tag, the installdox tool
1305 # does not have to be run to correct the links.
1306 # Note that each tag file must have a unique name
1307 # (where the name does NOT include the path)
1308 # If a tag file is not located in the directory in which doxygen
1309 # is run, you must also specify the path to the tagfile here.
1310
1311 TAGFILES               =
1312
1313 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1314 # a tag file that is based on the input files it reads.
1315
1316 GENERATE_TAGFILE       =
1317
1318 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1319 # in the class index. If set to NO only the inherited external classes
1320 # will be listed.
1321
1322 ALLEXTERNALS           = NO
1323
1324 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1325 # in the modules index. If set to NO, only the current project's groups will
1326 # be listed.
1327
1328 EXTERNAL_GROUPS        = YES
1329
1330 # The PERL_PATH should be the absolute path and name of the perl script
1331 # interpreter (i.e. the result of `which perl').
1332
1333 PERL_PATH              = /usr/bin/perl
1334
1335 #---------------------------------------------------------------------------
1336 # Configuration options related to the dot tool
1337 #---------------------------------------------------------------------------
1338
1339 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1340 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1341 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1342 # this option is superseded by the HAVE_DOT option below. This is only a
1343 # fallback. It is recommended to install and use dot, since it yields more
1344 # powerful graphs.
1345
1346 CLASS_DIAGRAMS         = NO
1347
1348 # You can define message sequence charts within doxygen comments using the \msc
1349 # command. Doxygen will then run the mscgen tool (see
1350 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1351 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1352 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1353 # default search path.
1354
1355 MSCGEN_PATH            =
1356
1357 # If set to YES, the inheritance and collaboration graphs will hide
1358 # inheritance and usage relations if the target is undocumented
1359 # or is not a class.
1360
1361 HIDE_UNDOC_RELATIONS   = NO
1362
1363 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1364 # available from the path. This tool is part of Graphviz, a graph visualization
1365 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1366 # have no effect if this option is set to NO (the default)
1367
1368 HAVE_DOT               = YES
1369
1370 # By default doxygen will write a font called FreeSans.ttf to the output
1371 # directory and reference it in all dot files that doxygen generates. This
1372 # font does not include all possible unicode characters however, so when you need
1373 # these (or just want a differently looking font) you can specify the font name
1374 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1375 # which can be done by putting it in a standard location or by setting the
1376 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1377 # containing the font.
1378
1379 DOT_FONTNAME           = FreeSans
1380
1381 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1382 # The default size is 10pt.
1383
1384 DOT_FONTSIZE           = 10
1385
1386 # By default doxygen will tell dot to use the output directory to look for the
1387 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1388 # different font using DOT_FONTNAME you can set the path where dot
1389 # can find it using this tag.
1390
1391 DOT_FONTPATH           =
1392
1393 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1394 # will generate a graph for each documented class showing the direct and
1395 # indirect inheritance relations. Setting this tag to YES will force the
1396 # the CLASS_DIAGRAMS tag to NO.
1397
1398 CLASS_GRAPH            = YES
1399
1400 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1401 # will generate a graph for each documented class showing the direct and
1402 # indirect implementation dependencies (inheritance, containment, and
1403 # class references variables) of the class with other documented classes.
1404
1405 COLLABORATION_GRAPH    = YES
1406
1407 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1408 # will generate a graph for groups, showing the direct groups dependencies
1409
1410 GROUP_GRAPHS           = YES
1411
1412 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1413 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1414 # Language.
1415
1416 UML_LOOK               = NO
1417
1418 # If set to YES, the inheritance and collaboration graphs will show the
1419 # relations between templates and their instances.
1420
1421 TEMPLATE_RELATIONS     = YES
1422
1423 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1424 # tags are set to YES then doxygen will generate a graph for each documented
1425 # file showing the direct and indirect include dependencies of the file with
1426 # other documented files.
1427
1428 INCLUDE_GRAPH          = YES
1429
1430 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1431 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1432 # documented header file showing the documented files that directly or
1433 # indirectly include this file.
1434
1435 INCLUDED_BY_GRAPH      = YES
1436
1437 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1438 # doxygen will generate a call dependency graph for every global function
1439 # or class method. Note that enabling this option will significantly increase
1440 # the time of a run. So in most cases it will be better to enable call graphs
1441 # for selected functions only using the \callgraph command.
1442
1443 CALL_GRAPH             = YES
1444
1445 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1446 # doxygen will generate a caller dependency graph for every global function
1447 # or class method. Note that enabling this option will significantly increase
1448 # the time of a run. So in most cases it will be better to enable caller
1449 # graphs for selected functions only using the \callergraph command.
1450
1451 CALLER_GRAPH           = NO
1452
1453 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1454 # will graphical hierarchy of all classes instead of a textual one.
1455
1456 GRAPHICAL_HIERARCHY    = YES
1457
1458 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1459 # then doxygen will show the dependencies a directory has on other directories
1460 # in a graphical way. The dependency relations are determined by the #include
1461 # relations between the files in the directories.
1462
1463 DIRECTORY_GRAPH        = YES
1464
1465 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1466 # generated by dot. Possible values are png, jpg, or gif
1467 # If left blank png will be used.
1468
1469 DOT_IMAGE_FORMAT       = png
1470
1471 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1472 # found. If left blank, it is assumed the dot tool can be found in the path.
1473
1474 DOT_PATH               =
1475
1476 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1477 # contain dot files that are included in the documentation (see the
1478 # \dotfile command).
1479
1480 DOTFILE_DIRS           =
1481
1482 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1483 # nodes that will be shown in the graph. If the number of nodes in a graph
1484 # becomes larger than this value, doxygen will truncate the graph, which is
1485 # visualized by representing a node as a red box. Note that doxygen if the
1486 # number of direct children of the root node in a graph is already larger than
1487 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1488 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1489
1490 DOT_GRAPH_MAX_NODES    = 50
1491
1492 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1493 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1494 # from the root by following a path via at most 3 edges will be shown. Nodes
1495 # that lay further from the root node will be omitted. Note that setting this
1496 # option to 1 or 2 may greatly reduce the computation time needed for large
1497 # code bases. Also note that the size of a graph can be further restricted by
1498 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1499
1500 MAX_DOT_GRAPH_DEPTH    = 1000
1501
1502 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1503 # background. This is disabled by default, because dot on Windows does not
1504 # seem to support this out of the box. Warning: Depending on the platform used,
1505 # enabling this option may lead to badly anti-aliased labels on the edges of
1506 # a graph (i.e. they become hard to read).
1507
1508 DOT_TRANSPARENT        = NO
1509
1510 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1511 # files in one run (i.e. multiple -o and -T options on the command line). This
1512 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1513 # support this, this feature is disabled by default.
1514
1515 DOT_MULTI_TARGETS      = YES
1516
1517 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1518 # generate a legend page explaining the meaning of the various boxes and
1519 # arrows in the dot generated graphs.
1520
1521 GENERATE_LEGEND        = YES
1522
1523 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1524 # remove the intermediate dot files that are used to generate
1525 # the various graphs.
1526
1527 DOT_CLEANUP            = YES