Doxyfile 57.8 KB
Newer Older
1
# Doxyfile 1.5.6
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.

J
Janne Grunau 已提交
28
PROJECT_NAME           = Libav
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 37 38
# 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
39 40 41 42
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = doxy

43 44 45 46 47 48 49 50 51
# 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

52 53 54 55
# 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:
56 57 58 59 60 61
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, 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, Slovak, Slovene, Spanish, Swedish,
# and Ukrainian.
62 63 64

OUTPUT_LANGUAGE        = English

65 66 67 68 69 70 71 72 73 74 75 76 77 78
# 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

79 80 81 82 83 84 85 86 87 88 89 90
# 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       =

91 92 93 94 95 96
# 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

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
# operators of the base classes will not be shown.
101 102 103 104 105 106 107 108 109 110

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
111
# can be used to strip a user-defined part of the path. Stripping is
112
# only done if one of the specified strings matches the left-hand part of
113 114 115
# 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.
116 117 118

STRIP_FROM_PATH        = .

119 120 121 122 123 124 125 126 127
# 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    =

128 129 130 131 132 133 134 135 136
# 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
137 138
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
139 140 141

JAVADOC_AUTOBRIEF      = YES

142 143 144 145 146 147 148 149
# 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

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
# 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 DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.

DETAILS_AT_TOP         = 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
167
# re-implements.
168 169 170

INHERIT_DOCS           = YES

171 172 173 174 175 176
# 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

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

ALIASES                =

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

OPTIMIZE_OUTPUT_FOR_C  = YES

198 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 will look different, etc.
202 203 204

OPTIMIZE_OUTPUT_JAVA   = NO

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 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
# 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

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

TYPEDEF_HIDES_STRUCT   = NO

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

275 276 277
# 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
278 279
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

M
Michael Niedermayer 已提交
280
EXTRACT_ALL            = YES
281

282
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
283 284 285 286
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

287
# If the EXTRACT_STATIC tag is set to YES all static members of a file
288 289 290 291
# will be included in the documentation.

EXTRACT_STATIC         = YES

292 293
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
294 295 296 297
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
# 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

313 314 315 316
# 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.
317 318 319 320
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

321 322
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
323
# If set to NO (the default) these classes will be included in the various
324 325 326 327
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

328 329 330
# 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
331 332 333 334
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

335 336 337
# 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
338 339 340 341
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

342 343 344
# 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.
345 346 347 348
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

349
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
350
# file names in lower-case letters. If set to YES upper-case letters are also
351 352
# 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
353
# and Mac users are advised to set this option to NO.
354 355 356

CASE_SENSE_NAMES       = YES

357 358
# 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
359 360 361 362
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

363
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
364
# will put a list of the files that are included by a file in the documentation
365 366 367 368
# of that file.

SHOW_INCLUDE_FILES     = YES

369
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
370 371 372 373
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

374 375 376
# 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
377 378 379 380
# declaration order.

SORT_MEMBER_DOCS       = YES

381 382 383 384
# 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.
385

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
SORT_BRIEF_DOCS        = NO

# 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
403

404 405
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
406 407 408 409
# commands in the documentation.

GENERATE_TODOLIST      = YES

410 411
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
412 413 414 415
# commands in the documentation.

GENERATE_TESTLIST      = YES

416 417
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
418 419 420 421
# commands in the documentation.

GENERATE_BUGLIST       = YES

422 423
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
424 425 426 427
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

428
# The ENABLED_SECTIONS tag can be used to enable conditional
429 430
# documentation sections, marked by \if sectionname ... \endif.

431
ENABLED_SECTIONS       =
432

433
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
434
# the initial value of a variable or define consists of for it to appear in
435 436 437 438
# 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
439 440 441 442
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

443 444 445
# 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.
446

447
SHOW_USED_FILES        = YES
448

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.

SHOW_DIRECTORIES       = NO

# 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
# Namespaces page.  This will remove the Namespaces entry from the Quick Index
# 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    =

477 478 479 480
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

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

484
QUIET                  = YES
485

486 487
# 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
488 489 490 491
# NO is used.

WARNINGS               = YES

492 493
# 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
494 495 496 497
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
# 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

513 514 515
# 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
516 517 518
# 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)
519 520 521

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

522 523
# 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
524 525
# to stderr.

526
WARN_LOGFILE           =
527 528 529 530 531

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

532 533 534
# 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
535 536
# with spaces.

537
INPUT                  =
538

539 540 541 542 543 544 545 546
# 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

547 548 549 550
# 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:
551 552
# *.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
553

554
FILE_PATTERNS          =
555

556 557
# 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.
558 559 560 561
# If left blank NO is used.

RECURSIVE              = YES

562 563
# 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
564 565
# subdirectory from a directory tree whose root is specified with the INPUT tag.

566
EXCLUDE                =
567

568 569 570
# 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.
571 572 573

EXCLUDE_SYMLINKS       = NO

574 575
# 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
576 577 578
# 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/*
579

J
Janne Grunau 已提交
580
EXCLUDE_PATTERNS       = *.git *.d
581

582 583 584 585 586 587 588 589
# 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        =

590 591
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
592 593
# the \include command).

594
EXAMPLE_PATH           = libavcodec/ libavformat/
595

596 597 598
# 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
599 600
# blank all files are included.

601
EXAMPLE_PATTERNS       = *-example.c
602

603 604 605
# 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.
606 607 608 609
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

610 611
# 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
612 613
# the \image command).

614
IMAGE_PATH             =
615

616 617 618 619 620
# 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
621 622
# to standard output.  If FILTER_PATTERNS is specified, this tag will be
# ignored.
623

624
INPUT_FILTER           =
625

626 627 628 629 630 631 632 633 634
# 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
# is applied to all files.

FILTER_PATTERNS        =

635 636
# 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
637 638 639 640 641 642 643 644
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

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

645
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
646
# be generated. Documented entities will be cross-referenced with these sources.
647 648
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
649 650 651

SOURCE_BROWSER         = YES

652
# Setting the INLINE_SOURCES tag to YES will include the body
653 654 655 656
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

657 658
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
659 660 661 662
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

663
# If the REFERENCED_BY_RELATION tag is set to YES
664
# then for each documented function all documented
665 666 667 668
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

669
# If the REFERENCES_RELATION tag is set to YES
670
# then for each documented function all documented entities
671 672
# called/used by that function will be listed.

M
Michael Niedermayer 已提交
673
REFERENCES_RELATION    = NO
674

675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
# 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
# link to the source code.  Otherwise they will link to the documentstion.

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

690 691 692 693 694 695
# 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

696 697 698 699
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

700 701
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
702 703 704 705
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

706 707
# 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
708 709 710 711
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

712 713 714
# 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
715 716
# should be ignored while generating the index headers.

717
IGNORE_PREFIX          =
718 719 720 721 722

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

723
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
724 725 726 727
# generate HTML output.

GENERATE_HTML          = YES

728 729
# 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
730 731 732 733
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

734 735
# 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
736 737 738 739
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

740 741
# 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
742 743
# standard header.

744
HTML_HEADER            =
745

746 747
# 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
748 749
# standard footer.

750
HTML_FOOTER            =
751

752
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
753 754
# 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
755 756 757
# 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!
758

759
HTML_STYLESHEET        =
760

761 762
# 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
763 764 765 766
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

767 768
# 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
769
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
770 771 772 773
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
# 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
# integrated development environment, introduced with OSX 10.5 (Leopard).
# 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.

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

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

HTML_DYNAMIC_SECTIONS  = NO

807 808 809
# 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
810
# written to the html output directory.
811

812
CHM_FILE               =
813

814 815
# 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
816 817
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
818

819
HHC_LOCATION           =
820

821 822
# 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
823 824 825 826
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

827 828 829 830 831 832
# 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     =

833 834
# 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
835 836 837 838
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

839
# The TOC_EXPAND flag can be set to YES to add extra items for group members
840
# to the contents of the HTML help documentation and to the tree view.
841 842 843

TOC_EXPAND             = NO

844 845
# 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
846 847 848 849
# the value YES disables it.

DISABLE_INDEX          = NO

850
# This tag can be used to set the number of enum values (range [1..20])
851 852 853 854
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

855 856 857 858
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to FRAME, a side panel will be generated
# containing a tree-like index structure (just like the one that
859
# is generated for HTML Help). For this to work a browser that supports
860 861 862 863 864 865 866 867 868
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature. Other possible values
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
# and Class Hiererachy pages using a tree view instead of an ordered list;
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
# disables this behavior completely. For backwards compatibility with previous
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
# respectively.
869 870 871

GENERATE_TREEVIEW      = NO

872 873
# 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
874 875 876 877
# is shown.

TREEVIEW_WIDTH         = 250

878 879 880 881 882 883 884 885
# 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

886 887 888 889
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

890
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
891 892
# generate Latex output.

893
GENERATE_LATEX         = NO
894

895 896
# 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
897 898 899 900
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

901
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
902 903 904 905
# invoked. If left blank `latex' will be used as the default command name.

LATEX_CMD_NAME         = latex

906 907
# 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
908 909 910 911
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

912 913
# 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
914 915 916 917
# save some trees in general.

COMPACT_LATEX          = NO

918 919
# 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
920 921 922 923
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

924
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
925 926
# packages that should be included in the LaTeX output.

927
EXTRA_PACKAGES         =
928

929 930 931
# 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
932 933
# standard header. Notice: only use this tag if you know what you are doing!

934
LATEX_HEADER           =
935

936 937 938
# 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
939 940 941 942
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = NO

943 944
# 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
945 946 947 948
# higher quality PDF documentation.

USE_PDFLATEX           = NO

949 950 951
# 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.
952 953 954 955
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

956 957 958 959 960 961
# 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

962 963 964 965
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

966
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
967
# The RTF output is optimized for Word 97 and may not look very pretty with
968 969 970 971
# other RTF readers or editors.

GENERATE_RTF           = NO

972 973
# 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
974 975 976 977
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

978 979
# 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
980 981 982 983
# save some trees in general.

COMPACT_RTF            = NO

984 985 986 987 988
# 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.
989 990 991 992
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

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

997
RTF_STYLESHEET_FILE    =
998

999
# Set optional variables used in the generation of an rtf document.
1000 1001
# Syntax is similar to doxygen's config file.

1002
RTF_EXTENSIONS_FILE    =
1003 1004 1005 1006 1007

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

1008
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1009 1010 1011 1012
# generate man pages

GENERATE_MAN           = NO

1013 1014
# 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
1015 1016 1017 1018
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

1019
# The MAN_EXTENSION tag determines the extension that is added to
1020 1021 1022 1023
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

1024 1025 1026 1027
# 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
1028 1029 1030 1031 1032 1033 1034 1035
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

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

1036 1037
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
1038
# the code including all documentation.
1039 1040 1041

GENERATE_XML           = NO

1042 1043 1044 1045 1046 1047
# 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

1048 1049
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
1050 1051
# syntax of the XML files.

1052
XML_SCHEMA             =
1053

1054 1055
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
1056 1057
# syntax of the XML files.

1058
XML_DTD                =
1059

1060 1061 1062 1063 1064 1065 1066
# 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

1067 1068 1069 1070
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

1071 1072 1073 1074
# 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
1075 1076 1077 1078 1079 1080 1081 1082
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

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

1083 1084 1085 1086
# 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
1087 1088 1089 1090
# moment.

GENERATE_PERLMOD       = NO

1091 1092
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1093 1094 1095 1096
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

1097 1098 1099 1100
# 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
1101 1102 1103 1104
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

1105 1106 1107
# 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
1108 1109
# Makefile don't overwrite each other's variables.

1110
PERLMOD_MAKEVAR_PREFIX =
1111 1112

#---------------------------------------------------------------------------
1113
# Configuration options related to the preprocessor
1114 1115
#---------------------------------------------------------------------------

1116 1117
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
1118 1119 1120 1121
# files.

ENABLE_PREPROCESSING   = YES

1122 1123 1124
# 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
1125 1126 1127 1128
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = YES

1129 1130
# 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
1131
# PREDEFINED and EXPAND_AS_DEFINED tags.
1132 1133 1134

EXPAND_ONLY_PREDEF     = YES

1135
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1136 1137 1138 1139
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

1140 1141
# 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
1142 1143
# the preprocessor.

1144
INCLUDE_PATH           =
1145

1146 1147 1148
# 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
1149 1150
# be used.

1151
INCLUDE_FILE_PATTERNS  =
1152

1153 1154 1155 1156
# 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
1157 1158 1159
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
1160

M
Michael Niedermayer 已提交
1161
PREDEFINED             = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
D
Diego Biurrun 已提交
1162
                         HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_AMD3DNOW \
1163
                         "DECLARE_ALIGNED(a,t,n)=t n" "offsetof(x,y)=0x42" \
1164

1165 1166 1167
# 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.
1168 1169 1170
# Use the PREDEFINED tag if you want to use a different macro definition.

#EXPAND_AS_DEFINED      = FF_COMMON_FRAME
M
Michael Niedermayer 已提交
1171
EXPAND_AS_DEFINED      = declare_idct(idct, table, idct_row_head, idct_row, idct_row_tail, idct_row_mid)
1172

1173 1174 1175
# 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
1176 1177
# function macros are typically used for boiler-plate code, and will confuse
# the parser if not removed.
1178 1179 1180 1181

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
1182
# Configuration::additions related to external references
1183 1184
#---------------------------------------------------------------------------

1185
# The TAGFILES option can be used to specify one or more tagfiles.
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
# 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:
#   TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
#   TAGFILES = file1=loc1 "file2 = loc2" ...
# 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.
1199

1200
TAGFILES               =
1201

1202
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1203 1204
# a tag file that is based on the input files it reads.

1205
GENERATE_TAGFILE       =
1206

1207 1208
# 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
1209 1210 1211 1212
# will be listed.

ALLEXTERNALS           = NO

1213 1214
# 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
1215 1216 1217 1218
# be listed.

EXTERNAL_GROUPS        = YES

1219
# The PERL_PATH should be the absolute path and name of the perl script
1220 1221 1222 1223 1224
# interpreter (i.e. the result of `which perl').

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------
1225
# Configuration options related to the dot tool
1226 1227
#---------------------------------------------------------------------------

1228
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1229 1230 1231 1232 1233
# 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.
1234 1235 1236

CLASS_DIAGRAMS         = YES

1237 1238 1239 1240 1241 1242 1243 1244 1245
# 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            =

1246 1247
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
1248 1249 1250 1251
# or is not a class.

HIDE_UNDOC_RELATIONS   = YES

1252 1253 1254
# 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
1255 1256 1257 1258
# have no effect if this option is set to NO (the default)

HAVE_DOT               = NO

1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
# 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

# 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           =

1277 1278 1279
# 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
1280 1281 1282 1283
# the CLASS_DIAGRAMS tag to NO.

CLASS_GRAPH            = YES

1284 1285 1286
# 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
1287 1288 1289 1290
# class references variables) of the class with other documented classes.

COLLABORATION_GRAPH    = YES

1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
# 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

1302
# If set to YES, the inheritance and collaboration graphs will show the
1303 1304 1305 1306
# relations between templates and their instances.

TEMPLATE_RELATIONS     = YES

1307 1308 1309
# 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
1310 1311 1312 1313
# other documented files.

INCLUDE_GRAPH          = YES

1314 1315 1316
# 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
1317 1318 1319 1320
# indirectly include this file.

INCLUDED_BY_GRAPH      = YES

1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
# 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

1337
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1338 1339 1340 1341
# will graphical hierarchy of all classes instead of a textual one.

GRAPHICAL_HIERARCHY    = YES

1342 1343 1344 1345 1346 1347 1348
# 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

1349
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1350 1351 1352 1353 1354
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.

DOT_IMAGE_FORMAT       = png

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

1358
DOT_PATH               =
1359

1360 1361
# 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
1362 1363
# \dotfile command).

1364
DOTFILE_DIRS           =
1365

1366 1367 1368 1369 1370 1371 1372
# 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.
1373

1374
DOT_GRAPH_MAX_NODES    = 50
1375

1376 1377 1378 1379 1380 1381 1382
# 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.
1383

1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
MAX_DOT_GRAPH_DEPTH    = 0

# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is enabled by default, which results in a transparent
# background. 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).

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
1400

1401 1402
# 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
1403 1404 1405 1406
# arrows in the dot generated graphs.

GENERATE_LEGEND        = YES

1407
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1408
# remove the intermediate dot files that are used to generate
1409 1410 1411 1412 1413
# the various graphs.

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------
1414
# Configuration::additions related to the search engine
1415 1416
#---------------------------------------------------------------------------

1417
# The SEARCHENGINE tag specifies whether or not a search engine should be
1418 1419 1420
# used. If set to NO the values of all tags below this one will be ignored.

SEARCHENGINE           = NO