add Flash Screen Video 2 decoder
[libav.git] / Doxyfile
CommitLineData
10dde477 1# Doxyfile 1.7.1
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
070c5d0f 28PROJECT_NAME = Libav
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 56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
10dde477
RT
57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
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
18bb522b
DB
158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159# member inherits the documentation from any documented member that it
f31abc6c 160# re-implements.
18bb522b
DB
161
162INHERIT_DOCS = YES
163
ac7a4056
DB
164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165# a new page for each member. If set to NO, the documentation of a member will
166# be part of the file/class/namespace that contains it.
167
168SEPARATE_MEMBER_PAGES = NO
169
18bb522b
DB
170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171# Doxygen uses this value to replace tabs by spaces in code fragments.
172
173TAB_SIZE = 8
174
175# This tag can be used to specify a number of aliases that acts
176# as commands in the documentation. An alias has the form "name=value".
177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178# put the command \sideeffect (or @sideeffect) in the documentation, which
f31abc6c 179# will result in a user-defined paragraph with heading "Side Effects:".
18bb522b
DB
180# You can put \n's in the value part of an alias to insert newlines.
181
182ALIASES =
183
f31abc6c
DB
184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185# sources only. Doxygen will then generate output that is more tailored for C.
186# For instance, some of the names that are used will be different. The list
18bb522b
DB
187# of all members will be omitted, etc.
188
189OPTIMIZE_OUTPUT_FOR_C = YES
190
f31abc6c
DB
191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192# sources only. Doxygen will then generate output that is more tailored for
193# Java. For instance, namespaces will be presented as packages, qualified
194# scopes will look different, etc.
18bb522b
DB
195
196OPTIMIZE_OUTPUT_JAVA = NO
197
ac7a4056
DB
198# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199# sources only. Doxygen will then generate output that is more tailored for
200# Fortran.
201
202OPTIMIZE_FOR_FORTRAN = NO
203
204# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205# sources. Doxygen will then generate output that is tailored for
206# VHDL.
207
208OPTIMIZE_OUTPUT_VHDL = NO
209
10dde477
RT
210# Doxygen selects the parser to use depending on the extension of the files it
211# parses. With this tag you can assign which parser to use for a given extension.
212# Doxygen has a built-in mapping, but you can override or extend it using this
213# tag. The format is ext=language, where ext is a file extension, and language
214# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
215# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
216# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
217# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
218# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
219
220EXTENSION_MAPPING =
221
ac7a4056
DB
222# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223# to include (a tag file for) the STL sources as input, then you should
224# set this tag to YES in order to let doxygen match functions declarations and
225# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226# func(std::string) {}). This also make the inheritance and collaboration
227# diagrams that involve STL classes more complete and accurate.
228
229BUILTIN_STL_SUPPORT = NO
230
231# If you use Microsoft's C++/CLI language, you should set this option to YES to
232# enable parsing support.
233
234CPP_CLI_SUPPORT = NO
235
236# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237# Doxygen will parse them like normal C++ but will assume all classes use public
238# instead of private inheritance when no explicit protection keyword is present.
239
240SIP_SUPPORT = NO
241
242# For Microsoft's IDL there are propget and propput attributes to indicate getter
243# and setter methods for a property. Setting this option to YES (the default)
244# will make doxygen to replace the get and set methods by a property in the
245# documentation. This will only work if the methods are indeed getting or
246# setting a simple type. If this is not the case, or you want to show the
247# methods anyway, you should set this option to NO.
248
249IDL_PROPERTY_SUPPORT = YES
250
251# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
252# tag is set to YES, then doxygen will reuse the documentation of the first
253# member in the group (if any) for the other members of the group. By default
254# all members of a group must be documented explicitly.
255
256DISTRIBUTE_GROUP_DOC = NO
257
258# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259# the same type (for instance a group of public functions) to be put as a
260# subgroup of that type (e.g. under the Public Functions section). Set it to
261# NO to prevent subgrouping. Alternatively, this can be done per class using
262# the \nosubgrouping command.
263
264SUBGROUPING = YES
265
266# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267# is documented as struct, union, or enum with the name of the typedef. So
268# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
269# with name TypeT. When disabled the typedef will appear as a member of a file,
270# namespace, or class. And the struct will be named TypeS. This can typically
271# be useful for C code in case the coding convention dictates that all compound
272# types are typedef'ed and only the typedef is referenced, never the tag name.
273
274TYPEDEF_HIDES_STRUCT = NO
275
10dde477
RT
276# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277# determine which symbols to keep in memory and which to flush to disk.
278# When the cache is full, less often used symbols will be written to disk.
279# For small to medium size projects (<1000 input files) the default value is
280# probably good enough. For larger projects a too small cache size can cause
281# doxygen to be busy swapping symbols to and from disk most of the time
282# causing a significant performance penality.
283# If the system has enough physical memory increasing the cache will improve the
284# performance by keeping more symbols in memory. Note that the value works on
285# a logarithmic scale so increasing the size by one will rougly double the
286# memory usage. The cache size is given by this formula:
287# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288# corresponding to a cache size of 2^16 = 65536 symbols
289
290SYMBOL_CACHE_SIZE = 0
291
ac7a4056
DB
292#---------------------------------------------------------------------------
293# Build related configuration options
294#---------------------------------------------------------------------------
295
115329f1
DB
296# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297# documentation are documented, even if no documentation was available.
298# Private class members and static file members will be hidden unless
3b8b687d
MN
299# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
300
7b3da204 301EXTRACT_ALL = YES
3b8b687d 302
115329f1 303# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
3b8b687d
MN
304# will be included in the documentation.
305
306EXTRACT_PRIVATE = YES
307
115329f1 308# If the EXTRACT_STATIC tag is set to YES all static members of a file
3b8b687d
MN
309# will be included in the documentation.
310
311EXTRACT_STATIC = YES
312
115329f1
DB
313# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314# defined locally in source files will be included in the documentation.
3b8b687d
MN
315# If set to NO only classes defined in header files are included.
316
317EXTRACT_LOCAL_CLASSES = YES
318
ac7a4056
DB
319# This flag is only useful for Objective-C code. When set to YES local
320# methods, which are defined in the implementation section but not in
321# the interface are included in the documentation.
322# If set to NO (the default) only methods in the interface are included.
323
324EXTRACT_LOCAL_METHODS = NO
325
326# If this flag is set to YES, the members of anonymous namespaces will be
327# extracted and appear in the documentation as a namespace called
328# 'anonymous_namespace{file}', where file will be replaced with the base
329# name of the file that contains the anonymous namespace. By default
330# anonymous namespace are hidden.
331
332EXTRACT_ANON_NSPACES = NO
333
115329f1
DB
334# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335# undocumented members of documented classes, files or namespaces.
336# If set to NO (the default) these members will be included in the
337# various overviews, but no documentation section is generated.
3b8b687d
MN
338# This option has no effect if EXTRACT_ALL is enabled.
339
340HIDE_UNDOC_MEMBERS = NO
341
115329f1
DB
342# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343# undocumented classes that are normally visible in the class hierarchy.
f31abc6c 344# If set to NO (the default) these classes will be included in the various
3b8b687d
MN
345# overviews. This option has no effect if EXTRACT_ALL is enabled.
346
347HIDE_UNDOC_CLASSES = NO
348
115329f1
DB
349# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350# friend (class|struct|union) declarations.
351# If set to NO (the default) these declarations will be included in the
3b8b687d
MN
352# documentation.
353
354HIDE_FRIEND_COMPOUNDS = NO
355
115329f1
DB
356# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357# documentation blocks found inside the body of a function.
358# If set to NO (the default) these blocks will be appended to the
3b8b687d
MN
359# function's detailed documentation block.
360
361HIDE_IN_BODY_DOCS = NO
362
115329f1
DB
363# The INTERNAL_DOCS tag determines if documentation
364# that is typed after a \internal command is included. If the tag is set
365# to NO (the default) then the documentation will be excluded.
3b8b687d
MN
366# Set it to YES to include the internal documentation.
367
368INTERNAL_DOCS = NO
369
115329f1 370# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
f31abc6c 371# file names in lower-case letters. If set to YES upper-case letters are also
115329f1
DB
372# allowed. This is useful if you have classes or files whose names only differ
373# in case and if your file system supports case sensitive file names. Windows
ac7a4056 374# and Mac users are advised to set this option to NO.
3b8b687d
MN
375
376CASE_SENSE_NAMES = YES
377
115329f1
DB
378# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379# will show members with their full class and namespace scopes in the
3b8b687d
MN
380# documentation. If set to YES the scope will be hidden.
381
382HIDE_SCOPE_NAMES = NO
383
115329f1 384# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
f31abc6c 385# will put a list of the files that are included by a file in the documentation
3b8b687d
MN
386# of that file.
387
388SHOW_INCLUDE_FILES = YES
389
10dde477
RT
390# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
391# will list include files with double quotes in the documentation
392# rather than with sharp brackets.
393
394FORCE_LOCAL_INCLUDES = NO
395
115329f1 396# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
3b8b687d
MN
397# is inserted in the documentation for inline members.
398
399INLINE_INFO = YES
400
115329f1
DB
401# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
402# will sort the (detailed) documentation of file and class members
403# alphabetically by member name. If set to NO the members will appear in
3b8b687d
MN
404# declaration order.
405
406SORT_MEMBER_DOCS = YES
407
ac7a4056
DB
408# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
409# brief documentation of file, namespace and class members alphabetically
410# by member name. If set to NO (the default) the members will appear in
411# declaration order.
3b8b687d 412
ac7a4056
DB
413SORT_BRIEF_DOCS = NO
414
10dde477
RT
415# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
416# will sort the (brief and detailed) documentation of class members so that
417# constructors and destructors are listed first. If set to NO (the default)
418# the constructors will appear in the respective orders defined by
419# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
420# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
421# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
422
423SORT_MEMBERS_CTORS_1ST = NO
424
ac7a4056
DB
425# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
426# hierarchy of group names into alphabetical order. If set to NO (the default)
427# the group names will appear in their defined order.
428
429SORT_GROUP_NAMES = NO
430
431# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
432# sorted by fully-qualified names, including namespaces. If set to
433# NO (the default), the class list will be sorted only by class name,
434# not including the namespace part.
435# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
436# Note: This option applies only to the class list, not to the
437# alphabetical list.
438
439SORT_BY_SCOPE_NAME = NO
d7650484 440
115329f1
DB
441# The GENERATE_TODOLIST tag can be used to enable (YES) or
442# disable (NO) the todo list. This list is created by putting \todo
3b8b687d
MN
443# commands in the documentation.
444
445GENERATE_TODOLIST = YES
446
115329f1
DB
447# The GENERATE_TESTLIST tag can be used to enable (YES) or
448# disable (NO) the test list. This list is created by putting \test
3b8b687d
MN
449# commands in the documentation.
450
451GENERATE_TESTLIST = YES
452
115329f1
DB
453# The GENERATE_BUGLIST tag can be used to enable (YES) or
454# disable (NO) the bug list. This list is created by putting \bug
3b8b687d
MN
455# commands in the documentation.
456
457GENERATE_BUGLIST = YES
458
115329f1
DB
459# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
460# disable (NO) the deprecated list. This list is created by putting
3b8b687d
MN
461# \deprecated commands in the documentation.
462
463GENERATE_DEPRECATEDLIST= YES
464
115329f1 465# The ENABLED_SECTIONS tag can be used to enable conditional
3b8b687d
MN
466# documentation sections, marked by \if sectionname ... \endif.
467
115329f1 468ENABLED_SECTIONS =
3b8b687d 469
115329f1 470# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
f31abc6c 471# the initial value of a variable or define consists of for it to appear in
115329f1
DB
472# the documentation. If the initializer consists of more lines than specified
473# here it will be hidden. Use a value of 0 to hide initializers completely.
474# The appearance of the initializer of individual variables and defines in the
475# documentation can be controlled using \showinitializer or \hideinitializer
3b8b687d
MN
476# command in the documentation regardless of this setting.
477
478MAX_INITIALIZER_LINES = 30
479
157b7d0c
DB
480# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
481# at the bottom of the documentation of classes and structs. If set to YES the
482# list will mention the files that were used to generate the documentation.
d7650484 483
157b7d0c 484SHOW_USED_FILES = YES
d7650484 485
ac7a4056
DB
486# If the sources in your project are distributed over multiple directories
487# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
488# in the documentation. The default is NO.
489
490SHOW_DIRECTORIES = NO
491
492# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
493# This will remove the Files entry from the Quick Index and from the
494# Folder Tree View (if specified). The default is YES.
495
496SHOW_FILES = YES
497
498# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
10dde477
RT
499# Namespaces page.
500# This will remove the Namespaces entry from the Quick Index
ac7a4056
DB
501# and from the Folder Tree View (if specified). The default is YES.
502
503SHOW_NAMESPACES = YES
504
505# The FILE_VERSION_FILTER tag can be used to specify a program or script that
506# doxygen should invoke to get the current version for each file (typically from
507# the version control system). Doxygen will invoke the program by executing (via
508# popen()) the command <command> <input-file>, where <command> is the value of
509# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
510# provided by doxygen. Whatever the program writes to standard output
511# is used as the file version. See the manual for examples.
512
513FILE_VERSION_FILTER =
514
10dde477
RT
515# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
516# by doxygen. The layout file controls the global structure of the generated
517# output files in an output format independent way. The create the layout file
518# that represents doxygen's defaults, run doxygen with the -l option.
519# You can optionally specify a file name after the option, if omitted
520# DoxygenLayout.xml will be used as the name of the layout file.
521
522LAYOUT_FILE =
523
3b8b687d
MN
524#---------------------------------------------------------------------------
525# configuration options related to warning and progress messages
526#---------------------------------------------------------------------------
527
115329f1 528# The QUIET tag can be used to turn on/off the messages that are generated
3b8b687d
MN
529# by doxygen. Possible values are YES and NO. If left blank NO is used.
530
655a29e7 531QUIET = YES
3b8b687d 532
115329f1
DB
533# The WARNINGS tag can be used to turn on/off the warning messages that are
534# generated by doxygen. Possible values are YES and NO. If left blank
3b8b687d
MN
535# NO is used.
536
537WARNINGS = YES
538
115329f1
DB
539# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
540# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
3b8b687d
MN
541# automatically be disabled.
542
543WARN_IF_UNDOCUMENTED = YES
544
ac7a4056
DB
545# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
546# potential errors in the documentation, such as not documenting some
547# parameters in a documented function, or documenting parameters that
548# don't exist or using markup commands wrongly.
549
550WARN_IF_DOC_ERROR = YES
551
552# This WARN_NO_PARAMDOC option can be abled to get warnings for
553# functions that are documented, but have no documentation for their parameters
554# or return value. If set to NO (the default) doxygen will only warn about
555# wrong or incomplete parameter documentation, but not about the absence of
556# documentation.
557
558WARN_NO_PARAMDOC = NO
559
115329f1
DB
560# The WARN_FORMAT tag determines the format of the warning messages that
561# doxygen can produce. The string should contain the $file, $line, and $text
562# tags, which will be replaced by the file and line number from which the
ac7a4056
DB
563# warning originated and the warning text. Optionally the format may contain
564# $version, which will be replaced by the version of the file (if it could
565# be obtained via FILE_VERSION_FILTER)
3b8b687d
MN
566
567WARN_FORMAT = "$file:$line: $text"
568
115329f1
DB
569# The WARN_LOGFILE tag can be used to specify a file to which warning
570# and error messages should be written. If left blank the output is written
3b8b687d
MN
571# to stderr.
572
115329f1 573WARN_LOGFILE =
3b8b687d
MN
574
575#---------------------------------------------------------------------------
576# configuration options related to the input files
577#---------------------------------------------------------------------------
578
115329f1
DB
579# The INPUT tag can be used to specify the files and/or directories that contain
580# documented source files. You may enter file names like "myfile.cpp" or
581# directories like "/usr/src/myproject". Separate the files or directories
3b8b687d
MN
582# with spaces.
583
115329f1 584INPUT =
3b8b687d 585
ac7a4056
DB
586# This tag can be used to specify the character encoding of the source files
587# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
588# also the default input encoding. Doxygen uses libiconv (or the iconv built
589# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
590# the list of possible encodings.
591
592INPUT_ENCODING = UTF-8
593
115329f1
DB
594# If the value of the INPUT tag contains directories, you can use the
595# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
596# and *.h) to filter out the source-files in the directories. If left
597# blank the following patterns are tested:
ac7a4056
DB
598# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
599# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
3b8b687d 600
115329f1 601FILE_PATTERNS =
3b8b687d 602
115329f1
DB
603# The RECURSIVE tag can be used to turn specify whether or not subdirectories
604# should be searched for input files as well. Possible values are YES and NO.
3b8b687d
MN
605# If left blank NO is used.
606
607RECURSIVE = YES
608
115329f1
DB
609# The EXCLUDE tag can be used to specify files and/or directories that should
610# excluded from the INPUT source files. This way you can easily exclude a
3b8b687d
MN
611# subdirectory from a directory tree whose root is specified with the INPUT tag.
612
115329f1 613EXCLUDE =
3b8b687d 614
f31abc6c
DB
615# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
616# directories that are symbolic links (a Unix filesystem feature) are excluded
617# from the input.
3b8b687d
MN
618
619EXCLUDE_SYMLINKS = NO
620
115329f1
DB
621# If the value of the INPUT tag contains directories, you can use the
622# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
ac7a4056
DB
623# certain files from those directories. Note that the wildcards are matched
624# against the file with absolute path, so to exclude all test directories
625# for example use the pattern */test/*
3b8b687d 626
10dde477
RT
627EXCLUDE_PATTERNS = *.git \
628 *.d
3b8b687d 629
ac7a4056
DB
630# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
631# (namespaces, classes, functions, etc.) that should be excluded from the
632# output. The symbol name can be a fully qualified name, a word, or if the
633# wildcard * is used, a substring. Examples: ANamespace, AClass,
634# AClass::ANamespace, ANamespace::*Test
635
636EXCLUDE_SYMBOLS =
637
115329f1
DB
638# The EXAMPLE_PATH tag can be used to specify one or more files or
639# directories that contain example code fragments that are included (see
3b8b687d
MN
640# the \include command).
641
10dde477
RT
642EXAMPLE_PATH = libavcodec/ \
643 libavformat/
3b8b687d 644
115329f1
DB
645# If the value of the EXAMPLE_PATH tag contains directories, you can use the
646# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
647# and *.h) to filter out the source-files in the directories. If left
3b8b687d
MN
648# blank all files are included.
649
7655cfb1 650EXAMPLE_PATTERNS = *-example.c
3b8b687d 651
115329f1
DB
652# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
653# searched for input files to be used with the \include or \dontinclude
654# commands irrespective of the value of the RECURSIVE tag.
3b8b687d
MN
655# Possible values are YES and NO. If left blank NO is used.
656
657EXAMPLE_RECURSIVE = NO
658
115329f1
DB
659# The IMAGE_PATH tag can be used to specify one or more files or
660# directories that contain image that are included in the documentation (see
3b8b687d
MN
661# the \image command).
662
115329f1 663IMAGE_PATH =
3b8b687d 664
115329f1
DB
665# The INPUT_FILTER tag can be used to specify a program that doxygen should
666# invoke to filter for each input file. Doxygen will invoke the filter program
667# by executing (via popen()) the command <filter> <input-file>, where <filter>
668# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
669# input file. Doxygen will then use the output that the filter program writes
10dde477
RT
670# to standard output.
671# If FILTER_PATTERNS is specified, this tag will be
ac7a4056 672# ignored.
3b8b687d 673
115329f1 674INPUT_FILTER =
3b8b687d 675
ac7a4056 676# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
10dde477
RT
677# basis.
678# Doxygen will compare the file name with each pattern and apply the
679# filter if there is a match.
680# The filters are a list of the form:
ac7a4056
DB
681# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
682# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
683# is applied to all files.
684
685FILTER_PATTERNS =
686
115329f1
DB
687# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
688# INPUT_FILTER) will be used to filter the input files when producing source
3b8b687d
MN
689# files to browse (i.e. when SOURCE_BROWSER is set to YES).
690
691FILTER_SOURCE_FILES = NO
692
693#---------------------------------------------------------------------------
694# configuration options related to source browsing
695#---------------------------------------------------------------------------
696
115329f1 697# If the SOURCE_BROWSER tag is set to YES then a list of source files will
3b8b687d 698# be generated. Documented entities will be cross-referenced with these sources.
ac7a4056
DB
699# Note: To get rid of all source code in the generated output, make sure also
700# VERBATIM_HEADERS is set to NO.
3b8b687d
MN
701
702SOURCE_BROWSER = YES
703
115329f1 704# Setting the INLINE_SOURCES tag to YES will include the body
3b8b687d
MN
705# of functions and classes directly in the documentation.
706
707INLINE_SOURCES = NO
708
115329f1
DB
709# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
710# doxygen to hide any special comment blocks from generated source code
3b8b687d
MN
711# fragments. Normal C and C++ comments will always remain visible.
712
713STRIP_CODE_COMMENTS = YES
714
ac7a4056 715# If the REFERENCED_BY_RELATION tag is set to YES
115329f1 716# then for each documented function all documented
3b8b687d
MN
717# functions referencing it will be listed.
718
719REFERENCED_BY_RELATION = YES
720
ac7a4056 721# If the REFERENCES_RELATION tag is set to YES
115329f1 722# then for each documented function all documented entities
3b8b687d
MN
723# called/used by that function will be listed.
724
7b3da204 725REFERENCES_RELATION = NO
3b8b687d 726
ac7a4056
DB
727# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
728# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
729# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
10dde477
RT
730# link to the source code.
731# Otherwise they will link to the documentation.
ac7a4056
DB
732
733REFERENCES_LINK_SOURCE = YES
734
735# If the USE_HTAGS tag is set to YES then the references to source code
736# will point to the HTML generated by the htags(1) tool instead of doxygen
737# built-in source browser. The htags tool is part of GNU's global source
738# tagging system (see http://www.gnu.org/software/global/global.html). You
739# will need version 4.8.6 or higher.
740
741USE_HTAGS = NO
742
18bb522b
DB
743# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
744# will generate a verbatim copy of the header file for each class for
745# which an include is specified. Set to NO to disable this.
746
747VERBATIM_HEADERS = YES
748
3b8b687d
MN
749#---------------------------------------------------------------------------
750# configuration options related to the alphabetical class index
751#---------------------------------------------------------------------------
752
115329f1
DB
753# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
754# of all compounds will be generated. Enable this if the project
3b8b687d
MN
755# contains a lot of classes, structs, unions or interfaces.
756
757ALPHABETICAL_INDEX = YES
758
115329f1
DB
759# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
760# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
3b8b687d
MN
761# in which this list will be split (can be a number in the range [1..20])
762
763COLS_IN_ALPHA_INDEX = 5
764
115329f1
DB
765# In case all classes in a project start with a common prefix, all
766# classes will be put under the same header in the alphabetical index.
767# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
3b8b687d
MN
768# should be ignored while generating the index headers.
769
115329f1 770IGNORE_PREFIX =
3b8b687d
MN
771
772#---------------------------------------------------------------------------
773# configuration options related to the HTML output
774#---------------------------------------------------------------------------
775
115329f1 776# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
3b8b687d
MN
777# generate HTML output.
778
779GENERATE_HTML = YES
780
115329f1
DB
781# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
782# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
783# put in front of it. If left blank `html' will be used as the default path.
784
785HTML_OUTPUT = html
786
115329f1
DB
787# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
788# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
3b8b687d
MN
789# doxygen will generate files with .html extension.
790
791HTML_FILE_EXTENSION = .html
792
115329f1
DB
793# The HTML_HEADER tag can be used to specify a personal HTML header for
794# each generated HTML page. If it is left blank doxygen will generate a
3b8b687d
MN
795# standard header.
796
115329f1 797HTML_HEADER =
3b8b687d 798
115329f1
DB
799# The HTML_FOOTER tag can be used to specify a personal HTML footer for
800# each generated HTML page. If it is left blank doxygen will generate a
3b8b687d
MN
801# standard footer.
802
115329f1 803HTML_FOOTER =
3b8b687d 804
f31abc6c 805# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
115329f1
DB
806# style sheet that is used by each HTML page. It can be used to
807# fine-tune the look of the HTML output. If the tag is left blank doxygen
ac7a4056
DB
808# will generate a default style sheet. Note that doxygen will try to copy
809# the style sheet file to the HTML output directory, so don't put your own
810# stylesheet in the HTML output directory as well, or it will be erased!
3b8b687d 811
115329f1 812HTML_STYLESHEET =
3b8b687d 813
10dde477
RT
814# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
815# Doxygen will adjust the colors in the stylesheet and background images
816# according to this color. Hue is specified as an angle on a colorwheel,
817# see http://en.wikipedia.org/wiki/Hue for more information.
818# For instance the value 0 represents red, 60 is yellow, 120 is green,
819# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
820# The allowed range is 0 to 359.
821
822HTML_COLORSTYLE_HUE = 220
823
824# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
825# the colors in the HTML output. For a value of 0 the output will use
826# grayscales only. A value of 255 will produce the most vivid colors.
827
828HTML_COLORSTYLE_SAT = 100
829
830# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
831# the luminance component of the colors in the HTML output. Values below
832# 100 gradually make the output lighter, whereas values above 100 make
833# the output darker. The value divided by 100 is the actual gamma applied,
834# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
835# and 100 does not change the gamma.
836
837HTML_COLORSTYLE_GAMMA = 80
838
839# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
840# page will contain the date and time when the page was generated. Setting
841# this to NO can help when comparing the output of multiple runs.
842
843HTML_TIMESTAMP = YES
844
115329f1
DB
845# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
846# files or namespaces will be aligned in HTML using tables. If set to
3b8b687d
MN
847# NO a bullet list will be used.
848
849HTML_ALIGN_MEMBERS = YES
850
10dde477
RT
851# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
852# documentation will contain sections that can be hidden and shown after the
853# page has loaded. For this to work a browser that supports
854# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
855# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
3b8b687d 856
10dde477 857HTML_DYNAMIC_SECTIONS = NO
3b8b687d 858
ac7a4056
DB
859# If the GENERATE_DOCSET tag is set to YES, additional index files
860# will be generated that can be used as input for Apple's Xcode 3
861# integrated development environment, introduced with OSX 10.5 (Leopard).
862# To create a documentation set, doxygen will generate a Makefile in the
863# HTML output directory. Running make will produce the docset in that
864# directory and running "make install" will install the docset in
865# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
866# it at startup.
10dde477
RT
867# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
868# for more information.
ac7a4056
DB
869
870GENERATE_DOCSET = NO
871
872# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
873# feed. A documentation feed provides an umbrella under which multiple
874# documentation sets from a single provider (such as a company or product suite)
875# can be grouped.
876
877DOCSET_FEEDNAME = "Doxygen generated docs"
878
879# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
880# should uniquely identify the documentation set bundle. This should be a
881# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
882# will append .docset to the name.
883
884DOCSET_BUNDLE_ID = org.doxygen.Project
885
10dde477
RT
886# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
887# the documentation publisher. This should be a reverse domain-name style
888# string, e.g. com.mycompany.MyDocSet.documentation.
ac7a4056 889
10dde477
RT
890DOCSET_PUBLISHER_ID = org.doxygen.Publisher
891
892# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
893
894DOCSET_PUBLISHER_NAME = Publisher
895
896# If the GENERATE_HTMLHELP tag is set to YES, additional index files
897# will be generated that can be used as input for tools like the
898# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
899# of the generated HTML documentation.
900
901GENERATE_HTMLHELP = NO
ac7a4056 902
115329f1
DB
903# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
904# be used to specify the file name of the resulting .chm file. You
905# can add a path in front of the file if the result should not be
f31abc6c 906# written to the html output directory.
3b8b687d 907
115329f1 908CHM_FILE =
3b8b687d 909
115329f1
DB
910# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
911# be used to specify the location (absolute path including file name) of
f31abc6c
DB
912# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
913# the HTML help compiler on the generated index.hhp.
3b8b687d 914
115329f1 915HHC_LOCATION =
3b8b687d 916
115329f1
DB
917# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
918# controls if a separate .chi index file is generated (YES) or that
3b8b687d
MN
919# it should be included in the master .chm file (NO).
920
921GENERATE_CHI = NO
922
ac7a4056
DB
923# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
924# is used to encode HtmlHelp index (hhk), content (hhc) and project file
925# content.
926
927CHM_INDEX_ENCODING =
928
115329f1
DB
929# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
930# controls whether a binary table of contents is generated (YES) or a
3b8b687d
MN
931# normal table of contents (NO) in the .chm file.
932
933BINARY_TOC = NO
934
115329f1 935# The TOC_EXPAND flag can be set to YES to add extra items for group members
f31abc6c 936# to the contents of the HTML help documentation and to the tree view.
3b8b687d
MN
937
938TOC_EXPAND = NO
939
10dde477
RT
940# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
941# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
942# that can be used as input for Qt's qhelpgenerator to generate a
943# Qt Compressed Help (.qch) of the generated HTML documentation.
944
945GENERATE_QHP = NO
946
947# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
948# be used to specify the file name of the resulting .qch file.
949# The path specified is relative to the HTML output folder.
950
951QCH_FILE =
952
953# The QHP_NAMESPACE tag specifies the namespace to use when generating
954# Qt Help Project output. For more information please see
955# http://doc.trolltech.com/qthelpproject.html#namespace
956
957QHP_NAMESPACE = org.doxygen.Project
958
959# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
960# Qt Help Project output. For more information please see
961# http://doc.trolltech.com/qthelpproject.html#virtual-folders
962
963QHP_VIRTUAL_FOLDER = doc
964
965# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
966# add. For more information please see
967# http://doc.trolltech.com/qthelpproject.html#custom-filters
968
969QHP_CUST_FILTER_NAME =
970
971# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
972# custom filter to add. For more information please see
973# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
974# Qt Help Project / Custom Filters</a>.
975
976QHP_CUST_FILTER_ATTRS =
977
978# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
979# project's
980# filter section matches.
981# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
982# Qt Help Project / Filter Attributes</a>.
983
984QHP_SECT_FILTER_ATTRS =
985
986# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
987# be used to specify the location of Qt's qhelpgenerator.
988# If non-empty doxygen will try to run qhelpgenerator on the generated
989# .qhp file.
990
991QHG_LOCATION =
992
993# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
994# will be generated, which together with the HTML files, form an Eclipse help
995# plugin. To install this plugin and make it available under the help contents
996# menu in Eclipse, the contents of the directory containing the HTML and XML
997# files needs to be copied into the plugins directory of eclipse. The name of
998# the directory within the plugins directory should be the same as
999# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1000# the help appears.
1001
1002GENERATE_ECLIPSEHELP = NO
1003
1004# A unique identifier for the eclipse help plugin. When installing the plugin
1005# the directory name containing the HTML and XML files should also have
1006# this name.
1007
1008ECLIPSE_DOC_ID = org.doxygen.Project
1009
115329f1
DB
1010# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1011# top of each HTML page. The value NO (the default) enables the index and
3b8b687d
MN
1012# the value YES disables it.
1013
1014DISABLE_INDEX = NO
1015
115329f1 1016# This tag can be used to set the number of enum values (range [1..20])
3b8b687d
MN
1017# that doxygen will group on one line in the generated HTML documentation.
1018
1019ENUM_VALUES_PER_LINE = 4
1020
ac7a4056
DB
1021# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1022# structure should be generated to display hierarchical information.
10dde477 1023# If the tag value is set to YES, a side panel will be generated
ac7a4056 1024# containing a tree-like index structure (just like the one that
115329f1 1025# is generated for HTML Help). For this to work a browser that supports
10dde477
RT
1026# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1027# Windows users are probably better off using the HTML help feature.
3b8b687d
MN
1028
1029GENERATE_TREEVIEW = NO
1030
10dde477
RT
1031# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1032# and Class Hierarchy pages using a tree view instead of an ordered list.
1033
1034USE_INLINE_TREES = NO
1035
115329f1
DB
1036# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1037# used to set the initial width (in pixels) of the frame in which the tree
3b8b687d
MN
1038# is shown.
1039
1040TREEVIEW_WIDTH = 250
1041
10dde477
RT
1042# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1043# links to external symbols imported via tag files in a separate window.
1044
1045EXT_LINKS_IN_WINDOW = NO
1046
ac7a4056
DB
1047# Use this tag to change the font size of Latex formulas included
1048# as images in the HTML documentation. The default is 10. Note that
1049# when you change the font size after a successful doxygen run you need
1050# to manually remove any form_*.png images from the HTML output directory
1051# to force them to be regenerated.
1052
1053FORMULA_FONTSIZE = 10
1054
10dde477
RT
1055# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1056# generated for formulas are transparent PNGs. Transparent PNGs are
1057# not supported properly for IE 6.0, but are supported on all modern browsers.
1058# Note that when changing this option you need to delete any form_*.png files
1059# in the HTML output before the changes have effect.
1060
1061FORMULA_TRANSPARENT = YES
1062
1063# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1064# for the HTML output. The underlying search engine uses javascript
1065# and DHTML and should work on any modern browser. Note that when using
1066# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1067# (GENERATE_DOCSET) there is already a search function so this one should
1068# typically be disabled. For large projects the javascript based search engine
1069# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1070
1071SEARCHENGINE = NO
1072
1073# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1074# implemented using a PHP enabled web server instead of at the web client
1075# using Javascript. Doxygen will generate the search PHP script and index
1076# file to put on the web server. The advantage of the server
1077# based approach is that it scales better to large projects and allows
1078# full text search. The disadvances is that it is more difficult to setup
1079# and does not have live searching capabilities.
1080
1081SERVER_BASED_SEARCH = NO
1082
3b8b687d
MN
1083#---------------------------------------------------------------------------
1084# configuration options related to the LaTeX output
1085#---------------------------------------------------------------------------
1086
115329f1 1087# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
3b8b687d
MN
1088# generate Latex output.
1089
65415bb9 1090GENERATE_LATEX = NO
3b8b687d 1091
115329f1
DB
1092# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1093# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
1094# put in front of it. If left blank `latex' will be used as the default path.
1095
1096LATEX_OUTPUT = latex
1097
115329f1 1098# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
3b8b687d 1099# invoked. If left blank `latex' will be used as the default command name.
10dde477
RT
1100# Note that when enabling USE_PDFLATEX this option is only used for
1101# generating bitmaps for formulas in the HTML output, but not in the
1102# Makefile that is written to the output directory.
3b8b687d
MN
1103
1104LATEX_CMD_NAME = latex
1105
115329f1
DB
1106# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1107# generate index for LaTeX. If left blank `makeindex' will be used as the
3b8b687d
MN
1108# default command name.
1109
1110MAKEINDEX_CMD_NAME = makeindex
1111
115329f1
DB
1112# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1113# LaTeX documents. This may be useful for small projects and may help to
3b8b687d
MN
1114# save some trees in general.
1115
1116COMPACT_LATEX = NO
1117
115329f1
DB
1118# The PAPER_TYPE tag can be used to set the paper type that is used
1119# by the printer. Possible values are: a4, a4wide, letter, legal and
3b8b687d
MN
1120# executive. If left blank a4wide will be used.
1121
1122PAPER_TYPE = a4wide
1123
115329f1 1124# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
3b8b687d
MN
1125# packages that should be included in the LaTeX output.
1126
115329f1 1127EXTRA_PACKAGES =
3b8b687d 1128
115329f1
DB
1129# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1130# the generated latex document. The header should contain everything until
1131# the first chapter. If it is left blank doxygen will generate a
3b8b687d
MN
1132# standard header. Notice: only use this tag if you know what you are doing!
1133
115329f1 1134LATEX_HEADER =
3b8b687d 1135
115329f1
DB
1136# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1137# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1138# contain links (just like the HTML output) instead of page references
3b8b687d
MN
1139# This makes the output suitable for online browsing using a pdf viewer.
1140
1141PDF_HYPERLINKS = NO
1142
115329f1
DB
1143# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1144# plain latex in the generated Makefile. Set this option to YES to get a
3b8b687d
MN
1145# higher quality PDF documentation.
1146
1147USE_PDFLATEX = NO
1148
115329f1
DB
1149# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1150# command to the generated LaTeX files. This will instruct LaTeX to keep
1151# running if errors occur, instead of asking the user for help.
3b8b687d
MN
1152# This option is also used when generating formulas in HTML.
1153
1154LATEX_BATCHMODE = NO
1155
ac7a4056
DB
1156# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1157# include the index chapters (such as File Index, Compound Index, etc.)
1158# in the output.
1159
1160LATEX_HIDE_INDICES = NO
1161
10dde477
RT
1162# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1163# source code with syntax highlighting in the LaTeX output.
1164# Note that which sources are shown also depends on other settings
1165# such as SOURCE_BROWSER.
1166
1167LATEX_SOURCE_CODE = NO
1168
3b8b687d
MN
1169#---------------------------------------------------------------------------
1170# configuration options related to the RTF output
1171#---------------------------------------------------------------------------
1172
115329f1 1173# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
56cc85a0 1174# The RTF output is optimized for Word 97 and may not look very pretty with
3b8b687d
MN
1175# other RTF readers or editors.
1176
1177GENERATE_RTF = NO
1178
115329f1
DB
1179# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1180# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
1181# put in front of it. If left blank `rtf' will be used as the default path.
1182
1183RTF_OUTPUT = rtf
1184
115329f1
DB
1185# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1186# RTF documents. This may be useful for small projects and may help to
3b8b687d
MN
1187# save some trees in general.
1188
1189COMPACT_RTF = NO
1190
115329f1
DB
1191# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1192# will contain hyperlink fields. The RTF file will
1193# contain links (just like the HTML output) instead of page references.
1194# This makes the output suitable for online browsing using WORD or other
1195# programs which support those fields.
3b8b687d
MN
1196# Note: wordpad (write) and others do not support links.
1197
1198RTF_HYPERLINKS = NO
1199
115329f1 1200# Load stylesheet definitions from file. Syntax is similar to doxygen's
f31abc6c 1201# config file, i.e. a series of assignments. You only have to provide
3b8b687d
MN
1202# replacements, missing definitions are set to their default value.
1203
115329f1 1204RTF_STYLESHEET_FILE =
3b8b687d 1205
115329f1 1206# Set optional variables used in the generation of an rtf document.
3b8b687d
MN
1207# Syntax is similar to doxygen's config file.
1208
115329f1 1209RTF_EXTENSIONS_FILE =
3b8b687d
MN
1210
1211#---------------------------------------------------------------------------
1212# configuration options related to the man page output
1213#---------------------------------------------------------------------------
1214
115329f1 1215# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
3b8b687d
MN
1216# generate man pages
1217
1218GENERATE_MAN = NO
1219
115329f1
DB
1220# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1221# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3b8b687d
MN
1222# put in front of it. If left blank `man' will be used as the default path.
1223
1224MAN_OUTPUT = man
1225
115329f1 1226# The MAN_EXTENSION tag determines the extension that is added to
3b8b687d
MN
1227# the generated man pages (default is the subroutine's section .3)
1228
1229MAN_EXTENSION = .3
1230
115329f1
DB
1231# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1232# then it will generate one additional man file for each entity
1233# documented in the real man page(s). These additional files
1234# only source the real man page, but without them the man command
3b8b687d
MN
1235# would be unable to find the correct page. The default is NO.
1236
1237MAN_LINKS = NO
1238
1239#---------------------------------------------------------------------------
1240# configuration options related to the XML output
1241#---------------------------------------------------------------------------
1242
115329f1
DB
1243# If the GENERATE_XML tag is set to YES Doxygen will
1244# generate an XML file that captures the structure of
ac7a4056 1245# the code including all documentation.
3b8b687d
MN
1246
1247GENERATE_XML = NO
1248
ac7a4056
DB
1249# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1250# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1251# put in front of it. If left blank `xml' will be used as the default path.
1252
1253XML_OUTPUT = xml
1254
115329f1
DB
1255# The XML_SCHEMA tag can be used to specify an XML schema,
1256# which can be used by a validating XML parser to check the
3b8b687d
MN
1257# syntax of the XML files.
1258
115329f1 1259XML_SCHEMA =
3b8b687d 1260
115329f1
DB
1261# The XML_DTD tag can be used to specify an XML DTD,
1262# which can be used by a validating XML parser to check the
3b8b687d
MN
1263# syntax of the XML files.
1264
115329f1 1265XML_DTD =
3b8b687d 1266
ac7a4056
DB
1267# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1268# dump the program listings (including syntax highlighting
1269# and cross-referencing information) to the XML output. Note that
1270# enabling this will significantly increase the size of the XML output.
1271
1272XML_PROGRAMLISTING = YES
1273
3b8b687d
MN
1274#---------------------------------------------------------------------------
1275# configuration options for the AutoGen Definitions output
1276#---------------------------------------------------------------------------
1277
115329f1
DB
1278# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1279# generate an AutoGen Definitions (see autogen.sf.net) file
1280# that captures the structure of the code including all
1281# documentation. Note that this feature is still experimental
3b8b687d
MN
1282# and incomplete at the moment.
1283
1284GENERATE_AUTOGEN_DEF = NO
1285
1286#---------------------------------------------------------------------------
1287# configuration options related to the Perl module output
1288#---------------------------------------------------------------------------
1289
115329f1
DB
1290# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1291# generate a Perl module file that captures the structure of
1292# the code including all documentation. Note that this
1293# feature is still experimental and incomplete at the
3b8b687d
MN
1294# moment.
1295
1296GENERATE_PERLMOD = NO
1297
115329f1
DB
1298# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1299# the necessary Makefile rules, Perl scripts and LaTeX code to be able
3b8b687d
MN
1300# to generate PDF and DVI output from the Perl module output.
1301
1302PERLMOD_LATEX = NO
1303
115329f1 1304# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
10dde477
RT
1305# nicely formatted so it can be parsed by a human reader.
1306# This is useful
1307# if you want to understand what is going on.
1308# On the other hand, if this
115329f1 1309# tag is set to NO the size of the Perl module output will be much smaller
3b8b687d
MN
1310# and Perl will parse it just the same.
1311
1312PERLMOD_PRETTY = YES
1313
115329f1
DB
1314# The names of the make variables in the generated doxyrules.make file
1315# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1316# This is useful so different doxyrules.make files included by the same
3b8b687d
MN
1317# Makefile don't overwrite each other's variables.
1318
115329f1 1319PERLMOD_MAKEVAR_PREFIX =
3b8b687d
MN
1320
1321#---------------------------------------------------------------------------
115329f1 1322# Configuration options related to the preprocessor
3b8b687d
MN
1323#---------------------------------------------------------------------------
1324
115329f1
DB
1325# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1326# evaluate all C-preprocessor directives found in the sources and include
3b8b687d
MN
1327# files.
1328
1329ENABLE_PREPROCESSING = YES
1330
115329f1
DB
1331# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1332# names in the source code. If set to NO (the default) only conditional
1333# compilation will be performed. Macro expansion can be done in a controlled
3b8b687d
MN
1334# way by setting EXPAND_ONLY_PREDEF to YES.
1335
1336MACRO_EXPANSION = YES
1337
115329f1
DB
1338# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1339# then the macro expansion is limited to the macros specified with the
ac7a4056 1340# PREDEFINED and EXPAND_AS_DEFINED tags.
3b8b687d
MN
1341
1342EXPAND_ONLY_PREDEF = YES
1343
115329f1 1344# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
3b8b687d
MN
1345# in the INCLUDE_PATH (see below) will be search if a #include is found.
1346
1347SEARCH_INCLUDES = YES
1348
115329f1
DB
1349# The INCLUDE_PATH tag can be used to specify one or more directories that
1350# contain include files that are not input files but should be processed by
3b8b687d
MN
1351# the preprocessor.
1352
115329f1 1353INCLUDE_PATH =
3b8b687d 1354
115329f1
DB
1355# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1356# patterns (like *.h and *.hpp) to filter out the header-files in the
1357# directories. If left blank, the patterns specified with FILE_PATTERNS will
3b8b687d
MN
1358# be used.
1359
115329f1 1360INCLUDE_FILE_PATTERNS =
3b8b687d 1361
115329f1
DB
1362# The PREDEFINED tag can be used to specify one or more macro names that
1363# are defined before the preprocessor is started (similar to the -D option of
1364# gcc). The argument of the tag is a list of macros of the form: name
1365# or name=definition (no spaces). If the definition and the = are
ac7a4056
DB
1366# omitted =1 is assumed. To prevent a macro definition from being
1367# undefined via #undef or recursively expanded use the := operator
1368# instead of the = operator.
3b8b687d 1369
10dde477
RT
1370PREDEFINED = "__attribute__(x)=" \
1371 "RENAME(x)=x ## _TMPL" \
1372 "DEF(x)=x ## _TMPL" \
1373 HAVE_AV_CONFIG_H \
1374 HAVE_MMX \
1375 HAVE_MMX2 \
1376 HAVE_AMD3DNOW \
1377 "DECLARE_ALIGNED(a,t,n)=t n" \
1378 "offsetof(x,y)=0x42"
3b8b687d 1379
115329f1
DB
1380# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1381# this tag can be used to specify a list of macro names that should be expanded.
1382# The macro definition that is found in the sources will be used.
3b8b687d
MN
1383# Use the PREDEFINED tag if you want to use a different macro definition.
1384
d0fcf39f
DB
1385EXPAND_AS_DEFINED = declare_idct \
1386 READ_PAR_DATA \
3b8b687d 1387
115329f1
DB
1388# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1389# doxygen's preprocessor will remove all function-like macros that are alone
1390# on a line, have an all uppercase name, and do not end with a semicolon. Such
f31abc6c
DB
1391# function macros are typically used for boiler-plate code, and will confuse
1392# the parser if not removed.
3b8b687d
MN
1393
1394SKIP_FUNCTION_MACROS = YES
1395
1396#---------------------------------------------------------------------------
f31abc6c 1397# Configuration::additions related to external references
3b8b687d
MN
1398#---------------------------------------------------------------------------
1399
f31abc6c 1400# The TAGFILES option can be used to specify one or more tagfiles.
ac7a4056
DB
1401# Optionally an initial location of the external documentation
1402# can be added for each tagfile. The format of a tag file without
1403# this location is as follows:
10dde477
RT
1404#
1405# TAGFILES = file1 file2 ...
ac7a4056 1406# Adding location for the tag files is done as follows:
10dde477
RT
1407#
1408# TAGFILES = file1=loc1 "file2 = loc2" ...
ac7a4056
DB
1409# where "loc1" and "loc2" can be relative or absolute paths or
1410# URLs. If a location is present for each tag, the installdox tool
1411# does not have to be run to correct the links.
1412# Note that each tag file must have a unique name
1413# (where the name does NOT include the path)
1414# If a tag file is not located in the directory in which doxygen
1415# is run, you must also specify the path to the tagfile here.
3b8b687d 1416
115329f1 1417TAGFILES =
3b8b687d 1418
115329f1 1419# When a file name is specified after GENERATE_TAGFILE, doxygen will create
3b8b687d
MN
1420# a tag file that is based on the input files it reads.
1421
115329f1 1422GENERATE_TAGFILE =
3b8b687d 1423
115329f1
DB
1424# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1425# in the class index. If set to NO only the inherited external classes
3b8b687d
MN
1426# will be listed.
1427
1428ALLEXTERNALS = NO
1429
115329f1
DB
1430# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1431# in the modules index. If set to NO, only the current project's groups will
3b8b687d
MN
1432# be listed.
1433
1434EXTERNAL_GROUPS = YES
1435
115329f1 1436# The PERL_PATH should be the absolute path and name of the perl script
3b8b687d
MN
1437# interpreter (i.e. the result of `which perl').
1438
1439PERL_PATH = /usr/bin/perl
1440
1441#---------------------------------------------------------------------------
115329f1 1442# Configuration options related to the dot tool
3b8b687d
MN
1443#---------------------------------------------------------------------------
1444
115329f1 1445# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
f31abc6c
DB
1446# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1447# or super classes. Setting the tag to NO turns the diagrams off. Note that
1448# this option is superseded by the HAVE_DOT option below. This is only a
1449# fallback. It is recommended to install and use dot, since it yields more
1450# powerful graphs.
3b8b687d
MN
1451
1452CLASS_DIAGRAMS = YES
1453
ac7a4056
DB
1454# You can define message sequence charts within doxygen comments using the \msc
1455# command. Doxygen will then run the mscgen tool (see
1456# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1457# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1458# the mscgen tool resides. If left empty the tool is assumed to be found in the
1459# default search path.
1460
1461MSCGEN_PATH =
1462
115329f1
DB
1463# If set to YES, the inheritance and collaboration graphs will hide
1464# inheritance and usage relations if the target is undocumented
3b8b687d
MN
1465# or is not a class.
1466
1467HIDE_UNDOC_RELATIONS = YES
1468
115329f1
DB
1469# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1470# available from the path. This tool is part of Graphviz, a graph visualization
1471# toolkit from AT&T and Lucent Bell Labs. The other options in this section
3b8b687d
MN
1472# have no effect if this option is set to NO (the default)
1473
1474HAVE_DOT = NO
1475
10dde477
RT
1476# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1477# allowed to run in parallel. When set to 0 (the default) doxygen will
1478# base this on the number of processors available in the system. You can set it
1479# explicitly to a value larger than 0 to get control over the balance
1480# between CPU load and processing speed.
1481
1482DOT_NUM_THREADS = 0
1483
ac7a4056
DB
1484# By default doxygen will write a font called FreeSans.ttf to the output
1485# directory and reference it in all dot files that doxygen generates. This
1486# font does not include all possible unicode characters however, so when you need
1487# these (or just want a differently looking font) you can specify the font name
1488# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1489# which can be done by putting it in a standard location or by setting the
1490# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1491# containing the font.
1492
1493DOT_FONTNAME = FreeSans
1494
10dde477
RT
1495# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1496# The default size is 10pt.
1497
1498DOT_FONTSIZE = 10
1499
ac7a4056
DB
1500# By default doxygen will tell dot to use the output directory to look for the
1501# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1502# different font using DOT_FONTNAME you can set the path where dot
1503# can find it using this tag.
1504
1505DOT_FONTPATH =
1506
115329f1
DB
1507# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1508# will generate a graph for each documented class showing the direct and
1509# indirect inheritance relations. Setting this tag to YES will force the
3b8b687d
MN
1510# the CLASS_DIAGRAMS tag to NO.
1511
1512CLASS_GRAPH = YES
1513
115329f1
DB
1514# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1515# will generate a graph for each documented class showing the direct and
1516# indirect implementation dependencies (inheritance, containment, and
3b8b687d
MN
1517# class references variables) of the class with other documented classes.
1518
1519COLLABORATION_GRAPH = YES
1520
ac7a4056
DB
1521# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1522# will generate a graph for groups, showing the direct groups dependencies
1523
1524GROUP_GRAPHS = YES
1525
1526# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1527# collaboration diagrams in a style similar to the OMG's Unified Modeling
1528# Language.
1529
1530UML_LOOK = NO
1531
115329f1 1532# If set to YES, the inheritance and collaboration graphs will show the
3b8b687d
MN
1533# relations between templates and their instances.
1534
1535TEMPLATE_RELATIONS = YES
1536
115329f1
DB
1537# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1538# tags are set to YES then doxygen will generate a graph for each documented
1539# file showing the direct and indirect include dependencies of the file with
3b8b687d
MN
1540# other documented files.
1541
1542INCLUDE_GRAPH = YES
1543
115329f1
DB
1544# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1545# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1546# documented header file showing the documented files that directly or
3b8b687d
MN
1547# indirectly include this file.
1548
1549INCLUDED_BY_GRAPH = YES
1550
ac7a4056
DB
1551# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1552# doxygen will generate a call dependency graph for every global function
1553# or class method. Note that enabling this option will significantly increase
1554# the time of a run. So in most cases it will be better to enable call graphs
1555# for selected functions only using the \callgraph command.
1556
1557CALL_GRAPH = NO
1558
1559# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1560# doxygen will generate a caller dependency graph for every global function
1561# or class method. Note that enabling this option will significantly increase
1562# the time of a run. So in most cases it will be better to enable caller
1563# graphs for selected functions only using the \callergraph command.
1564
1565CALLER_GRAPH = NO
1566
115329f1 1567# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
3b8b687d
MN
1568# will graphical hierarchy of all classes instead of a textual one.
1569
1570GRAPHICAL_HIERARCHY = YES
1571
ac7a4056
DB
1572# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1573# then doxygen will show the dependencies a directory has on other directories
1574# in a graphical way. The dependency relations are determined by the #include
1575# relations between the files in the directories.
1576
1577DIRECTORY_GRAPH = YES
1578
115329f1 1579# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
3b8b687d
MN
1580# generated by dot. Possible values are png, jpg, or gif
1581# If left blank png will be used.
1582
1583DOT_IMAGE_FORMAT = png
1584
115329f1 1585# The tag DOT_PATH can be used to specify the path where the dot tool can be
f31abc6c 1586# found. If left blank, it is assumed the dot tool can be found in the path.
3b8b687d 1587
115329f1 1588DOT_PATH =
3b8b687d 1589
115329f1
DB
1590# The DOTFILE_DIRS tag can be used to specify one or more directories that
1591# contain dot files that are included in the documentation (see the
3b8b687d
MN
1592# \dotfile command).
1593
115329f1 1594DOTFILE_DIRS =
3b8b687d 1595
ac7a4056
DB
1596# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1597# nodes that will be shown in the graph. If the number of nodes in a graph
1598# becomes larger than this value, doxygen will truncate the graph, which is
1599# visualized by representing a node as a red box. Note that doxygen if the
1600# number of direct children of the root node in a graph is already larger than
1601# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1602# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
3b8b687d 1603
ac7a4056 1604DOT_GRAPH_MAX_NODES = 50
3b8b687d 1605
ac7a4056
DB
1606# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1607# graphs generated by dot. A depth value of 3 means that only nodes reachable
1608# from the root by following a path via at most 3 edges will be shown. Nodes
1609# that lay further from the root node will be omitted. Note that setting this
1610# option to 1 or 2 may greatly reduce the computation time needed for large
1611# code bases. Also note that the size of a graph can be further restricted by
1612# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
3b8b687d 1613
ac7a4056
DB
1614MAX_DOT_GRAPH_DEPTH = 0
1615
1616# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
10dde477
RT
1617# background. This is disabled by default, because dot on Windows does not
1618# seem to support this out of the box. Warning: Depending on the platform used,
1619# enabling this option may lead to badly anti-aliased labels on the edges of
1620# a graph (i.e. they become hard to read).
ac7a4056
DB
1621
1622DOT_TRANSPARENT = YES
1623
1624# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1625# files in one run (i.e. multiple -o and -T options on the command line). This
1626# makes dot run faster, but since only newer versions of dot (>1.8.10)
1627# support this, this feature is disabled by default.
1628
1629DOT_MULTI_TARGETS = NO
3b8b687d 1630
115329f1
DB
1631# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1632# generate a legend page explaining the meaning of the various boxes and
3b8b687d
MN
1633# arrows in the dot generated graphs.
1634
1635GENERATE_LEGEND = YES
1636
115329f1 1637# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
f31abc6c 1638# remove the intermediate dot files that are used to generate
3b8b687d
MN
1639# the various graphs.
1640
1641DOT_CLEANUP = YES