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