Doxyfile 66.3 KB
Newer Older
1
# Doxyfile 1.7.1
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
15 16
#---------------------------------------------------------------------------

17 18 19 20 21 22 23 24
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 27
# by quotes) that should identify the project.

28
PROJECT_NAME           = FFmpeg
29

30 31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
32 33
# if some version control system is used.

34
PROJECT_NUMBER         =
35

36
# With the PROJECT_LOGO tag one can specify a logo or icon that is included
37 38 39 40 41
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will
# copy the logo to the output directory.
PROJECT_LOGO           =

42 43 44
# 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
45 46
# where doxygen was started. If left blank the current directory will be used.

47
OUTPUT_DIRECTORY       = doc/doxy
48

49 50 51 52 53 54 55 56 57
# 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
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

58 59 60 61
# 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:
62
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
63 64 65 66 67
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
68 69 70

OUTPUT_LANGUAGE        = English

71 72 73 74 75 76 77 78 79 80 81 82 83 84
# 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).
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

# 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
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

85 86 87 88 89 90 91 92 93 94 95 96
# 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"
# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       =

97 98 99 100 101 102
# 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
# description.

ALWAYS_DETAILED_SEC    = NO

103 104 105 106
# 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
# operators of the base classes will not be shown.
107 108 109 110 111 112 113 114 115 116

INLINE_INHERITED_MEMB  = NO

# 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
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117
# can be used to strip a user-defined part of the path. Stripping is
118
# only done if one of the specified strings matches the left-hand part of
119 120 121
# 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
# path to strip.
122 123 124

STRIP_FROM_PATH        = .

125 126 127 128 129 130 131 132 133
# 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
# are normally passed to the compiler using the -I flag.

STRIP_FROM_INC_PATH    =

134 135 136 137 138 139 140 141 142
# 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
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

# 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
143 144
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
145 146 147

JAVADOC_AUTOBRIEF      = YES

148 149 150 151 152 153 154 155
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

156 157 158 159 160 161 162 163 164 165
# 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
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
166
# re-implements.
167 168 169

INHERIT_DOCS           = YES

170 171 172 173 174 175
# 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
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

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

TAB_SIZE               = 8

# 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
185
# will result in a user-defined paragraph with heading "Side Effects:".
186 187 188 189
# You can put \n's in the value part of an alias to insert newlines.

ALIASES                =

190 191 192
# 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
193 194 195 196
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

197 198 199 200
# 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 will look different, etc.
201 202 203

OPTIMIZE_OUTPUT_JAVA   = NO

204 205 206 207 208 209 210 211 212 213 214 215
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

216 217 218 219 220 221 222 223 224 225 226 227
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this
# tag. The format is ext=language, where ext is a file extension, and language
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING      =

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.

CPP_CLI_SUPPORT        = NO

# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

# 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
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

# 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
# the \nosubgrouping command.

SUBGROUPING            = YES

# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.

280
TYPEDEF_HIDES_STRUCT   = YES
281

282 283 284 285 286 287 288 289 290
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
Diego Biurrun's avatar
Diego Biurrun committed
291
# a logarithmic scale so increasing the size by one will roughly double the
292 293 294 295 296 297
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols

SYMBOL_CACHE_SIZE      = 0

298 299 300 301
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

302 303 304
# 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
305 306
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

Michael Niedermayer's avatar
Michael Niedermayer committed
307
EXTRACT_ALL            = YES
308

309
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
310 311 312 313
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

314
# If the EXTRACT_STATIC tag is set to YES all static members of a file
315 316 317 318
# will be included in the documentation.

EXTRACT_STATIC         = YES

319 320
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
321 322 323 324
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
# 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.
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

340 341 342 343
# 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.
344 345 346 347
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

348 349
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
350
# If set to NO (the default) these classes will be included in the various
351 352 353 354
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

355 356 357
# 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
358 359 360 361
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

362 363 364
# 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
365 366 367 368
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

369 370 371
# 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.
372 373 374 375
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

376
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
377
# file names in lower-case letters. If set to YES upper-case letters are also
378 379
# 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
380
# and Mac users are advised to set this option to NO.
381 382 383

CASE_SENSE_NAMES       = YES

384 385
# 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
386 387 388 389
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

390
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
391
# will put a list of the files that are included by a file in the documentation
392 393 394 395
# of that file.

SHOW_INCLUDE_FILES     = YES

396 397 398 399 400 401
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

402
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
403 404 405 406
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

407 408 409
# 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
410 411
# declaration order.

412
SORT_MEMBER_DOCS       = NO
413

414 415 416 417
# 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
# declaration order.
418

419 420
SORT_BRIEF_DOCS        = NO

421 422 423 424 425 426 427 428 429 430
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the default)
# the constructors will appear in the respective orders defined by
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

# 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.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO
446

447 448
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
449 450 451 452
# commands in the documentation.

GENERATE_TODOLIST      = YES

453 454
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
455 456 457 458
# commands in the documentation.

GENERATE_TESTLIST      = YES

459 460
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
461 462 463 464
# commands in the documentation.

GENERATE_BUGLIST       = YES

465 466
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
467 468 469 470
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

471
# The ENABLED_SECTIONS tag can be used to enable conditional
472 473
# documentation sections, marked by \if sectionname ... \endif.

474
ENABLED_SECTIONS       =
475

476
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
477
# the initial value of a variable or define consists of for it to appear in
478 479 480 481
# 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
482 483 484 485
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

486 487 488
# 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
# list will mention the files that were used to generate the documentation.
489

490
SHOW_USED_FILES        = YES
491

492 493 494 495 496 497 498
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
499 500
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
501 502 503 504 505 506 507 508 509 510 511 512 513 514
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

# 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 program writes to standard output
# is used as the file version. See the manual for examples.

FILE_VERSION_FILTER    =

515 516 517 518 519 520 521 522 523
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. The create the layout file
# that represents doxygen's defaults, run doxygen with the -l option.
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.

LAYOUT_FILE            =

524 525 526 527
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

528
# The QUIET tag can be used to turn on/off the messages that are generated
529 530
# by doxygen. Possible values are YES and NO. If left blank NO is used.

531
QUIET                  = YES
532

533 534
# 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
535 536 537 538
# NO is used.

WARNINGS               = YES

539 540
# 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
541 542 543 544
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
# 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
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

# 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
# documentation.

WARN_NO_PARAMDOC       = NO

560 561 562
# 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
563 564 565
# 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
# be obtained via FILE_VERSION_FILTER)
566 567 568

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

569 570
# 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
571 572
# to stderr.

573
WARN_LOGFILE           =
574 575 576 577 578

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

579 580 581
# 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
582 583
# with spaces.

584
INPUT                  =
585

586 587 588 589 590 591 592 593
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

594 595 596 597
# 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:
598 599
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
600

601
FILE_PATTERNS          =
602

603 604
# 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.
605 606 607 608
# If left blank NO is used.

RECURSIVE              = YES

609 610
# 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
611 612
# subdirectory from a directory tree whose root is specified with the INPUT tag.

613
EXCLUDE                =
614

615 616 617
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
# from the input.
618 619 620

EXCLUDE_SYMLINKS       = NO

621 622
# 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
623 624 625
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
626

627
EXCLUDE_PATTERNS       = *.git \
Lou Logan's avatar
Lou Logan committed
628
                         *.d
629

630 631 632 633 634 635 636 637
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test

EXCLUDE_SYMBOLS        =

638 639
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
640 641
# the \include command).

642
EXAMPLE_PATH           = doc/examples/
643

644 645 646
# 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
647 648
# blank all files are included.

649
EXAMPLE_PATTERNS       = *.c
650

651 652 653
# 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.
654 655 656 657
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

658 659
# 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
660 661
# the \image command).

662
IMAGE_PATH             =
663

664 665 666 667 668
# 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
669 670
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
671
# ignored.
672

673
INPUT_FILTER           =
674

675
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
676 677 678 679
# 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:
680 681 682 683 684 685
# 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
# is applied to all files.

FILTER_PATTERNS        =

686 687
# 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
688 689 690 691 692 693 694 695
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

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

696
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
697
# be generated. Documented entities will be cross-referenced with these sources.
698 699
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
700 701 702

SOURCE_BROWSER         = YES

703
# Setting the INLINE_SOURCES tag to YES will include the body
704 705 706 707
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

708 709
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
710 711
# fragments. Normal C and C++ comments will always remain visible.

712
STRIP_CODE_COMMENTS    = NO
713

714
# If the REFERENCED_BY_RELATION tag is set to YES
715
# then for each documented function all documented
716 717 718 719
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

720
# If the REFERENCES_RELATION tag is set to YES
721
# then for each documented function all documented entities
722 723
# called/used by that function will be listed.

Michael Niedermayer's avatar
Michael Niedermayer committed
724
REFERENCES_RELATION    = NO
725

726 727 728
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
729 730
# link to the source code.
# Otherwise they will link to the documentation.
731 732 733 734 735 736 737 738 739 740 741

REFERENCES_LINK_SOURCE = YES

# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

742 743 744 745 746 747
# 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
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

748 749 750 751
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

752 753
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
754 755 756 757
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

758 759
# 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
760 761
# in which this list will be split (can be a number in the range [1..20])

762
COLS_IN_ALPHA_INDEX    = 2
763

764 765 766
# 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
767 768
# should be ignored while generating the index headers.

769
IGNORE_PREFIX          =
770 771 772 773 774

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

775
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
776 777 778 779
# generate HTML output.

GENERATE_HTML          = YES

780 781
# 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
782 783 784 785
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

786 787
# 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
788 789 790 791
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

792 793
# 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
794 795
# standard header.

796
HTML_HEADER            =
797

798 799
# 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
800 801
# standard footer.

802
HTML_FOOTER            =
803

804
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
805 806
# 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
807 808 809
# 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
# stylesheet in the HTML output directory as well, or it will be erased!
810

811
HTML_STYLESHEET        =
812

813 814 815 816 817 818 819 820
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images
# according to this color. Hue is specified as an angle on a colorwheel,
# see http://en.wikipedia.org/wiki/Hue for more information.
# For instance the value 0 represents red, 60 is yellow, 120 is green,
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
# The allowed range is 0 to 359.

821
#HTML_COLORSTYLE_HUE    = 120
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848

# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
# the colors in the HTML output. For a value of 0 the output will use
# grayscales only. A value of 255 will produce the most vivid colors.

HTML_COLORSTYLE_SAT    = 100

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
# the luminance component of the colors in the HTML output. Values below
# 100 gradually make the output lighter, whereas values above 100 make
# the output darker. The value divided by 100 is the actual gamma applied,
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
# and 100 does not change the gamma.

HTML_COLORSTYLE_GAMMA  = 80

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
849

850
HTML_DYNAMIC_SECTIONS  = NO
851

852 853
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
854
# integrated development environment, introduced with OS X 10.5 (Leopard).
855 856 857 858 859
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
860 861
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878

GENERATE_DOCSET        = NO

# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

879 880 881
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
882

883 884 885 886 887 888 889 890 891 892 893 894
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

DOCSET_PUBLISHER_NAME  = Publisher

# 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 compiled HTML help file (.chm)
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO
895

896 897 898
# 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
899
# written to the html output directory.
900

901
CHM_FILE               =
902

903 904
# 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
905 906
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
907

908
HHC_LOCATION           =
909

910 911
# 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
912 913 914 915
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

916 917 918 919 920 921
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.

CHM_INDEX_ENCODING     =

922 923
# 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
924 925 926 927
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

928
# The TOC_EXPAND flag can be set to YES to add extra items for group members
929
# to the contents of the HTML help documentation and to the tree view.
930 931 932

TOC_EXPAND             = NO

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
# that can be used as input for Qt's qhelpgenerator to generate a
# Qt Compressed Help (.qch) of the generated HTML documentation.

GENERATE_QHP           = NO

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.

QCH_FILE               =

# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace

QHP_NAMESPACE          = org.doxygen.Project

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
# add. For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters

QHP_CUST_FILTER_NAME   =

# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
# Qt Help Project / Custom Filters</a>.

QHP_CUST_FILTER_ATTRS  =

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's
# filter section matches.
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
# Qt Help Project / Filter Attributes</a>.

QHP_SECT_FILTER_ATTRS  =

# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.

QHG_LOCATION           =

# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
#  will be generated, which together with the HTML files, form an Eclipse help
# plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
# the help appears.

GENERATE_ECLIPSEHELP   = NO

# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.

ECLIPSE_DOC_ID         = org.doxygen.Project

1003 1004
# 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
1005 1006 1007 1008
# the value YES disables it.

DISABLE_INDEX          = NO

1009
# This tag can be used to set the number of enum values (range [1..20])
1010 1011 1012 1013
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

1014 1015
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
1016
# If the tag value is set to YES, a side panel will be generated
1017
# containing a tree-like index structure (just like the one that
1018
# is generated for HTML Help). For this to work a browser that supports
1019 1020
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
1021 1022 1023

GENERATE_TREEVIEW      = NO

1024 1025
# 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
1026 1027 1028 1029
# is shown.

TREEVIEW_WIDTH         = 250

1030 1031 1032 1033 1034
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
# links to external symbols imported via tag files in a separate window.

EXT_LINKS_IN_WINDOW    = NO

1035 1036 1037 1038 1039 1040 1041 1042
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are
# not supported properly for IE 6.0, but are supported on all modern browsers.
# Note that when changing this option you need to delete any form_*.png files
# in the HTML output before the changes have effect.

FORMULA_TRANSPARENT    = YES

# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
# (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = NO

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a PHP enabled web server instead of at the web client
# using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server
# based approach is that it scales better to large projects and allows
# full text search. The disadvances is that it is more difficult to setup
# and does not have live searching capabilities.

SERVER_BASED_SEARCH    = NO

1071 1072 1073 1074
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

1075
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1076 1077
# generate Latex output.

1078
GENERATE_LATEX         = NO
1079

1080 1081
# 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
1082 1083 1084 1085
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

1086
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1087
# invoked. If left blank `latex' will be used as the default command name.
1088 1089 1090
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
1091 1092 1093

LATEX_CMD_NAME         = latex

1094 1095
# 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
1096 1097 1098 1099
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

1100 1101
# 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
1102 1103 1104 1105
# save some trees in general.

COMPACT_LATEX          = NO

1106 1107
# 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
1108 1109 1110 1111
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

1112
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1113 1114
# packages that should be included in the LaTeX output.

1115
EXTRA_PACKAGES         =
1116

1117 1118 1119
# 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
1120 1121
# standard header. Notice: only use this tag if you know what you are doing!

1122
LATEX_HEADER           =
1123

1124 1125 1126
# 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
1127 1128 1129 1130
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = NO

1131 1132
# 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
1133 1134 1135 1136
# higher quality PDF documentation.

USE_PDFLATEX           = NO

1137 1138 1139
# 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.
1140 1141 1142 1143
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

1144 1145 1146 1147 1148 1149
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
# in the output.

LATEX_HIDE_INDICES     = NO

1150 1151 1152 1153 1154 1155 1156
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
# source code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings
# such as SOURCE_BROWSER.

LATEX_SOURCE_CODE      = NO

1157 1158 1159 1160
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

1161
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1162
# The RTF output is optimized for Word 97 and may not look very pretty with
1163 1164 1165 1166
# other RTF readers or editors.

GENERATE_RTF           = NO

1167 1168
# 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
1169 1170 1171 1172
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

1173 1174
# 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
1175 1176 1177 1178
# save some trees in general.

COMPACT_RTF            = NO

1179 1180 1181 1182 1183
# 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.
1184 1185 1186 1187
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

1188
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1189
# config file, i.e. a series of assignments. You only have to provide
1190 1191
# replacements, missing definitions are set to their default value.

1192
RTF_STYLESHEET_FILE    =
1193

1194
# Set optional variables used in the generation of an rtf document.
1195 1196
# Syntax is similar to doxygen's config file.

1197
RTF_EXTENSIONS_FILE    =
1198 1199 1200 1201 1202

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

1203
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1204 1205 1206 1207
# generate man pages

GENERATE_MAN           = NO

1208 1209
# 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
1210 1211 1212 1213
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

1214
# The MAN_EXTENSION tag determines the extension that is added to
1215 1216 1217 1218
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

1219 1220 1221 1222
# 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
1223 1224 1225 1226 1227 1228 1229 1230
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

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

1231 1232
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
1233
# the code including all documentation.
1234 1235 1236

GENERATE_XML           = NO

1237 1238 1239 1240 1241 1242
# 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
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

1243 1244
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
1245 1246
# syntax of the XML files.

1247
XML_SCHEMA             =
1248

1249 1250
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
1251 1252
# syntax of the XML files.

1253
XML_DTD                =
1254

1255 1256 1257 1258 1259 1260 1261
# 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
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

1262 1263 1264 1265
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

1266 1267 1268 1269
# 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
1270 1271 1272 1273 1274 1275 1276 1277
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

1278 1279 1280 1281
# 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
1282 1283 1284 1285
# moment.

GENERATE_PERLMOD       = NO

1286 1287
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1288 1289 1290 1291
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

1292
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1293 1294 1295 1296
# 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
1297
# tag is set to NO the size of the Perl module output will be much smaller
1298 1299 1300 1301
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

1302 1303 1304
# 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
1305 1306
# Makefile don't overwrite each other's variables.

1307
PERLMOD_MAKEVAR_PREFIX =
1308 1309

#---------------------------------------------------------------------------
1310
# Configuration options related to the preprocessor
1311 1312
#---------------------------------------------------------------------------

1313 1314
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
1315 1316 1317 1318
# files.

ENABLE_PREPROCESSING   = YES

1319 1320 1321
# 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
1322 1323 1324 1325
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = YES

1326 1327
# 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
1328
# PREDEFINED and EXPAND_AS_DEFINED tags.
1329 1330 1331

EXPAND_ONLY_PREDEF     = YES

1332
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1333 1334 1335 1336
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

1337 1338
# 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
1339 1340
# the preprocessor.

1341
INCLUDE_PATH           =
1342

1343 1344 1345
# 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
1346 1347
# be used.

1348
INCLUDE_FILE_PATTERNS  =
1349

1350 1351 1352 1353
# 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
1354 1355 1356
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
1357

1358 1359
PREDEFINED             = "__attribute__(x)=" \
                         "DECLARE_ALIGNED(a,t,n)=t n" \
1360 1361
                         "offsetof(x,y)=0x42" \
                         av_alloc_size \
1362

1363 1364 1365
# 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.
1366 1367
# Use the PREDEFINED tag if you want to use a different macro definition.

1368 1369
EXPAND_AS_DEFINED      = declare_idct  \
                         READ_PAR_DATA \
1370

1371 1372 1373
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1374 1375
# function macros are typically used for boiler-plate code, and will confuse
# the parser if not removed.
1376 1377 1378 1379

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
1380
# Configuration::additions related to external references
1381 1382
#---------------------------------------------------------------------------

1383
# The TAGFILES option can be used to specify one or more tagfiles.
1384 1385 1386
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
1387 1388
#
# TAGFILES = file1 file2 ...
1389
# Adding location for the tag files is done as follows:
1390 1391
#
# TAGFILES = file1=loc1 "file2 = loc2" ...
1392 1393 1394 1395 1396 1397 1398
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
1399

1400
TAGFILES               =
1401

1402
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1403 1404
# a tag file that is based on the input files it reads.

1405
GENERATE_TAGFILE       =
1406

1407 1408
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
1409 1410 1411 1412
# will be listed.

ALLEXTERNALS           = NO

1413 1414
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
1415 1416 1417 1418
# be listed.

EXTERNAL_GROUPS        = YES

1419
# The PERL_PATH should be the absolute path and name of the perl script
1420 1421 1422 1423 1424
# interpreter (i.e. the result of `which perl').

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------
1425
# Configuration options related to the dot tool
1426 1427
#---------------------------------------------------------------------------

1428
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1429 1430 1431 1432 1433
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
# or super classes. Setting the tag to NO turns the diagrams off. Note that
# this option is superseded by the HAVE_DOT option below. This is only a
# fallback. It is recommended to install and use dot, since it yields more
# powerful graphs.
1434 1435 1436

CLASS_DIAGRAMS         = YES

1437 1438 1439 1440 1441 1442 1443 1444 1445
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.

MSCGEN_PATH            =

1446 1447
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
1448 1449 1450 1451
# or is not a class.

HIDE_UNDOC_RELATIONS   = YES

1452 1453 1454
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1455 1456 1457 1458
# have no effect if this option is set to NO (the default)

HAVE_DOT               = NO

1459 1460 1461 1462 1463 1464 1465 1466
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
# allowed to run in parallel. When set to 0 (the default) doxygen will
# base this on the number of processors available in the system. You can set it
# explicitly to a value larger than 0 to get control over the balance
# between CPU load and processing speed.

DOT_NUM_THREADS        = 0

1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.

DOT_FONTNAME           = FreeSans

1478 1479 1480 1481 1482
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.

DOT_FONTSIZE           = 10

1483 1484 1485 1486 1487 1488 1489
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.

DOT_FONTPATH           =

1490 1491 1492
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
1493 1494 1495 1496
# the CLASS_DIAGRAMS tag to NO.

CLASS_GRAPH            = YES

1497 1498 1499
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
1500 1501 1502 1503
# class references variables) of the class with other documented classes.

COLLABORATION_GRAPH    = YES

1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies

GROUP_GRAPHS           = YES

# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.

UML_LOOK               = NO

1515
# If set to YES, the inheritance and collaboration graphs will show the
1516 1517 1518 1519
# relations between templates and their instances.

TEMPLATE_RELATIONS     = YES

1520 1521 1522
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
1523 1524 1525 1526
# other documented files.

INCLUDE_GRAPH          = YES

1527 1528 1529
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
1530 1531 1532 1533
# indirectly include this file.

INCLUDED_BY_GRAPH      = YES

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.

CALL_GRAPH             = NO

# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable caller
# graphs for selected functions only using the \callergraph command.

CALLER_GRAPH           = NO

1550
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1551 1552 1553 1554
# will graphical hierarchy of all classes instead of a textual one.

GRAPHICAL_HIERARCHY    = YES

1555 1556 1557 1558 1559 1560 1561
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.

DIRECTORY_GRAPH        = YES

1562
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1563 1564 1565 1566 1567
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.

DOT_IMAGE_FORMAT       = png

1568
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1569
# found. If left blank, it is assumed the dot tool can be found in the path.
1570

1571
DOT_PATH               =
1572

1573 1574
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
1575 1576
# \dotfile command).

1577
DOTFILE_DIRS           =
1578

1579 1580 1581 1582 1583 1584 1585
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1586

1587
DOT_GRAPH_MAX_NODES    = 50
1588

1589 1590 1591 1592 1593 1594 1595
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1596

1597 1598 1599
MAX_DOT_GRAPH_DEPTH    = 0

# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1600 1601 1602 1603
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. Warning: Depending on the platform used,
# enabling this option may lead to badly anti-aliased labels on the edges of
# a graph (i.e. they become hard to read).
1604 1605 1606 1607 1608 1609 1610 1611 1612

DOT_TRANSPARENT        = YES

# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10)
# support this, this feature is disabled by default.

DOT_MULTI_TARGETS      = NO
1613

1614 1615
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
1616 1617 1618 1619
# arrows in the dot generated graphs.

GENERATE_LEGEND        = YES

1620
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1621
# remove the intermediate dot files that are used to generate
1622 1623 1624
# the various graphs.

DOT_CLEANUP            = YES