rtsp: Move the definition of SDP_MAX_SIZE up, use it in the RTSP muxer, too
[libav.git] / Doxyfile
CommitLineData
ac7a4056 1# Doxyfile 1.5.6
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#---------------------------------------------------------------------------
ac7a4056 14# Project related configuration options
3b8b687d
MN
15#---------------------------------------------------------------------------
16
ac7a4056
DB
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
115329f1 25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
3b8b687d
MN
26# by quotes) that should identify the project.
27
f2ed1a41 28PROJECT_NAME = FFmpeg
3b8b687d 29
115329f1
DB
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
3b8b687d
MN
32# if some version control system is used.
33
115329f1 34PROJECT_NUMBER =
3b8b687d 35
115329f1
DB
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
3b8b687d
MN
39# where doxygen was started. If left blank the current directory will be used.
40
41OUTPUT_DIRECTORY = doxy
42
ac7a4056
DB
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS = NO
51
115329f1
DB
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
ac7a4056
DB
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61# and Ukrainian.
3b8b687d
MN
62
63OUTPUT_LANGUAGE = English
64
18bb522b
DB
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
ac7a4056
DB
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
89ABBREVIATE_BRIEF =
90
18bb522b
DB
91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92# Doxygen will generate a detailed section even if there is only a brief
93# description.
94
95ALWAYS_DETAILED_SEC = NO
96
f31abc6c
DB
97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98# inherited members of a class in the documentation of that class as if those
99# members were ordinary class members. Constructors, destructors and assignment
100# operators of the base classes will not be shown.
18bb522b
DB
101
102INLINE_INHERITED_MEMB = NO
103
104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105# path before files name in the file list and in the header files. If set
106# to NO the shortest path that makes the file name unique will be used.
107
108FULL_PATH_NAMES = YES
109
110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
f31abc6c 111# can be used to strip a user-defined part of the path. Stripping is
18bb522b 112# only done if one of the specified strings matches the left-hand part of
ac7a4056
DB
113# the path. The tag can be used to show relative paths in the file list.
114# If left blank the directory from which doxygen is run is used as the
115# path to strip.
18bb522b
DB
116
117STRIP_FROM_PATH = .
118
ac7a4056
DB
119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120# the path mentioned in the documentation of a class, which tells
121# the reader which header file to include in order to use a class.
122# If left blank only the name of the header file containing the class
123# definition is used. Otherwise one should specify the include paths that
124# are normally passed to the compiler using the -I flag.
125
126STRIP_FROM_INC_PATH =
127
18bb522b
DB
128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129# (but less readable) file names. This can be useful is your file systems
130# doesn't support long names like on DOS, Mac, or CD-ROM.
131
132SHORT_NAMES = NO
133
134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135# will interpret the first line (until the first dot) of a JavaDoc-style
136# comment as the brief description. If set to NO, the JavaDoc
f31abc6c
DB
137# comments will behave just like regular Qt-style comments
138# (thus requiring an explicit @brief command for a brief description.)
18bb522b
DB
139
140JAVADOC_AUTOBRIEF = YES
141
ac7a4056
DB
142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143# interpret the first line (until the first dot) of a Qt-style
144# comment as the brief description. If set to NO, the comments
145# will behave just like regular Qt-style comments (thus requiring
146# an explicit \brief command for a brief description.)
147
148QT_AUTOBRIEF = NO
149
18bb522b
DB
150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152# comments) as a brief description. This used to be the default behaviour.
153# The new default is to treat a multi-line C++ comment block as a detailed
154# description. Set this tag to YES if you prefer the old behaviour instead.
155
156MULTILINE_CPP_IS_BRIEF = NO
157
158# If the DETAILS_AT_TOP tag is set to YES then Doxygen
159# will output the detailed description near the top, like JavaDoc.
160# If set to NO, the detailed description appears after the member
161# documentation.
162
163DETAILS_AT_TOP = NO
164
165# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166# member inherits the documentation from any documented member that it
f31abc6c 167# re-implements.
18bb522b
DB
168
169INHERIT_DOCS = YES
170
ac7a4056
DB
171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172# a new page for each member. If set to NO, the documentation of a member will
173# be part of the file/class/namespace that contains it.
174
175SEPARATE_MEMBER_PAGES = NO
176
18bb522b
DB
177# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178# Doxygen uses this value to replace tabs by spaces in code fragments.
179
180TAB_SIZE = 8
181
182# This tag can be used to specify a number of aliases that acts
183# as commands in the documentation. An alias has the form "name=value".
184# For example adding "sideeffect=\par Side Effects:\n" will allow you to
185# put the command \sideeffect (or @sideeffect) in the documentation, which
f31abc6c 186# will result in a user-defined paragraph with heading "Side Effects:".
18bb522b
DB
187# You can put \n's in the value part of an alias to insert newlines.
188
189ALIASES =
190
f31abc6c
DB
191# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192# sources only. Doxygen will then generate output that is more tailored for C.
193# For instance, some of the names that are used will be different. The list
18bb522b
DB
194# of all members will be omitted, etc.
195
196OPTIMIZE_OUTPUT_FOR_C = YES
197
f31abc6c
DB
198# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199# sources only. Doxygen will then generate output that is more tailored for
200# Java. For instance, namespaces will be presented as packages, qualified
201# scopes will look different, etc.
18bb522b
DB
202
203OPTIMIZE_OUTPUT_JAVA = NO
204
ac7a4056
DB
205# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206# sources only. Doxygen will then generate output that is more tailored for
207# Fortran.
208
209OPTIMIZE_FOR_FORTRAN = NO
210
211# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212# sources. Doxygen will then generate output that is tailored for
213# VHDL.
214
215OPTIMIZE_OUTPUT_VHDL = NO
216
217# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218# to include (a tag file for) the STL sources as input, then you should
219# set this tag to YES in order to let doxygen match functions declarations and
220# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221# func(std::string) {}). This also make the inheritance and collaboration
222# diagrams that involve STL classes more complete and accurate.
223
224BUILTIN_STL_SUPPORT = NO
225
226# If you use Microsoft's C++/CLI language, you should set this option to YES to
227# enable parsing support.
228
229CPP_CLI_SUPPORT = NO
230
231# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232# Doxygen will parse them like normal C++ but will assume all classes use public
233# instead of private inheritance when no explicit protection keyword is present.
234
235SIP_SUPPORT = NO
236
237# For Microsoft's IDL there are propget and propput attributes to indicate getter
238# and setter methods for a property. Setting this option to YES (the default)
239# will make doxygen to replace the get and set methods by a property in the
240# documentation. This will only work if the methods are indeed getting or
241# setting a simple type. If this is not the case, or you want to show the
242# methods anyway, you should set this option to NO.
243
244IDL_PROPERTY_SUPPORT = YES
245
246# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
247# tag is set to YES, then doxygen will reuse the documentation of the first
248# member in the group (if any) for the other members of the group. By default
249# all members of a group must be documented explicitly.
250
251DISTRIBUTE_GROUP_DOC = NO
252
253# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
254# the same type (for instance a group of public functions) to be put as a
255# subgroup of that type (e.g. under the Public Functions section). Set it to
256# NO to prevent subgrouping. Alternatively, this can be done per class using
257# the \nosubgrouping command.
258
259SUBGROUPING = YES
260
261# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
262# is documented as struct, union, or enum with the name of the typedef. So
263# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
264# with name TypeT. When disabled the typedef will appear as a member of a file,
265# namespace, or class. And the struct will be named TypeS. This can typically
266# be useful for C code in case the coding convention dictates that all compound
267# types are typedef'ed and only the typedef is referenced, never the tag name.
268
269TYPEDEF_HIDES_STRUCT = NO
270
271#---------------------------------------------------------------------------
272# Build related configuration options
273#---------------------------------------------------------------------------
274
115329f1
DB
275# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
276# documentation are documented, even if no documentation was available.
277# Private class members and static file members will be hidden unless
3b8b687d
MN
278# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
279
7b3da204 280EXTRACT_ALL = YES
3b8b687d 281
115329f1 282# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
3b8b687d
MN
283# will be included in the documentation.
284
285EXTRACT_PRIVATE = YES
286
115329f1 287# If the EXTRACT_STATIC tag is set to YES all static members of a file
3b8b687d
MN
288# will be included in the documentation.
289
290EXTRACT_STATIC = YES
291
115329f1
DB
292# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
293# defined locally in source files will be included in the documentation.
3b8b687d
MN
294# If set to NO only classes defined in header files are included.
295
296EXTRACT_LOCAL_CLASSES = YES
297
ac7a4056
DB
298# This flag is only useful for Objective-C code. When set to YES local
299# methods, which are defined in the implementation section but not in
300# the interface are included in the documentation.
301# If set to NO (the default) only methods in the interface are included.
302
303EXTRACT_LOCAL_METHODS = NO
304
305# If this flag is set to YES, the members of anonymous namespaces will be
306# extracted and appear in the documentation as a namespace called
307# 'anonymous_namespace{file}', where file will be replaced with the base
308# name of the file that contains the anonymous namespace. By default
309# anonymous namespace are hidden.
310
311EXTRACT_ANON_NSPACES = NO
312
115329f1
DB
313# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
314# undocumented members of documented classes, files or namespaces.
315# If set to NO (the default) these members will be included in the
316# various overviews, but no documentation section is generated.
3b8b687d
MN
317# This option has no effect if EXTRACT_ALL is enabled.
318
319HIDE_UNDOC_MEMBERS = NO
320
115329f1
DB
321# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
322# undocumented classes that are normally visible in the class hierarchy.
f31abc6c 323# If set to NO (the default) these classes will be included in the various
3b8b687d
MN
324# overviews. This option has no effect if EXTRACT_ALL is enabled.
325
326HIDE_UNDOC_CLASSES = NO
327
115329f1
DB
328# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
329# friend (class|struct|union) declarations.
330# If set to NO (the default) these declarations will be included in the
3b8b687d
MN
331# documentation.
332
333HIDE_FRIEND_COMPOUNDS = NO
334
115329f1
DB
335# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
336# documentation blocks found inside the body of a function.
337# If set to NO (the default) these blocks will be appended to the
3b8b687d
MN
338# function's detailed documentation block.
339
340HIDE_IN_BODY_DOCS = NO
341
115329f1
DB
342# The INTERNAL_DOCS tag determines if documentation
343# that is typed after a \internal command is included. If the tag is set
344# to NO (the default) then the documentation will be excluded.
3b8b687d
MN
345# Set it to YES to include the internal documentation.
346
347INTERNAL_DOCS = NO
348
115329f1 349# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
f31abc6c 350# file names in lower-case letters. If set to YES upper-case letters are also
115329f1
DB
351# allowed. This is useful if you have classes or files whose names only differ
352# in case and if your file system supports case sensitive file names. Windows
ac7a4056 353# and Mac users are advised to set this option to NO.
3b8b687d
MN
354
355CASE_SENSE_NAMES = YES
356
115329f1
DB
357# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
358# will show members with their full class and namespace scopes in the
3b8b687d
MN
359# documentation. If set to YES the scope will be hidden.
360
361HIDE_SCOPE_NAMES = NO
362
115329f1 363# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
f31abc6c 364# will put a list of the files that are included by a file in the documentation
3b8b687d
MN
365# of that file.
366
367SHOW_INCLUDE_FILES = YES
368
115329f1 369# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
3b8b687d
MN
370# is inserted in the documentation for inline members.
371
372INLINE_INFO = YES
373
115329f1
DB
374# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
375# will sort the (detailed) documentation of file and class members
376# alphabetically by member name. If set to NO the members will appear in
3b8b687d
MN
377# declaration order.
378
379SORT_MEMBER_DOCS = YES
380
ac7a4056
DB
381# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
382# brief documentation of file, namespace and class members alphabetically
383# by member name. If set to NO (the default) the members will appear in
384# declaration order.
3b8b687d 385
ac7a4056
DB
386SORT_BRIEF_DOCS = NO
387
388# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
389# hierarchy of group names into alphabetical order. If set to NO (the default)
390# the group names will appear in their defined order.
391
392SORT_GROUP_NAMES = NO
393
394# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
395# sorted by fully-qualified names, including namespaces. If set to
396# NO (the default), the class list will be sorted only by class name,
397# not including the namespace part.
398# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
399# Note: This option applies only to the class list, not to the
400# alphabetical list.
401
402SORT_BY_SCOPE_NAME = NO
d7650484 403
115329f1
DB
404# The GENERATE_TODOLIST tag can be used to enable (YES) or
405# disable (NO) the todo list. This list is created by putting \todo
3b8b687d
MN
406# commands in the documentation.
407
408GENERATE_TODOLIST = YES
409
115329f1
DB
410# The GENERATE_TESTLIST tag can be used to enable (YES) or
411# disable (NO) the test list. This list is created by putting \test
3b8b687d
MN
412# commands in the documentation.
413
414GENERATE_TESTLIST = YES
415
115329f1
DB
416# The GENERATE_BUGLIST tag can be used to enable (YES) or
417# disable (NO) the bug list. This list is created by putting \bug
3b8b687d
MN
418# commands in the documentation.
419
420GENERATE_BUGLIST = YES
421
115329f1
DB
422# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
423# disable (NO) the deprecated list. This list is created by putting
3b8b687d
MN
424# \deprecated commands in the documentation.
425
426GENERATE_DEPRECATEDLIST= YES
427
115329f1 428# The ENABLED_SECTIONS tag can be used to enable conditional
3b8b687d
MN
429# documentation sections, marked by \if sectionname ... \endif.
430
115329f1 431ENABLED_SECTIONS =
3b8b687d 432
115329f1 433# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
f31abc6c 434# the initial value of a variable or define consists of for it to appear in
115329f1
DB
435# the documentation. If the initializer consists of more lines than specified
436# here it will be hidden. Use a value of 0 to hide initializers completely.
437# The appearance of the initializer of individual variables and defines in the
438# documentation can be controlled using \showinitializer or \hideinitializer
3b8b687d
MN
439# command in the documentation regardless of this setting.
440
441MAX_INITIALIZER_LINES = 30
442
157b7d0c
DB
443# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
444# at the bottom of the documentation of classes and structs. If set to YES the
445# list will mention the files that were used to generate the documentation.
d7650484 446
157b7d0c 447SHOW_USED_FILES = YES
d7650484 448
ac7a4056
DB
449# If the sources in your project are distributed over multiple directories
450# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
451# in the documentation. The default is NO.
452
453SHOW_DIRECTORIES = NO
454
455# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
456# This will remove the Files entry from the Quick Index and from the
457# Folder Tree View (if specified). The default is YES.
458
459SHOW_FILES = YES
460
461# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
462# Namespaces page. This will remove the Namespaces entry from the Quick Index
463# and from the Folder Tree View (if specified). The default is YES.
464
465SHOW_NAMESPACES = YES
466
467# The FILE_VERSION_FILTER tag can be used to specify a program or script that
468# doxygen should invoke to get the current version for each file (typically from
469# the version control system). Doxygen will invoke the program by executing (via
470# popen()) the command <command> <input-file>, where <command> is the value of
471# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
472# provided by doxygen. Whatever the program writes to standard output
473# is used as the file version. See the manual for examples.
474
475FILE_VERSION_FILTER =
476
3b8b687d
MN
477#---------------------------------------------------------------------------
478# configuration options related to warning and progress messages
479#---------------------------------------------------------------------------
480
115329f1 481# The QUIET tag can be used to turn on/off the messages that are generated
3b8b687d
MN
482# by doxygen. Possible values are YES and NO. If left blank NO is used.
483
655a29e7 484QUIET = YES
3b8b687d 485
115329f1
DB
486# The WARNINGS tag can be used to turn on/off the warning messages that are
487# generated by doxygen. Possible values are YES and NO. If left blank
3b8b687d
MN
488# NO is used.
489
490WARNINGS = YES
491
115329f1
DB
492# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
493# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
3b8b687d
MN
494# automatically be disabled.
495
496WARN_IF_UNDOCUMENTED = YES
497
ac7a4056
DB
498# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
499# potential errors in the documentation, such as not documenting some
500# parameters in a documented function, or documenting parameters that
501# don't exist or using markup commands wrongly.
502
503WARN_IF_DOC_ERROR = YES
504
505# This WARN_NO_PARAMDOC option can be abled to get warnings for
506# functions that are documented, but have no documentation for their parameters
507# or return value. If set to NO (the default) doxygen will only warn about
508# wrong or incomplete parameter documentation, but not about the absence of
509# documentation.
510
511WARN_NO_PARAMDOC = NO
512
115329f1
DB
513# The WARN_FORMAT tag determines the format of the warning messages that
514# doxygen can produce. The string should contain the $file, $line, and $text
515# tags, which will be replaced by the file and line number from which the
ac7a4056
DB
516# warning originated and the warning text. Optionally the format may contain
517# $version, which will be replaced by the version of the file (if it could
518# be obtained via FILE_VERSION_FILTER)
3b8b687d
MN
519
520WARN_FORMAT = "$file:$line: $text"
521
115329f1
DB
522# The WARN_LOGFILE tag can be used to specify a file to which warning
523# and error messages should be written. If left blank the output is written
3b8b687d
MN
524# to stderr.
525
115329f1 526WARN_LOGFILE =
3b8b687d
MN
527
528#---------------------------------------------------------------------------
529# configuration options related to the input files
530#---------------------------------------------------------------------------
531
115329f1
DB
532# The INPUT tag can be used to specify the files and/or directories that contain
533# documented source files. You may enter file names like "myfile.cpp" or
534# directories like "/usr/src/myproject". Separate the files or directories
3b8b687d
MN
535# with spaces.
536
115329f1 537INPUT =
3b8b687d 538
ac7a4056
DB
539# This tag can be used to specify the character encoding of the source files
540# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
541# also the default input encoding. Doxygen uses libiconv (or the iconv built
542# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
543# the list of possible encodings.
544
545INPUT_ENCODING = UTF-8
546
115329f1
DB
547# If the value of the INPUT tag contains directories, you can use the
548# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
549# and *.h) to filter out the source-files in the directories. If left
550# blank the following patterns are tested:
ac7a4056
DB
551# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
552# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
3b8b687d 553
115329f1 554FILE_PATTERNS =
3b8b687d 555
115329f1
DB
556# The RECURSIVE tag can be used to turn specify whether or not subdirectories
557# should be searched for input files as well. Possible values are YES and NO.
3b8b687d
MN
558# If left blank NO is used.
559
560RECURSIVE = YES
561
115329f1
DB
562# The EXCLUDE tag can be used to specify files and/or directories that should
563# excluded from the INPUT source files. This way you can easily exclude a
3b8b687d
MN
564# subdirectory from a directory tree whose root is specified with the INPUT tag.
565
115329f1 566EXCLUDE =
3b8b687d 567
f31abc6c
DB
568# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
569# directories that are symbolic links (a Unix filesystem feature) are excluded
570# from the input.
3b8b687d
MN
571
572EXCLUDE_SYMLINKS = NO
573
115329f1
DB
574# If the value of the INPUT tag contains directories, you can use the
575# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
ac7a4056
DB
576# certain files from those directories. Note that the wildcards are matched
577# against the file with absolute path, so to exclude all test directories
578# for example use the pattern */test/*
3b8b687d 579
ad9eff3f 580EXCLUDE_PATTERNS = *.svn *.git *.d
3b8b687d 581
ac7a4056
DB
582# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
583# (namespaces, classes, functions, etc.) that should be excluded from the
584# output. The symbol name can be a fully qualified name, a word, or if the
585# wildcard * is used, a substring. Examples: ANamespace, AClass,
586# AClass::ANamespace, ANamespace::*Test
587
588EXCLUDE_SYMBOLS =
589
115329f1
DB
590# The EXAMPLE_PATH tag can be used to specify one or more files or
591# directories that contain example code fragments that are included (see
3b8b687d
MN
592# the \include command).
593
115329f1 594EXAMPLE_PATH =
3b8b687d 595
115329f1
DB
596# If the value of the EXAMPLE_PATH tag contains directories, you can use the
597# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
598# and *.h) to filter out the source-files in the directories. If left
3b8b687d
MN
599# blank all files are included.
600
115329f1 601EXAMPLE_PATTERNS =
3b8b687d 602
115329f1
DB
603# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
604# searched for input files to be used with the \include or \dontinclude
605# commands irrespective of the value of the RECURSIVE tag.
3b8b687d
MN
606# Possible values are YES and NO. If left blank NO is used.
607
608EXAMPLE_RECURSIVE = NO
609
115329f1
DB
610# The IMAGE_PATH tag can be used to specify one or more files or
611# directories that contain image that are included in the documentation (see
3b8b687d
MN
612# the \image command).
613
115329f1 614IMAGE_PATH =
3b8b687d 615
115329f1
DB
616# The INPUT_FILTER tag can be used to specify a program that doxygen should
617# invoke to filter for each input file. Doxygen will invoke the filter program
618# by executing (via popen()) the command <filter> <input-file>, where <filter>
619# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
620# input file. Doxygen will then use the output that the filter program writes
ac7a4056
DB
621# to standard output. If FILTER_PATTERNS is specified, this tag will be
622# ignored.
3b8b687d 623
115329f1 624INPUT_FILTER =
3b8b687d 625
ac7a4056
DB
626# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
627# basis. Doxygen will compare the file name with each pattern and apply the
628# filter if there is a match. The filters are a list of the form:
629# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
630# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
631# is applied to all files.
632
633FILTER_PATTERNS =
634
115329f1
DB
635# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
636# INPUT_FILTER) will be used to filter the input files when producing source
3b8b687d
MN
637# files to browse (i.e. when SOURCE_BROWSER is set to YES).
638
639FILTER_SOURCE_FILES = NO
640
641#---------------------------------------------------------------------------
642# configuration options related to source browsing
643#---------------------------------------------------------------------------
644
115329f1 645# If the SOURCE_BROWSER tag is set to YES then a list of source files will
3b8b687d 646# be generated. Documented entities will be cross-referenced with these sources.
ac7a4056
DB
647# Note: To get rid of all source code in the generated output, make sure also
648# VERBATIM_HEADERS is set to NO.
3b8b687d
MN
649
650SOURCE_BROWSER = YES
651
115329f1 652# Setting the INLINE_SOURCES tag to YES will include the body
3b8b687d
MN
653# of functions and classes directly in the documentation.
654
655INLINE_SOURCES = NO
656
115329f1
DB
657# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
658# doxygen to hide any special comment blocks from generated source code
3b8b687d
MN
659# fragments. Normal C and C++ comments will always remain visible.
660
661STRIP_CODE_COMMENTS = YES
662
ac7a4056 663# If the REFERENCED_BY_RELATION tag is set to YES
115329f1 664# then for each documented function all documented
3b8b687d
MN
665# functions referencing it will be listed.
666
667REFERENCED_BY_RELATION = YES
668
ac7a4056 669# If the REFERENCES_RELATION tag is set to YES
115329f1 670# then for each documented function all documented entities
3b8b687d
MN
671# called/used by that function will be listed.
672
7b3da204 673REFERENCES_RELATION = NO
3b8b687d 674
ac7a4056
DB
675# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
676# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
677# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
678# link to the source code. Otherwise they will link to the documentstion.
679
680REFERENCES_LINK_SOURCE = YES
681
682# If the USE_HTAGS tag is set to YES then the references to source code
683# will point to the HTML generated by the htags(1) tool instead of doxygen
684# built-in source browser. The htags tool is part of GNU's global source
685# tagging system (see http://www.gnu.org/software/global/global.html). You
686# will need version 4.8.6 or higher.
687
688USE_HTAGS = NO
689
18bb522b
DB
690# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
691# will generate a verbatim copy of the header file for each class for
692# which an include is specified. Set to NO to disable this.
693
694VERBATIM_HEADERS = YES
695
3b8b687d
MN
696#---------------------------------------------------------------------------
697# configuration options related to the alphabetical class index
698#---------------------------------------------------------------------------
699
115329f1
DB
700# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
701# of all compounds will be generated. Enable this if the project
3b8b687d
MN
702# contains a lot of classes, structs, unions or interfaces.
703
704ALPHABETICAL_INDEX = YES
705
115329f1
DB
706# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
707# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
3b8b687d
MN
708# in which this list will be split (can be a number in the range [1..20])
709
710COLS_IN_ALPHA_INDEX = 5
711
115329f1
DB
712# In case all classes in a project start with a common prefix, all
713# classes will be put under the same header in the alphabetical index.
714# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
3b8b687d
MN
715# should be ignored while generating the index headers.
716
115329f1 717IGNORE_PREFIX =
3b8b687d
MN
718
719#---------------------------------------------------------------------------
720# configuration options related to the HTML output
721#---------------------------------------------------------------------------
722
115329f1 723# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
3b8b687d
MN
724# generate HTML output.
725
726GENERATE_HTML = YES
727
115329f1
DB
728# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
729# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
730# put in front of it. If left blank `html' will be used as the default path.
731
732HTML_OUTPUT = html
733
115329f1
DB
734# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
735# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
3b8b687d
MN
736# doxygen will generate files with .html extension.
737
738HTML_FILE_EXTENSION = .html
739
115329f1
DB
740# The HTML_HEADER tag can be used to specify a personal HTML header for
741# each generated HTML page. If it is left blank doxygen will generate a
3b8b687d
MN
742# standard header.
743
115329f1 744HTML_HEADER =
3b8b687d 745
115329f1
DB
746# The HTML_FOOTER tag can be used to specify a personal HTML footer for
747# each generated HTML page. If it is left blank doxygen will generate a
3b8b687d
MN
748# standard footer.
749
115329f1 750HTML_FOOTER =
3b8b687d 751
f31abc6c 752# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
115329f1
DB
753# style sheet that is used by each HTML page. It can be used to
754# fine-tune the look of the HTML output. If the tag is left blank doxygen
ac7a4056
DB
755# will generate a default style sheet. Note that doxygen will try to copy
756# the style sheet file to the HTML output directory, so don't put your own
757# stylesheet in the HTML output directory as well, or it will be erased!
3b8b687d 758
115329f1 759HTML_STYLESHEET =
3b8b687d 760
115329f1
DB
761# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
762# files or namespaces will be aligned in HTML using tables. If set to
3b8b687d
MN
763# NO a bullet list will be used.
764
765HTML_ALIGN_MEMBERS = YES
766
115329f1
DB
767# If the GENERATE_HTMLHELP tag is set to YES, additional index files
768# will be generated that can be used as input for tools like the
f31abc6c 769# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
3b8b687d
MN
770# of the generated HTML documentation.
771
772GENERATE_HTMLHELP = NO
773
ac7a4056
DB
774# If the GENERATE_DOCSET tag is set to YES, additional index files
775# will be generated that can be used as input for Apple's Xcode 3
776# integrated development environment, introduced with OSX 10.5 (Leopard).
777# To create a documentation set, doxygen will generate a Makefile in the
778# HTML output directory. Running make will produce the docset in that
779# directory and running "make install" will install the docset in
780# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
781# it at startup.
782
783GENERATE_DOCSET = NO
784
785# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
786# feed. A documentation feed provides an umbrella under which multiple
787# documentation sets from a single provider (such as a company or product suite)
788# can be grouped.
789
790DOCSET_FEEDNAME = "Doxygen generated docs"
791
792# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
793# should uniquely identify the documentation set bundle. This should be a
794# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
795# will append .docset to the name.
796
797DOCSET_BUNDLE_ID = org.doxygen.Project
798
799# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
800# documentation will contain sections that can be hidden and shown after the
801# page has loaded. For this to work a browser that supports
802# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
803# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
804
805HTML_DYNAMIC_SECTIONS = NO
806
115329f1
DB
807# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
808# be used to specify the file name of the resulting .chm file. You
809# can add a path in front of the file if the result should not be
f31abc6c 810# written to the html output directory.
3b8b687d 811
115329f1 812CHM_FILE =
3b8b687d 813
115329f1
DB
814# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
815# be used to specify the location (absolute path including file name) of
f31abc6c
DB
816# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
817# the HTML help compiler on the generated index.hhp.
3b8b687d 818
115329f1 819HHC_LOCATION =
3b8b687d 820
115329f1
DB
821# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
822# controls if a separate .chi index file is generated (YES) or that
3b8b687d
MN
823# it should be included in the master .chm file (NO).
824
825GENERATE_CHI = NO
826
ac7a4056
DB
827# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
828# is used to encode HtmlHelp index (hhk), content (hhc) and project file
829# content.
830
831CHM_INDEX_ENCODING =
832
115329f1
DB
833# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
834# controls whether a binary table of contents is generated (YES) or a
3b8b687d
MN
835# normal table of contents (NO) in the .chm file.
836
837BINARY_TOC = NO
838
115329f1 839# The TOC_EXPAND flag can be set to YES to add extra items for group members
f31abc6c 840# to the contents of the HTML help documentation and to the tree view.
3b8b687d
MN
841
842TOC_EXPAND = NO
843
115329f1
DB
844# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
845# top of each HTML page. The value NO (the default) enables the index and
3b8b687d
MN
846# the value YES disables it.
847
848DISABLE_INDEX = NO
849
115329f1 850# This tag can be used to set the number of enum values (range [1..20])
3b8b687d
MN
851# that doxygen will group on one line in the generated HTML documentation.
852
853ENUM_VALUES_PER_LINE = 4
854
ac7a4056
DB
855# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
856# structure should be generated to display hierarchical information.
857# If the tag value is set to FRAME, a side panel will be generated
858# containing a tree-like index structure (just like the one that
115329f1 859# is generated for HTML Help). For this to work a browser that supports
ac7a4056
DB
860# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
861# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
862# probably better off using the HTML help feature. Other possible values
863# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
864# and Class Hiererachy pages using a tree view instead of an ordered list;
865# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
866# disables this behavior completely. For backwards compatibility with previous
867# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
868# respectively.
3b8b687d
MN
869
870GENERATE_TREEVIEW = NO
871
115329f1
DB
872# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
873# used to set the initial width (in pixels) of the frame in which the tree
3b8b687d
MN
874# is shown.
875
876TREEVIEW_WIDTH = 250
877
ac7a4056
DB
878# Use this tag to change the font size of Latex formulas included
879# as images in the HTML documentation. The default is 10. Note that
880# when you change the font size after a successful doxygen run you need
881# to manually remove any form_*.png images from the HTML output directory
882# to force them to be regenerated.
883
884FORMULA_FONTSIZE = 10
885
3b8b687d
MN
886#---------------------------------------------------------------------------
887# configuration options related to the LaTeX output
888#---------------------------------------------------------------------------
889
115329f1 890# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
3b8b687d
MN
891# generate Latex output.
892
65415bb9 893GENERATE_LATEX = NO
3b8b687d 894
115329f1
DB
895# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
896# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
897# put in front of it. If left blank `latex' will be used as the default path.
898
899LATEX_OUTPUT = latex
900
115329f1 901# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
3b8b687d
MN
902# invoked. If left blank `latex' will be used as the default command name.
903
904LATEX_CMD_NAME = latex
905
115329f1
DB
906# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
907# generate index for LaTeX. If left blank `makeindex' will be used as the
3b8b687d
MN
908# default command name.
909
910MAKEINDEX_CMD_NAME = makeindex
911
115329f1
DB
912# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
913# LaTeX documents. This may be useful for small projects and may help to
3b8b687d
MN
914# save some trees in general.
915
916COMPACT_LATEX = NO
917
115329f1
DB
918# The PAPER_TYPE tag can be used to set the paper type that is used
919# by the printer. Possible values are: a4, a4wide, letter, legal and
3b8b687d
MN
920# executive. If left blank a4wide will be used.
921
922PAPER_TYPE = a4wide
923
115329f1 924# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
3b8b687d
MN
925# packages that should be included in the LaTeX output.
926
115329f1 927EXTRA_PACKAGES =
3b8b687d 928
115329f1
DB
929# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
930# the generated latex document. The header should contain everything until
931# the first chapter. If it is left blank doxygen will generate a
3b8b687d
MN
932# standard header. Notice: only use this tag if you know what you are doing!
933
115329f1 934LATEX_HEADER =
3b8b687d 935
115329f1
DB
936# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
937# is prepared for conversion to pdf (using ps2pdf). The pdf file will
938# contain links (just like the HTML output) instead of page references
3b8b687d
MN
939# This makes the output suitable for online browsing using a pdf viewer.
940
941PDF_HYPERLINKS = NO
942
115329f1
DB
943# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
944# plain latex in the generated Makefile. Set this option to YES to get a
3b8b687d
MN
945# higher quality PDF documentation.
946
947USE_PDFLATEX = NO
948
115329f1
DB
949# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
950# command to the generated LaTeX files. This will instruct LaTeX to keep
951# running if errors occur, instead of asking the user for help.
3b8b687d
MN
952# This option is also used when generating formulas in HTML.
953
954LATEX_BATCHMODE = NO
955
ac7a4056
DB
956# If LATEX_HIDE_INDICES is set to YES then doxygen will not
957# include the index chapters (such as File Index, Compound Index, etc.)
958# in the output.
959
960LATEX_HIDE_INDICES = NO
961
3b8b687d
MN
962#---------------------------------------------------------------------------
963# configuration options related to the RTF output
964#---------------------------------------------------------------------------
965
115329f1 966# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
56cc85a0 967# The RTF output is optimized for Word 97 and may not look very pretty with
3b8b687d
MN
968# other RTF readers or editors.
969
970GENERATE_RTF = NO
971
115329f1
DB
972# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
973# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
974# put in front of it. If left blank `rtf' will be used as the default path.
975
976RTF_OUTPUT = rtf
977
115329f1
DB
978# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
979# RTF documents. This may be useful for small projects and may help to
3b8b687d
MN
980# save some trees in general.
981
982COMPACT_RTF = NO
983
115329f1
DB
984# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
985# will contain hyperlink fields. The RTF file will
986# contain links (just like the HTML output) instead of page references.
987# This makes the output suitable for online browsing using WORD or other
988# programs which support those fields.
3b8b687d
MN
989# Note: wordpad (write) and others do not support links.
990
991RTF_HYPERLINKS = NO
992
115329f1 993# Load stylesheet definitions from file. Syntax is similar to doxygen's
f31abc6c 994# config file, i.e. a series of assignments. You only have to provide
3b8b687d
MN
995# replacements, missing definitions are set to their default value.
996
115329f1 997RTF_STYLESHEET_FILE =
3b8b687d 998
115329f1 999# Set optional variables used in the generation of an rtf document.
3b8b687d
MN
1000# Syntax is similar to doxygen's config file.
1001
115329f1 1002RTF_EXTENSIONS_FILE =
3b8b687d
MN
1003
1004#---------------------------------------------------------------------------
1005# configuration options related to the man page output
1006#---------------------------------------------------------------------------
1007
115329f1 1008# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
3b8b687d
MN
1009# generate man pages
1010
1011GENERATE_MAN = NO
1012
115329f1
DB
1013# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1014# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
1015# put in front of it. If left blank `man' will be used as the default path.
1016
1017MAN_OUTPUT = man
1018
115329f1 1019# The MAN_EXTENSION tag determines the extension that is added to
3b8b687d
MN
1020# the generated man pages (default is the subroutine's section .3)
1021
1022MAN_EXTENSION = .3
1023
115329f1
DB
1024# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1025# then it will generate one additional man file for each entity
1026# documented in the real man page(s). These additional files
1027# only source the real man page, but without them the man command
3b8b687d
MN
1028# would be unable to find the correct page. The default is NO.
1029
1030MAN_LINKS = NO
1031
1032#---------------------------------------------------------------------------
1033# configuration options related to the XML output
1034#---------------------------------------------------------------------------
1035
115329f1
DB
1036# If the GENERATE_XML tag is set to YES Doxygen will
1037# generate an XML file that captures the structure of
ac7a4056 1038# the code including all documentation.
3b8b687d
MN
1039
1040GENERATE_XML = NO
1041
ac7a4056
DB
1042# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1043# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1044# put in front of it. If left blank `xml' will be used as the default path.
1045
1046XML_OUTPUT = xml
1047
115329f1
DB
1048# The XML_SCHEMA tag can be used to specify an XML schema,
1049# which can be used by a validating XML parser to check the
3b8b687d
MN
1050# syntax of the XML files.
1051
115329f1 1052XML_SCHEMA =
3b8b687d 1053
115329f1
DB
1054# The XML_DTD tag can be used to specify an XML DTD,
1055# which can be used by a validating XML parser to check the
3b8b687d
MN
1056# syntax of the XML files.
1057
115329f1 1058XML_DTD =
3b8b687d 1059
ac7a4056
DB
1060# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1061# dump the program listings (including syntax highlighting
1062# and cross-referencing information) to the XML output. Note that
1063# enabling this will significantly increase the size of the XML output.
1064
1065XML_PROGRAMLISTING = YES
1066
3b8b687d
MN
1067#---------------------------------------------------------------------------
1068# configuration options for the AutoGen Definitions output
1069#---------------------------------------------------------------------------
1070
115329f1
DB
1071# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1072# generate an AutoGen Definitions (see autogen.sf.net) file
1073# that captures the structure of the code including all
1074# documentation. Note that this feature is still experimental
3b8b687d
MN
1075# and incomplete at the moment.
1076
1077GENERATE_AUTOGEN_DEF = NO
1078
1079#---------------------------------------------------------------------------
1080# configuration options related to the Perl module output
1081#---------------------------------------------------------------------------
1082
115329f1
DB
1083# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1084# generate a Perl module file that captures the structure of
1085# the code including all documentation. Note that this
1086# feature is still experimental and incomplete at the
3b8b687d
MN
1087# moment.
1088
1089GENERATE_PERLMOD = NO
1090
115329f1
DB
1091# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1092# the necessary Makefile rules, Perl scripts and LaTeX code to be able
3b8b687d
MN
1093# to generate PDF and DVI output from the Perl module output.
1094
1095PERLMOD_LATEX = NO
1096
115329f1
DB
1097# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1098# nicely formatted so it can be parsed by a human reader. This is useful
1099# if you want to understand what is going on. On the other hand, if this
1100# tag is set to NO the size of the Perl module output will be much smaller
3b8b687d
MN
1101# and Perl will parse it just the same.
1102
1103PERLMOD_PRETTY = YES
1104
115329f1
DB
1105# The names of the make variables in the generated doxyrules.make file
1106# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1107# This is useful so different doxyrules.make files included by the same
3b8b687d
MN
1108# Makefile don't overwrite each other's variables.
1109
115329f1 1110PERLMOD_MAKEVAR_PREFIX =
3b8b687d
MN
1111
1112#---------------------------------------------------------------------------
115329f1 1113# Configuration options related to the preprocessor
3b8b687d
MN
1114#---------------------------------------------------------------------------
1115
115329f1
DB
1116# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1117# evaluate all C-preprocessor directives found in the sources and include
3b8b687d
MN
1118# files.
1119
1120ENABLE_PREPROCESSING = YES
1121
115329f1
DB
1122# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1123# names in the source code. If set to NO (the default) only conditional
1124# compilation will be performed. Macro expansion can be done in a controlled
3b8b687d
MN
1125# way by setting EXPAND_ONLY_PREDEF to YES.
1126
1127MACRO_EXPANSION = YES
1128
115329f1
DB
1129# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1130# then the macro expansion is limited to the macros specified with the
ac7a4056 1131# PREDEFINED and EXPAND_AS_DEFINED tags.
3b8b687d
MN
1132
1133EXPAND_ONLY_PREDEF = YES
1134
115329f1 1135# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
3b8b687d
MN
1136# in the INCLUDE_PATH (see below) will be search if a #include is found.
1137
1138SEARCH_INCLUDES = YES
1139
115329f1
DB
1140# The INCLUDE_PATH tag can be used to specify one or more directories that
1141# contain include files that are not input files but should be processed by
3b8b687d
MN
1142# the preprocessor.
1143
115329f1 1144INCLUDE_PATH =
3b8b687d 1145
115329f1
DB
1146# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1147# patterns (like *.h and *.hpp) to filter out the header-files in the
1148# directories. If left blank, the patterns specified with FILE_PATTERNS will
3b8b687d
MN
1149# be used.
1150
115329f1 1151INCLUDE_FILE_PATTERNS =
3b8b687d 1152
115329f1
DB
1153# The PREDEFINED tag can be used to specify one or more macro names that
1154# are defined before the preprocessor is started (similar to the -D option of
1155# gcc). The argument of the tag is a list of macros of the form: name
1156# or name=definition (no spaces). If the definition and the = are
ac7a4056
DB
1157# omitted =1 is assumed. To prevent a macro definition from being
1158# undefined via #undef or recursively expanded use the := operator
1159# instead of the = operator.
3b8b687d 1160
c545ddca 1161PREDEFINED = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
67eb5da6 1162 HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_AMD3DNOW \
3b8b687d 1163
115329f1
DB
1164# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1165# this tag can be used to specify a list of macro names that should be expanded.
1166# The macro definition that is found in the sources will be used.
3b8b687d
MN
1167# Use the PREDEFINED tag if you want to use a different macro definition.
1168
1169#EXPAND_AS_DEFINED = FF_COMMON_FRAME
c545ddca 1170EXPAND_AS_DEFINED = declare_idct(idct, table, idct_row_head, idct_row, idct_row_tail, idct_row_mid)
3b8b687d 1171
115329f1
DB
1172# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1173# doxygen's preprocessor will remove all function-like macros that are alone
1174# on a line, have an all uppercase name, and do not end with a semicolon. Such
f31abc6c
DB
1175# function macros are typically used for boiler-plate code, and will confuse
1176# the parser if not removed.
3b8b687d
MN
1177
1178SKIP_FUNCTION_MACROS = YES
1179
1180#---------------------------------------------------------------------------
f31abc6c 1181# Configuration::additions related to external references
3b8b687d
MN
1182#---------------------------------------------------------------------------
1183
f31abc6c 1184# The TAGFILES option can be used to specify one or more tagfiles.
ac7a4056
DB
1185# Optionally an initial location of the external documentation
1186# can be added for each tagfile. The format of a tag file without
1187# this location is as follows:
1188# TAGFILES = file1 file2 ...
1189# Adding location for the tag files is done as follows:
1190# TAGFILES = file1=loc1 "file2 = loc2" ...
1191# where "loc1" and "loc2" can be relative or absolute paths or
1192# URLs. If a location is present for each tag, the installdox tool
1193# does not have to be run to correct the links.
1194# Note that each tag file must have a unique name
1195# (where the name does NOT include the path)
1196# If a tag file is not located in the directory in which doxygen
1197# is run, you must also specify the path to the tagfile here.
3b8b687d 1198
115329f1 1199TAGFILES =
3b8b687d 1200
115329f1 1201# When a file name is specified after GENERATE_TAGFILE, doxygen will create
3b8b687d
MN
1202# a tag file that is based on the input files it reads.
1203
115329f1 1204GENERATE_TAGFILE =
3b8b687d 1205
115329f1
DB
1206# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1207# in the class index. If set to NO only the inherited external classes
3b8b687d
MN
1208# will be listed.
1209
1210ALLEXTERNALS = NO
1211
115329f1
DB
1212# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1213# in the modules index. If set to NO, only the current project's groups will
3b8b687d
MN
1214# be listed.
1215
1216EXTERNAL_GROUPS = YES
1217
115329f1 1218# The PERL_PATH should be the absolute path and name of the perl script
3b8b687d
MN
1219# interpreter (i.e. the result of `which perl').
1220
1221PERL_PATH = /usr/bin/perl
1222
1223#---------------------------------------------------------------------------
115329f1 1224# Configuration options related to the dot tool
3b8b687d
MN
1225#---------------------------------------------------------------------------
1226
115329f1 1227# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
f31abc6c
DB
1228# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1229# or super classes. Setting the tag to NO turns the diagrams off. Note that
1230# this option is superseded by the HAVE_DOT option below. This is only a
1231# fallback. It is recommended to install and use dot, since it yields more
1232# powerful graphs.
3b8b687d
MN
1233
1234CLASS_DIAGRAMS = YES
1235
ac7a4056
DB
1236# You can define message sequence charts within doxygen comments using the \msc
1237# command. Doxygen will then run the mscgen tool (see
1238# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1239# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1240# the mscgen tool resides. If left empty the tool is assumed to be found in the
1241# default search path.
1242
1243MSCGEN_PATH =
1244
115329f1
DB
1245# If set to YES, the inheritance and collaboration graphs will hide
1246# inheritance and usage relations if the target is undocumented
3b8b687d
MN
1247# or is not a class.
1248
1249HIDE_UNDOC_RELATIONS = YES
1250
115329f1
DB
1251# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1252# available from the path. This tool is part of Graphviz, a graph visualization
1253# toolkit from AT&T and Lucent Bell Labs. The other options in this section
3b8b687d
MN
1254# have no effect if this option is set to NO (the default)
1255
1256HAVE_DOT = NO
1257
ac7a4056
DB
1258# By default doxygen will write a font called FreeSans.ttf to the output
1259# directory and reference it in all dot files that doxygen generates. This
1260# font does not include all possible unicode characters however, so when you need
1261# these (or just want a differently looking font) you can specify the font name
1262# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1263# which can be done by putting it in a standard location or by setting the
1264# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1265# containing the font.
1266
1267DOT_FONTNAME = FreeSans
1268
1269# By default doxygen will tell dot to use the output directory to look for the
1270# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1271# different font using DOT_FONTNAME you can set the path where dot
1272# can find it using this tag.
1273
1274DOT_FONTPATH =
1275
115329f1
DB
1276# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1277# will generate a graph for each documented class showing the direct and
1278# indirect inheritance relations. Setting this tag to YES will force the
3b8b687d
MN
1279# the CLASS_DIAGRAMS tag to NO.
1280
1281CLASS_GRAPH = YES
1282
115329f1
DB
1283# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1284# will generate a graph for each documented class showing the direct and
1285# indirect implementation dependencies (inheritance, containment, and
3b8b687d
MN
1286# class references variables) of the class with other documented classes.
1287
1288COLLABORATION_GRAPH = YES
1289
ac7a4056
DB
1290# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1291# will generate a graph for groups, showing the direct groups dependencies
1292
1293GROUP_GRAPHS = YES
1294
1295# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1296# collaboration diagrams in a style similar to the OMG's Unified Modeling
1297# Language.
1298
1299UML_LOOK = NO
1300
115329f1 1301# If set to YES, the inheritance and collaboration graphs will show the
3b8b687d
MN
1302# relations between templates and their instances.
1303
1304TEMPLATE_RELATIONS = YES
1305
115329f1
DB
1306# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1307# tags are set to YES then doxygen will generate a graph for each documented
1308# file showing the direct and indirect include dependencies of the file with
3b8b687d
MN
1309# other documented files.
1310
1311INCLUDE_GRAPH = YES
1312
115329f1
DB
1313# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1314# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1315# documented header file showing the documented files that directly or
3b8b687d
MN
1316# indirectly include this file.
1317
1318INCLUDED_BY_GRAPH = YES
1319
ac7a4056
DB
1320# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1321# doxygen will generate a call dependency graph for every global function
1322# or class method. Note that enabling this option will significantly increase
1323# the time of a run. So in most cases it will be better to enable call graphs
1324# for selected functions only using the \callgraph command.
1325
1326CALL_GRAPH = NO
1327
1328# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1329# doxygen will generate a caller dependency graph for every global function
1330# or class method. Note that enabling this option will significantly increase
1331# the time of a run. So in most cases it will be better to enable caller
1332# graphs for selected functions only using the \callergraph command.
1333
1334CALLER_GRAPH = NO
1335
115329f1 1336# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
3b8b687d
MN
1337# will graphical hierarchy of all classes instead of a textual one.
1338
1339GRAPHICAL_HIERARCHY = YES
1340
ac7a4056
DB
1341# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1342# then doxygen will show the dependencies a directory has on other directories
1343# in a graphical way. The dependency relations are determined by the #include
1344# relations between the files in the directories.
1345
1346DIRECTORY_GRAPH = YES
1347
115329f1 1348# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
3b8b687d
MN
1349# generated by dot. Possible values are png, jpg, or gif
1350# If left blank png will be used.
1351
1352DOT_IMAGE_FORMAT = png
1353
115329f1 1354# The tag DOT_PATH can be used to specify the path where the dot tool can be
f31abc6c 1355# found. If left blank, it is assumed the dot tool can be found in the path.
3b8b687d 1356
115329f1 1357DOT_PATH =
3b8b687d 1358
115329f1
DB
1359# The DOTFILE_DIRS tag can be used to specify one or more directories that
1360# contain dot files that are included in the documentation (see the
3b8b687d
MN
1361# \dotfile command).
1362
115329f1 1363DOTFILE_DIRS =
3b8b687d 1364
ac7a4056
DB
1365# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1366# nodes that will be shown in the graph. If the number of nodes in a graph
1367# becomes larger than this value, doxygen will truncate the graph, which is
1368# visualized by representing a node as a red box. Note that doxygen if the
1369# number of direct children of the root node in a graph is already larger than
1370# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1371# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
3b8b687d 1372
ac7a4056 1373DOT_GRAPH_MAX_NODES = 50
3b8b687d 1374
ac7a4056
DB
1375# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1376# graphs generated by dot. A depth value of 3 means that only nodes reachable
1377# from the root by following a path via at most 3 edges will be shown. Nodes
1378# that lay further from the root node will be omitted. Note that setting this
1379# option to 1 or 2 may greatly reduce the computation time needed for large
1380# code bases. Also note that the size of a graph can be further restricted by
1381# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
3b8b687d 1382
ac7a4056
DB
1383MAX_DOT_GRAPH_DEPTH = 0
1384
1385# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1386# background. This is enabled by default, which results in a transparent
1387# background. Warning: Depending on the platform used, enabling this option
1388# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1389# become hard to read).
1390
1391DOT_TRANSPARENT = YES
1392
1393# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1394# files in one run (i.e. multiple -o and -T options on the command line). This
1395# makes dot run faster, but since only newer versions of dot (>1.8.10)
1396# support this, this feature is disabled by default.
1397
1398DOT_MULTI_TARGETS = NO
3b8b687d 1399
115329f1
DB
1400# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1401# generate a legend page explaining the meaning of the various boxes and
3b8b687d
MN
1402# arrows in the dot generated graphs.
1403
1404GENERATE_LEGEND = YES
1405
115329f1 1406# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
f31abc6c 1407# remove the intermediate dot files that are used to generate
3b8b687d
MN
1408# the various graphs.
1409
1410DOT_CLEANUP = YES
1411
1412#---------------------------------------------------------------------------
f31abc6c 1413# Configuration::additions related to the search engine
3b8b687d
MN
1414#---------------------------------------------------------------------------
1415
115329f1 1416# The SEARCHENGINE tag specifies whether or not a search engine should be
3b8b687d
MN
1417# used. If set to NO the values of all tags below this one will be ignored.
1418
1419SEARCHENGINE = NO