blob: 87c4849e7a86dbd10d8012e36479611b75773f67 [file] [log] [blame]
Josh Coalson58c2acb2006-10-06 05:26:22 +00001# Doxyfile 1.4.2
Josh Coalson5e5fc012002-07-16 16:09:53 +00002
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#---------------------------------------------------------------------------
Josh Coalson58c2acb2006-10-06 05:26:22 +000014# Project related configuration options
Josh Coalson5e5fc012002-07-16 16:09:53 +000015#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = FLAC
21
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.
25
Josh Coalsonfd5fbc72006-10-07 07:01:29 +000026PROJECT_NUMBER = 1.1.3
Josh Coalson5e5fc012002-07-16 16:09:53 +000027
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.
32
33OUTPUT_DIRECTORY = doxytmp
34
Josh Coalson58c2acb2006-10-06 05:26:22 +000035# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of
39# source files, where putting all generated files in the same directory would
40# otherwise cause performance problems for the file system.
41
42CREATE_SUBDIRS = NO
43
Josh Coalson5e5fc012002-07-16 16:09:53 +000044# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are:
Josh Coalson58c2acb2006-10-06 05:26:22 +000048# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52# Swedish, and Ukrainian.
Josh Coalson5e5fc012002-07-16 16:09:53 +000053
54OUTPUT_LANGUAGE = English
55
Josh Coalson58c2acb2006-10-06 05:26:22 +000056# This tag can be used to specify the encoding used in the generated output.
57# The encoding is not always determined by the language that is chosen,
58# but also whether or not the output is meant for Windows or non-Windows users.
59# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60# forces the Windows encoding (this is the default for the Windows binary),
61# whereas setting the tag to NO uses a Unix-style encoding (the default for
62# all platforms other than Windows).
63
64USE_WINDOWS_ENCODING = NO
65
66# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67# include brief member descriptions after the members that are listed in
68# the file and class documentation (similar to JavaDoc).
69# Set to NO to disable this.
70
Josh Coalsone401faa2006-10-07 05:42:39 +000071BRIEF_MEMBER_DESC = NO
Josh Coalson58c2acb2006-10-06 05:26:22 +000072
73# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74# the brief description of a member or function before the detailed description.
75# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76# brief descriptions will be completely suppressed.
77
78REPEAT_BRIEF = YES
79
80# This tag implements a quasi-intelligent brief description abbreviator
81# that is used to form the text in various listings. Each string
82# in this list, if found as the leading text of the brief description, will be
83# stripped from the text and the result after processing the whole list, is
84# used as the annotated text. Otherwise, the brief description is used as-is.
85# If left blank, the following values are used ("$name" is automatically
86# replaced with the name of the entity): "The $name class" "The $name widget"
87# "The $name file" "is" "provides" "specifies" "contains"
88# "represents" "a" "an" "the"
89
90ABBREVIATE_BRIEF =
91
92# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93# Doxygen will generate a detailed section even if there is only a brief
94# description.
95
Josh Coalsone401faa2006-10-07 05:42:39 +000096ALWAYS_DETAILED_SEC = YES
Josh Coalson58c2acb2006-10-06 05:26:22 +000097
98# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99# inherited members of a class in the documentation of that class as if those
100# members were ordinary class members. Constructors, destructors and assignment
101# operators of the base classes will not be shown.
102
Josh Coalsone401faa2006-10-07 05:42:39 +0000103INLINE_INHERITED_MEMB = YES
Josh Coalson58c2acb2006-10-06 05:26:22 +0000104
105# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106# path before files name in the file list and in the header files. If set
107# to NO the shortest path that makes the file name unique will be used.
108
109FULL_PATH_NAMES = YES
110
111# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112# can be used to strip a user-defined part of the path. Stripping is
113# only done if one of the specified strings matches the left-hand part of
114# the path. The tag can be used to show relative paths in the file list.
115# If left blank the directory from which doxygen is run is used as the
116# path to strip.
117
118STRIP_FROM_PATH = ..
119
120# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121# the path mentioned in the documentation of a class, which tells
122# the reader which header file to include in order to use a class.
123# If left blank only the name of the header file containing the class
124# definition is used. Otherwise one should specify the include paths that
125# are normally passed to the compiler using the -I flag.
126
127STRIP_FROM_INC_PATH =
128
129# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130# (but less readable) file names. This can be useful is your file systems
131# doesn't support long names like on DOS, Mac, or CD-ROM.
132
133SHORT_NAMES = NO
134
135# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136# will interpret the first line (until the first dot) of a JavaDoc-style
137# comment as the brief description. If set to NO, the JavaDoc
138# comments will behave just like the Qt-style comments (thus requiring an
139# explicit @brief command for a brief description.
140
141JAVADOC_AUTOBRIEF = NO
142
143# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144# treat a multi-line C++ special comment block (i.e. a block of //! or ///
145# comments) as a brief description. This used to be the default behaviour.
146# The new default is to treat a multi-line C++ comment block as a detailed
147# description. Set this tag to YES if you prefer the old behaviour instead.
148
149MULTILINE_CPP_IS_BRIEF = NO
150
151# If the DETAILS_AT_TOP tag is set to YES then Doxygen
152# will output the detailed description near the top, like JavaDoc.
153# If set to NO, the detailed description appears after the member
154# documentation.
155
156DETAILS_AT_TOP = YES
157
158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159# member inherits the documentation from any documented member that it
160# re-implements.
161
162INHERIT_DOCS = YES
163
164# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
165# tag is set to YES, then doxygen will reuse the documentation of the first
166# member in the group (if any) for the other members of the group. By default
167# all members of a group must be documented explicitly.
168
169DISTRIBUTE_GROUP_DOC = YES
170
171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172# a new page for each member. If set to NO, the documentation of a member will
173# be part of the file/class/namespace that contains it.
174
175SEPARATE_MEMBER_PAGES = NO
176
177# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178# Doxygen uses this value to replace tabs by spaces in code fragments.
179
180TAB_SIZE = 4
181
182# This tag can be used to specify a number of aliases that acts
183# as commands in the documentation. An alias has the form "name=value".
184# For example adding "sideeffect=\par Side Effects:\n" will allow you to
185# put the command \sideeffect (or @sideeffect) in the documentation, which
186# will result in a user-defined paragraph with heading "Side Effects:".
187# You can put \n's in the value part of an alias to insert newlines.
188
189ALIASES = "assert=\par Assertions:\n" \
190 "default=\par Default Value:\n"
191
192# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
193# sources only. Doxygen will then generate output that is more tailored for C.
194# For instance, some of the names that are used will be different. The list
195# of all members will be omitted, etc.
196
197OPTIMIZE_OUTPUT_FOR_C = NO
198
199# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
200# only. Doxygen will then generate output that is more tailored for Java.
201# For instance, namespaces will be presented as packages, qualified scopes
202# will look different, etc.
203
204OPTIMIZE_OUTPUT_JAVA = NO
205
206# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
207# the same type (for instance a group of public functions) to be put as a
208# subgroup of that type (e.g. under the Public Functions section). Set it to
209# NO to prevent subgrouping. Alternatively, this can be done per class using
210# the \nosubgrouping command.
211
212SUBGROUPING = YES
213
214#---------------------------------------------------------------------------
215# Build related configuration options
216#---------------------------------------------------------------------------
217
Josh Coalson5e5fc012002-07-16 16:09:53 +0000218# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
219# documentation are documented, even if no documentation was available.
220# Private class members and static file members will be hidden unless
221# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
222
223EXTRACT_ALL = NO
224
225# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
226# will be included in the documentation.
227
228EXTRACT_PRIVATE = NO
229
230# If the EXTRACT_STATIC tag is set to YES all static members of a file
231# will be included in the documentation.
232
233EXTRACT_STATIC = NO
234
235# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
236# defined locally in source files will be included in the documentation.
237# If set to NO only classes defined in header files are included.
238
239EXTRACT_LOCAL_CLASSES = YES
240
Josh Coalson58c2acb2006-10-06 05:26:22 +0000241# This flag is only useful for Objective-C code. When set to YES local
242# methods, which are defined in the implementation section but not in
243# the interface are included in the documentation.
244# If set to NO (the default) only methods in the interface are included.
245
246EXTRACT_LOCAL_METHODS = NO
247
Josh Coalson5e5fc012002-07-16 16:09:53 +0000248# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
249# undocumented members of documented classes, files or namespaces.
250# If set to NO (the default) these members will be included in the
251# various overviews, but no documentation section is generated.
252# This option has no effect if EXTRACT_ALL is enabled.
253
254HIDE_UNDOC_MEMBERS = NO
255
256# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
257# undocumented classes that are normally visible in the class hierarchy.
Josh Coalson58c2acb2006-10-06 05:26:22 +0000258# If set to NO (the default) these classes will be included in the various
Josh Coalson5e5fc012002-07-16 16:09:53 +0000259# overviews. This option has no effect if EXTRACT_ALL is enabled.
260
261HIDE_UNDOC_CLASSES = NO
262
Josh Coalson58c2acb2006-10-06 05:26:22 +0000263# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
264# friend (class|struct|union) declarations.
265# If set to NO (the default) these declarations will be included in the
266# documentation.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000267
Josh Coalson58c2acb2006-10-06 05:26:22 +0000268HIDE_FRIEND_COMPOUNDS = NO
Josh Coalson5e5fc012002-07-16 16:09:53 +0000269
Josh Coalson58c2acb2006-10-06 05:26:22 +0000270# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
271# documentation blocks found inside the body of a function.
272# If set to NO (the default) these blocks will be appended to the
273# function's detailed documentation block.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000274
Josh Coalson58c2acb2006-10-06 05:26:22 +0000275HIDE_IN_BODY_DOCS = NO
Josh Coalson5e5fc012002-07-16 16:09:53 +0000276
277# The INTERNAL_DOCS tag determines if documentation
278# that is typed after a \internal command is included. If the tag is set
279# to NO (the default) then the documentation will be excluded.
280# Set it to YES to include the internal documentation.
281
282INTERNAL_DOCS = NO
283
Josh Coalson5e5fc012002-07-16 16:09:53 +0000284# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
Josh Coalson58c2acb2006-10-06 05:26:22 +0000285# file names in lower-case letters. If set to YES upper-case letters are also
Josh Coalson5e5fc012002-07-16 16:09:53 +0000286# allowed. This is useful if you have classes or files whose names only differ
287# in case and if your file system supports case sensitive file names. Windows
Josh Coalson58c2acb2006-10-06 05:26:22 +0000288# and Mac users are advised to set this option to NO.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000289
290CASE_SENSE_NAMES = YES
291
Josh Coalson5e5fc012002-07-16 16:09:53 +0000292# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
293# will show members with their full class and namespace scopes in the
294# documentation. If set to YES the scope will be hidden.
295
296HIDE_SCOPE_NAMES = NO
297
Josh Coalson5e5fc012002-07-16 16:09:53 +0000298# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
Josh Coalson58c2acb2006-10-06 05:26:22 +0000299# will put a list of the files that are included by a file in the documentation
Josh Coalson5e5fc012002-07-16 16:09:53 +0000300# of that file.
301
302SHOW_INCLUDE_FILES = YES
303
Josh Coalson5e5fc012002-07-16 16:09:53 +0000304# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
305# is inserted in the documentation for inline members.
306
307INLINE_INFO = YES
308
309# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
310# will sort the (detailed) documentation of file and class members
311# alphabetically by member name. If set to NO the members will appear in
312# declaration order.
313
314SORT_MEMBER_DOCS = NO
315
Josh Coalson58c2acb2006-10-06 05:26:22 +0000316# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
317# brief documentation of file, namespace and class members alphabetically
318# by member name. If set to NO (the default) the members will appear in
319# declaration order.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000320
Josh Coalson58c2acb2006-10-06 05:26:22 +0000321SORT_BRIEF_DOCS = NO
Josh Coalson5e5fc012002-07-16 16:09:53 +0000322
Josh Coalson58c2acb2006-10-06 05:26:22 +0000323# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
324# sorted by fully-qualified names, including namespaces. If set to
325# NO (the default), the class list will be sorted only by class name,
326# not including the namespace part.
327# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
328# Note: This option applies only to the class list, not to the
329# alphabetical list.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000330
Josh Coalsone401faa2006-10-07 05:42:39 +0000331SORT_BY_SCOPE_NAME = YES
Josh Coalson5e5fc012002-07-16 16:09:53 +0000332
333# The GENERATE_TODOLIST tag can be used to enable (YES) or
334# disable (NO) the todo list. This list is created by putting \todo
335# commands in the documentation.
336
337GENERATE_TODOLIST = YES
338
339# The GENERATE_TESTLIST tag can be used to enable (YES) or
340# disable (NO) the test list. This list is created by putting \test
341# commands in the documentation.
342
343GENERATE_TESTLIST = YES
344
345# The GENERATE_BUGLIST tag can be used to enable (YES) or
346# disable (NO) the bug list. This list is created by putting \bug
347# commands in the documentation.
348
349GENERATE_BUGLIST = YES
350
Josh Coalson58c2acb2006-10-06 05:26:22 +0000351# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
352# disable (NO) the deprecated list. This list is created by putting
353# \deprecated commands in the documentation.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000354
Josh Coalson58c2acb2006-10-06 05:26:22 +0000355GENERATE_DEPRECATEDLIST= YES
Josh Coalson5e5fc012002-07-16 16:09:53 +0000356
357# The ENABLED_SECTIONS tag can be used to enable conditional
358# documentation sections, marked by \if sectionname ... \endif.
359
360ENABLED_SECTIONS =
361
362# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
Josh Coalson58c2acb2006-10-06 05:26:22 +0000363# the initial value of a variable or define consists of for it to appear in
Josh Coalson5e5fc012002-07-16 16:09:53 +0000364# the documentation. If the initializer consists of more lines than specified
365# here it will be hidden. Use a value of 0 to hide initializers completely.
366# The appearance of the initializer of individual variables and defines in the
367# documentation can be controlled using \showinitializer or \hideinitializer
368# command in the documentation regardless of this setting.
369
370MAX_INITIALIZER_LINES = 30
371
Josh Coalson5e5fc012002-07-16 16:09:53 +0000372# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
373# at the bottom of the documentation of classes and structs. If set to YES the
374# list will mention the files that were used to generate the documentation.
375
376SHOW_USED_FILES = YES
377
Josh Coalson58c2acb2006-10-06 05:26:22 +0000378# If the sources in your project are distributed over multiple directories
379# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
380# in the documentation.
381
382SHOW_DIRECTORIES = YES
383
384# The FILE_VERSION_FILTER tag can be used to specify a program or script that
385# doxygen should invoke to get the current version for each file (typically from the
386# version control system). Doxygen will invoke the program by executing (via
387# popen()) the command <command> <input-file>, where <command> is the value of
388# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
389# provided by doxygen. Whatever the progam writes to standard output
390# is used as the file version. See the manual for examples.
391
392FILE_VERSION_FILTER =
393
Josh Coalson5e5fc012002-07-16 16:09:53 +0000394#---------------------------------------------------------------------------
395# configuration options related to warning and progress messages
396#---------------------------------------------------------------------------
397
398# The QUIET tag can be used to turn on/off the messages that are generated
399# by doxygen. Possible values are YES and NO. If left blank NO is used.
400
401QUIET = NO
402
403# The WARNINGS tag can be used to turn on/off the warning messages that are
404# generated by doxygen. Possible values are YES and NO. If left blank
405# NO is used.
406
407WARNINGS = YES
408
409# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
410# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
411# automatically be disabled.
412
413WARN_IF_UNDOCUMENTED = YES
414
Josh Coalson58c2acb2006-10-06 05:26:22 +0000415# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
416# potential errors in the documentation, such as not documenting some
417# parameters in a documented function, or documenting parameters that
418# don't exist or using markup commands wrongly.
419
420WARN_IF_DOC_ERROR = YES
421
422# This WARN_NO_PARAMDOC option can be abled to get warnings for
423# functions that are documented, but have no documentation for their parameters
424# or return value. If set to NO (the default) doxygen will only warn about
425# wrong or incomplete parameter documentation, but not about the absence of
426# documentation.
427
428WARN_NO_PARAMDOC = NO
429
Josh Coalson5e5fc012002-07-16 16:09:53 +0000430# The WARN_FORMAT tag determines the format of the warning messages that
431# doxygen can produce. The string should contain the $file, $line, and $text
432# tags, which will be replaced by the file and line number from which the
Josh Coalson58c2acb2006-10-06 05:26:22 +0000433# warning originated and the warning text. Optionally the format may contain
434# $version, which will be replaced by the version of the file (if it could
435# be obtained via FILE_VERSION_FILTER)
Josh Coalson5e5fc012002-07-16 16:09:53 +0000436
437WARN_FORMAT = "$file:$line: $text"
438
439# The WARN_LOGFILE tag can be used to specify a file to which warning
440# and error messages should be written. If left blank the output is written
441# to stderr.
442
443WARN_LOGFILE =
444
445#---------------------------------------------------------------------------
446# configuration options related to the input files
447#---------------------------------------------------------------------------
448
449# The INPUT tag can be used to specify the files and/or directories that contain
450# documented source files. You may enter file names like "myfile.cpp" or
451# directories like "/usr/src/myproject". Separate the files or directories
452# with spaces.
453
Josh Coalson58c2acb2006-10-06 05:26:22 +0000454INPUT = ../include/FLAC \
455 ../include/FLAC++ \
456 ../include/OggFLAC \
457 ../include/OggFLAC++
Josh Coalson5e5fc012002-07-16 16:09:53 +0000458
459# If the value of the INPUT tag contains directories, you can use the
460# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
461# and *.h) to filter out the source-files in the directories. If left
462# blank the following patterns are tested:
Josh Coalson58c2acb2006-10-06 05:26:22 +0000463# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
464# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
Josh Coalson5e5fc012002-07-16 16:09:53 +0000465
466FILE_PATTERNS =
467
468# The RECURSIVE tag can be used to turn specify whether or not subdirectories
469# should be searched for input files as well. Possible values are YES and NO.
470# If left blank NO is used.
471
472RECURSIVE = NO
473
474# The EXCLUDE tag can be used to specify files and/or directories that should
475# excluded from the INPUT source files. This way you can easily exclude a
476# subdirectory from a directory tree whose root is specified with the INPUT tag.
477
Josh Coalsone401faa2006-10-07 05:42:39 +0000478EXCLUDE =
Josh Coalson5e5fc012002-07-16 16:09:53 +0000479
Josh Coalson58c2acb2006-10-06 05:26:22 +0000480# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
481# directories that are symbolic links (a Unix filesystem feature) are excluded
482# from the input.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000483
484EXCLUDE_SYMLINKS = NO
485
486# If the value of the INPUT tag contains directories, you can use the
487# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
488# certain files from those directories.
489
490EXCLUDE_PATTERNS =
491
492# The EXAMPLE_PATH tag can be used to specify one or more files or
493# directories that contain example code fragments that are included (see
494# the \include command).
495
496EXAMPLE_PATH =
497
498# If the value of the EXAMPLE_PATH tag contains directories, you can use the
499# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
500# and *.h) to filter out the source-files in the directories. If left
501# blank all files are included.
502
503EXAMPLE_PATTERNS =
504
505# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
506# searched for input files to be used with the \include or \dontinclude
507# commands irrespective of the value of the RECURSIVE tag.
508# Possible values are YES and NO. If left blank NO is used.
509
510EXAMPLE_RECURSIVE = NO
511
512# The IMAGE_PATH tag can be used to specify one or more files or
513# directories that contain image that are included in the documentation (see
514# the \image command).
515
516IMAGE_PATH =
517
518# The INPUT_FILTER tag can be used to specify a program that doxygen should
519# invoke to filter for each input file. Doxygen will invoke the filter program
520# by executing (via popen()) the command <filter> <input-file>, where <filter>
521# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
522# input file. Doxygen will then use the output that the filter program writes
Josh Coalson58c2acb2006-10-06 05:26:22 +0000523# to standard output. If FILTER_PATTERNS is specified, this tag will be
524# ignored.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000525
526INPUT_FILTER =
527
Josh Coalson58c2acb2006-10-06 05:26:22 +0000528# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
529# basis. Doxygen will compare the file name with each pattern and apply the
530# filter if there is a match. The filters are a list of the form:
531# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
532# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
533# is applied to all files.
534
535FILTER_PATTERNS =
536
Josh Coalson5e5fc012002-07-16 16:09:53 +0000537# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
538# INPUT_FILTER) will be used to filter the input files when producing source
Josh Coalson58c2acb2006-10-06 05:26:22 +0000539# files to browse (i.e. when SOURCE_BROWSER is set to YES).
Josh Coalson5e5fc012002-07-16 16:09:53 +0000540
541FILTER_SOURCE_FILES = NO
542
543#---------------------------------------------------------------------------
544# configuration options related to source browsing
545#---------------------------------------------------------------------------
546
547# If the SOURCE_BROWSER tag is set to YES then a list of source files will
Josh Coalson58c2acb2006-10-06 05:26:22 +0000548# be generated. Documented entities will be cross-referenced with these sources.
549# Note: To get rid of all source code in the generated output, make sure also
550# VERBATIM_HEADERS is set to NO.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000551
552SOURCE_BROWSER = NO
553
554# Setting the INLINE_SOURCES tag to YES will include the body
555# of functions and classes directly in the documentation.
556
557INLINE_SOURCES = NO
558
Josh Coalson58c2acb2006-10-06 05:26:22 +0000559# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
560# doxygen to hide any special comment blocks from generated source code
561# fragments. Normal C and C++ comments will always remain visible.
562
563STRIP_CODE_COMMENTS = YES
564
Josh Coalson5e5fc012002-07-16 16:09:53 +0000565# If the REFERENCED_BY_RELATION tag is set to YES (the default)
566# then for each documented function all documented
567# functions referencing it will be listed.
568
569REFERENCED_BY_RELATION = YES
570
571# If the REFERENCES_RELATION tag is set to YES (the default)
572# then for each documented function all documented entities
573# called/used by that function will be listed.
574
575REFERENCES_RELATION = YES
576
Josh Coalson58c2acb2006-10-06 05:26:22 +0000577# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
578# will generate a verbatim copy of the header file for each class for
579# which an include is specified. Set to NO to disable this.
580
581VERBATIM_HEADERS = YES
582
Josh Coalson5e5fc012002-07-16 16:09:53 +0000583#---------------------------------------------------------------------------
584# configuration options related to the alphabetical class index
585#---------------------------------------------------------------------------
586
587# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
588# of all compounds will be generated. Enable this if the project
589# contains a lot of classes, structs, unions or interfaces.
590
591ALPHABETICAL_INDEX = YES
592
593# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
594# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
595# in which this list will be split (can be a number in the range [1..20])
596
597COLS_IN_ALPHA_INDEX = 5
598
599# In case all classes in a project start with a common prefix, all
600# classes will be put under the same header in the alphabetical index.
601# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
602# should be ignored while generating the index headers.
603
604IGNORE_PREFIX =
605
606#---------------------------------------------------------------------------
607# configuration options related to the HTML output
608#---------------------------------------------------------------------------
609
610# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
611# generate HTML output.
612
613GENERATE_HTML = YES
614
615# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
616# If a relative path is entered the value of OUTPUT_DIRECTORY will be
617# put in front of it. If left blank `html' will be used as the default path.
618
619HTML_OUTPUT = html
620
621# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
622# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
623# doxygen will generate files with .html extension.
624
625HTML_FILE_EXTENSION = .html
626
627# The HTML_HEADER tag can be used to specify a personal HTML header for
628# each generated HTML page. If it is left blank doxygen will generate a
629# standard header.
630
631HTML_HEADER =
632
633# The HTML_FOOTER tag can be used to specify a personal HTML footer for
634# each generated HTML page. If it is left blank doxygen will generate a
635# standard footer.
636
Josh Coalson58c2acb2006-10-06 05:26:22 +0000637HTML_FOOTER = doxygen.footer.html
Josh Coalson5e5fc012002-07-16 16:09:53 +0000638
Josh Coalson58c2acb2006-10-06 05:26:22 +0000639# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
Josh Coalson5e5fc012002-07-16 16:09:53 +0000640# style sheet that is used by each HTML page. It can be used to
641# fine-tune the look of the HTML output. If the tag is left blank doxygen
Josh Coalson58c2acb2006-10-06 05:26:22 +0000642# will generate a default style sheet. Note that doxygen will try to copy
643# the style sheet file to the HTML output directory, so don't put your own
644# stylesheet in the HTML output directory as well, or it will be erased!
Josh Coalson5e5fc012002-07-16 16:09:53 +0000645
646HTML_STYLESHEET =
647
648# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
649# files or namespaces will be aligned in HTML using tables. If set to
650# NO a bullet list will be used.
651
652HTML_ALIGN_MEMBERS = YES
653
654# If the GENERATE_HTMLHELP tag is set to YES, additional index files
655# will be generated that can be used as input for tools like the
656# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
657# of the generated HTML documentation.
658
659GENERATE_HTMLHELP = NO
660
Josh Coalson58c2acb2006-10-06 05:26:22 +0000661# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
662# be used to specify the file name of the resulting .chm file. You
663# can add a path in front of the file if the result should not be
664# written to the html output directory.
665
666CHM_FILE =
667
668# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
669# be used to specify the location (absolute path including file name) of
670# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
671# the HTML help compiler on the generated index.hhp.
672
673HHC_LOCATION =
674
Josh Coalson5e5fc012002-07-16 16:09:53 +0000675# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
676# controls if a separate .chi index file is generated (YES) or that
677# it should be included in the master .chm file (NO).
678
679GENERATE_CHI = NO
680
681# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
682# controls whether a binary table of contents is generated (YES) or a
683# normal table of contents (NO) in the .chm file.
684
685BINARY_TOC = NO
686
687# The TOC_EXPAND flag can be set to YES to add extra items for group members
Josh Coalson58c2acb2006-10-06 05:26:22 +0000688# to the contents of the HTML help documentation and to the tree view.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000689
690TOC_EXPAND = NO
691
692# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
693# top of each HTML page. The value NO (the default) enables the index and
694# the value YES disables it.
695
696DISABLE_INDEX = NO
697
698# This tag can be used to set the number of enum values (range [1..20])
699# that doxygen will group on one line in the generated HTML documentation.
700
701ENUM_VALUES_PER_LINE = 4
702
703# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
704# generated containing a tree-like index structure (just like the one that
705# is generated for HTML Help). For this to work a browser that supports
Josh Coalson58c2acb2006-10-06 05:26:22 +0000706# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
707# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
708# probably better off using the HTML help feature.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000709
710GENERATE_TREEVIEW = NO
711
712# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
713# used to set the initial width (in pixels) of the frame in which the tree
714# is shown.
715
716TREEVIEW_WIDTH = 250
717
718#---------------------------------------------------------------------------
719# configuration options related to the LaTeX output
720#---------------------------------------------------------------------------
721
722# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
723# generate Latex output.
724
Josh Coalsone401faa2006-10-07 05:42:39 +0000725GENERATE_LATEX = NO
Josh Coalson5e5fc012002-07-16 16:09:53 +0000726
727# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
728# If a relative path is entered the value of OUTPUT_DIRECTORY will be
729# put in front of it. If left blank `latex' will be used as the default path.
730
731LATEX_OUTPUT = latex
732
Josh Coalson58c2acb2006-10-06 05:26:22 +0000733# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
734# invoked. If left blank `latex' will be used as the default command name.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000735
736LATEX_CMD_NAME = latex
737
738# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
739# generate index for LaTeX. If left blank `makeindex' will be used as the
740# default command name.
741
742MAKEINDEX_CMD_NAME = makeindex
743
744# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
745# LaTeX documents. This may be useful for small projects and may help to
746# save some trees in general.
747
748COMPACT_LATEX = NO
749
750# The PAPER_TYPE tag can be used to set the paper type that is used
751# by the printer. Possible values are: a4, a4wide, letter, legal and
752# executive. If left blank a4wide will be used.
753
754PAPER_TYPE = a4wide
755
756# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
757# packages that should be included in the LaTeX output.
758
759EXTRA_PACKAGES =
760
761# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
762# the generated latex document. The header should contain everything until
763# the first chapter. If it is left blank doxygen will generate a
764# standard header. Notice: only use this tag if you know what you are doing!
765
766LATEX_HEADER =
767
768# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
769# is prepared for conversion to pdf (using ps2pdf). The pdf file will
770# contain links (just like the HTML output) instead of page references
771# This makes the output suitable for online browsing using a pdf viewer.
772
773PDF_HYPERLINKS = NO
774
775# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
776# plain latex in the generated Makefile. Set this option to YES to get a
777# higher quality PDF documentation.
778
779USE_PDFLATEX = NO
780
781# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
782# command to the generated LaTeX files. This will instruct LaTeX to keep
783# running if errors occur, instead of asking the user for help.
784# This option is also used when generating formulas in HTML.
785
786LATEX_BATCHMODE = NO
787
Josh Coalson58c2acb2006-10-06 05:26:22 +0000788# If LATEX_HIDE_INDICES is set to YES then doxygen will not
789# include the index chapters (such as File Index, Compound Index, etc.)
790# in the output.
791
792LATEX_HIDE_INDICES = NO
793
Josh Coalson5e5fc012002-07-16 16:09:53 +0000794#---------------------------------------------------------------------------
795# configuration options related to the RTF output
796#---------------------------------------------------------------------------
797
798# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
Josh Coalson58c2acb2006-10-06 05:26:22 +0000799# The RTF output is optimized for Word 97 and may not look very pretty with
Josh Coalson5e5fc012002-07-16 16:09:53 +0000800# other RTF readers or editors.
801
802GENERATE_RTF = NO
803
804# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
805# If a relative path is entered the value of OUTPUT_DIRECTORY will be
806# put in front of it. If left blank `rtf' will be used as the default path.
807
808RTF_OUTPUT = rtf
809
810# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
811# RTF documents. This may be useful for small projects and may help to
812# save some trees in general.
813
814COMPACT_RTF = NO
815
816# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
817# will contain hyperlink fields. The RTF file will
818# contain links (just like the HTML output) instead of page references.
819# This makes the output suitable for online browsing using WORD or other
820# programs which support those fields.
821# Note: wordpad (write) and others do not support links.
822
823RTF_HYPERLINKS = NO
824
825# Load stylesheet definitions from file. Syntax is similar to doxygen's
Josh Coalson58c2acb2006-10-06 05:26:22 +0000826# config file, i.e. a series of assignments. You only have to provide
Josh Coalson5e5fc012002-07-16 16:09:53 +0000827# replacements, missing definitions are set to their default value.
828
829RTF_STYLESHEET_FILE =
830
831# Set optional variables used in the generation of an rtf document.
832# Syntax is similar to doxygen's config file.
833
834RTF_EXTENSIONS_FILE =
835
836#---------------------------------------------------------------------------
837# configuration options related to the man page output
838#---------------------------------------------------------------------------
839
840# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
841# generate man pages
842
Josh Coalsone401faa2006-10-07 05:42:39 +0000843GENERATE_MAN = NO
Josh Coalson5e5fc012002-07-16 16:09:53 +0000844
845# The MAN_OUTPUT tag is used to specify where the man pages will be put.
846# If a relative path is entered the value of OUTPUT_DIRECTORY will be
847# put in front of it. If left blank `man' will be used as the default path.
848
849MAN_OUTPUT = man
850
851# The MAN_EXTENSION tag determines the extension that is added to
852# the generated man pages (default is the subroutine's section .3)
853
854MAN_EXTENSION = .3
855
856# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
857# then it will generate one additional man file for each entity
858# documented in the real man page(s). These additional files
859# only source the real man page, but without them the man command
860# would be unable to find the correct page. The default is NO.
861
862MAN_LINKS = NO
863
864#---------------------------------------------------------------------------
865# configuration options related to the XML output
866#---------------------------------------------------------------------------
867
868# If the GENERATE_XML tag is set to YES Doxygen will
869# generate an XML file that captures the structure of
Josh Coalson58c2acb2006-10-06 05:26:22 +0000870# the code including all documentation.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000871
872GENERATE_XML = NO
873
Josh Coalson58c2acb2006-10-06 05:26:22 +0000874# The XML_OUTPUT tag is used to specify where the XML pages will be put.
875# If a relative path is entered the value of OUTPUT_DIRECTORY will be
876# put in front of it. If left blank `xml' will be used as the default path.
877
878XML_OUTPUT = xml
879
880# The XML_SCHEMA tag can be used to specify an XML schema,
881# which can be used by a validating XML parser to check the
882# syntax of the XML files.
883
884XML_SCHEMA =
885
886# The XML_DTD tag can be used to specify an XML DTD,
887# which can be used by a validating XML parser to check the
888# syntax of the XML files.
889
890XML_DTD =
891
892# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
893# dump the program listings (including syntax highlighting
894# and cross-referencing information) to the XML output. Note that
895# enabling this will significantly increase the size of the XML output.
896
897XML_PROGRAMLISTING = YES
898
Josh Coalson5e5fc012002-07-16 16:09:53 +0000899#---------------------------------------------------------------------------
900# configuration options for the AutoGen Definitions output
901#---------------------------------------------------------------------------
902
903# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
904# generate an AutoGen Definitions (see autogen.sf.net) file
905# that captures the structure of the code including all
906# documentation. Note that this feature is still experimental
907# and incomplete at the moment.
908
909GENERATE_AUTOGEN_DEF = NO
910
911#---------------------------------------------------------------------------
Josh Coalson58c2acb2006-10-06 05:26:22 +0000912# configuration options related to the Perl module output
913#---------------------------------------------------------------------------
914
915# If the GENERATE_PERLMOD tag is set to YES Doxygen will
916# generate a Perl module file that captures the structure of
917# the code including all documentation. Note that this
918# feature is still experimental and incomplete at the
919# moment.
920
921GENERATE_PERLMOD = NO
922
923# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
924# the necessary Makefile rules, Perl scripts and LaTeX code to be able
925# to generate PDF and DVI output from the Perl module output.
926
927PERLMOD_LATEX = NO
928
929# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
930# nicely formatted so it can be parsed by a human reader. This is useful
931# if you want to understand what is going on. On the other hand, if this
932# tag is set to NO the size of the Perl module output will be much smaller
933# and Perl will parse it just the same.
934
935PERLMOD_PRETTY = YES
936
937# The names of the make variables in the generated doxyrules.make file
938# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
939# This is useful so different doxyrules.make files included by the same
940# Makefile don't overwrite each other's variables.
941
942PERLMOD_MAKEVAR_PREFIX =
943
944#---------------------------------------------------------------------------
Josh Coalson5e5fc012002-07-16 16:09:53 +0000945# Configuration options related to the preprocessor
946#---------------------------------------------------------------------------
947
948# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
949# evaluate all C-preprocessor directives found in the sources and include
950# files.
951
952ENABLE_PREPROCESSING = YES
953
954# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
955# names in the source code. If set to NO (the default) only conditional
956# compilation will be performed. Macro expansion can be done in a controlled
957# way by setting EXPAND_ONLY_PREDEF to YES.
958
Josh Coalsone610c8d2002-10-16 22:52:07 +0000959MACRO_EXPANSION = YES
Josh Coalson5e5fc012002-07-16 16:09:53 +0000960
961# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
962# then the macro expansion is limited to the macros specified with the
963# PREDEFINED and EXPAND_AS_PREDEFINED tags.
964
Josh Coalsone610c8d2002-10-16 22:52:07 +0000965EXPAND_ONLY_PREDEF = YES
Josh Coalson5e5fc012002-07-16 16:09:53 +0000966
967# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
968# in the INCLUDE_PATH (see below) will be search if a #include is found.
969
970SEARCH_INCLUDES = YES
971
972# The INCLUDE_PATH tag can be used to specify one or more directories that
973# contain include files that are not input files but should be processed by
974# the preprocessor.
975
976INCLUDE_PATH =
977
978# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
979# patterns (like *.h and *.hpp) to filter out the header-files in the
980# directories. If left blank, the patterns specified with FILE_PATTERNS will
981# be used.
982
983INCLUDE_FILE_PATTERNS =
984
985# The PREDEFINED tag can be used to specify one or more macro names that
986# are defined before the preprocessor is started (similar to the -D option of
987# gcc). The argument of the tag is a list of macros of the form: name
988# or name=definition (no spaces). If the definition and the = are
Josh Coalson58c2acb2006-10-06 05:26:22 +0000989# omitted =1 is assumed. To prevent a macro definition from being
990# undefined via #undef or recursively expanded use the := operator
991# instead of the = operator.
Josh Coalson5e5fc012002-07-16 16:09:53 +0000992
Josh Coalsoncb1dfb22002-10-18 05:51:59 +0000993PREDEFINED = FLAC__NO_DLL
Josh Coalson5e5fc012002-07-16 16:09:53 +0000994
Josh Coalson58c2acb2006-10-06 05:26:22 +0000995# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
Josh Coalson5e5fc012002-07-16 16:09:53 +0000996# this tag can be used to specify a list of macro names that should be expanded.
997# The macro definition that is found in the sources will be used.
998# Use the PREDEFINED tag if you want to use a different macro definition.
999
Josh Coalsone401faa2006-10-07 05:42:39 +00001000EXPAND_AS_DEFINED = FLAC_API FLACPP_API OggFLAC_API OggFLACPP_API
Josh Coalson5e5fc012002-07-16 16:09:53 +00001001
1002# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1003# doxygen's preprocessor will remove all function-like macros that are alone
Josh Coalson58c2acb2006-10-06 05:26:22 +00001004# on a line, have an all uppercase name, and do not end with a semicolon. Such
1005# function macros are typically used for boiler-plate code, and will confuse
1006# the parser if not removed.
Josh Coalson5e5fc012002-07-16 16:09:53 +00001007
1008SKIP_FUNCTION_MACROS = YES
1009
1010#---------------------------------------------------------------------------
Josh Coalson58c2acb2006-10-06 05:26:22 +00001011# Configuration::additions related to external references
Josh Coalson5e5fc012002-07-16 16:09:53 +00001012#---------------------------------------------------------------------------
1013
Josh Coalson58c2acb2006-10-06 05:26:22 +00001014# The TAGFILES option can be used to specify one or more tagfiles.
1015# Optionally an initial location of the external documentation
1016# can be added for each tagfile. The format of a tag file without
1017# this location is as follows:
1018# TAGFILES = file1 file2 ...
1019# Adding location for the tag files is done as follows:
1020# TAGFILES = file1=loc1 "file2 = loc2" ...
1021# where "loc1" and "loc2" can be relative or absolute paths or
1022# URLs. If a location is present for each tag, the installdox tool
1023# does not have to be run to correct the links.
1024# Note that each tag file must have a unique name
1025# (where the name does NOT include the path)
1026# If a tag file is not located in the directory in which doxygen
1027# is run, you must also specify the path to the tagfile here.
Josh Coalson5e5fc012002-07-16 16:09:53 +00001028
1029TAGFILES =
1030
1031# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1032# a tag file that is based on the input files it reads.
1033
1034GENERATE_TAGFILE = FLAC.tag
1035
1036# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1037# in the class index. If set to NO only the inherited external classes
1038# will be listed.
1039
1040ALLEXTERNALS = NO
1041
1042# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1043# in the modules index. If set to NO, only the current project's groups will
1044# be listed.
1045
1046EXTERNAL_GROUPS = YES
1047
1048# The PERL_PATH should be the absolute path and name of the perl script
1049# interpreter (i.e. the result of `which perl').
1050
1051PERL_PATH = /usr/bin/perl
1052
1053#---------------------------------------------------------------------------
1054# Configuration options related to the dot tool
1055#---------------------------------------------------------------------------
1056
1057# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
Josh Coalson58c2acb2006-10-06 05:26:22 +00001058# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1059# or super classes. Setting the tag to NO turns the diagrams off. Note that
1060# this option is superseded by the HAVE_DOT option below. This is only a
1061# fallback. It is recommended to install and use dot, since it yields more
1062# powerful graphs.
Josh Coalson5e5fc012002-07-16 16:09:53 +00001063
1064CLASS_DIAGRAMS = YES
1065
1066# If set to YES, the inheritance and collaboration graphs will hide
1067# inheritance and usage relations if the target is undocumented
1068# or is not a class.
1069
1070HIDE_UNDOC_RELATIONS = YES
1071
1072# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1073# available from the path. This tool is part of Graphviz, a graph visualization
1074# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1075# have no effect if this option is set to NO (the default)
1076
1077HAVE_DOT = NO
1078
1079# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1080# will generate a graph for each documented class showing the direct and
1081# indirect inheritance relations. Setting this tag to YES will force the
1082# the CLASS_DIAGRAMS tag to NO.
1083
1084CLASS_GRAPH = YES
1085
1086# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1087# will generate a graph for each documented class showing the direct and
1088# indirect implementation dependencies (inheritance, containment, and
1089# class references variables) of the class with other documented classes.
1090
1091COLLABORATION_GRAPH = YES
1092
Josh Coalson58c2acb2006-10-06 05:26:22 +00001093# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1094# will generate a graph for groups, showing the direct groups dependencies
1095
1096GROUP_GRAPHS = YES
1097
1098# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1099# collaboration diagrams in a style similar to the OMG's Unified Modeling
1100# Language.
1101
1102UML_LOOK = NO
1103
Josh Coalson5e5fc012002-07-16 16:09:53 +00001104# If set to YES, the inheritance and collaboration graphs will show the
1105# relations between templates and their instances.
1106
1107TEMPLATE_RELATIONS = YES
1108
1109# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1110# tags are set to YES then doxygen will generate a graph for each documented
1111# file showing the direct and indirect include dependencies of the file with
1112# other documented files.
1113
1114INCLUDE_GRAPH = YES
1115
1116# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1117# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1118# documented header file showing the documented files that directly or
1119# indirectly include this file.
1120
1121INCLUDED_BY_GRAPH = YES
1122
Josh Coalson58c2acb2006-10-06 05:26:22 +00001123# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1124# generate a call dependency graph for every global function or class method.
1125# Note that enabling this option will significantly increase the time of a run.
1126# So in most cases it will be better to enable call graphs for selected
1127# functions only using the \callgraph command.
1128
1129CALL_GRAPH = NO
1130
Josh Coalson5e5fc012002-07-16 16:09:53 +00001131# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1132# will graphical hierarchy of all classes instead of a textual one.
1133
1134GRAPHICAL_HIERARCHY = YES
1135
Josh Coalson58c2acb2006-10-06 05:26:22 +00001136# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1137# then doxygen will show the dependencies a directory has on other directories
1138# in a graphical way. The dependency relations are determined by the #include
1139# relations between the files in the directories.
1140
1141DIRECTORY_GRAPH = YES
1142
Josh Coalson5e5fc012002-07-16 16:09:53 +00001143# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1144# generated by dot. Possible values are png, jpg, or gif
1145# If left blank png will be used.
1146
1147DOT_IMAGE_FORMAT = png
1148
1149# The tag DOT_PATH can be used to specify the path where the dot tool can be
Josh Coalson58c2acb2006-10-06 05:26:22 +00001150# found. If left blank, it is assumed the dot tool can be found in the path.
Josh Coalson5e5fc012002-07-16 16:09:53 +00001151
1152DOT_PATH =
1153
1154# The DOTFILE_DIRS tag can be used to specify one or more directories that
1155# contain dot files that are included in the documentation (see the
1156# \dotfile command).
1157
1158DOTFILE_DIRS =
1159
1160# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1161# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1162# this value, doxygen will try to truncate the graph, so that it fits within
1163# the specified constraint. Beware that most browsers cannot cope with very
1164# large images.
1165
1166MAX_DOT_GRAPH_WIDTH = 1024
1167
1168# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1169# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1170# this value, doxygen will try to truncate the graph, so that it fits within
1171# the specified constraint. Beware that most browsers cannot cope with very
1172# large images.
1173
1174MAX_DOT_GRAPH_HEIGHT = 1024
1175
Josh Coalson58c2acb2006-10-06 05:26:22 +00001176# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1177# graphs generated by dot. A depth value of 3 means that only nodes reachable
1178# from the root by following a path via at most 3 edges will be shown. Nodes
1179# that lay further from the root node will be omitted. Note that setting this
1180# option to 1 or 2 may greatly reduce the computation time needed for large
1181# code bases. Also note that a graph may be further truncated if the graph's
1182# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1183# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1184# the graph is not depth-constrained.
1185
1186MAX_DOT_GRAPH_DEPTH = 0
1187
1188# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1189# background. This is disabled by default, which results in a white background.
1190# Warning: Depending on the platform used, enabling this option may lead to
1191# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1192# read).
1193
1194DOT_TRANSPARENT = NO
1195
1196# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1197# files in one run (i.e. multiple -o and -T options on the command line). This
1198# makes dot run faster, but since only newer versions of dot (>1.8.10)
1199# support this, this feature is disabled by default.
1200
1201DOT_MULTI_TARGETS = NO
1202
Josh Coalson5e5fc012002-07-16 16:09:53 +00001203# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1204# generate a legend page explaining the meaning of the various boxes and
1205# arrows in the dot generated graphs.
1206
1207GENERATE_LEGEND = YES
1208
1209# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
Josh Coalson58c2acb2006-10-06 05:26:22 +00001210# remove the intermediate dot files that are used to generate
Josh Coalson5e5fc012002-07-16 16:09:53 +00001211# the various graphs.
1212
1213DOT_CLEANUP = YES
1214
1215#---------------------------------------------------------------------------
Josh Coalson58c2acb2006-10-06 05:26:22 +00001216# Configuration::additions related to the search engine
Josh Coalson5e5fc012002-07-16 16:09:53 +00001217#---------------------------------------------------------------------------
1218
1219# The SEARCHENGINE tag specifies whether or not a search engine should be
1220# used. If set to NO the values of all tags below this one will be ignored.
1221
1222SEARCHENGINE = NO