annotate Doxyfile @ 982:5d4730da0276 osx-retina

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