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