Fix previously broken x86_64 check, simplifying it in the process.
[libav.git] / Doxyfile
CommitLineData
3b8b687d
MN
1# Doxyfile 1.3-rc1
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#---------------------------------------------------------------------------
14# General configuration options
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
1260756d 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:
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,
3b8b687d
MN
42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
43
44OUTPUT_LANGUAGE = English
45
115329f1
DB
46# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47# documentation are documented, even if no documentation was available.
48# Private class members and static file members will be hidden unless
3b8b687d
MN
49# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
50
7b3da204 51EXTRACT_ALL = YES
3b8b687d 52
115329f1 53# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
3b8b687d
MN
54# will be included in the documentation.
55
56EXTRACT_PRIVATE = YES
57
115329f1 58# If the EXTRACT_STATIC tag is set to YES all static members of a file
3b8b687d
MN
59# will be included in the documentation.
60
61EXTRACT_STATIC = YES
62
115329f1
DB
63# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64# defined locally in source files will be included in the documentation.
3b8b687d
MN
65# If set to NO only classes defined in header files are included.
66
67EXTRACT_LOCAL_CLASSES = YES
68
115329f1
DB
69# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70# undocumented members of documented classes, files or namespaces.
71# If set to NO (the default) these members will be included in the
72# various overviews, but no documentation section is generated.
3b8b687d
MN
73# This option has no effect if EXTRACT_ALL is enabled.
74
75HIDE_UNDOC_MEMBERS = NO
76
115329f1
DB
77# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78# undocumented classes that are normally visible in the class hierarchy.
79# If set to NO (the default) these class will be included in the various
3b8b687d
MN
80# overviews. This option has no effect if EXTRACT_ALL is enabled.
81
82HIDE_UNDOC_CLASSES = NO
83
115329f1
DB
84# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
85# friend (class|struct|union) declarations.
86# If set to NO (the default) these declarations will be included in the
3b8b687d
MN
87# documentation.
88
89HIDE_FRIEND_COMPOUNDS = NO
90
115329f1
DB
91# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
92# documentation blocks found inside the body of a function.
93# If set to NO (the default) these blocks will be appended to the
3b8b687d
MN
94# function's detailed documentation block.
95
96HIDE_IN_BODY_DOCS = NO
97
115329f1
DB
98# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
99# include brief member descriptions after the members that are listed in
100# the file and class documentation (similar to JavaDoc).
3b8b687d
MN
101# Set to NO to disable this.
102
103BRIEF_MEMBER_DESC = YES
104
115329f1
DB
105# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
106# the brief description of a member or function before the detailed description.
107# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
3b8b687d
MN
108# brief descriptions will be completely suppressed.
109
110REPEAT_BRIEF = YES
111
115329f1
DB
112# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
113# Doxygen will generate a detailed section even if there is only a brief
3b8b687d
MN
114# description.
115
116ALWAYS_DETAILED_SEC = NO
117
115329f1
DB
118# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
119# members of a class in the documentation of that class as if those members were
120# ordinary class members. Constructors, destructors and assignment operators of
3b8b687d
MN
121# the base classes will not be shown.
122
123INLINE_INHERITED_MEMB = NO
124
115329f1
DB
125# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
126# path before files name in the file list and in the header files. If set
3b8b687d
MN
127# to NO the shortest path that makes the file name unique will be used.
128
1ab3d669 129FULL_PATH_NAMES = YES
3b8b687d 130
115329f1
DB
131# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132# can be used to strip a user defined part of the path. Stripping is
133# only done if one of the specified strings matches the left-hand part of
3b8b687d
MN
134# the path. It is allowed to use relative paths in the argument list.
135
1ab3d669 136STRIP_FROM_PATH = .
3b8b687d 137
115329f1
DB
138# The INTERNAL_DOCS tag determines if documentation
139# that is typed after a \internal command is included. If the tag is set
140# to NO (the default) then the documentation will be excluded.
3b8b687d
MN
141# Set it to YES to include the internal documentation.
142
143INTERNAL_DOCS = NO
144
115329f1
DB
145# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
146# file names in lower case letters. If set to YES upper case letters are also
147# allowed. This is useful if you have classes or files whose names only differ
148# in case and if your file system supports case sensitive file names. Windows
3b8b687d
MN
149# users are adviced to set this option to NO.
150
151CASE_SENSE_NAMES = YES
152
115329f1
DB
153# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
154# (but less readable) file names. This can be useful is your file systems
3b8b687d
MN
155# doesn't support long names like on DOS, Mac, or CD-ROM.
156
157SHORT_NAMES = NO
158
115329f1
DB
159# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
160# will show members with their full class and namespace scopes in the
3b8b687d
MN
161# documentation. If set to YES the scope will be hidden.
162
163HIDE_SCOPE_NAMES = NO
164
115329f1
DB
165# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
166# will generate a verbatim copy of the header file for each class for
3b8b687d
MN
167# which an include is specified. Set to NO to disable this.
168
169VERBATIM_HEADERS = YES
170
115329f1
DB
171# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
172# will put list of the files that are included by a file in the documentation
3b8b687d
MN
173# of that file.
174
175SHOW_INCLUDE_FILES = YES
176
115329f1
DB
177# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
178# will interpret the first line (until the first dot) of a JavaDoc-style
179# comment as the brief description. If set to NO, the JavaDoc
180# comments will behave just like the Qt-style comments (thus requiring an
3b8b687d
MN
181# explict @brief command for a brief description.
182
183JAVADOC_AUTOBRIEF = YES
184
115329f1
DB
185# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
186# treat a multi-line C++ special comment block (i.e. a block of //! or ///
187# comments) as a brief description. This used to be the default behaviour.
188# The new default is to treat a multi-line C++ comment block as a detailed
3b8b687d
MN
189# description. Set this tag to YES if you prefer the old behaviour instead.
190
191MULTILINE_CPP_IS_BRIEF = NO
192
115329f1 193# If the DETAILS_AT_TOP tag is set to YES then Doxygen
3b8b687d 194# will output the detailed description near the top, like JavaDoc.
115329f1 195# If set to NO, the detailed description appears after the member
3b8b687d
MN
196# documentation.
197
198DETAILS_AT_TOP = NO
199
115329f1
DB
200# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
201# member inherits the documentation from any documented member that it
3b8b687d
MN
202# reimplements.
203
204INHERIT_DOCS = YES
205
115329f1 206# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
3b8b687d
MN
207# is inserted in the documentation for inline members.
208
209INLINE_INFO = YES
210
115329f1
DB
211# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
212# will sort the (detailed) documentation of file and class members
213# alphabetically by member name. If set to NO the members will appear in
3b8b687d
MN
214# declaration order.
215
216SORT_MEMBER_DOCS = YES
217
115329f1
DB
218# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
219# tag is set to YES, then doxygen will reuse the documentation of the first
220# member in the group (if any) for the other members of the group. By default
3b8b687d
MN
221# all members of a group must be documented explicitly.
222
223DISTRIBUTE_GROUP_DOC = NO
224
115329f1 225# The TAB_SIZE tag can be used to set the number of spaces in a tab.
3b8b687d
MN
226# Doxygen uses this value to replace tabs by spaces in code fragments.
227
228TAB_SIZE = 8
229
115329f1
DB
230# The GENERATE_TODOLIST tag can be used to enable (YES) or
231# disable (NO) the todo list. This list is created by putting \todo
3b8b687d
MN
232# commands in the documentation.
233
234GENERATE_TODOLIST = YES
235
115329f1
DB
236# The GENERATE_TESTLIST tag can be used to enable (YES) or
237# disable (NO) the test list. This list is created by putting \test
3b8b687d
MN
238# commands in the documentation.
239
240GENERATE_TESTLIST = YES
241
115329f1
DB
242# The GENERATE_BUGLIST tag can be used to enable (YES) or
243# disable (NO) the bug list. This list is created by putting \bug
3b8b687d
MN
244# commands in the documentation.
245
246GENERATE_BUGLIST = YES
247
115329f1
DB
248# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
249# disable (NO) the deprecated list. This list is created by putting
3b8b687d
MN
250# \deprecated commands in the documentation.
251
252GENERATE_DEPRECATEDLIST= YES
253
115329f1
DB
254# This tag can be used to specify a number of aliases that acts
255# as commands in the documentation. An alias has the form "name=value".
256# For example adding "sideeffect=\par Side Effects:\n" will allow you to
257# put the command \sideeffect (or @sideeffect) in the documentation, which
258# will result in a user defined paragraph with heading "Side Effects:".
3b8b687d
MN
259# You can put \n's in the value part of an alias to insert newlines.
260
115329f1 261ALIASES =
3b8b687d 262
115329f1 263# The ENABLED_SECTIONS tag can be used to enable conditional
3b8b687d
MN
264# documentation sections, marked by \if sectionname ... \endif.
265
115329f1 266ENABLED_SECTIONS =
3b8b687d 267
115329f1
DB
268# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
269# the initial value of a variable or define consist of for it to appear in
270# the documentation. If the initializer consists of more lines than specified
271# here it will be hidden. Use a value of 0 to hide initializers completely.
272# The appearance of the initializer of individual variables and defines in the
273# documentation can be controlled using \showinitializer or \hideinitializer
3b8b687d
MN
274# command in the documentation regardless of this setting.
275
276MAX_INITIALIZER_LINES = 30
277
115329f1
DB
278# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
279# only. Doxygen will then generate output that is more tailored for C.
280# For instance some of the names that are used will be different. The list
3b8b687d
MN
281# of all members will be omitted, etc.
282
283OPTIMIZE_OUTPUT_FOR_C = YES
284
115329f1
DB
285# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
286# only. Doxygen will then generate output that is more tailored for Java.
287# For instance namespaces will be presented as packages, qualified scopes
3b8b687d
MN
288# will look different, etc.
289
290OPTIMIZE_OUTPUT_JAVA = NO
291
115329f1
DB
292# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
293# at the bottom of the documentation of classes and structs. If set to YES the
3b8b687d
MN
294# list will mention the files that were used to generate the documentation.
295
296SHOW_USED_FILES = YES
297
298#---------------------------------------------------------------------------
299# configuration options related to warning and progress messages
300#---------------------------------------------------------------------------
301
115329f1 302# The QUIET tag can be used to turn on/off the messages that are generated
3b8b687d
MN
303# by doxygen. Possible values are YES and NO. If left blank NO is used.
304
305QUIET = NO
306
115329f1
DB
307# The WARNINGS tag can be used to turn on/off the warning messages that are
308# generated by doxygen. Possible values are YES and NO. If left blank
3b8b687d
MN
309# NO is used.
310
311WARNINGS = YES
312
115329f1
DB
313# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
314# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
3b8b687d
MN
315# automatically be disabled.
316
317WARN_IF_UNDOCUMENTED = YES
318
115329f1
DB
319# The WARN_FORMAT tag determines the format of the warning messages that
320# doxygen can produce. The string should contain the $file, $line, and $text
321# tags, which will be replaced by the file and line number from which the
3b8b687d
MN
322# warning originated and the warning text.
323
324WARN_FORMAT = "$file:$line: $text"
325
115329f1
DB
326# The WARN_LOGFILE tag can be used to specify a file to which warning
327# and error messages should be written. If left blank the output is written
3b8b687d
MN
328# to stderr.
329
115329f1 330WARN_LOGFILE =
3b8b687d
MN
331
332#---------------------------------------------------------------------------
333# configuration options related to the input files
334#---------------------------------------------------------------------------
335
115329f1
DB
336# The INPUT tag can be used to specify the files and/or directories that contain
337# documented source files. You may enter file names like "myfile.cpp" or
338# directories like "/usr/src/myproject". Separate the files or directories
3b8b687d
MN
339# with spaces.
340
115329f1 341INPUT =
3b8b687d 342
115329f1
DB
343# If the value of the INPUT tag contains directories, you can use the
344# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
345# and *.h) to filter out the source-files in the directories. If left
346# blank the following patterns are tested:
347# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
3b8b687d
MN
348# *.h++ *.idl *.odl
349
115329f1 350FILE_PATTERNS =
3b8b687d 351
115329f1
DB
352# The RECURSIVE tag can be used to turn specify whether or not subdirectories
353# should be searched for input files as well. Possible values are YES and NO.
3b8b687d
MN
354# If left blank NO is used.
355
356RECURSIVE = YES
357
115329f1
DB
358# The EXCLUDE tag can be used to specify files and/or directories that should
359# excluded from the INPUT source files. This way you can easily exclude a
3b8b687d
MN
360# subdirectory from a directory tree whose root is specified with the INPUT tag.
361
115329f1 362EXCLUDE =
3b8b687d 363
115329f1 364# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
3b8b687d
MN
365# that are symbolic links (a Unix filesystem feature) are excluded from the input.
366
367EXCLUDE_SYMLINKS = NO
368
115329f1
DB
369# If the value of the INPUT tag contains directories, you can use the
370# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
3b8b687d
MN
371# certain files from those directories.
372
115329f1 373EXCLUDE_PATTERNS =
3b8b687d 374
115329f1
DB
375# The EXAMPLE_PATH tag can be used to specify one or more files or
376# directories that contain example code fragments that are included (see
3b8b687d
MN
377# the \include command).
378
115329f1 379EXAMPLE_PATH =
3b8b687d 380
115329f1
DB
381# If the value of the EXAMPLE_PATH tag contains directories, you can use the
382# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
383# and *.h) to filter out the source-files in the directories. If left
3b8b687d
MN
384# blank all files are included.
385
115329f1 386EXAMPLE_PATTERNS =
3b8b687d 387
115329f1
DB
388# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
389# searched for input files to be used with the \include or \dontinclude
390# commands irrespective of the value of the RECURSIVE tag.
3b8b687d
MN
391# Possible values are YES and NO. If left blank NO is used.
392
393EXAMPLE_RECURSIVE = NO
394
115329f1
DB
395# The IMAGE_PATH tag can be used to specify one or more files or
396# directories that contain image that are included in the documentation (see
3b8b687d
MN
397# the \image command).
398
115329f1 399IMAGE_PATH =
3b8b687d 400
115329f1
DB
401# The INPUT_FILTER tag can be used to specify a program that doxygen should
402# invoke to filter for each input file. Doxygen will invoke the filter program
403# by executing (via popen()) the command <filter> <input-file>, where <filter>
404# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
405# input file. Doxygen will then use the output that the filter program writes
3b8b687d
MN
406# to standard output.
407
115329f1 408INPUT_FILTER =
3b8b687d 409
115329f1
DB
410# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
411# INPUT_FILTER) will be used to filter the input files when producing source
3b8b687d
MN
412# files to browse (i.e. when SOURCE_BROWSER is set to YES).
413
414FILTER_SOURCE_FILES = NO
415
416#---------------------------------------------------------------------------
417# configuration options related to source browsing
418#---------------------------------------------------------------------------
419
115329f1 420# If the SOURCE_BROWSER tag is set to YES then a list of source files will
3b8b687d
MN
421# be generated. Documented entities will be cross-referenced with these sources.
422
423SOURCE_BROWSER = YES
424
115329f1 425# Setting the INLINE_SOURCES tag to YES will include the body
3b8b687d
MN
426# of functions and classes directly in the documentation.
427
428INLINE_SOURCES = NO
429
115329f1
DB
430# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
431# doxygen to hide any special comment blocks from generated source code
3b8b687d
MN
432# fragments. Normal C and C++ comments will always remain visible.
433
434STRIP_CODE_COMMENTS = YES
435
115329f1
DB
436# If the REFERENCED_BY_RELATION tag is set to YES (the default)
437# then for each documented function all documented
3b8b687d
MN
438# functions referencing it will be listed.
439
440REFERENCED_BY_RELATION = YES
441
115329f1
DB
442# If the REFERENCES_RELATION tag is set to YES (the default)
443# then for each documented function all documented entities
3b8b687d
MN
444# called/used by that function will be listed.
445
7b3da204 446REFERENCES_RELATION = NO
3b8b687d
MN
447
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
115329f1
DB
504# The HTML_STYLESHEET tag can be used to specify a user defined cascading
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
3b8b687d
MN
507# will generate a default style sheet
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
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
3b8b687d
MN
527# written to the html output dir.
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
533# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
3b8b687d
MN
534# the html help compiler on the generated index.hhp.
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
3b8b687d
MN
551# to the contents of the Html help documentation and to the tree view.
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
566# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
115329f1
DB
567# 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# 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.
3b8b687d
MN
572# Windows users are probably better off using the HTML help feature.
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
DB
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
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
728# the code including all documentation. Note that this
729# feature is still experimental and incomplete at the
3b8b687d
MN
730# moment.
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
3b8b687d
MN
810# PREDEFINED and EXPAND_AS_PREDEFINED tags.
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
3b8b687d
MN
836# omitted =1 is assumed.
837
c545ddca 838PREDEFINED = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
a88fc5c0 839 HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_3DNOW \
161fe66e 840 ATTR_ALIGN(x)=""
3b8b687d 841
115329f1
DB
842# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
843# this tag can be used to specify a list of macro names that should be expanded.
844# The macro definition that is found in the sources will be used.
3b8b687d
MN
845# Use the PREDEFINED tag if you want to use a different macro definition.
846
847#EXPAND_AS_DEFINED = FF_COMMON_FRAME
c545ddca 848EXPAND_AS_DEFINED = declare_idct(idct, table, idct_row_head, idct_row, idct_row_tail, idct_row_mid)
3b8b687d 849
115329f1
DB
850# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
851# doxygen's preprocessor will remove all function-like macros that are alone
852# on a line, have an all uppercase name, and do not end with a semicolon. Such
853# function macros are typically used for boiler-plate code, and will confuse the
3b8b687d
MN
854# parser if not removed.
855
856SKIP_FUNCTION_MACROS = YES
857
858#---------------------------------------------------------------------------
115329f1 859# Configuration::addtions related to external references
3b8b687d
MN
860#---------------------------------------------------------------------------
861
862# The TAGFILES tag can be used to specify one or more tagfiles.
863
115329f1 864TAGFILES =
3b8b687d 865
115329f1 866# When a file name is specified after GENERATE_TAGFILE, doxygen will create
3b8b687d
MN
867# a tag file that is based on the input files it reads.
868
115329f1 869GENERATE_TAGFILE =
3b8b687d 870
115329f1
DB
871# If the ALLEXTERNALS tag is set to YES all external classes will be listed
872# in the class index. If set to NO only the inherited external classes
3b8b687d
MN
873# will be listed.
874
875ALLEXTERNALS = NO
876
115329f1
DB
877# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
878# in the modules index. If set to NO, only the current project's groups will
3b8b687d
MN
879# be listed.
880
881EXTERNAL_GROUPS = YES
882
115329f1 883# The PERL_PATH should be the absolute path and name of the perl script
3b8b687d
MN
884# interpreter (i.e. the result of `which perl').
885
886PERL_PATH = /usr/bin/perl
887
888#---------------------------------------------------------------------------
115329f1 889# Configuration options related to the dot tool
3b8b687d
MN
890#---------------------------------------------------------------------------
891
115329f1
DB
892# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
893# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
894# super classes. Setting the tag to NO turns the diagrams off. Note that this
895# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
3b8b687d
MN
896# recommended to install and use dot, since it yield more powerful graphs.
897
898CLASS_DIAGRAMS = YES
899
115329f1
DB
900# If set to YES, the inheritance and collaboration graphs will hide
901# inheritance and usage relations if the target is undocumented
3b8b687d
MN
902# or is not a class.
903
904HIDE_UNDOC_RELATIONS = YES
905
115329f1
DB
906# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
907# available from the path. This tool is part of Graphviz, a graph visualization
908# toolkit from AT&T and Lucent Bell Labs. The other options in this section
3b8b687d
MN
909# have no effect if this option is set to NO (the default)
910
911HAVE_DOT = NO
912
115329f1
DB
913# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
914# will generate a graph for each documented class showing the direct and
915# indirect inheritance relations. Setting this tag to YES will force the
3b8b687d
MN
916# the CLASS_DIAGRAMS tag to NO.
917
918CLASS_GRAPH = YES
919
115329f1
DB
920# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
921# will generate a graph for each documented class showing the direct and
922# indirect implementation dependencies (inheritance, containment, and
3b8b687d
MN
923# class references variables) of the class with other documented classes.
924
925COLLABORATION_GRAPH = YES
926
115329f1 927# If set to YES, the inheritance and collaboration graphs will show the
3b8b687d
MN
928# relations between templates and their instances.
929
930TEMPLATE_RELATIONS = YES
931
115329f1
DB
932# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
933# tags are set to YES then doxygen will generate a graph for each documented
934# file showing the direct and indirect include dependencies of the file with
3b8b687d
MN
935# other documented files.
936
937INCLUDE_GRAPH = YES
938
115329f1
DB
939# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
940# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
941# documented header file showing the documented files that directly or
3b8b687d
MN
942# indirectly include this file.
943
944INCLUDED_BY_GRAPH = YES
945
115329f1 946# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
3b8b687d
MN
947# will graphical hierarchy of all classes instead of a textual one.
948
949GRAPHICAL_HIERARCHY = YES
950
115329f1 951# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
3b8b687d
MN
952# generated by dot. Possible values are png, jpg, or gif
953# If left blank png will be used.
954
955DOT_IMAGE_FORMAT = png
956
115329f1 957# The tag DOT_PATH can be used to specify the path where the dot tool can be
3b8b687d
MN
958# found. If left blank, it is assumed the dot tool can be found on the path.
959
115329f1 960DOT_PATH =
3b8b687d 961
115329f1
DB
962# The DOTFILE_DIRS tag can be used to specify one or more directories that
963# contain dot files that are included in the documentation (see the
3b8b687d
MN
964# \dotfile command).
965
115329f1 966DOTFILE_DIRS =
3b8b687d 967
115329f1
DB
968# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
969# (in pixels) of the graphs generated by dot. If a graph becomes larger than
970# this value, doxygen will try to truncate the graph, so that it fits within
971# the specified constraint. Beware that most browsers cannot cope with very
3b8b687d
MN
972# large images.
973
974MAX_DOT_GRAPH_WIDTH = 1024
975
115329f1
DB
976# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
977# (in pixels) of the graphs generated by dot. If a graph becomes larger than
978# this value, doxygen will try to truncate the graph, so that it fits within
979# the specified constraint. Beware that most browsers cannot cope with very
3b8b687d
MN
980# large images.
981
982MAX_DOT_GRAPH_HEIGHT = 1024
983
115329f1
DB
984# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
985# generate a legend page explaining the meaning of the various boxes and
3b8b687d
MN
986# arrows in the dot generated graphs.
987
988GENERATE_LEGEND = YES
989
115329f1
DB
990# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
991# remove the intermedate dot files that are used to generate
3b8b687d
MN
992# the various graphs.
993
994DOT_CLEANUP = YES
995
996#---------------------------------------------------------------------------
115329f1 997# Configuration::addtions related to the search engine
3b8b687d
MN
998#---------------------------------------------------------------------------
999
115329f1 1000# The SEARCHENGINE tag specifies whether or not a search engine should be
3b8b687d
MN
1001# used. If set to NO the values of all tags below this one will be ignored.
1002
1003SEARCHENGINE = NO
1004
115329f1
DB
1005# The CGI_NAME tag should be the name of the CGI script that
1006# starts the search engine (doxysearch) with the correct parameters.
3b8b687d
MN
1007# A script with this name will be generated by doxygen.
1008
1009CGI_NAME = search.cgi
1010
115329f1
DB
1011# The CGI_URL tag should be the absolute URL to the directory where the
1012# cgi binaries are located. See the documentation of your http daemon for
3b8b687d
MN
1013# details.
1014
115329f1 1015CGI_URL =
3b8b687d 1016
115329f1
DB
1017# The DOC_URL tag should be the absolute URL to the directory where the
1018# documentation is located. If left blank the absolute path to the
3b8b687d
MN
1019# documentation, with file:// prepended to it, will be used.
1020
115329f1 1021DOC_URL =
3b8b687d 1022
115329f1
DB
1023# The DOC_ABSPATH tag should be the absolute path to the directory where the
1024# documentation is located. If left blank the directory on the local machine
3b8b687d
MN
1025# will be used.
1026
115329f1 1027DOC_ABSPATH =
3b8b687d 1028
115329f1 1029# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
3b8b687d
MN
1030# is installed.
1031
1032BIN_ABSPATH = /usr/local/bin/
1033
115329f1
DB
1034# The EXT_DOC_PATHS tag can be used to specify one or more paths to
1035# documentation generated for other projects. This allows doxysearch to search
3b8b687d
MN
1036# the documentation for these projects as well.
1037
115329f1 1038EXT_DOC_PATHS =