annotate doc/documentation.doxygen.in @ 144:7fbca00c2c05

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