Doxyfile.in 48.7 KB
Newer Older
1
# Doxyfile 1.4.2
Josh Coalson's avatar
Josh Coalson committed
2 3 4 5 6 7 8 9 10 11 12 13

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------
14
# Project related configuration options
Josh Coalson's avatar
Josh Coalson committed
15 16
#---------------------------------------------------------------------------

17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
Josh Coalson's avatar
Josh Coalson committed
18 19 20 21
# by quotes) that should identify the project.

PROJECT_NAME           = FLAC

22 23
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
Josh Coalson's avatar
Josh Coalson committed
24 25
# if some version control system is used.

26
PROJECT_NUMBER         = 1.3.0
Josh Coalson's avatar
Josh Coalson committed
27

28 29 30
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
Josh Coalson's avatar
Josh Coalson committed
31 32 33 34
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = doxytmp

35 36 37 38 39
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
40 41 42 43
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

44 45 46 47 48 49 50 51
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52
# Swedish, and Ukrainian.
Josh Coalson's avatar
Josh Coalson committed
53 54 55

OUTPUT_LANGUAGE        = English

56 57 58 59 60 61
# This tag can be used to specify the encoding used in the generated output.
# The encoding is not always determined by the language that is chosen,
# but also whether or not the output is meant for Windows or non-Windows users.
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
# forces the Windows encoding (this is the default for the Windows binary),
# whereas setting the tag to NO uses a Unix-style encoding (the default for
62 63 64 65
# all platforms other than Windows).

USE_WINDOWS_ENCODING   = NO

66 67 68
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
69 70
# Set to NO to disable this.

Josh Coalson's avatar
Josh Coalson committed
71
BRIEF_MEMBER_DESC      = NO
72

73 74 75
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76 77 78 79
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

80 81 82 83 84 85 86 87
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
88 89
# "represents" "a" "an" "the"

90
ABBREVIATE_BRIEF       =
91

92 93
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
94 95
# description.

Josh Coalson's avatar
Josh Coalson committed
96
ALWAYS_DETAILED_SEC    = YES
97

98 99 100
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
101 102
# operators of the base classes will not be shown.

Josh Coalson's avatar
Josh Coalson committed
103
INLINE_INHERITED_MEMB  = YES
104

105 106
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
107 108 109 110
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

111 112 113 114 115
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
116 117 118 119
# path to strip.

STRIP_FROM_PATH        = ..

120 121 122 123 124
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
125 126
# are normally passed to the compiler using the -I flag.

127
STRIP_FROM_INC_PATH    =
128

129 130
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
131 132 133 134
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

135 136 137 138
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like the Qt-style comments (thus requiring an
139 140 141 142
# explicit @brief command for a brief description.

JAVADOC_AUTOBRIEF      = NO

143 144 145 146
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
147 148 149 150
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

151
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
152
# will output the detailed description near the top, like JavaDoc.
153
# If set to NO, the detailed description appears after the member
154 155 156 157
# documentation.

DETAILS_AT_TOP         = YES

158 159
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
160 161 162 163
# re-implements.

INHERIT_DOCS           = YES

164 165 166
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
167 168 169 170
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = YES

171 172
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
173 174 175 176
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

177
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 179 180 181
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 4

182 183 184 185 186
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
187 188 189 190 191
# You can put \n's in the value part of an alias to insert newlines.

ALIASES                = "assert=\par Assertions:\n" \
                         "default=\par Default Value:\n"

192 193 194
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
195 196 197 198
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

199 200 201
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
# only. Doxygen will then generate output that is more tailored for Java.
# For instance, namespaces will be presented as packages, qualified scopes
202 203 204 205
# will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

206 207 208 209
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
210 211 212 213 214 215 216 217
# the \nosubgrouping command.

SUBGROUPING            = YES

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

218 219 220
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
Josh Coalson's avatar
Josh Coalson committed
221 222 223 224
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

225
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Josh Coalson's avatar
Josh Coalson committed
226 227 228 229
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

230
# If the EXTRACT_STATIC tag is set to YES all static members of a file
Josh Coalson's avatar
Josh Coalson committed
231 232 233 234
# will be included in the documentation.

EXTRACT_STATIC         = NO

235 236
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
Josh Coalson's avatar
Josh Coalson committed
237 238 239 240
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

241 242 243
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
244 245 246 247
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

248 249 250 251
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
Josh Coalson's avatar
Josh Coalson committed
252 253 254 255
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

256 257 258
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
Josh Coalson's avatar
Josh Coalson committed
259 260 261 262
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

263 264 265
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
266
# documentation.
Josh Coalson's avatar
Josh Coalson committed
267

268
HIDE_FRIEND_COMPOUNDS  = NO
Josh Coalson's avatar
Josh Coalson committed
269

270 271 272
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
273
# function's detailed documentation block.
Josh Coalson's avatar
Josh Coalson committed
274

275
HIDE_IN_BODY_DOCS      = NO
Josh Coalson's avatar
Josh Coalson committed
276

277 278 279
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
Josh Coalson's avatar
Josh Coalson committed
280 281 282 283
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

284 285 286 287
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
288
# and Mac users are advised to set this option to NO.
Josh Coalson's avatar
Josh Coalson committed
289 290 291

CASE_SENSE_NAMES       = YES

292 293
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
Josh Coalson's avatar
Josh Coalson committed
294 295 296 297
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

298 299
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
Josh Coalson's avatar
Josh Coalson committed
300 301 302 303
# of that file.

SHOW_INCLUDE_FILES     = YES

304
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Josh Coalson's avatar
Josh Coalson committed
305 306 307 308
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

309 310 311
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
Josh Coalson's avatar
Josh Coalson committed
312 313 314 315
# declaration order.

SORT_MEMBER_DOCS       = NO

316 317 318
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
319
# declaration order.
Josh Coalson's avatar
Josh Coalson committed
320

321
SORT_BRIEF_DOCS        = NO
Josh Coalson's avatar
Josh Coalson committed
322

323 324 325 326
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
327
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
328
# Note: This option applies only to the class list, not to the
329
# alphabetical list.
Josh Coalson's avatar
Josh Coalson committed
330

Josh Coalson's avatar
Josh Coalson committed
331
SORT_BY_SCOPE_NAME     = YES
Josh Coalson's avatar
Josh Coalson committed
332

333 334
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
Josh Coalson's avatar
Josh Coalson committed
335 336 337 338
# commands in the documentation.

GENERATE_TODOLIST      = YES

339 340
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
Josh Coalson's avatar
Josh Coalson committed
341 342 343 344
# commands in the documentation.

GENERATE_TESTLIST      = YES

345 346
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
Josh Coalson's avatar
Josh Coalson committed
347 348 349 350
# commands in the documentation.

GENERATE_BUGLIST       = YES

351 352
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
353
# \deprecated commands in the documentation.
Josh Coalson's avatar
Josh Coalson committed
354

355
GENERATE_DEPRECATEDLIST= YES
Josh Coalson's avatar
Josh Coalson committed
356

357
# The ENABLED_SECTIONS tag can be used to enable conditional
Josh Coalson's avatar
Josh Coalson committed
358 359
# documentation sections, marked by \if sectionname ... \endif.

360
ENABLED_SECTIONS       =
Josh Coalson's avatar
Josh Coalson committed
361

362 363 364 365 366 367
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
Josh Coalson's avatar
Josh Coalson committed
368 369 370 371
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

372 373
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
Josh Coalson's avatar
Josh Coalson committed
374 375 376 377
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

378 379
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
380 381 382 383
# in the documentation.

SHOW_DIRECTORIES       = YES

384 385 386 387 388 389
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from the
# version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# provided by doxygen. Whatever the progam writes to standard output
390 391
# is used as the file version. See the manual for examples.

392
FILE_VERSION_FILTER    =
393

Josh Coalson's avatar
Josh Coalson committed
394 395 396 397
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

398
# The QUIET tag can be used to turn on/off the messages that are generated
Josh Coalson's avatar
Josh Coalson committed
399 400 401 402
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

403 404
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
Josh Coalson's avatar
Josh Coalson committed
405 406 407 408
# NO is used.

WARNINGS               = YES

409 410
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
Josh Coalson's avatar
Josh Coalson committed
411 412 413 414
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

415 416 417
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
418 419 420 421
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

422 423 424 425
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
426 427 428 429
# documentation.

WARN_NO_PARAMDOC       = NO

430 431 432 433 434
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
435
# be obtained via FILE_VERSION_FILTER)
Josh Coalson's avatar
Josh Coalson committed
436 437 438

WARN_FORMAT            = "$file:$line: $text"

439 440
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
Josh Coalson's avatar
Josh Coalson committed
441 442
# to stderr.

443
WARN_LOGFILE           =
Josh Coalson's avatar
Josh Coalson committed
444 445 446 447 448

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

449 450 451
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
Josh Coalson's avatar
Josh Coalson committed
452 453
# with spaces.

Olivier Blin's avatar
Olivier Blin committed
454 455
INPUT                  = @top_srcdir@/include/FLAC \
                         @top_srcdir@/include/FLAC++
Josh Coalson's avatar
Josh Coalson committed
456

457 458 459 460 461
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
462
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
Josh Coalson's avatar
Josh Coalson committed
463

464
FILE_PATTERNS          =
Josh Coalson's avatar
Josh Coalson committed
465

466 467
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
Josh Coalson's avatar
Josh Coalson committed
468 469 470 471
# If left blank NO is used.

RECURSIVE              = NO

472 473
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
Josh Coalson's avatar
Josh Coalson committed
474 475
# subdirectory from a directory tree whose root is specified with the INPUT tag.

476
EXCLUDE                =
Josh Coalson's avatar
Josh Coalson committed
477

478 479
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
480
# from the input.
Josh Coalson's avatar
Josh Coalson committed
481 482 483

EXCLUDE_SYMLINKS       = NO

484 485
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Josh Coalson's avatar
Josh Coalson committed
486 487
# certain files from those directories.

488
EXCLUDE_PATTERNS       =
Josh Coalson's avatar
Josh Coalson committed
489

490 491
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
Josh Coalson's avatar
Josh Coalson committed
492 493
# the \include command).

494
EXAMPLE_PATH           =
Josh Coalson's avatar
Josh Coalson committed
495

496 497 498
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
Josh Coalson's avatar
Josh Coalson committed
499 500
# blank all files are included.

501
EXAMPLE_PATTERNS       =
Josh Coalson's avatar
Josh Coalson committed
502

503 504 505
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
Josh Coalson's avatar
Josh Coalson committed
506 507 508 509
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

510 511
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
Josh Coalson's avatar
Josh Coalson committed
512 513
# the \image command).

514
IMAGE_PATH             =
Josh Coalson's avatar
Josh Coalson committed
515

516 517 518 519 520 521
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.  If FILTER_PATTERNS is specified, this tag will be
522
# ignored.
Josh Coalson's avatar
Josh Coalson committed
523

524
INPUT_FILTER           =
Josh Coalson's avatar
Josh Coalson committed
525

526 527 528 529 530
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.  Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.  The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
531 532
# is applied to all files.

533
FILTER_PATTERNS        =
534

535 536
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
537
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
Josh Coalson's avatar
Josh Coalson committed
538 539 540 541 542 543 544

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

545 546 547
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
548
# VERBATIM_HEADERS is set to NO.
Josh Coalson's avatar
Josh Coalson committed
549 550 551

SOURCE_BROWSER         = NO

552
# Setting the INLINE_SOURCES tag to YES will include the body
Josh Coalson's avatar
Josh Coalson committed
553 554 555 556
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

557 558
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
559 560 561 562
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

563 564
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
Josh Coalson's avatar
Josh Coalson committed
565 566 567 568
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

569 570
# If the REFERENCES_RELATION tag is set to YES (the default)
# then for each documented function all documented entities
Josh Coalson's avatar
Josh Coalson committed
571 572 573 574
# called/used by that function will be listed.

REFERENCES_RELATION    = YES

575 576
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
577 578 579 580
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

Josh Coalson's avatar
Josh Coalson committed
581 582 583 584
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

585 586
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
Josh Coalson's avatar
Josh Coalson committed
587 588 589 590
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

591 592
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
Josh Coalson's avatar
Josh Coalson committed
593 594 595 596
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

597 598 599
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
Josh Coalson's avatar
Josh Coalson committed
600 601
# should be ignored while generating the index headers.

602
IGNORE_PREFIX          =
Josh Coalson's avatar
Josh Coalson committed
603 604 605 606 607

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

608
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Josh Coalson's avatar
Josh Coalson committed
609 610 611 612
# generate HTML output.

GENERATE_HTML          = YES

613 614
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Josh Coalson's avatar
Josh Coalson committed
615 616 617 618
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

619 620
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
Josh Coalson's avatar
Josh Coalson committed
621 622 623 624
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

625 626
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
Josh Coalson's avatar
Josh Coalson committed
627 628
# standard header.

629
HTML_HEADER            =
Josh Coalson's avatar
Josh Coalson committed
630

631 632
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
Josh Coalson's avatar
Josh Coalson committed
633 634
# standard footer.

Olivier Blin's avatar
Olivier Blin committed
635
HTML_FOOTER            = @top_srcdir@/doc/doxygen.footer.html
Josh Coalson's avatar
Josh Coalson committed
636

637 638 639 640 641
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
642
# stylesheet in the HTML output directory as well, or it will be erased!
Josh Coalson's avatar
Josh Coalson committed
643

644
HTML_STYLESHEET        =
Josh Coalson's avatar
Josh Coalson committed
645

646 647
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
Josh Coalson's avatar
Josh Coalson committed
648 649 650 651
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

652 653 654
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
Josh Coalson's avatar
Josh Coalson committed
655 656 657 658
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

659 660 661
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
662 663
# written to the html output directory.

664
CHM_FILE               =
665

666 667 668
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
669 670
# the HTML help compiler on the generated index.hhp.

671
HHC_LOCATION           =
672

673 674
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
Josh Coalson's avatar
Josh Coalson committed
675 676 677 678
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

679 680
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
Josh Coalson's avatar
Josh Coalson committed
681 682 683 684
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

685
# The TOC_EXPAND flag can be set to YES to add extra items for group members
686
# to the contents of the HTML help documentation and to the tree view.
Josh Coalson's avatar
Josh Coalson committed
687 688 689

TOC_EXPAND             = NO

690 691
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
Josh Coalson's avatar
Josh Coalson committed
692 693 694 695
# the value YES disables it.

DISABLE_INDEX          = NO

696
# This tag can be used to set the number of enum values (range [1..20])
Josh Coalson's avatar
Josh Coalson committed
697 698 699 700 701
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
702 703 704 705
# generated containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
706
# probably better off using the HTML help feature.
Josh Coalson's avatar
Josh Coalson committed
707 708 709

GENERATE_TREEVIEW      = NO

710 711
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
Josh Coalson's avatar
Josh Coalson committed
712 713 714 715 716 717 718 719
# is shown.

TREEVIEW_WIDTH         = 250

#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

720
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Josh Coalson's avatar
Josh Coalson committed
721 722
# generate Latex output.

Josh Coalson's avatar
Josh Coalson committed
723
GENERATE_LATEX         = NO
Josh Coalson's avatar
Josh Coalson committed
724

725 726
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Josh Coalson's avatar
Josh Coalson committed
727 728 729 730
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

731
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
732
# invoked. If left blank `latex' will be used as the default command name.
Josh Coalson's avatar
Josh Coalson committed
733 734 735

LATEX_CMD_NAME         = latex

736 737
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
Josh Coalson's avatar
Josh Coalson committed
738 739 740 741
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

742 743
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
Josh Coalson's avatar
Josh Coalson committed
744 745 746 747
# save some trees in general.

COMPACT_LATEX          = NO

748 749
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
Josh Coalson's avatar
Josh Coalson committed
750 751 752 753
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

754
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Josh Coalson's avatar
Josh Coalson committed
755 756
# packages that should be included in the LaTeX output.

757
EXTRA_PACKAGES         =
Josh Coalson's avatar
Josh Coalson committed
758

759 760 761
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
Josh Coalson's avatar
Josh Coalson committed
762 763
# standard header. Notice: only use this tag if you know what you are doing!

764
LATEX_HEADER           =
Josh Coalson's avatar
Josh Coalson committed
765

766 767 768
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
Josh Coalson's avatar
Josh Coalson committed
769 770 771 772
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = NO

773 774
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
Josh Coalson's avatar
Josh Coalson committed
775 776 777 778
# higher quality PDF documentation.

USE_PDFLATEX           = NO

779 780 781
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
Josh Coalson's avatar
Josh Coalson committed
782 783 784 785
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

786 787
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
788 789 790 791
# in the output.

LATEX_HIDE_INDICES     = NO

Josh Coalson's avatar
Josh Coalson committed
792 793 794 795
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

796 797
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
Josh Coalson's avatar
Josh Coalson committed
798 799 800 801
# other RTF readers or editors.

GENERATE_RTF           = NO

802 803
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Josh Coalson's avatar
Josh Coalson committed
804 805 806 807
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

808 809
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
Josh Coalson's avatar
Josh Coalson committed
810 811 812 813
# save some trees in general.

COMPACT_RTF            = NO

814 815 816 817 818
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
Josh Coalson's avatar
Josh Coalson committed
819 820 821 822
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

823 824
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
Josh Coalson's avatar
Josh Coalson committed
825 826
# replacements, missing definitions are set to their default value.

827
RTF_STYLESHEET_FILE    =
Josh Coalson's avatar
Josh Coalson committed
828

829
# Set optional variables used in the generation of an rtf document.
Josh Coalson's avatar
Josh Coalson committed
830 831
# Syntax is similar to doxygen's config file.

832
RTF_EXTENSIONS_FILE    =
Josh Coalson's avatar
Josh Coalson committed
833 834 835 836 837

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

838
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Josh Coalson's avatar
Josh Coalson committed
839 840
# generate man pages

Josh Coalson's avatar
Josh Coalson committed
841
GENERATE_MAN           = NO
Josh Coalson's avatar
Josh Coalson committed
842

843 844
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Josh Coalson's avatar
Josh Coalson committed
845 846 847 848
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

849
# The MAN_EXTENSION tag determines the extension that is added to
Josh Coalson's avatar
Josh Coalson committed
850 851 852 853
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

854 855 856 857
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
Josh Coalson's avatar
Josh Coalson committed
858 859 860 861 862 863 864 865
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------

866 867
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
868
# the code including all documentation.
Josh Coalson's avatar
Josh Coalson committed
869 870 871

GENERATE_XML           = NO

872 873
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
874 875 876 877
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

878 879
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
880 881
# syntax of the XML files.

882
XML_SCHEMA             =
883

884 885
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
886 887
# syntax of the XML files.

888
XML_DTD                =
889

890 891 892
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
893 894 895 896
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

Josh Coalson's avatar
Josh Coalson committed
897 898 899 900
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

901 902 903 904
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
Josh Coalson's avatar
Josh Coalson committed
905 906 907 908
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

909 910 911 912
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

913 914 915 916
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
917 918 919 920
# moment.

GENERATE_PERLMOD       = NO

921 922
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
923 924 925 926
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

927 928 929 930
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.  This is useful
# if you want to understand what is going on.  On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
931 932 933 934
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

935 936 937
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
938 939
# Makefile don't overwrite each other's variables.

940
PERLMOD_MAKEVAR_PREFIX =
941

Josh Coalson's avatar
Josh Coalson committed
942
#---------------------------------------------------------------------------
943
# Configuration options related to the preprocessor
Josh Coalson's avatar
Josh Coalson committed
944 945
#---------------------------------------------------------------------------

946 947
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
Josh Coalson's avatar
Josh Coalson committed
948 949 950 951
# files.

ENABLE_PREPROCESSING   = YES

952 953 954
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
Josh Coalson's avatar
Josh Coalson committed
955 956
# way by setting EXPAND_ONLY_PREDEF to YES.

957
MACRO_EXPANSION        = YES
Josh Coalson's avatar
Josh Coalson committed
958

959 960
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
Josh Coalson's avatar
Josh Coalson committed
961 962
# PREDEFINED and EXPAND_AS_PREDEFINED tags.

963
EXPAND_ONLY_PREDEF     = YES
Josh Coalson's avatar
Josh Coalson committed
964

965
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
Josh Coalson's avatar
Josh Coalson committed
966 967 968 969
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

970 971
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
Josh Coalson's avatar
Josh Coalson committed
972 973
# the preprocessor.

974
INCLUDE_PATH           =
Josh Coalson's avatar
Josh Coalson committed
975

976 977 978
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
Josh Coalson's avatar
Josh Coalson committed
979 980
# be used.

981
INCLUDE_FILE_PATTERNS  =
Josh Coalson's avatar
Josh Coalson committed
982

983 984 985 986 987 988
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
989
# instead of the = operator.
Josh Coalson's avatar
Josh Coalson committed
990

991
PREDEFINED             = FLAC__NO_DLL
Josh Coalson's avatar
Josh Coalson committed
992

993 994 995
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
Josh Coalson's avatar
Josh Coalson committed
996 997
# Use the PREDEFINED tag if you want to use a different macro definition.

998
EXPAND_AS_DEFINED      = FLAC_API FLACPP_API
Josh Coalson's avatar
Josh Coalson committed
999