annotate src/flac-1.2.1/doc/Doxyfile @ 169:223a55898ab9 tip default

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