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