Doxyfile 40.0 KB
Newer Older
1
# Doxyfile 1.3-rc1
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
# General configuration options
15 16
#---------------------------------------------------------------------------

17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 19
# by quotes) that should identify the project.

20
PROJECT_NAME           = FFmpeg
21

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

26
PROJECT_NUMBER         =
27

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

OUTPUT_DIRECTORY       = doxy

35 36 37 38
# 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:
39 40 41 42
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
43 44 45

OUTPUT_LANGUAGE        = English

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
# 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

# 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

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

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
# can be used to strip a user defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. It is allowed to use relative paths in the argument list.

STRIP_FROM_PATH        = .

# 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
# comments  will behave just like the Qt-style comments (thus requiring an
# explict @brief command for a brief description.

JAVADOC_AUTOBRIEF      = YES

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

INHERIT_DOCS           = YES

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

ALIASES                =

# 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
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

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

OPTIMIZE_OUTPUT_JAVA   = NO

149 150 151
# 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
152 153
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

M
Michael Niedermayer 已提交
154
EXTRACT_ALL            = YES
155

156
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
157 158 159 160
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

161
# If the EXTRACT_STATIC tag is set to YES all static members of a file
162 163 164 165
# will be included in the documentation.

EXTRACT_STATIC         = YES

166 167
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
168 169 170 171
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

172 173 174 175
# 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.
176 177 178 179
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

180 181
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
182
# If set to NO (the default) these class will be included in the various
183 184 185 186
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

187 188 189
# 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
190 191 192 193
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

194 195 196
# 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
197 198 199 200
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

201 202 203
# 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.
204 205 206 207
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

208
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
209
# file names in lower case letters. If set to YES upper case letters are also
210 211
# 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
212
# users are adviced to set this option to NO.
213 214 215

CASE_SENSE_NAMES       = YES

216 217
# 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
218 219 220 221
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

222
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
223
# will put list of the files that are included by a file in the documentation
224 225 226 227
# of that file.

SHOW_INCLUDE_FILES     = YES

228
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
229 230 231 232
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

233 234 235
# 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
236 237 238 239
# declaration order.

SORT_MEMBER_DOCS       = YES

240 241 242 243
# 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.
244

245
DISTRIBUTE_GROUP_DOC   = NO
246

247 248
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
249 250 251 252
# commands in the documentation.

GENERATE_TODOLIST      = YES

253 254
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
255 256 257 258
# commands in the documentation.

GENERATE_TESTLIST      = YES

259 260
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
261 262 263 264
# commands in the documentation.

GENERATE_BUGLIST       = YES

265 266
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
267 268 269 270
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

271
# The ENABLED_SECTIONS tag can be used to enable conditional
272 273
# documentation sections, marked by \if sectionname ... \endif.

274
ENABLED_SECTIONS       =
275

276
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
277
# the initial value of a variable or define consist of for it to appear in
278 279 280 281
# 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
282 283 284 285
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

286 287 288
# 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.
289

290
SHOW_USED_FILES        = YES
291

292 293 294 295
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

296
# The QUIET tag can be used to turn on/off the messages that are generated
297 298 299 300
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

301 302
# 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
303 304 305 306
# NO is used.

WARNINGS               = YES

307 308
# 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
309 310 311 312
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

313 314 315
# 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
316
# warning originated and the warning text.
317 318 319

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

320 321
# 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
322 323
# to stderr.

324
WARN_LOGFILE           =
325 326 327 328 329

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

330 331 332
# 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
333 334
# with spaces.

335
INPUT                  =
336

337 338 339 340
# 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:
341 342
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
# *.h++ *.idl *.odl
343

344
FILE_PATTERNS          =
345

346 347
# 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.
348 349 350 351
# If left blank NO is used.

RECURSIVE              = YES

352 353
# 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
354 355
# subdirectory from a directory tree whose root is specified with the INPUT tag.

356
EXCLUDE                =
357

358 359
# 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.
360 361 362

EXCLUDE_SYMLINKS       = NO

363 364
# 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
365
# certain files from those directories.
366

367
EXCLUDE_PATTERNS       = *.svn *.git
368

369 370
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
371 372
# the \include command).

373
EXAMPLE_PATH           =
374

375 376 377
# 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
378 379
# blank all files are included.

380
EXAMPLE_PATTERNS       =
381

382 383 384
# 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.
385 386 387 388
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

389 390
# 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
391 392
# the \image command).

393
IMAGE_PATH             =
394

395 396 397 398 399
# 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
400
# to standard output.
401

402
INPUT_FILTER           =
403

404 405
# 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
406 407 408 409 410 411 412 413
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

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

414
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
415 416 417 418
# be generated. Documented entities will be cross-referenced with these sources.

SOURCE_BROWSER         = YES

419
# Setting the INLINE_SOURCES tag to YES will include the body
420 421 422 423
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

424 425
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
426 427 428 429
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

430
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
431
# then for each documented function all documented
432 433 434 435
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

436
# If the REFERENCES_RELATION tag is set to YES (the default)
437
# then for each documented function all documented entities
438 439
# called/used by that function will be listed.

M
Michael Niedermayer 已提交
440
REFERENCES_RELATION    = NO
441

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

448 449 450 451
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

452 453
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
454 455 456 457
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

458 459
# 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
460 461 462 463
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

464 465 466
# 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
467 468
# should be ignored while generating the index headers.

469
IGNORE_PREFIX          =
470 471 472 473 474

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

475
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
476 477 478 479
# generate HTML output.

GENERATE_HTML          = YES

480 481
# 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
482 483 484 485
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

486 487
# 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
488 489 490 491
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

492 493
# 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
494 495
# standard header.

496
HTML_HEADER            =
497

498 499
# 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
500 501
# standard footer.

502
HTML_FOOTER            =
503

504
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
505 506
# 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
507
# will generate a default style sheet
508

509
HTML_STYLESHEET        =
510

511 512
# 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
513 514 515 516
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

517 518
# 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
519
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
520 521 522 523
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

524 525 526
# 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
527
# written to the html output dir.
528

529
CHM_FILE               =
530

531 532
# 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
533 534
# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
# the html help compiler on the generated index.hhp.
535

536
HHC_LOCATION           =
537

538 539
# 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
540 541 542 543
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

544 545
# 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
546 547 548 549
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

550
# The TOC_EXPAND flag can be set to YES to add extra items for group members
551
# to the contents of the Html help documentation and to the tree view.
552 553 554

TOC_EXPAND             = NO

555 556
# 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
557 558 559 560
# the value YES disables it.

DISABLE_INDEX          = NO

561
# This tag can be used to set the number of enum values (range [1..20])
562 563 564 565
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

566 567
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
# generated containing a tree-like index structure (just like the one that
568
# is generated for HTML Help). For this to work a browser that supports
569 570 571 572
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
# or Internet explorer 4.0+). Note that for large projects the tree generation
# can take a very long time. In such cases it is better to disable this feature.
# Windows users are probably better off using the HTML help feature.
573 574 575

GENERATE_TREEVIEW      = NO

576 577
# 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
578 579 580 581 582 583 584 585
# is shown.

TREEVIEW_WIDTH         = 250

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

586
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
587 588 589 590
# generate Latex output.

GENERATE_LATEX         = YES

591 592
# 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
593 594 595 596
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

597
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
598 599 600 601
# invoked. If left blank `latex' will be used as the default command name.

LATEX_CMD_NAME         = latex

602 603
# 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
604 605 606 607
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

608 609
# 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
610 611 612 613
# save some trees in general.

COMPACT_LATEX          = NO

614 615
# 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
616 617 618 619
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

620
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
621 622
# packages that should be included in the LaTeX output.

623
EXTRA_PACKAGES         =
624

625 626 627
# 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
628 629
# standard header. Notice: only use this tag if you know what you are doing!

630
LATEX_HEADER           =
631

632 633 634
# 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
635 636 637 638
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = NO

639 640
# 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
641 642 643 644
# higher quality PDF documentation.

USE_PDFLATEX           = NO

645 646 647
# 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.
648 649 650 651 652 653 654 655
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

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

656
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
657
# The RTF output is optimized for Word 97 and may not look very pretty with
658 659 660 661
# other RTF readers or editors.

GENERATE_RTF           = NO

662 663
# 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
664 665 666 667
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

668 669
# 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
670 671 672 673
# save some trees in general.

COMPACT_RTF            = NO

674 675 676 677 678
# 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.
679 680 681 682
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

683
# Load stylesheet definitions from file. Syntax is similar to doxygen's
684
# config file, i.e. a series of assigments. You only have to provide
685 686
# replacements, missing definitions are set to their default value.

687
RTF_STYLESHEET_FILE    =
688

689
# Set optional variables used in the generation of an rtf document.
690 691
# Syntax is similar to doxygen's config file.

692
RTF_EXTENSIONS_FILE    =
693 694 695 696 697

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

698
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
699 700 701 702
# generate man pages

GENERATE_MAN           = NO

703 704
# 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
705 706 707 708
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

709
# The MAN_EXTENSION tag determines the extension that is added to
710 711 712 713
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

714 715 716 717
# 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
718 719 720 721 722 723 724 725
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

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

726 727
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
728 729 730
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
731 732 733

GENERATE_XML           = NO

734 735
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
736 737
# syntax of the XML files.

738
XML_SCHEMA             =
739

740 741
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
742 743
# syntax of the XML files.

744
XML_DTD                =
745 746 747 748 749

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

750 751 752 753
# 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
754 755 756 757 758 759 760 761
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

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

762 763 764 765
# 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
766 767 768 769
# moment.

GENERATE_PERLMOD       = NO

770 771
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
772 773 774 775
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

776 777 778 779
# 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
780 781 782 783
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

784 785 786
# 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
787 788
# Makefile don't overwrite each other's variables.

789
PERLMOD_MAKEVAR_PREFIX =
790 791

#---------------------------------------------------------------------------
792
# Configuration options related to the preprocessor
793 794
#---------------------------------------------------------------------------

795 796
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
797 798 799 800
# files.

ENABLE_PREPROCESSING   = YES

801 802 803
# 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
804 805 806 807
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = YES

808 809
# 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
810
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
811 812 813

EXPAND_ONLY_PREDEF     = YES

814
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
815 816 817 818
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

819 820
# 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
821 822
# the preprocessor.

823
INCLUDE_PATH           =
824

825 826 827
# 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
828 829
# be used.

830
INCLUDE_FILE_PATTERNS  =
831

832 833 834 835
# 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
836
# omitted =1 is assumed.
837

M
Michael Niedermayer 已提交
838
PREDEFINED             = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
D
Diego Biurrun 已提交
839
                         HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_AMD3DNOW \
840

841 842 843
# 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.
844 845 846
# Use the PREDEFINED tag if you want to use a different macro definition.

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

849 850 851
# 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
852 853
# function macros are typically used for boiler-plate code, and will confuse the
# parser if not removed.
854 855 856 857

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
858
# Configuration::addtions related to external references
859 860
#---------------------------------------------------------------------------

861
# The TAGFILES tag can be used to specify one or more tagfiles.
862

863
TAGFILES               =
864

865
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
866 867
# a tag file that is based on the input files it reads.

868
GENERATE_TAGFILE       =
869

870 871
# 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
872 873 874 875
# will be listed.

ALLEXTERNALS           = NO

876 877
# 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
878 879 880 881
# be listed.

EXTERNAL_GROUPS        = YES

882
# The PERL_PATH should be the absolute path and name of the perl script
883 884 885 886 887
# interpreter (i.e. the result of `which perl').

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------
888
# Configuration options related to the dot tool
889 890
#---------------------------------------------------------------------------

891
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
892 893 894 895
# 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 superceded by the HAVE_DOT option below. This is only a fallback. It is
# recommended to install and use dot, since it yield more powerful graphs.
896 897 898

CLASS_DIAGRAMS         = YES

899 900
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
901 902 903 904
# or is not a class.

HIDE_UNDOC_RELATIONS   = YES

905 906 907
# 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
908 909 910 911
# have no effect if this option is set to NO (the default)

HAVE_DOT               = NO

912 913 914
# 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
915 916 917 918
# the CLASS_DIAGRAMS tag to NO.

CLASS_GRAPH            = YES

919 920 921
# 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
922 923 924 925
# class references variables) of the class with other documented classes.

COLLABORATION_GRAPH    = YES

926
# If set to YES, the inheritance and collaboration graphs will show the
927 928 929 930
# relations between templates and their instances.

TEMPLATE_RELATIONS     = YES

931 932 933
# 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
934 935 936 937
# other documented files.

INCLUDE_GRAPH          = YES

938 939 940
# 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
941 942 943 944
# indirectly include this file.

INCLUDED_BY_GRAPH      = YES

945
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
946 947 948 949
# will graphical hierarchy of all classes instead of a textual one.

GRAPHICAL_HIERARCHY    = YES

950
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
951 952 953 954 955
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.

DOT_IMAGE_FORMAT       = png

956
# The tag DOT_PATH can be used to specify the path where the dot tool can be
957
# found. If left blank, it is assumed the dot tool can be found on the path.
958

959
DOT_PATH               =
960

961 962
# 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
963 964
# \dotfile command).

965
DOTFILE_DIRS           =
966

967 968 969 970 971
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
972

973
MAX_DOT_GRAPH_WIDTH    = 1024
974

975 976 977 978 979
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
980

981
MAX_DOT_GRAPH_HEIGHT   = 1024
982

983 984
# 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
985 986 987 988
# arrows in the dot generated graphs.

GENERATE_LEGEND        = YES

989
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
990
# remove the intermedate dot files that are used to generate
991 992 993 994 995
# the various graphs.

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------
996
# Configuration::addtions related to the search engine
997 998
#---------------------------------------------------------------------------

999
# The SEARCHENGINE tag specifies whether or not a search engine should be
1000 1001 1002
# used. If set to NO the values of all tags below this one will be ignored.

SEARCHENGINE           = NO
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037

# The CGI_NAME tag should be the name of the CGI script that
# starts the search engine (doxysearch) with the correct parameters.
# A script with this name will be generated by doxygen.

CGI_NAME               = search.cgi

# The CGI_URL tag should be the absolute URL to the directory where the
# cgi binaries are located. See the documentation of your http daemon for
# details.

CGI_URL                =

# The DOC_URL tag should be the absolute URL to the directory where the
# documentation is located. If left blank the absolute path to the
# documentation, with file:// prepended to it, will be used.

DOC_URL                =

# The DOC_ABSPATH tag should be the absolute path to the directory where the
# documentation is located. If left blank the directory on the local machine
# will be used.

DOC_ABSPATH            =

# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
# is installed.

BIN_ABSPATH            = /usr/local/bin/

# The EXT_DOC_PATHS tag can be used to specify one or more paths to
# documentation generated for other projects. This allows doxysearch to search
# the documentation for these projects as well.

EXT_DOC_PATHS          =