annotate doc/Doxyfile @ 285:89fe52066db1 tip master

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