3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
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 (" ")
13
#---------------------------------------------------------------------------
14
# General configuration options
15
#---------------------------------------------------------------------------
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23
# This could be handy for archiving the generated documentation or
24
# if some version control system is used.
26
PROJECT_NUMBER = 1.1.0
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
31
# where doxygen was started. If left blank the current directory will be used.
33
OUTPUT_DIRECTORY = doxytmp
35
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36
# documentation generated by doxygen is written. Doxygen will use this
37
# information to generate all constant output in the proper language.
38
# The default language is English, other supported languages are:
39
# Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean,
41
# Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovene,
42
# Spanish, Swedish and Ukrainian.
44
OUTPUT_LANGUAGE = English
46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47
# documentation are documented, even if no documentation was available.
48
# Private class members and static file members will be hidden unless
49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
54
# will be included in the documentation.
58
# If the EXTRACT_STATIC tag is set to YES all static members of a file
59
# will be included in the documentation.
63
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64
# defined locally in source files will be included in the documentation.
65
# If set to NO only classes defined in header files are included.
67
EXTRACT_LOCAL_CLASSES = YES
69
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70
# undocumented members of documented classes, files or namespaces.
71
# If set to NO (the default) these members will be included in the
72
# various overviews, but no documentation section is generated.
73
# This option has no effect if EXTRACT_ALL is enabled.
75
HIDE_UNDOC_MEMBERS = NO
77
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78
# undocumented classes that are normally visible in the class hierarchy.
79
# If set to NO (the default) these class will be included in the various
80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
82
HIDE_UNDOC_CLASSES = NO
84
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
85
# include brief member descriptions after the members that are listed in
86
# the file and class documentation (similar to JavaDoc).
87
# Set to NO to disable this.
89
BRIEF_MEMBER_DESC = YES
91
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
92
# the brief description of a member or function before the detailed description.
93
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
94
# brief descriptions will be completely suppressed.
98
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
99
# Doxygen will generate a detailed section even if there is only a brief
102
ALWAYS_DETAILED_SEC = NO
104
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
105
# members of a class in the documentation of that class as if those members were
106
# ordinary class members. Constructors, destructors and assignment operators of
107
# the base classes will not be shown.
109
INLINE_INHERITED_MEMB = NO
111
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
112
# path before files name in the file list and in the header files. If set
113
# to NO the shortest path that makes the file name unique will be used.
115
FULL_PATH_NAMES = YES
117
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
118
# can be used to strip a user defined part of the path. Stripping is
119
# only done if one of the specified strings matches the left-hand part of
120
# the path. It is allowed to use relative paths in the argument list.
124
# The INTERNAL_DOCS tag determines if documentation
125
# that is typed after a \internal command is included. If the tag is set
126
# to NO (the default) then the documentation will be excluded.
127
# Set it to YES to include the internal documentation.
131
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
132
# doxygen to hide any special comment blocks from generated source code
133
# fragments. Normal C and C++ comments will always remain visible.
135
STRIP_CODE_COMMENTS = YES
137
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
138
# file names in lower case letters. If set to YES upper case letters are also
139
# allowed. This is useful if you have classes or files whose names only differ
140
# in case and if your file system supports case sensitive file names. Windows
141
# users are adviced to set this option to NO.
143
CASE_SENSE_NAMES = YES
145
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
146
# (but less readable) file names. This can be useful is your file systems
147
# doesn't support long names like on DOS, Mac, or CD-ROM.
151
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
152
# will show members with their full class and namespace scopes in the
153
# documentation. If set to YES the scope will be hidden.
155
HIDE_SCOPE_NAMES = NO
157
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
158
# will generate a verbatim copy of the header file for each class for
159
# which an include is specified. Set to NO to disable this.
161
VERBATIM_HEADERS = YES
163
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
164
# will put list of the files that are included by a file in the documentation
167
SHOW_INCLUDE_FILES = YES
169
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
170
# will interpret the first line (until the first dot) of a JavaDoc-style
171
# comment as the brief description. If set to NO, the JavaDoc
172
# comments will behave just like the Qt-style comments (thus requiring an
173
# explict @brief command for a brief description.
175
JAVADOC_AUTOBRIEF = NO
177
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
178
# will output the detailed description near the top, like JavaDoc.
179
# If set to NO, the detailed description appears after the member
184
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
185
# member inherits the documentation from any documented member that it
190
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
191
# is inserted in the documentation for inline members.
195
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
196
# will sort the (detailed) documentation of file and class members
197
# alphabetically by member name. If set to NO the members will appear in
200
SORT_MEMBER_DOCS = NO
202
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
203
# tag is set to YES, then doxygen will reuse the documentation of the first
204
# member in the group (if any) for the other members of the group. By default
205
# all members of a group must be documented explicitly.
207
DISTRIBUTE_GROUP_DOC = YES
209
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
210
# Doxygen uses this value to replace tabs by spaces in code fragments.
214
# The GENERATE_TODOLIST tag can be used to enable (YES) or
215
# disable (NO) the todo list. This list is created by putting \todo
216
# commands in the documentation.
218
GENERATE_TODOLIST = YES
220
# The GENERATE_TESTLIST tag can be used to enable (YES) or
221
# disable (NO) the test list. This list is created by putting \test
222
# commands in the documentation.
224
GENERATE_TESTLIST = YES
226
# The GENERATE_BUGLIST tag can be used to enable (YES) or
227
# disable (NO) the bug list. This list is created by putting \bug
228
# commands in the documentation.
230
GENERATE_BUGLIST = YES
232
# This tag can be used to specify a number of aliases that acts
233
# as commands in the documentation. An alias has the form "name=value".
234
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
235
# put the command \sideeffect (or @sideeffect) in the documentation, which
236
# will result in a user defined paragraph with heading "Side Effects:".
237
# You can put \n's in the value part of an alias to insert newlines.
239
ALIASES = "assert=\par Assertions:\n" \
240
"default=\par Default Value:\n"
242
# The ENABLED_SECTIONS tag can be used to enable conditional
243
# documentation sections, marked by \if sectionname ... \endif.
247
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
248
# the initial value of a variable or define consist of for it to appear in
249
# the documentation. If the initializer consists of more lines than specified
250
# here it will be hidden. Use a value of 0 to hide initializers completely.
251
# The appearance of the initializer of individual variables and defines in the
252
# documentation can be controlled using \showinitializer or \hideinitializer
253
# command in the documentation regardless of this setting.
255
MAX_INITIALIZER_LINES = 30
257
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
258
# only. Doxygen will then generate output that is more tailored for C.
259
# For instance some of the names that are used will be different. The list
260
# of all members will be omitted, etc.
262
OPTIMIZE_OUTPUT_FOR_C = NO
264
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
265
# only. Doxygen will then generate output that is more tailored for Java.
266
# For instance namespaces will be presented as packages, qualified scopes
267
# will look different, etc.
269
OPTIMIZE_OUTPUT_JAVA = NO
271
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
272
# at the bottom of the documentation of classes and structs. If set to YES the
273
# list will mention the files that were used to generate the documentation.
275
SHOW_USED_FILES = YES
277
#---------------------------------------------------------------------------
278
# configuration options related to warning and progress messages
279
#---------------------------------------------------------------------------
281
# The QUIET tag can be used to turn on/off the messages that are generated
282
# by doxygen. Possible values are YES and NO. If left blank NO is used.
286
# The WARNINGS tag can be used to turn on/off the warning messages that are
287
# generated by doxygen. Possible values are YES and NO. If left blank
292
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
293
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
294
# automatically be disabled.
296
WARN_IF_UNDOCUMENTED = YES
298
# The WARN_FORMAT tag determines the format of the warning messages that
299
# doxygen can produce. The string should contain the $file, $line, and $text
300
# tags, which will be replaced by the file and line number from which the
301
# warning originated and the warning text.
303
WARN_FORMAT = "$file:$line: $text"
305
# The WARN_LOGFILE tag can be used to specify a file to which warning
306
# and error messages should be written. If left blank the output is written
311
#---------------------------------------------------------------------------
312
# configuration options related to the input files
313
#---------------------------------------------------------------------------
315
# The INPUT tag can be used to specify the files and/or directories that contain
316
# documented source files. You may enter file names like "myfile.cpp" or
317
# directories like "/usr/src/myproject". Separate the files or directories
320
INPUT = ../include/FLAC ../include/FLAC++ ../include/OggFLAC ../include/OggFLAC++
322
# If the value of the INPUT tag contains directories, you can use the
323
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
324
# and *.h) to filter out the source-files in the directories. If left
325
# blank the following patterns are tested:
326
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
331
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
332
# should be searched for input files as well. Possible values are YES and NO.
333
# If left blank NO is used.
337
# The EXCLUDE tag can be used to specify files and/or directories that should
338
# excluded from the INPUT source files. This way you can easily exclude a
339
# subdirectory from a directory tree whose root is specified with the INPUT tag.
341
EXCLUDE = ../include/OggFLAC/seekable_stream_decoder.h ../include/OggFLAC/file_decoder.h
343
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
344
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
346
EXCLUDE_SYMLINKS = NO
348
# If the value of the INPUT tag contains directories, you can use the
349
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
350
# certain files from those directories.
354
# The EXAMPLE_PATH tag can be used to specify one or more files or
355
# directories that contain example code fragments that are included (see
356
# the \include command).
360
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
361
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
362
# and *.h) to filter out the source-files in the directories. If left
363
# blank all files are included.
367
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
368
# searched for input files to be used with the \include or \dontinclude
369
# commands irrespective of the value of the RECURSIVE tag.
370
# Possible values are YES and NO. If left blank NO is used.
372
EXAMPLE_RECURSIVE = NO
374
# The IMAGE_PATH tag can be used to specify one or more files or
375
# directories that contain image that are included in the documentation (see
376
# the \image command).
380
# The INPUT_FILTER tag can be used to specify a program that doxygen should
381
# invoke to filter for each input file. Doxygen will invoke the filter program
382
# by executing (via popen()) the command <filter> <input-file>, where <filter>
383
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
384
# input file. Doxygen will then use the output that the filter program writes
385
# to standard output.
389
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
390
# INPUT_FILTER) will be used to filter the input files when producing source
393
FILTER_SOURCE_FILES = NO
395
#---------------------------------------------------------------------------
396
# configuration options related to source browsing
397
#---------------------------------------------------------------------------
399
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
400
# be generated. Documented entities will be cross-referenced with these sources.
404
# Setting the INLINE_SOURCES tag to YES will include the body
405
# of functions and classes directly in the documentation.
409
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
410
# then for each documented function all documented
411
# functions referencing it will be listed.
413
REFERENCED_BY_RELATION = YES
415
# If the REFERENCES_RELATION tag is set to YES (the default)
416
# then for each documented function all documented entities
417
# called/used by that function will be listed.
419
REFERENCES_RELATION = YES
421
#---------------------------------------------------------------------------
422
# configuration options related to the alphabetical class index
423
#---------------------------------------------------------------------------
425
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
426
# of all compounds will be generated. Enable this if the project
427
# contains a lot of classes, structs, unions or interfaces.
429
ALPHABETICAL_INDEX = YES
431
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
432
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
433
# in which this list will be split (can be a number in the range [1..20])
435
COLS_IN_ALPHA_INDEX = 5
437
# In case all classes in a project start with a common prefix, all
438
# classes will be put under the same header in the alphabetical index.
439
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
440
# should be ignored while generating the index headers.
444
#---------------------------------------------------------------------------
445
# configuration options related to the HTML output
446
#---------------------------------------------------------------------------
448
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
449
# generate HTML output.
453
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
454
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
455
# put in front of it. If left blank `html' will be used as the default path.
459
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
460
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
461
# doxygen will generate files with .html extension.
463
HTML_FILE_EXTENSION = .html
465
# The HTML_HEADER tag can be used to specify a personal HTML header for
466
# each generated HTML page. If it is left blank doxygen will generate a
471
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
472
# each generated HTML page. If it is left blank doxygen will generate a
477
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
478
# style sheet that is used by each HTML page. It can be used to
479
# fine-tune the look of the HTML output. If the tag is left blank doxygen
480
# will generate a default style sheet
484
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
485
# files or namespaces will be aligned in HTML using tables. If set to
486
# NO a bullet list will be used.
488
HTML_ALIGN_MEMBERS = YES
490
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
491
# will be generated that can be used as input for tools like the
492
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
493
# of the generated HTML documentation.
495
GENERATE_HTMLHELP = NO
497
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
498
# controls if a separate .chi index file is generated (YES) or that
499
# it should be included in the master .chm file (NO).
503
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
504
# controls whether a binary table of contents is generated (YES) or a
505
# normal table of contents (NO) in the .chm file.
509
# The TOC_EXPAND flag can be set to YES to add extra items for group members
510
# to the contents of the Html help documentation and to the tree view.
514
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
515
# top of each HTML page. The value NO (the default) enables the index and
516
# the value YES disables it.
520
# This tag can be used to set the number of enum values (range [1..20])
521
# that doxygen will group on one line in the generated HTML documentation.
523
ENUM_VALUES_PER_LINE = 4
525
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
526
# generated containing a tree-like index structure (just like the one that
527
# is generated for HTML Help). For this to work a browser that supports
528
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
529
# or Internet explorer 4.0+). Note that for large projects the tree generation
530
# can take a very long time. In such cases it is better to disable this feature.
531
# Windows users are probably better off using the HTML help feature.
533
GENERATE_TREEVIEW = NO
535
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
536
# used to set the initial width (in pixels) of the frame in which the tree
541
#---------------------------------------------------------------------------
542
# configuration options related to the LaTeX output
543
#---------------------------------------------------------------------------
545
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
546
# generate Latex output.
550
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
551
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
552
# put in front of it. If left blank `latex' will be used as the default path.
556
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
558
LATEX_CMD_NAME = latex
560
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
561
# generate index for LaTeX. If left blank `makeindex' will be used as the
562
# default command name.
564
MAKEINDEX_CMD_NAME = makeindex
566
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
567
# LaTeX documents. This may be useful for small projects and may help to
568
# save some trees in general.
572
# The PAPER_TYPE tag can be used to set the paper type that is used
573
# by the printer. Possible values are: a4, a4wide, letter, legal and
574
# executive. If left blank a4wide will be used.
578
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
579
# packages that should be included in the LaTeX output.
583
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
584
# the generated latex document. The header should contain everything until
585
# the first chapter. If it is left blank doxygen will generate a
586
# standard header. Notice: only use this tag if you know what you are doing!
590
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
591
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
592
# contain links (just like the HTML output) instead of page references
593
# This makes the output suitable for online browsing using a pdf viewer.
597
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
598
# plain latex in the generated Makefile. Set this option to YES to get a
599
# higher quality PDF documentation.
603
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
604
# command to the generated LaTeX files. This will instruct LaTeX to keep
605
# running if errors occur, instead of asking the user for help.
606
# This option is also used when generating formulas in HTML.
610
#---------------------------------------------------------------------------
611
# configuration options related to the RTF output
612
#---------------------------------------------------------------------------
614
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
615
# The RTF output is optimised for Word 97 and may not look very pretty with
616
# other RTF readers or editors.
620
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
621
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
622
# put in front of it. If left blank `rtf' will be used as the default path.
626
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
627
# RTF documents. This may be useful for small projects and may help to
628
# save some trees in general.
632
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
633
# will contain hyperlink fields. The RTF file will
634
# contain links (just like the HTML output) instead of page references.
635
# This makes the output suitable for online browsing using WORD or other
636
# programs which support those fields.
637
# Note: wordpad (write) and others do not support links.
641
# Load stylesheet definitions from file. Syntax is similar to doxygen's
642
# config file, i.e. a series of assigments. You only have to provide
643
# replacements, missing definitions are set to their default value.
645
RTF_STYLESHEET_FILE =
647
# Set optional variables used in the generation of an rtf document.
648
# Syntax is similar to doxygen's config file.
650
RTF_EXTENSIONS_FILE =
652
#---------------------------------------------------------------------------
653
# configuration options related to the man page output
654
#---------------------------------------------------------------------------
656
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
661
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
662
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
663
# put in front of it. If left blank `man' will be used as the default path.
667
# The MAN_EXTENSION tag determines the extension that is added to
668
# the generated man pages (default is the subroutine's section .3)
672
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
673
# then it will generate one additional man file for each entity
674
# documented in the real man page(s). These additional files
675
# only source the real man page, but without them the man command
676
# would be unable to find the correct page. The default is NO.
680
#---------------------------------------------------------------------------
681
# configuration options related to the XML output
682
#---------------------------------------------------------------------------
684
# If the GENERATE_XML tag is set to YES Doxygen will
685
# generate an XML file that captures the structure of
686
# the code including all documentation. Note that this
687
# feature is still experimental and incomplete at the
692
#---------------------------------------------------------------------------
693
# configuration options for the AutoGen Definitions output
694
#---------------------------------------------------------------------------
696
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
697
# generate an AutoGen Definitions (see autogen.sf.net) file
698
# that captures the structure of the code including all
699
# documentation. Note that this feature is still experimental
700
# and incomplete at the moment.
702
GENERATE_AUTOGEN_DEF = NO
704
#---------------------------------------------------------------------------
705
# Configuration options related to the preprocessor
706
#---------------------------------------------------------------------------
708
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
709
# evaluate all C-preprocessor directives found in the sources and include
712
ENABLE_PREPROCESSING = YES
714
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
715
# names in the source code. If set to NO (the default) only conditional
716
# compilation will be performed. Macro expansion can be done in a controlled
717
# way by setting EXPAND_ONLY_PREDEF to YES.
719
MACRO_EXPANSION = YES
721
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
722
# then the macro expansion is limited to the macros specified with the
723
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
725
EXPAND_ONLY_PREDEF = YES
727
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
728
# in the INCLUDE_PATH (see below) will be search if a #include is found.
730
SEARCH_INCLUDES = YES
732
# The INCLUDE_PATH tag can be used to specify one or more directories that
733
# contain include files that are not input files but should be processed by
738
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
739
# patterns (like *.h and *.hpp) to filter out the header-files in the
740
# directories. If left blank, the patterns specified with FILE_PATTERNS will
743
INCLUDE_FILE_PATTERNS =
745
# The PREDEFINED tag can be used to specify one or more macro names that
746
# are defined before the preprocessor is started (similar to the -D option of
747
# gcc). The argument of the tag is a list of macros of the form: name
748
# or name=definition (no spaces). If the definition and the = are
749
# omitted =1 is assumed.
751
PREDEFINED = FLAC__NO_DLL
753
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
754
# this tag can be used to specify a list of macro names that should be expanded.
755
# The macro definition that is found in the sources will be used.
756
# Use the PREDEFINED tag if you want to use a different macro definition.
758
EXPAND_AS_DEFINED = FLAC_API
760
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
761
# doxygen's preprocessor will remove all function-like macros that are alone
762
# on a line and do not end with a semicolon. Such function macros are typically
763
# used for boiler-plate code, and will confuse the parser if not removed.
765
SKIP_FUNCTION_MACROS = YES
767
#---------------------------------------------------------------------------
768
# Configuration::addtions related to external references
769
#---------------------------------------------------------------------------
771
# The TAGFILES tag can be used to specify one or more tagfiles.
775
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
776
# a tag file that is based on the input files it reads.
778
GENERATE_TAGFILE = FLAC.tag
780
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
781
# in the class index. If set to NO only the inherited external classes
786
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
787
# in the modules index. If set to NO, only the current project's groups will
790
EXTERNAL_GROUPS = YES
792
# The PERL_PATH should be the absolute path and name of the perl script
793
# interpreter (i.e. the result of `which perl').
795
PERL_PATH = /usr/bin/perl
797
#---------------------------------------------------------------------------
798
# Configuration options related to the dot tool
799
#---------------------------------------------------------------------------
801
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
802
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
803
# super classes. Setting the tag to NO turns the diagrams off. Note that this
804
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
805
# recommended to install and use dot, since it yield more powerful graphs.
809
# If set to YES, the inheritance and collaboration graphs will hide
810
# inheritance and usage relations if the target is undocumented
813
HIDE_UNDOC_RELATIONS = YES
815
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
816
# available from the path. This tool is part of Graphviz, a graph visualization
817
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
818
# have no effect if this option is set to NO (the default)
822
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
823
# will generate a graph for each documented class showing the direct and
824
# indirect inheritance relations. Setting this tag to YES will force the
825
# the CLASS_DIAGRAMS tag to NO.
829
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
830
# will generate a graph for each documented class showing the direct and
831
# indirect implementation dependencies (inheritance, containment, and
832
# class references variables) of the class with other documented classes.
834
COLLABORATION_GRAPH = YES
836
# If set to YES, the inheritance and collaboration graphs will show the
837
# relations between templates and their instances.
839
TEMPLATE_RELATIONS = YES
841
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
842
# tags are set to YES then doxygen will generate a graph for each documented
843
# file showing the direct and indirect include dependencies of the file with
844
# other documented files.
848
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
849
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
850
# documented header file showing the documented files that directly or
851
# indirectly include this file.
853
INCLUDED_BY_GRAPH = YES
855
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
856
# will graphical hierarchy of all classes instead of a textual one.
858
GRAPHICAL_HIERARCHY = YES
860
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
861
# generated by dot. Possible values are png, jpg, or gif
862
# If left blank png will be used.
864
DOT_IMAGE_FORMAT = png
866
# The tag DOT_PATH can be used to specify the path where the dot tool can be
867
# found. If left blank, it is assumed the dot tool can be found on the path.
871
# The DOTFILE_DIRS tag can be used to specify one or more directories that
872
# contain dot files that are included in the documentation (see the
877
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
878
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
879
# this value, doxygen will try to truncate the graph, so that it fits within
880
# the specified constraint. Beware that most browsers cannot cope with very
883
MAX_DOT_GRAPH_WIDTH = 1024
885
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
886
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
887
# this value, doxygen will try to truncate the graph, so that it fits within
888
# the specified constraint. Beware that most browsers cannot cope with very
891
MAX_DOT_GRAPH_HEIGHT = 1024
893
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
894
# generate a legend page explaining the meaning of the various boxes and
895
# arrows in the dot generated graphs.
897
GENERATE_LEGEND = YES
899
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
900
# remove the intermedate dot files that are used to generate
901
# the various graphs.
905
#---------------------------------------------------------------------------
906
# Configuration::addtions related to the search engine
907
#---------------------------------------------------------------------------
909
# The SEARCHENGINE tag specifies whether or not a search engine should be
910
# used. If set to NO the values of all tags below this one will be ignored.
914
# The CGI_NAME tag should be the name of the CGI script that
915
# starts the search engine (doxysearch) with the correct parameters.
916
# A script with this name will be generated by doxygen.
918
CGI_NAME = search.cgi
920
# The CGI_URL tag should be the absolute URL to the directory where the
921
# cgi binaries are located. See the documentation of your http daemon for
926
# The DOC_URL tag should be the absolute URL to the directory where the
927
# documentation is located. If left blank the absolute path to the
928
# documentation, with file:// prepended to it, will be used.
932
# The DOC_ABSPATH tag should be the absolute path to the directory where the
933
# documentation is located. If left blank the directory on the local machine
938
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
941
BIN_ABSPATH = /usr/local/bin/
943
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
944
# documentation generated for other projects. This allows doxysearch to search
945
# the documentation for these projects as well.
added
removed
doc/Doxyfile
