blob: ec33da6dd3271dcb138a66de9d33b3a547cfba20 [file] [log] [blame]
Tanya Lattner7102b702011-10-21 20:51:54 +00001# Doxyfile 1.5.6
Chris Lattner3785a662002-01-26 21:16:41 +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#---------------------------------------------------------------------------
Tanya Lattner7102b702011-10-21 20:51:54 +000014# Project related configuration options
Chris Lattner3785a662002-01-26 21:16:41 +000015#---------------------------------------------------------------------------
16
Tanya Lattner7102b702011-10-21 20:51:54 +000017# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
Tanya Lattner6a0fd932008-09-18 16:32:28 +000021# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
Tanya Lattner7102b702011-10-21 20:51:54 +000025# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
Chris Lattner3785a662002-01-26 21:16:41 +000026# by quotes) that should identify the project.
27
28PROJECT_NAME = LLVM
29
Tanya Lattner7102b702011-10-21 20:51:54 +000030# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
Chris Lattner3785a662002-01-26 21:16:41 +000032# if some version control system is used.
33
mike-me2c3a492010-05-07 00:28:04 +000034PROJECT_NUMBER = @PACKAGE_VERSION@
Chris Lattner3785a662002-01-26 21:16:41 +000035
Tanya Lattner7102b702011-10-21 20:51:54 +000036# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
Chris Lattner3785a662002-01-26 21:16:41 +000039# where doxygen was started. If left blank the current directory will be used.
40
mike-me2c3a492010-05-07 00:28:04 +000041OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen
Chris Lattner3785a662002-01-26 21:16:41 +000042
Tanya Lattner7102b702011-10-21 20:51:54 +000043# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
Reid Spencer80626a72006-05-15 21:36:13 +000048# otherwise cause performance problems for the file system.
49
Bill Wendling28588e12011-10-16 06:43:10 +000050CREATE_SUBDIRS = YES
Reid Spencer80626a72006-05-15 21:36:13 +000051
Tanya Lattner7102b702011-10-21 20:51:54 +000052# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61# and Ukrainian.
Chris Lattner3785a662002-01-26 21:16:41 +000062
63OUTPUT_LANGUAGE = English
64
Tanya Lattner7102b702011-10-21 20:51:54 +000065# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
Reid Spencer80626a72006-05-15 21:36:13 +000068# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
Tanya Lattner7102b702011-10-21 20:51:54 +000072# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Reid Spencer80626a72006-05-15 21:36:13 +000075# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
Tanya Lattner7102b702011-10-21 20:51:54 +000079# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
Reid Spencer80626a72006-05-15 21:36:13 +000087# "represents" "a" "an" "the"
88
Tanya Lattner7102b702011-10-21 20:51:54 +000089ABBREVIATE_BRIEF =
Reid Spencer80626a72006-05-15 21:36:13 +000090
Tanya Lattner7102b702011-10-21 20:51:54 +000091# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92# Doxygen will generate a detailed section even if there is only a brief
Reid Spencer80626a72006-05-15 21:36:13 +000093# description.
94
95ALWAYS_DETAILED_SEC = NO
96
Tanya Lattner7102b702011-10-21 20:51:54 +000097# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98# inherited members of a class in the documentation of that class as if those
99# members were ordinary class members. Constructors, destructors and assignment
Reid Spencer80626a72006-05-15 21:36:13 +0000100# operators of the base classes will not be shown.
101
102INLINE_INHERITED_MEMB = NO
103
Tanya Lattner7102b702011-10-21 20:51:54 +0000104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105# path before files name in the file list and in the header files. If set
Reid Spencer80626a72006-05-15 21:36:13 +0000106# to NO the shortest path that makes the file name unique will be used.
107
mike-me2c3a492010-05-07 00:28:04 +0000108FULL_PATH_NAMES = NO
Reid Spencer80626a72006-05-15 21:36:13 +0000109
Tanya Lattner7102b702011-10-21 20:51:54 +0000110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111# can be used to strip a user-defined part of the path. Stripping is
112# only done if one of the specified strings matches the left-hand part of
113# the path. The tag can be used to show relative paths in the file list.
114# If left blank the directory from which doxygen is run is used as the
Reid Spencer80626a72006-05-15 21:36:13 +0000115# path to strip.
116
mike-me2c3a492010-05-07 00:28:04 +0000117STRIP_FROM_PATH = ../..
Reid Spencer80626a72006-05-15 21:36:13 +0000118
Tanya Lattner7102b702011-10-21 20:51:54 +0000119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120# the path mentioned in the documentation of a class, which tells
121# the reader which header file to include in order to use a class.
122# If left blank only the name of the header file containing the class
123# definition is used. Otherwise one should specify the include paths that
Reid Spencer80626a72006-05-15 21:36:13 +0000124# are normally passed to the compiler using the -I flag.
125
Tanya Lattner7102b702011-10-21 20:51:54 +0000126STRIP_FROM_INC_PATH =
Reid Spencer80626a72006-05-15 21:36:13 +0000127
Tanya Lattner7102b702011-10-21 20:51:54 +0000128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129# (but less readable) file names. This can be useful is your file systems
Reid Spencer80626a72006-05-15 21:36:13 +0000130# doesn't support long names like on DOS, Mac, or CD-ROM.
131
132SHORT_NAMES = NO
133
Tanya Lattner7102b702011-10-21 20:51:54 +0000134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135# will interpret the first line (until the first dot) of a JavaDoc-style
136# comment as the brief description. If set to NO, the JavaDoc
137# comments will behave just like regular Qt-style comments
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000138# (thus requiring an explicit @brief command for a brief description.)
Reid Spencer80626a72006-05-15 21:36:13 +0000139
140JAVADOC_AUTOBRIEF = NO
141
Tanya Lattner7102b702011-10-21 20:51:54 +0000142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143# interpret the first line (until the first dot) of a Qt-style
144# comment as the brief description. If set to NO, the comments
145# will behave just like regular Qt-style comments (thus requiring
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000146# an explicit \brief command for a brief description.)
147
148QT_AUTOBRIEF = NO
149
Tanya Lattner7102b702011-10-21 20:51:54 +0000150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152# comments) as a brief description. This used to be the default behaviour.
153# The new default is to treat a multi-line C++ comment block as a detailed
Reid Spencer80626a72006-05-15 21:36:13 +0000154# description. Set this tag to YES if you prefer the old behaviour instead.
155
156MULTILINE_CPP_IS_BRIEF = NO
157
Tanya Lattner7102b702011-10-21 20:51:54 +0000158# If the DETAILS_AT_TOP tag is set to YES then Doxygen
159# will output the detailed description near the top, like JavaDoc.
160# If set to NO, the detailed description appears after the member
161# documentation.
162
163DETAILS_AT_TOP = NO
164
165# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166# member inherits the documentation from any documented member that it
Reid Spencer80626a72006-05-15 21:36:13 +0000167# re-implements.
168
169INHERIT_DOCS = YES
170
Tanya Lattner7102b702011-10-21 20:51:54 +0000171# 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
Reid Spencer80626a72006-05-15 21:36:13 +0000173# be part of the file/class/namespace that contains it.
174
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000175SEPARATE_MEMBER_PAGES = NO
Reid Spencer80626a72006-05-15 21:36:13 +0000176
Tanya Lattner7102b702011-10-21 20:51:54 +0000177# The TAB_SIZE tag can be used to set the number of spaces in a tab.
Reid Spencer80626a72006-05-15 21:36:13 +0000178# Doxygen uses this value to replace tabs by spaces in code fragments.
179
180TAB_SIZE = 2
181
Tanya Lattner7102b702011-10-21 20:51:54 +0000182# 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:".
Reid Spencer80626a72006-05-15 21:36:13 +0000187# You can put \n's in the value part of an alias to insert newlines.
188
Tanya Lattner7102b702011-10-21 20:51:54 +0000189ALIASES =
Reid Spencer80626a72006-05-15 21:36:13 +0000190
Tanya Lattner7102b702011-10-21 20:51:54 +0000191# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192# sources only. Doxygen will then generate output that is more tailored for C.
193# For instance, some of the names that are used will be different. The list
Reid Spencer80626a72006-05-15 21:36:13 +0000194# of all members will be omitted, etc.
195
196OPTIMIZE_OUTPUT_FOR_C = NO
197
Tanya Lattner7102b702011-10-21 20:51:54 +0000198# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199# sources only. Doxygen will then generate output that is more tailored for
200# Java. For instance, namespaces will be presented as packages, qualified
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000201# scopes will look different, etc.
Reid Spencer80626a72006-05-15 21:36:13 +0000202
203OPTIMIZE_OUTPUT_JAVA = NO
204
Tanya Lattner7102b702011-10-21 20:51:54 +0000205# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206# sources only. Doxygen will then generate output that is more tailored for
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000207# Fortran.
208
209OPTIMIZE_FOR_FORTRAN = NO
210
Tanya Lattner7102b702011-10-21 20:51:54 +0000211# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212# sources. Doxygen will then generate output that is tailored for
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000213# VHDL.
214
215OPTIMIZE_OUTPUT_VHDL = NO
216
Tanya Lattner7102b702011-10-21 20:51:54 +0000217# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218# to include (a tag file for) the STL sources as input, then you should
219# set this tag to YES in order to let doxygen match functions declarations and
220# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221# func(std::string) {}). This also make the inheritance and collaboration
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000222# diagrams that involve STL classes more complete and accurate.
223
224BUILTIN_STL_SUPPORT = NO
225
226# If you use Microsoft's C++/CLI language, you should set this option to YES to
227# enable parsing support.
228
229CPP_CLI_SUPPORT = NO
230
Tanya Lattner7102b702011-10-21 20:51:54 +0000231# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232# Doxygen will parse them like normal C++ but will assume all classes use public
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000233# instead of private inheritance when no explicit protection keyword is present.
234
235SIP_SUPPORT = NO
236
Tanya Lattner7102b702011-10-21 20:51:54 +0000237# For Microsoft's IDL there are propget and propput attributes to indicate getter
238# and setter methods for a property. Setting this option to YES (the default)
239# will make doxygen to replace the get and set methods by a property in the
240# documentation. This will only work if the methods are indeed getting or
241# setting a simple type. If this is not the case, or you want to show the
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000242# methods anyway, you should set this option to NO.
243
244IDL_PROPERTY_SUPPORT = YES
245
Tanya Lattner7102b702011-10-21 20:51:54 +0000246# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
247# tag is set to YES, then doxygen will reuse the documentation of the first
248# member in the group (if any) for the other members of the group. By default
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000249# all members of a group must be documented explicitly.
250
251DISTRIBUTE_GROUP_DOC = NO
252
Tanya Lattner7102b702011-10-21 20:51:54 +0000253# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
254# the same type (for instance a group of public functions) to be put as a
255# subgroup of that type (e.g. under the Public Functions section). Set it to
256# NO to prevent subgrouping. Alternatively, this can be done per class using
Reid Spencer80626a72006-05-15 21:36:13 +0000257# the \nosubgrouping command.
258
259SUBGROUPING = YES
260
Tanya Lattner7102b702011-10-21 20:51:54 +0000261# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
262# is documented as struct, union, or enum with the name of the typedef. So
263# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
264# with name TypeT. When disabled the typedef will appear as a member of a file,
265# namespace, or class. And the struct will be named TypeS. This can typically
266# be useful for C code in case the coding convention dictates that all compound
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000267# types are typedef'ed and only the typedef is referenced, never the tag name.
268
269TYPEDEF_HIDES_STRUCT = NO
270
Reid Spencer80626a72006-05-15 21:36:13 +0000271#---------------------------------------------------------------------------
272# Build related configuration options
273#---------------------------------------------------------------------------
274
Tanya Lattner7102b702011-10-21 20:51:54 +0000275# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
276# documentation are documented, even if no documentation was available.
277# Private class members and static file members will be hidden unless
Chris Lattner3785a662002-01-26 21:16:41 +0000278# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
279
280EXTRACT_ALL = YES
281
Tanya Lattner7102b702011-10-21 20:51:54 +0000282# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Chris Lattner3785a662002-01-26 21:16:41 +0000283# will be included in the documentation.
284
285EXTRACT_PRIVATE = NO
286
Tanya Lattner7102b702011-10-21 20:51:54 +0000287# If the EXTRACT_STATIC tag is set to YES all static members of a file
Chris Lattner3785a662002-01-26 21:16:41 +0000288# will be included in the documentation.
289
290EXTRACT_STATIC = YES
291
Tanya Lattner7102b702011-10-21 20:51:54 +0000292# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
293# defined locally in source files will be included in the documentation.
Chris Lattner3785a662002-01-26 21:16:41 +0000294# If set to NO only classes defined in header files are included.
295
296EXTRACT_LOCAL_CLASSES = YES
297
Tanya Lattner7102b702011-10-21 20:51:54 +0000298# This flag is only useful for Objective-C code. When set to YES local
299# methods, which are defined in the implementation section but not in
300# the interface are included in the documentation.
Reid Spencer80626a72006-05-15 21:36:13 +0000301# If set to NO (the default) only methods in the interface are included.
302
303EXTRACT_LOCAL_METHODS = NO
304
Tanya Lattner7102b702011-10-21 20:51:54 +0000305# If this flag is set to YES, the members of anonymous namespaces will be
306# extracted and appear in the documentation as a namespace called
307# 'anonymous_namespace{file}', where file will be replaced with the base
308# name of the file that contains the anonymous namespace. By default
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000309# anonymous namespace are hidden.
310
311EXTRACT_ANON_NSPACES = NO
312
Tanya Lattner7102b702011-10-21 20:51:54 +0000313# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
314# undocumented members of documented classes, files or namespaces.
315# If set to NO (the default) these members will be included in the
316# various overviews, but no documentation section is generated.
Chris Lattner3785a662002-01-26 21:16:41 +0000317# This option has no effect if EXTRACT_ALL is enabled.
318
319HIDE_UNDOC_MEMBERS = NO
320
Tanya Lattner7102b702011-10-21 20:51:54 +0000321# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
322# undocumented classes that are normally visible in the class hierarchy.
323# If set to NO (the default) these classes will be included in the various
Chris Lattner3785a662002-01-26 21:16:41 +0000324# overviews. This option has no effect if EXTRACT_ALL is enabled.
325
326HIDE_UNDOC_CLASSES = NO
327
Tanya Lattner7102b702011-10-21 20:51:54 +0000328# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
329# friend (class|struct|union) declarations.
330# If set to NO (the default) these declarations will be included in the
Reid Spencer80626a72006-05-15 21:36:13 +0000331# documentation.
Chris Lattner3785a662002-01-26 21:16:41 +0000332
Reid Spencer80626a72006-05-15 21:36:13 +0000333HIDE_FRIEND_COMPOUNDS = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000334
Tanya Lattner7102b702011-10-21 20:51:54 +0000335# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
336# documentation blocks found inside the body of a function.
337# If set to NO (the default) these blocks will be appended to the
Reid Spencer80626a72006-05-15 21:36:13 +0000338# function's detailed documentation block.
Chris Lattner3785a662002-01-26 21:16:41 +0000339
Reid Spencer80626a72006-05-15 21:36:13 +0000340HIDE_IN_BODY_DOCS = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000341
Tanya Lattner7102b702011-10-21 20:51:54 +0000342# The INTERNAL_DOCS tag determines if documentation
343# that is typed after a \internal command is included. If the tag is set
344# to NO (the default) then the documentation will be excluded.
Chris Lattner3785a662002-01-26 21:16:41 +0000345# Set it to YES to include the internal documentation.
346
347INTERNAL_DOCS = NO
348
Tanya Lattner7102b702011-10-21 20:51:54 +0000349# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
350# file names in lower-case letters. If set to YES upper-case letters are also
351# allowed. This is useful if you have classes or files whose names only differ
352# in case and if your file system supports case sensitive file names. Windows
Reid Spencer80626a72006-05-15 21:36:13 +0000353# and Mac users are advised to set this option to NO.
Chris Lattner3785a662002-01-26 21:16:41 +0000354
355CASE_SENSE_NAMES = YES
356
Tanya Lattner7102b702011-10-21 20:51:54 +0000357# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
358# will show members with their full class and namespace scopes in the
Chris Lattner3785a662002-01-26 21:16:41 +0000359# documentation. If set to YES the scope will be hidden.
360
361HIDE_SCOPE_NAMES = NO
362
Tanya Lattner7102b702011-10-21 20:51:54 +0000363# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
364# will put a list of the files that are included by a file in the documentation
Chris Lattner3785a662002-01-26 21:16:41 +0000365# of that file.
366
367SHOW_INCLUDE_FILES = YES
368
Tanya Lattner7102b702011-10-21 20:51:54 +0000369# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Chris Lattner3785a662002-01-26 21:16:41 +0000370# is inserted in the documentation for inline members.
371
372INLINE_INFO = YES
373
Tanya Lattner7102b702011-10-21 20:51:54 +0000374# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
375# will sort the (detailed) documentation of file and class members
376# alphabetically by member name. If set to NO the members will appear in
Chris Lattner3785a662002-01-26 21:16:41 +0000377# declaration order.
378
379SORT_MEMBER_DOCS = YES
380
Tanya Lattner7102b702011-10-21 20:51:54 +0000381# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
382# brief documentation of file, namespace and class members alphabetically
383# by member name. If set to NO (the default) the members will appear in
Reid Spencer80626a72006-05-15 21:36:13 +0000384# declaration order.
Chris Lattner3785a662002-01-26 21:16:41 +0000385
mike-me2c3a492010-05-07 00:28:04 +0000386SORT_BRIEF_DOCS = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000387
Tanya Lattner7102b702011-10-21 20:51:54 +0000388# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
389# hierarchy of group names into alphabetical order. If set to NO (the default)
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000390# the group names will appear in their defined order.
391
392SORT_GROUP_NAMES = NO
393
Tanya Lattner7102b702011-10-21 20:51:54 +0000394# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
395# sorted by fully-qualified names, including namespaces. If set to
396# NO (the default), the class list will be sorted only by class name,
397# not including the namespace part.
Reid Spencer80626a72006-05-15 21:36:13 +0000398# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Tanya Lattner7102b702011-10-21 20:51:54 +0000399# Note: This option applies only to the class list, not to the
Reid Spencer80626a72006-05-15 21:36:13 +0000400# alphabetical list.
Chris Lattner3785a662002-01-26 21:16:41 +0000401
mike-me2c3a492010-05-07 00:28:04 +0000402SORT_BY_SCOPE_NAME = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000403
Tanya Lattner7102b702011-10-21 20:51:54 +0000404# The GENERATE_TODOLIST tag can be used to enable (YES) or
405# disable (NO) the todo list. This list is created by putting \todo
Chris Lattner3785a662002-01-26 21:16:41 +0000406# commands in the documentation.
407
408GENERATE_TODOLIST = YES
409
Tanya Lattner7102b702011-10-21 20:51:54 +0000410# The GENERATE_TESTLIST tag can be used to enable (YES) or
411# disable (NO) the test list. This list is created by putting \test
Chris Lattner3785a662002-01-26 21:16:41 +0000412# commands in the documentation.
413
414GENERATE_TESTLIST = YES
415
Tanya Lattner7102b702011-10-21 20:51:54 +0000416# The GENERATE_BUGLIST tag can be used to enable (YES) or
417# disable (NO) the bug list. This list is created by putting \bug
Chris Lattner3785a662002-01-26 21:16:41 +0000418# commands in the documentation.
419
420GENERATE_BUGLIST = YES
421
Tanya Lattner7102b702011-10-21 20:51:54 +0000422# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
423# disable (NO) the deprecated list. This list is created by putting
Reid Spencer80626a72006-05-15 21:36:13 +0000424# \deprecated commands in the documentation.
Chris Lattner3785a662002-01-26 21:16:41 +0000425
Reid Spencer80626a72006-05-15 21:36:13 +0000426GENERATE_DEPRECATEDLIST= YES
Chris Lattner3785a662002-01-26 21:16:41 +0000427
Tanya Lattner7102b702011-10-21 20:51:54 +0000428# The ENABLED_SECTIONS tag can be used to enable conditional
Chris Lattner3785a662002-01-26 21:16:41 +0000429# documentation sections, marked by \if sectionname ... \endif.
430
Tanya Lattner7102b702011-10-21 20:51:54 +0000431ENABLED_SECTIONS =
Chris Lattner3785a662002-01-26 21:16:41 +0000432
Tanya Lattner7102b702011-10-21 20:51:54 +0000433# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
434# the initial value of a variable or define consists of for it to appear in
435# the documentation. If the initializer consists of more lines than specified
436# here it will be hidden. Use a value of 0 to hide initializers completely.
437# The appearance of the initializer of individual variables and defines in the
438# documentation can be controlled using \showinitializer or \hideinitializer
Chris Lattner3785a662002-01-26 21:16:41 +0000439# command in the documentation regardless of this setting.
440
441MAX_INITIALIZER_LINES = 30
442
Tanya Lattner7102b702011-10-21 20:51:54 +0000443# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
444# at the bottom of the documentation of classes and structs. If set to YES the
Chris Lattner3785a662002-01-26 21:16:41 +0000445# list will mention the files that were used to generate the documentation.
446
447SHOW_USED_FILES = YES
448
Tanya Lattner7102b702011-10-21 20:51:54 +0000449# If the sources in your project are distributed over multiple directories
450# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000451# in the documentation. The default is NO.
Reid Spencer80626a72006-05-15 21:36:13 +0000452
453SHOW_DIRECTORIES = YES
454
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000455# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
Tanya Lattner7102b702011-10-21 20:51:54 +0000456# This will remove the Files entry from the Quick Index and from the
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000457# Folder Tree View (if specified). The default is YES.
458
459SHOW_FILES = YES
460
Tanya Lattner7102b702011-10-21 20:51:54 +0000461# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
462# Namespaces page. This will remove the Namespaces entry from the Quick Index
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000463# and from the Folder Tree View (if specified). The default is YES.
464
465SHOW_NAMESPACES = YES
466
Tanya Lattner7102b702011-10-21 20:51:54 +0000467# The FILE_VERSION_FILTER tag can be used to specify a program or script that
468# doxygen should invoke to get the current version for each file (typically from
469# the version control system). Doxygen will invoke the program by executing (via
470# popen()) the command <command> <input-file>, where <command> is the value of
471# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
472# provided by doxygen. Whatever the program writes to standard output
Reid Spencer80626a72006-05-15 21:36:13 +0000473# is used as the file version. See the manual for examples.
474
Tanya Lattner7102b702011-10-21 20:51:54 +0000475FILE_VERSION_FILTER =
Reid Spencer80626a72006-05-15 21:36:13 +0000476
Chris Lattner3785a662002-01-26 21:16:41 +0000477#---------------------------------------------------------------------------
478# configuration options related to warning and progress messages
479#---------------------------------------------------------------------------
480
Tanya Lattner7102b702011-10-21 20:51:54 +0000481# The QUIET tag can be used to turn on/off the messages that are generated
Chris Lattner3785a662002-01-26 21:16:41 +0000482# by doxygen. Possible values are YES and NO. If left blank NO is used.
483
mike-me2c3a492010-05-07 00:28:04 +0000484QUIET = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000485
Tanya Lattner7102b702011-10-21 20:51:54 +0000486# The WARNINGS tag can be used to turn on/off the warning messages that are
487# generated by doxygen. Possible values are YES and NO. If left blank
Chris Lattner3785a662002-01-26 21:16:41 +0000488# NO is used.
489
490WARNINGS = NO
491
Tanya Lattner7102b702011-10-21 20:51:54 +0000492# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
493# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
Chris Lattner3785a662002-01-26 21:16:41 +0000494# automatically be disabled.
495
496WARN_IF_UNDOCUMENTED = NO
497
Tanya Lattner7102b702011-10-21 20:51:54 +0000498# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
499# potential errors in the documentation, such as not documenting some
500# parameters in a documented function, or documenting parameters that
Reid Spencer80626a72006-05-15 21:36:13 +0000501# don't exist or using markup commands wrongly.
502
mike-me2c3a492010-05-07 00:28:04 +0000503WARN_IF_DOC_ERROR = YES
Reid Spencer80626a72006-05-15 21:36:13 +0000504
Tanya Lattner7102b702011-10-21 20:51:54 +0000505# This WARN_NO_PARAMDOC option can be abled to get warnings for
506# functions that are documented, but have no documentation for their parameters
507# or return value. If set to NO (the default) doxygen will only warn about
508# wrong or incomplete parameter documentation, but not about the absence of
Reid Spencer80626a72006-05-15 21:36:13 +0000509# documentation.
510
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000511WARN_NO_PARAMDOC = NO
Reid Spencer80626a72006-05-15 21:36:13 +0000512
Tanya Lattner7102b702011-10-21 20:51:54 +0000513# The WARN_FORMAT tag determines the format of the warning messages that
514# doxygen can produce. The string should contain the $file, $line, and $text
515# tags, which will be replaced by the file and line number from which the
516# warning originated and the warning text. Optionally the format may contain
517# $version, which will be replaced by the version of the file (if it could
Reid Spencer80626a72006-05-15 21:36:13 +0000518# be obtained via FILE_VERSION_FILTER)
Chris Lattner3785a662002-01-26 21:16:41 +0000519
Tanya Lattner7102b702011-10-21 20:51:54 +0000520WARN_FORMAT =
Chris Lattner3785a662002-01-26 21:16:41 +0000521
Tanya Lattner7102b702011-10-21 20:51:54 +0000522# The WARN_LOGFILE tag can be used to specify a file to which warning
523# and error messages should be written. If left blank the output is written
Chris Lattner3785a662002-01-26 21:16:41 +0000524# to stderr.
525
Tanya Lattner7102b702011-10-21 20:51:54 +0000526WARN_LOGFILE =
Chris Lattner3785a662002-01-26 21:16:41 +0000527
528#---------------------------------------------------------------------------
529# configuration options related to the input files
530#---------------------------------------------------------------------------
531
Tanya Lattner7102b702011-10-21 20:51:54 +0000532# The INPUT tag can be used to specify the files and/or directories that contain
533# documented source files. You may enter file names like "myfile.cpp" or
534# directories like "/usr/src/myproject". Separate the files or directories
Reid Spencer80626a72006-05-15 21:36:13 +0000535# with spaces.
Chris Lattner3785a662002-01-26 21:16:41 +0000536
mike-me2c3a492010-05-07 00:28:04 +0000537INPUT = @abs_top_srcdir@/include \
538 @abs_top_srcdir@/lib \
539 @abs_top_srcdir@/docs/doxygen.intro
Chris Lattner3785a662002-01-26 21:16:41 +0000540
Tanya Lattner7102b702011-10-21 20:51:54 +0000541# This tag can be used to specify the character encoding of the source files
542# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
543# also the default input encoding. Doxygen uses libiconv (or the iconv built
544# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000545# the list of possible encodings.
546
547INPUT_ENCODING = UTF-8
548
Tanya Lattner7102b702011-10-21 20:51:54 +0000549# If the value of the INPUT tag contains directories, you can use the
550# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
551# and *.h) to filter out the source-files in the directories. If left
552# blank the following patterns are tested:
553# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000554# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
Chris Lattner3785a662002-01-26 21:16:41 +0000555
Tanya Lattner7102b702011-10-21 20:51:54 +0000556FILE_PATTERNS =
Chris Lattner3785a662002-01-26 21:16:41 +0000557
Tanya Lattner7102b702011-10-21 20:51:54 +0000558# The RECURSIVE tag can be used to turn specify whether or not subdirectories
559# should be searched for input files as well. Possible values are YES and NO.
Chris Lattner3785a662002-01-26 21:16:41 +0000560# If left blank NO is used.
561
562RECURSIVE = YES
563
Tanya Lattner7102b702011-10-21 20:51:54 +0000564# The EXCLUDE tag can be used to specify files and/or directories that should
565# excluded from the INPUT source files. This way you can easily exclude a
Chris Lattner3785a662002-01-26 21:16:41 +0000566# subdirectory from a directory tree whose root is specified with the INPUT tag.
567
Tanya Lattner7102b702011-10-21 20:51:54 +0000568EXCLUDE =
Chris Lattner3785a662002-01-26 21:16:41 +0000569
Tanya Lattner7102b702011-10-21 20:51:54 +0000570# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
571# directories that are symbolic links (a Unix filesystem feature) are excluded
Reid Spencer80626a72006-05-15 21:36:13 +0000572# from the input.
573
574EXCLUDE_SYMLINKS = NO
575
Tanya Lattner7102b702011-10-21 20:51:54 +0000576# If the value of the INPUT tag contains directories, you can use the
577# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
578# certain files from those directories. Note that the wildcards are matched
579# against the file with absolute path, so to exclude all test directories
Reid Spencer80626a72006-05-15 21:36:13 +0000580# for example use the pattern */test/*
Chris Lattner3785a662002-01-26 21:16:41 +0000581
Tanya Lattner7102b702011-10-21 20:51:54 +0000582EXCLUDE_PATTERNS =
Chris Lattner3785a662002-01-26 21:16:41 +0000583
Tanya Lattner7102b702011-10-21 20:51:54 +0000584# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
585# (namespaces, classes, functions, etc.) that should be excluded from the
586# output. The symbol name can be a fully qualified name, a word, or if the
587# wildcard * is used, a substring. Examples: ANamespace, AClass,
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000588# AClass::ANamespace, ANamespace::*Test
589
Tanya Lattner7102b702011-10-21 20:51:54 +0000590EXCLUDE_SYMBOLS =
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000591
Tanya Lattner7102b702011-10-21 20:51:54 +0000592# The EXAMPLE_PATH tag can be used to specify one or more files or
593# directories that contain example code fragments that are included (see
Chris Lattner3785a662002-01-26 21:16:41 +0000594# the \include command).
595
mike-me2c3a492010-05-07 00:28:04 +0000596EXAMPLE_PATH = @abs_top_srcdir@/examples
Chris Lattner3785a662002-01-26 21:16:41 +0000597
Tanya Lattner7102b702011-10-21 20:51:54 +0000598# If the value of the EXAMPLE_PATH tag contains directories, you can use the
599# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
600# and *.h) to filter out the source-files in the directories. If left
Chris Lattner3785a662002-01-26 21:16:41 +0000601# blank all files are included.
602
Tanya Lattner7102b702011-10-21 20:51:54 +0000603EXAMPLE_PATTERNS =
Chris Lattner3785a662002-01-26 21:16:41 +0000604
Tanya Lattner7102b702011-10-21 20:51:54 +0000605# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
606# searched for input files to be used with the \include or \dontinclude
607# commands irrespective of the value of the RECURSIVE tag.
Chris Lattner3785a662002-01-26 21:16:41 +0000608# Possible values are YES and NO. If left blank NO is used.
609
Reid Spencer22e4cde2004-11-29 03:33:22 +0000610EXAMPLE_RECURSIVE = YES
Chris Lattner3785a662002-01-26 21:16:41 +0000611
Tanya Lattner7102b702011-10-21 20:51:54 +0000612# The IMAGE_PATH tag can be used to specify one or more files or
613# directories that contain image that are included in the documentation (see
Chris Lattner3785a662002-01-26 21:16:41 +0000614# the \image command).
615
mike-me2c3a492010-05-07 00:28:04 +0000616IMAGE_PATH = @abs_top_srcdir@/docs/img
Chris Lattner3785a662002-01-26 21:16:41 +0000617
Tanya Lattner7102b702011-10-21 20:51:54 +0000618# The INPUT_FILTER tag can be used to specify a program that doxygen should
619# invoke to filter for each input file. Doxygen will invoke the filter program
620# by executing (via popen()) the command <filter> <input-file>, where <filter>
621# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
622# input file. Doxygen will then use the output that the filter program writes
623# to standard output. If FILTER_PATTERNS is specified, this tag will be
Reid Spencer80626a72006-05-15 21:36:13 +0000624# ignored.
Chris Lattner3785a662002-01-26 21:16:41 +0000625
Tanya Lattner7102b702011-10-21 20:51:54 +0000626INPUT_FILTER =
Chris Lattner3785a662002-01-26 21:16:41 +0000627
Tanya Lattner7102b702011-10-21 20:51:54 +0000628# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
629# basis. Doxygen will compare the file name with each pattern and apply the
630# filter if there is a match. The filters are a list of the form:
631# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
632# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
Reid Spencer80626a72006-05-15 21:36:13 +0000633# is applied to all files.
634
Tanya Lattner7102b702011-10-21 20:51:54 +0000635FILTER_PATTERNS =
Reid Spencer80626a72006-05-15 21:36:13 +0000636
Tanya Lattner7102b702011-10-21 20:51:54 +0000637# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
638# INPUT_FILTER) will be used to filter the input files when producing source
Reid Spencer80626a72006-05-15 21:36:13 +0000639# files to browse (i.e. when SOURCE_BROWSER is set to YES).
Chris Lattner3785a662002-01-26 21:16:41 +0000640
641FILTER_SOURCE_FILES = NO
642
643#---------------------------------------------------------------------------
644# configuration options related to source browsing
645#---------------------------------------------------------------------------
646
Tanya Lattner7102b702011-10-21 20:51:54 +0000647# If the SOURCE_BROWSER tag is set to YES then a list of source files will
648# be generated. Documented entities will be cross-referenced with these sources.
649# Note: To get rid of all source code in the generated output, make sure also
Reid Spencer80626a72006-05-15 21:36:13 +0000650# VERBATIM_HEADERS is set to NO.
Chris Lattner3785a662002-01-26 21:16:41 +0000651
652SOURCE_BROWSER = YES
653
Tanya Lattner7102b702011-10-21 20:51:54 +0000654# Setting the INLINE_SOURCES tag to YES will include the body
Chris Lattner3785a662002-01-26 21:16:41 +0000655# of functions and classes directly in the documentation.
656
657INLINE_SOURCES = NO
658
Tanya Lattner7102b702011-10-21 20:51:54 +0000659# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
660# doxygen to hide any special comment blocks from generated source code
Reid Spencer80626a72006-05-15 21:36:13 +0000661# fragments. Normal C and C++ comments will always remain visible.
662
663STRIP_CODE_COMMENTS = NO
664
Tanya Lattner7102b702011-10-21 20:51:54 +0000665# If the REFERENCED_BY_RELATION tag is set to YES
666# then for each documented function all documented
Chris Lattner3785a662002-01-26 21:16:41 +0000667# functions referencing it will be listed.
668
669REFERENCED_BY_RELATION = YES
670
Tanya Lattner7102b702011-10-21 20:51:54 +0000671# If the REFERENCES_RELATION tag is set to YES
672# then for each documented function all documented entities
Chris Lattner3785a662002-01-26 21:16:41 +0000673# called/used by that function will be listed.
674
675REFERENCES_RELATION = YES
676
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000677# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
678# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
679# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
Tanya Lattner7102b702011-10-21 20:51:54 +0000680# link to the source code. Otherwise they will link to the documentstion.
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000681
682REFERENCES_LINK_SOURCE = YES
683
Tanya Lattner7102b702011-10-21 20:51:54 +0000684# If the USE_HTAGS tag is set to YES then the references to source code
685# will point to the HTML generated by the htags(1) tool instead of doxygen
686# built-in source browser. The htags tool is part of GNU's global source
687# tagging system (see http://www.gnu.org/software/global/global.html). You
Reid Spencer80626a72006-05-15 21:36:13 +0000688# will need version 4.8.6 or higher.
689
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000690USE_HTAGS = NO
Reid Spencer80626a72006-05-15 21:36:13 +0000691
Tanya Lattner7102b702011-10-21 20:51:54 +0000692# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
693# will generate a verbatim copy of the header file for each class for
Reid Spencer80626a72006-05-15 21:36:13 +0000694# which an include is specified. Set to NO to disable this.
695
696VERBATIM_HEADERS = YES
697
Chris Lattner3785a662002-01-26 21:16:41 +0000698#---------------------------------------------------------------------------
699# configuration options related to the alphabetical class index
700#---------------------------------------------------------------------------
701
Tanya Lattner7102b702011-10-21 20:51:54 +0000702# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
703# of all compounds will be generated. Enable this if the project
Chris Lattner3785a662002-01-26 21:16:41 +0000704# contains a lot of classes, structs, unions or interfaces.
705
706ALPHABETICAL_INDEX = YES
707
Tanya Lattner7102b702011-10-21 20:51:54 +0000708# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
709# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
Chris Lattner3785a662002-01-26 21:16:41 +0000710# in which this list will be split (can be a number in the range [1..20])
711
Reid Spencer06a3db02004-06-12 14:46:02 +0000712COLS_IN_ALPHA_INDEX = 4
Chris Lattner3785a662002-01-26 21:16:41 +0000713
Tanya Lattner7102b702011-10-21 20:51:54 +0000714# In case all classes in a project start with a common prefix, all
715# classes will be put under the same header in the alphabetical index.
716# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
Chris Lattner3785a662002-01-26 21:16:41 +0000717# should be ignored while generating the index headers.
718
Reid Spencer22e4cde2004-11-29 03:33:22 +0000719IGNORE_PREFIX = llvm::
Chris Lattner3785a662002-01-26 21:16:41 +0000720
721#---------------------------------------------------------------------------
722# configuration options related to the HTML output
723#---------------------------------------------------------------------------
724
Tanya Lattner7102b702011-10-21 20:51:54 +0000725# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Chris Lattner3785a662002-01-26 21:16:41 +0000726# generate HTML output.
727
728GENERATE_HTML = YES
729
Tanya Lattner7102b702011-10-21 20:51:54 +0000730# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
731# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris Lattner3785a662002-01-26 21:16:41 +0000732# put in front of it. If left blank `html' will be used as the default path.
733
mike-me2c3a492010-05-07 00:28:04 +0000734HTML_OUTPUT = html
Chris Lattner3785a662002-01-26 21:16:41 +0000735
Tanya Lattner7102b702011-10-21 20:51:54 +0000736# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
737# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
Reid Spencer80626a72006-05-15 21:36:13 +0000738# doxygen will generate files with .html extension.
739
740HTML_FILE_EXTENSION = .html
741
Tanya Lattner7102b702011-10-21 20:51:54 +0000742# The HTML_HEADER tag can be used to specify a personal HTML header for
743# each generated HTML page. If it is left blank doxygen will generate a
Chris Lattner3785a662002-01-26 21:16:41 +0000744# standard header.
745
mike-me2c3a492010-05-07 00:28:04 +0000746HTML_HEADER = @abs_top_srcdir@/docs/doxygen.header
Chris Lattner3785a662002-01-26 21:16:41 +0000747
Tanya Lattner7102b702011-10-21 20:51:54 +0000748# The HTML_FOOTER tag can be used to specify a personal HTML footer for
749# each generated HTML page. If it is left blank doxygen will generate a
Chris Lattner3785a662002-01-26 21:16:41 +0000750# standard footer.
751
mike-me2c3a492010-05-07 00:28:04 +0000752HTML_FOOTER = @abs_top_srcdir@/docs/doxygen.footer
Chris Lattner3785a662002-01-26 21:16:41 +0000753
Tanya Lattner7102b702011-10-21 20:51:54 +0000754# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
755# style sheet that is used by each HTML page. It can be used to
756# fine-tune the look of the HTML output. If the tag is left blank doxygen
757# will generate a default style sheet. Note that doxygen will try to copy
758# the style sheet file to the HTML output directory, so don't put your own
Reid Spencer80626a72006-05-15 21:36:13 +0000759# stylesheet in the HTML output directory as well, or it will be erased!
Chris Lattner3785a662002-01-26 21:16:41 +0000760
mike-me2c3a492010-05-07 00:28:04 +0000761HTML_STYLESHEET = @abs_top_srcdir@/docs/doxygen.css
Chris Lattner3785a662002-01-26 21:16:41 +0000762
Tanya Lattner7102b702011-10-21 20:51:54 +0000763# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
764# files or namespaces will be aligned in HTML using tables. If set to
Chris Lattner3785a662002-01-26 21:16:41 +0000765# NO a bullet list will be used.
766
767HTML_ALIGN_MEMBERS = YES
768
Tanya Lattner7102b702011-10-21 20:51:54 +0000769# If the GENERATE_HTMLHELP tag is set to YES, additional index files
770# will be generated that can be used as input for tools like the
771# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
Bill Wendlingeb13b612011-10-11 07:25:38 +0000772# of the generated HTML documentation.
773
774GENERATE_HTMLHELP = NO
775
Tanya Lattner7102b702011-10-21 20:51:54 +0000776# If the GENERATE_DOCSET tag is set to YES, additional index files
777# will be generated that can be used as input for Apple's Xcode 3
778# integrated development environment, introduced with OSX 10.5 (Leopard).
779# To create a documentation set, doxygen will generate a Makefile in the
780# HTML output directory. Running make will produce the docset in that
781# directory and running "make install" will install the docset in
782# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
783# it at startup.
784
785GENERATE_DOCSET = NO
786
787# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
788# feed. A documentation feed provides an umbrella under which multiple
789# documentation sets from a single provider (such as a company or product suite)
790# can be grouped.
791
792DOCSET_FEEDNAME = "Doxygen generated docs"
793
794# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
795# should uniquely identify the documentation set bundle. This should be a
796# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
797# will append .docset to the name.
798
799DOCSET_BUNDLE_ID = org.doxygen.Project
800
801# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
802# documentation will contain sections that can be hidden and shown after the
803# page has loaded. For this to work a browser that supports
804# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
805# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
806
807HTML_DYNAMIC_SECTIONS = NO
808
809# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
810# be used to specify the file name of the resulting .chm file. You
811# can add a path in front of the file if the result should not be
Reid Spencer80626a72006-05-15 21:36:13 +0000812# written to the html output directory.
813
Tanya Lattner7102b702011-10-21 20:51:54 +0000814CHM_FILE =
Reid Spencer80626a72006-05-15 21:36:13 +0000815
Tanya Lattner7102b702011-10-21 20:51:54 +0000816# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
817# be used to specify the location (absolute path including file name) of
818# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
Reid Spencer80626a72006-05-15 21:36:13 +0000819# the HTML help compiler on the generated index.hhp.
820
Tanya Lattner7102b702011-10-21 20:51:54 +0000821HHC_LOCATION =
Reid Spencer80626a72006-05-15 21:36:13 +0000822
Tanya Lattner7102b702011-10-21 20:51:54 +0000823# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
824# controls if a separate .chi index file is generated (YES) or that
Chris Lattner3785a662002-01-26 21:16:41 +0000825# it should be included in the master .chm file (NO).
826
827GENERATE_CHI = NO
828
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000829# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
830# is used to encode HtmlHelp index (hhk), content (hhc) and project file
831# content.
832
Tanya Lattner7102b702011-10-21 20:51:54 +0000833CHM_INDEX_ENCODING =
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000834
Tanya Lattner7102b702011-10-21 20:51:54 +0000835# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
836# controls whether a binary table of contents is generated (YES) or a
Chris Lattner3785a662002-01-26 21:16:41 +0000837# normal table of contents (NO) in the .chm file.
838
839BINARY_TOC = NO
840
Tanya Lattner7102b702011-10-21 20:51:54 +0000841# The TOC_EXPAND flag can be set to YES to add extra items for group members
Reid Spencer80626a72006-05-15 21:36:13 +0000842# to the contents of the HTML help documentation and to the tree view.
Chris Lattner3785a662002-01-26 21:16:41 +0000843
844TOC_EXPAND = NO
845
Tanya Lattner7102b702011-10-21 20:51:54 +0000846# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
847# top of each HTML page. The value NO (the default) enables the index and
Chris Lattner3785a662002-01-26 21:16:41 +0000848# the value YES disables it.
849
850DISABLE_INDEX = NO
851
Tanya Lattner7102b702011-10-21 20:51:54 +0000852# This tag can be used to set the number of enum values (range [1..20])
Chris Lattner3785a662002-01-26 21:16:41 +0000853# that doxygen will group on one line in the generated HTML documentation.
854
855ENUM_VALUES_PER_LINE = 4
856
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000857# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
858# structure should be generated to display hierarchical information.
Tanya Lattner7102b702011-10-21 20:51:54 +0000859# If the tag value is set to FRAME, a side panel will be generated
860# containing a tree-like index structure (just like the one that
861# is generated for HTML Help). For this to work a browser that supports
862# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
863# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
864# probably better off using the HTML help feature. Other possible values
865# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
866# and Class Hiererachy pages using a tree view instead of an ordered list;
867# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
868# disables this behavior completely. For backwards compatibility with previous
869# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
870# respectively.
Chris Lattner3785a662002-01-26 21:16:41 +0000871
872GENERATE_TREEVIEW = NO
873
Tanya Lattner7102b702011-10-21 20:51:54 +0000874# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
875# used to set the initial width (in pixels) of the frame in which the tree
Chris Lattner3785a662002-01-26 21:16:41 +0000876# is shown.
877
878TREEVIEW_WIDTH = 250
879
Tanya Lattner7102b702011-10-21 20:51:54 +0000880# Use this tag to change the font size of Latex formulas included
881# as images in the HTML documentation. The default is 10. Note that
882# when you change the font size after a successful doxygen run you need
883# to manually remove any form_*.png images from the HTML output directory
Tanya Lattner6a0fd932008-09-18 16:32:28 +0000884# to force them to be regenerated.
885
886FORMULA_FONTSIZE = 10
887
Chris Lattner3785a662002-01-26 21:16:41 +0000888#---------------------------------------------------------------------------
889# configuration options related to the LaTeX output
890#---------------------------------------------------------------------------
891
Tanya Lattner7102b702011-10-21 20:51:54 +0000892# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Chris Lattner3785a662002-01-26 21:16:41 +0000893# generate Latex output.
894
895GENERATE_LATEX = NO
896
Tanya Lattner7102b702011-10-21 20:51:54 +0000897# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
898# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris Lattner3785a662002-01-26 21:16:41 +0000899# put in front of it. If left blank `latex' will be used as the default path.
900
Tanya Lattner7102b702011-10-21 20:51:54 +0000901LATEX_OUTPUT =
Chris Lattner3785a662002-01-26 21:16:41 +0000902
Tanya Lattner7102b702011-10-21 20:51:54 +0000903# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Reid Spencer80626a72006-05-15 21:36:13 +0000904# invoked. If left blank `latex' will be used as the default command name.
905
906LATEX_CMD_NAME = latex
907
Tanya Lattner7102b702011-10-21 20:51:54 +0000908# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
909# generate index for LaTeX. If left blank `makeindex' will be used as the
Reid Spencer80626a72006-05-15 21:36:13 +0000910# default command name.
911
912MAKEINDEX_CMD_NAME = makeindex
913
Tanya Lattner7102b702011-10-21 20:51:54 +0000914# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
915# LaTeX documents. This may be useful for small projects and may help to
Chris Lattner3785a662002-01-26 21:16:41 +0000916# save some trees in general.
917
918COMPACT_LATEX = NO
919
Tanya Lattner7102b702011-10-21 20:51:54 +0000920# The PAPER_TYPE tag can be used to set the paper type that is used
921# by the printer. Possible values are: a4, a4wide, letter, legal and
Chris Lattner3785a662002-01-26 21:16:41 +0000922# executive. If left blank a4wide will be used.
923
mike-me2c3a492010-05-07 00:28:04 +0000924PAPER_TYPE = letter
Chris Lattner3785a662002-01-26 21:16:41 +0000925
Tanya Lattner7102b702011-10-21 20:51:54 +0000926# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Chris Lattner3785a662002-01-26 21:16:41 +0000927# packages that should be included in the LaTeX output.
928
Tanya Lattner7102b702011-10-21 20:51:54 +0000929EXTRA_PACKAGES =
Chris Lattner3785a662002-01-26 21:16:41 +0000930
Tanya Lattner7102b702011-10-21 20:51:54 +0000931# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
932# the generated latex document. The header should contain everything until
933# the first chapter. If it is left blank doxygen will generate a
Chris Lattner3785a662002-01-26 21:16:41 +0000934# standard header. Notice: only use this tag if you know what you are doing!
935
Tanya Lattner7102b702011-10-21 20:51:54 +0000936LATEX_HEADER =
Chris Lattner3785a662002-01-26 21:16:41 +0000937
Tanya Lattner7102b702011-10-21 20:51:54 +0000938# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
939# is prepared for conversion to pdf (using ps2pdf). The pdf file will
940# contain links (just like the HTML output) instead of page references
Chris Lattner3785a662002-01-26 21:16:41 +0000941# This makes the output suitable for online browsing using a pdf viewer.
942
mike-me2c3a492010-05-07 00:28:04 +0000943PDF_HYPERLINKS = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000944
Tanya Lattner7102b702011-10-21 20:51:54 +0000945# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
946# plain latex in the generated Makefile. Set this option to YES to get a
Chris Lattner3785a662002-01-26 21:16:41 +0000947# higher quality PDF documentation.
948
mike-me2c3a492010-05-07 00:28:04 +0000949USE_PDFLATEX = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000950
Tanya Lattner7102b702011-10-21 20:51:54 +0000951# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
952# command to the generated LaTeX files. This will instruct LaTeX to keep
953# running if errors occur, instead of asking the user for help.
Chris Lattner3785a662002-01-26 21:16:41 +0000954# This option is also used when generating formulas in HTML.
955
956LATEX_BATCHMODE = NO
957
Tanya Lattner7102b702011-10-21 20:51:54 +0000958# If LATEX_HIDE_INDICES is set to YES then doxygen will not
959# include the index chapters (such as File Index, Compound Index, etc.)
Reid Spencer80626a72006-05-15 21:36:13 +0000960# in the output.
961
962LATEX_HIDE_INDICES = NO
963
Chris Lattner3785a662002-01-26 21:16:41 +0000964#---------------------------------------------------------------------------
965# configuration options related to the RTF output
966#---------------------------------------------------------------------------
967
Tanya Lattner7102b702011-10-21 20:51:54 +0000968# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
969# The RTF output is optimized for Word 97 and may not look very pretty with
Chris Lattner3785a662002-01-26 21:16:41 +0000970# other RTF readers or editors.
971
972GENERATE_RTF = NO
973
Tanya Lattner7102b702011-10-21 20:51:54 +0000974# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
975# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris Lattner3785a662002-01-26 21:16:41 +0000976# put in front of it. If left blank `rtf' will be used as the default path.
977
Tanya Lattner7102b702011-10-21 20:51:54 +0000978RTF_OUTPUT =
Chris Lattner3785a662002-01-26 21:16:41 +0000979
Tanya Lattner7102b702011-10-21 20:51:54 +0000980# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
981# RTF documents. This may be useful for small projects and may help to
Chris Lattner3785a662002-01-26 21:16:41 +0000982# save some trees in general.
983
984COMPACT_RTF = NO
985
Tanya Lattner7102b702011-10-21 20:51:54 +0000986# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
987# will contain hyperlink fields. The RTF file will
988# contain links (just like the HTML output) instead of page references.
989# This makes the output suitable for online browsing using WORD or other
990# programs which support those fields.
Chris Lattner3785a662002-01-26 21:16:41 +0000991# Note: wordpad (write) and others do not support links.
992
993RTF_HYPERLINKS = NO
994
Tanya Lattner7102b702011-10-21 20:51:54 +0000995# Load stylesheet definitions from file. Syntax is similar to doxygen's
996# config file, i.e. a series of assignments. You only have to provide
Chris Lattner3785a662002-01-26 21:16:41 +0000997# replacements, missing definitions are set to their default value.
998
Tanya Lattner7102b702011-10-21 20:51:54 +0000999RTF_STYLESHEET_FILE =
Chris Lattner3785a662002-01-26 21:16:41 +00001000
Tanya Lattner7102b702011-10-21 20:51:54 +00001001# Set optional variables used in the generation of an rtf document.
Chris Lattner3785a662002-01-26 21:16:41 +00001002# Syntax is similar to doxygen's config file.
1003
Tanya Lattner7102b702011-10-21 20:51:54 +00001004RTF_EXTENSIONS_FILE =
Chris Lattner3785a662002-01-26 21:16:41 +00001005
1006#---------------------------------------------------------------------------
1007# configuration options related to the man page output
1008#---------------------------------------------------------------------------
1009
Tanya Lattner7102b702011-10-21 20:51:54 +00001010# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Chris Lattner3785a662002-01-26 21:16:41 +00001011# generate man pages
1012
1013GENERATE_MAN = NO
1014
Tanya Lattner7102b702011-10-21 20:51:54 +00001015# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1016# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris Lattner3785a662002-01-26 21:16:41 +00001017# put in front of it. If left blank `man' will be used as the default path.
1018
Tanya Lattner7102b702011-10-21 20:51:54 +00001019MAN_OUTPUT =
Chris Lattner3785a662002-01-26 21:16:41 +00001020
Tanya Lattner7102b702011-10-21 20:51:54 +00001021# The MAN_EXTENSION tag determines the extension that is added to
Chris Lattner3785a662002-01-26 21:16:41 +00001022# the generated man pages (default is the subroutine's section .3)
1023
Tanya Lattner7102b702011-10-21 20:51:54 +00001024MAN_EXTENSION =
Chris Lattner3785a662002-01-26 21:16:41 +00001025
Tanya Lattner7102b702011-10-21 20:51:54 +00001026# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1027# then it will generate one additional man file for each entity
1028# documented in the real man page(s). These additional files
1029# only source the real man page, but without them the man command
Chris Lattner3785a662002-01-26 21:16:41 +00001030# would be unable to find the correct page. The default is NO.
1031
1032MAN_LINKS = NO
1033
1034#---------------------------------------------------------------------------
1035# configuration options related to the XML output
1036#---------------------------------------------------------------------------
1037
Tanya Lattner7102b702011-10-21 20:51:54 +00001038# If the GENERATE_XML tag is set to YES Doxygen will
1039# generate an XML file that captures the structure of
Reid Spencer80626a72006-05-15 21:36:13 +00001040# the code including all documentation.
Chris Lattner3785a662002-01-26 21:16:41 +00001041
1042GENERATE_XML = NO
1043
Tanya Lattner7102b702011-10-21 20:51:54 +00001044# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1045# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Reid Spencer80626a72006-05-15 21:36:13 +00001046# put in front of it. If left blank `xml' will be used as the default path.
1047
1048XML_OUTPUT = xml
1049
Tanya Lattner7102b702011-10-21 20:51:54 +00001050# The XML_SCHEMA tag can be used to specify an XML schema,
1051# which can be used by a validating XML parser to check the
Reid Spencer80626a72006-05-15 21:36:13 +00001052# syntax of the XML files.
1053
Tanya Lattner7102b702011-10-21 20:51:54 +00001054XML_SCHEMA =
Reid Spencer80626a72006-05-15 21:36:13 +00001055
Tanya Lattner7102b702011-10-21 20:51:54 +00001056# The XML_DTD tag can be used to specify an XML DTD,
1057# which can be used by a validating XML parser to check the
Reid Spencer80626a72006-05-15 21:36:13 +00001058# syntax of the XML files.
1059
Tanya Lattner7102b702011-10-21 20:51:54 +00001060XML_DTD =
Reid Spencer80626a72006-05-15 21:36:13 +00001061
Tanya Lattner7102b702011-10-21 20:51:54 +00001062# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1063# dump the program listings (including syntax highlighting
1064# and cross-referencing information) to the XML output. Note that
Reid Spencer80626a72006-05-15 21:36:13 +00001065# enabling this will significantly increase the size of the XML output.
1066
1067XML_PROGRAMLISTING = YES
1068
Chris Lattner3785a662002-01-26 21:16:41 +00001069#---------------------------------------------------------------------------
1070# configuration options for the AutoGen Definitions output
1071#---------------------------------------------------------------------------
1072
Tanya Lattner7102b702011-10-21 20:51:54 +00001073# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1074# generate an AutoGen Definitions (see autogen.sf.net) file
1075# that captures the structure of the code including all
1076# documentation. Note that this feature is still experimental
Chris Lattner3785a662002-01-26 21:16:41 +00001077# and incomplete at the moment.
1078
1079GENERATE_AUTOGEN_DEF = NO
1080
1081#---------------------------------------------------------------------------
Reid Spencer80626a72006-05-15 21:36:13 +00001082# configuration options related to the Perl module output
1083#---------------------------------------------------------------------------
1084
Tanya Lattner7102b702011-10-21 20:51:54 +00001085# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1086# generate a Perl module file that captures the structure of
1087# the code including all documentation. Note that this
1088# feature is still experimental and incomplete at the
Reid Spencer80626a72006-05-15 21:36:13 +00001089# moment.
1090
1091GENERATE_PERLMOD = NO
1092
Tanya Lattner7102b702011-10-21 20:51:54 +00001093# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1094# the necessary Makefile rules, Perl scripts and LaTeX code to be able
Reid Spencer80626a72006-05-15 21:36:13 +00001095# to generate PDF and DVI output from the Perl module output.
1096
1097PERLMOD_LATEX = NO
1098
Tanya Lattner7102b702011-10-21 20:51:54 +00001099# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1100# nicely formatted so it can be parsed by a human reader. This is useful
1101# if you want to understand what is going on. On the other hand, if this
1102# tag is set to NO the size of the Perl module output will be much smaller
Reid Spencer80626a72006-05-15 21:36:13 +00001103# and Perl will parse it just the same.
1104
1105PERLMOD_PRETTY = YES
1106
Tanya Lattner7102b702011-10-21 20:51:54 +00001107# The names of the make variables in the generated doxyrules.make file
1108# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1109# This is useful so different doxyrules.make files included by the same
Reid Spencer80626a72006-05-15 21:36:13 +00001110# Makefile don't overwrite each other's variables.
1111
Tanya Lattner7102b702011-10-21 20:51:54 +00001112PERLMOD_MAKEVAR_PREFIX =
Reid Spencer80626a72006-05-15 21:36:13 +00001113
1114#---------------------------------------------------------------------------
Tanya Lattner7102b702011-10-21 20:51:54 +00001115# Configuration options related to the preprocessor
Chris Lattner3785a662002-01-26 21:16:41 +00001116#---------------------------------------------------------------------------
1117
Tanya Lattner7102b702011-10-21 20:51:54 +00001118# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1119# evaluate all C-preprocessor directives found in the sources and include
Chris Lattner3785a662002-01-26 21:16:41 +00001120# files.
1121
1122ENABLE_PREPROCESSING = YES
1123
Tanya Lattner7102b702011-10-21 20:51:54 +00001124# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1125# names in the source code. If set to NO (the default) only conditional
1126# compilation will be performed. Macro expansion can be done in a controlled
Chris Lattner3785a662002-01-26 21:16:41 +00001127# way by setting EXPAND_ONLY_PREDEF to YES.
1128
1129MACRO_EXPANSION = NO
1130
Tanya Lattner7102b702011-10-21 20:51:54 +00001131# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1132# then the macro expansion is limited to the macros specified with the
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001133# PREDEFINED and EXPAND_AS_DEFINED tags.
Chris Lattner3785a662002-01-26 21:16:41 +00001134
1135EXPAND_ONLY_PREDEF = NO
1136
Tanya Lattner7102b702011-10-21 20:51:54 +00001137# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
Chris Lattner3785a662002-01-26 21:16:41 +00001138# in the INCLUDE_PATH (see below) will be search if a #include is found.
1139
1140SEARCH_INCLUDES = YES
1141
Tanya Lattner7102b702011-10-21 20:51:54 +00001142# The INCLUDE_PATH tag can be used to specify one or more directories that
1143# contain include files that are not input files but should be processed by
Chris Lattner3785a662002-01-26 21:16:41 +00001144# the preprocessor.
1145
mike-me2c3a492010-05-07 00:28:04 +00001146INCLUDE_PATH = ../include
Chris Lattner3785a662002-01-26 21:16:41 +00001147
Tanya Lattner7102b702011-10-21 20:51:54 +00001148# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1149# patterns (like *.h and *.hpp) to filter out the header-files in the
1150# directories. If left blank, the patterns specified with FILE_PATTERNS will
Chris Lattner3785a662002-01-26 21:16:41 +00001151# be used.
1152
Tanya Lattner7102b702011-10-21 20:51:54 +00001153INCLUDE_FILE_PATTERNS =
Chris Lattner3785a662002-01-26 21:16:41 +00001154
Tanya Lattner7102b702011-10-21 20:51:54 +00001155# The PREDEFINED tag can be used to specify one or more macro names that
1156# are defined before the preprocessor is started (similar to the -D option of
1157# gcc). The argument of the tag is a list of macros of the form: name
1158# or name=definition (no spaces). If the definition and the = are
1159# omitted =1 is assumed. To prevent a macro definition from being
1160# undefined via #undef or recursively expanded use the := operator
Reid Spencer80626a72006-05-15 21:36:13 +00001161# instead of the = operator.
Chris Lattner3785a662002-01-26 21:16:41 +00001162
Tanya Lattner7102b702011-10-21 20:51:54 +00001163PREDEFINED =
Chris Lattner3785a662002-01-26 21:16:41 +00001164
Tanya Lattner7102b702011-10-21 20:51:54 +00001165# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1166# this tag can be used to specify a list of macro names that should be expanded.
1167# The macro definition that is found in the sources will be used.
Chris Lattner3785a662002-01-26 21:16:41 +00001168# Use the PREDEFINED tag if you want to use a different macro definition.
1169
Tanya Lattner7102b702011-10-21 20:51:54 +00001170EXPAND_AS_DEFINED =
Chris Lattner3785a662002-01-26 21:16:41 +00001171
Tanya Lattner7102b702011-10-21 20:51:54 +00001172# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1173# doxygen's preprocessor will remove all function-like macros that are alone
1174# on a line, have an all uppercase name, and do not end with a semicolon. Such
1175# function macros are typically used for boiler-plate code, and will confuse
Reid Spencer80626a72006-05-15 21:36:13 +00001176# the parser if not removed.
Chris Lattner3785a662002-01-26 21:16:41 +00001177
1178SKIP_FUNCTION_MACROS = YES
1179
1180#---------------------------------------------------------------------------
Tanya Lattner7102b702011-10-21 20:51:54 +00001181# Configuration::additions related to external references
Chris Lattner3785a662002-01-26 21:16:41 +00001182#---------------------------------------------------------------------------
1183
Tanya Lattner7102b702011-10-21 20:51:54 +00001184# The TAGFILES option can be used to specify one or more tagfiles.
1185# Optionally an initial location of the external documentation
1186# can be added for each tagfile. The format of a tag file without
1187# this location is as follows:
1188# TAGFILES = file1 file2 ...
1189# Adding location for the tag files is done as follows:
1190# TAGFILES = file1=loc1 "file2 = loc2" ...
1191# where "loc1" and "loc2" can be relative or absolute paths or
1192# URLs. If a location is present for each tag, the installdox tool
Reid Spencer80626a72006-05-15 21:36:13 +00001193# does not have to be run to correct the links.
1194# Note that each tag file must have a unique name
1195# (where the name does NOT include the path)
Tanya Lattner7102b702011-10-21 20:51:54 +00001196# If a tag file is not located in the directory in which doxygen
Reid Spencer80626a72006-05-15 21:36:13 +00001197# is run, you must also specify the path to the tagfile here.
Chris Lattner3785a662002-01-26 21:16:41 +00001198
Tanya Lattner7102b702011-10-21 20:51:54 +00001199TAGFILES =
Chris Lattner3785a662002-01-26 21:16:41 +00001200
Tanya Lattner7102b702011-10-21 20:51:54 +00001201# When a file name is specified after GENERATE_TAGFILE, doxygen will create
Chris Lattner3785a662002-01-26 21:16:41 +00001202# a tag file that is based on the input files it reads.
1203
Tanya Lattner7102b702011-10-21 20:51:54 +00001204GENERATE_TAGFILE =
Chris Lattner3785a662002-01-26 21:16:41 +00001205
Tanya Lattner7102b702011-10-21 20:51:54 +00001206# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1207# in the class index. If set to NO only the inherited external classes
Chris Lattner3785a662002-01-26 21:16:41 +00001208# will be listed.
1209
1210ALLEXTERNALS = YES
1211
Tanya Lattner7102b702011-10-21 20:51:54 +00001212# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1213# in the modules index. If set to NO, only the current project's groups will
Reid Spencer80626a72006-05-15 21:36:13 +00001214# be listed.
1215
1216EXTERNAL_GROUPS = YES
1217
Tanya Lattner7102b702011-10-21 20:51:54 +00001218# The PERL_PATH should be the absolute path and name of the perl script
Chris Lattner3785a662002-01-26 21:16:41 +00001219# interpreter (i.e. the result of `which perl').
1220
Tanya Lattner7102b702011-10-21 20:51:54 +00001221PERL_PATH =
Chris Lattner3785a662002-01-26 21:16:41 +00001222
1223#---------------------------------------------------------------------------
Tanya Lattner7102b702011-10-21 20:51:54 +00001224# Configuration options related to the dot tool
Chris Lattner3785a662002-01-26 21:16:41 +00001225#---------------------------------------------------------------------------
1226
Tanya Lattner7102b702011-10-21 20:51:54 +00001227# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1228# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1229# or super classes. Setting the tag to NO turns the diagrams off. Note that
1230# this option is superseded by the HAVE_DOT option below. This is only a
1231# fallback. It is recommended to install and use dot, since it yields more
Reid Spencer80626a72006-05-15 21:36:13 +00001232# powerful graphs.
Chris Lattner3785a662002-01-26 21:16:41 +00001233
1234CLASS_DIAGRAMS = YES
1235
Tanya Lattner7102b702011-10-21 20:51:54 +00001236# You can define message sequence charts within doxygen comments using the \msc
1237# command. Doxygen will then run the mscgen tool (see
1238# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1239# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1240# the mscgen tool resides. If left empty the tool is assumed to be found in the
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001241# default search path.
1242
Tanya Lattner7102b702011-10-21 20:51:54 +00001243MSCGEN_PATH =
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001244
Tanya Lattner7102b702011-10-21 20:51:54 +00001245# If set to YES, the inheritance and collaboration graphs will hide
1246# inheritance and usage relations if the target is undocumented
Reid Spencer80626a72006-05-15 21:36:13 +00001247# or is not a class.
1248
1249HIDE_UNDOC_RELATIONS = NO
1250
Tanya Lattner7102b702011-10-21 20:51:54 +00001251# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1252# available from the path. This tool is part of Graphviz, a graph visualization
1253# toolkit from AT&T and Lucent Bell Labs. The other options in this section
Chris Lattner3785a662002-01-26 21:16:41 +00001254# have no effect if this option is set to NO (the default)
1255
1256HAVE_DOT = YES
1257
Tanya Lattner7102b702011-10-21 20:51:54 +00001258# By default doxygen will write a font called FreeSans.ttf to the output
1259# directory and reference it in all dot files that doxygen generates. This
1260# font does not include all possible unicode characters however, so when you need
1261# these (or just want a differently looking font) you can specify the font name
1262# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1263# which can be done by putting it in a standard location or by setting the
1264# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001265# containing the font.
1266
1267DOT_FONTNAME = FreeSans
1268
Tanya Lattner7102b702011-10-21 20:51:54 +00001269# By default doxygen will tell dot to use the output directory to look for the
1270# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1271# different font using DOT_FONTNAME you can set the path where dot
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001272# can find it using this tag.
1273
Tanya Lattner7102b702011-10-21 20:51:54 +00001274DOT_FONTPATH =
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001275
Tanya Lattner7102b702011-10-21 20:51:54 +00001276# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1277# will generate a graph for each documented class showing the direct and
1278# indirect inheritance relations. Setting this tag to YES will force the
Chris Lattner3785a662002-01-26 21:16:41 +00001279# the CLASS_DIAGRAMS tag to NO.
1280
1281CLASS_GRAPH = YES
1282
Tanya Lattner7102b702011-10-21 20:51:54 +00001283# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1284# will generate a graph for each documented class showing the direct and
1285# indirect implementation dependencies (inheritance, containment, and
Chris Lattner3785a662002-01-26 21:16:41 +00001286# class references variables) of the class with other documented classes.
1287
mike-me2c3a492010-05-07 00:28:04 +00001288COLLABORATION_GRAPH = YES
Chris Lattner3785a662002-01-26 21:16:41 +00001289
Tanya Lattner7102b702011-10-21 20:51:54 +00001290# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
Reid Spencer80626a72006-05-15 21:36:13 +00001291# will generate a graph for groups, showing the direct groups dependencies
1292
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001293GROUP_GRAPHS = YES
Reid Spencer80626a72006-05-15 21:36:13 +00001294
Tanya Lattner7102b702011-10-21 20:51:54 +00001295# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1296# collaboration diagrams in a style similar to the OMG's Unified Modeling
Reid Spencer80626a72006-05-15 21:36:13 +00001297# Language.
1298
1299UML_LOOK = NO
1300
Tanya Lattner7102b702011-10-21 20:51:54 +00001301# If set to YES, the inheritance and collaboration graphs will show the
Chris Lattner3785a662002-01-26 21:16:41 +00001302# relations between templates and their instances.
1303
1304TEMPLATE_RELATIONS = YES
1305
Tanya Lattner7102b702011-10-21 20:51:54 +00001306# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1307# tags are set to YES then doxygen will generate a graph for each documented
1308# file showing the direct and indirect include dependencies of the file with
Chris Lattner3785a662002-01-26 21:16:41 +00001309# other documented files.
1310
1311INCLUDE_GRAPH = YES
1312
Tanya Lattner7102b702011-10-21 20:51:54 +00001313# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1314# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1315# documented header file showing the documented files that directly or
Chris Lattner3785a662002-01-26 21:16:41 +00001316# indirectly include this file.
1317
1318INCLUDED_BY_GRAPH = YES
1319
Tanya Lattner7102b702011-10-21 20:51:54 +00001320# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1321# doxygen will generate a call dependency graph for every global function
1322# or class method. Note that enabling this option will significantly increase
1323# the time of a run. So in most cases it will be better to enable call graphs
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001324# for selected functions only using the \callgraph command.
Reid Spencer80626a72006-05-15 21:36:13 +00001325
1326CALL_GRAPH = NO
1327
Tanya Lattner7102b702011-10-21 20:51:54 +00001328# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1329# doxygen will generate a caller dependency graph for every global function
1330# or class method. Note that enabling this option will significantly increase
1331# the time of a run. So in most cases it will be better to enable caller
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001332# graphs for selected functions only using the \callergraph command.
1333
1334CALLER_GRAPH = NO
1335
Tanya Lattner7102b702011-10-21 20:51:54 +00001336# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
Chris Lattner3785a662002-01-26 21:16:41 +00001337# will graphical hierarchy of all classes instead of a textual one.
1338
1339GRAPHICAL_HIERARCHY = YES
1340
Tanya Lattner7102b702011-10-21 20:51:54 +00001341# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1342# then doxygen will show the dependencies a directory has on other directories
Reid Spencer80626a72006-05-15 21:36:13 +00001343# in a graphical way. The dependency relations are determined by the #include
1344# relations between the files in the directories.
1345
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001346DIRECTORY_GRAPH = YES
Reid Spencer80626a72006-05-15 21:36:13 +00001347
Tanya Lattner7102b702011-10-21 20:51:54 +00001348# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Reid Spencer80626a72006-05-15 21:36:13 +00001349# generated by dot. Possible values are png, jpg, or gif
1350# If left blank png will be used.
1351
1352DOT_IMAGE_FORMAT = png
1353
Tanya Lattner7102b702011-10-21 20:51:54 +00001354# The tag DOT_PATH can be used to specify the path where the dot tool can be
Reid Spencer80626a72006-05-15 21:36:13 +00001355# found. If left blank, it is assumed the dot tool can be found in the path.
Chris Lattner3785a662002-01-26 21:16:41 +00001356
mike-me2c3a492010-05-07 00:28:04 +00001357DOT_PATH = @DOT@
Chris Lattner3785a662002-01-26 21:16:41 +00001358
Tanya Lattner7102b702011-10-21 20:51:54 +00001359# The DOTFILE_DIRS tag can be used to specify one or more directories that
1360# contain dot files that are included in the documentation (see the
Chris Lattner3785a662002-01-26 21:16:41 +00001361# \dotfile command).
1362
Tanya Lattner7102b702011-10-21 20:51:54 +00001363DOTFILE_DIRS =
Chris Lattner3785a662002-01-26 21:16:41 +00001364
Tanya Lattner7102b702011-10-21 20:51:54 +00001365# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1366# nodes that will be shown in the graph. If the number of nodes in a graph
1367# becomes larger than this value, doxygen will truncate the graph, which is
1368# visualized by representing a node as a red box. Note that doxygen if the
1369# number of direct children of the root node in a graph is already larger than
1370# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001371# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
Chris Lattner3785a662002-01-26 21:16:41 +00001372
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001373DOT_GRAPH_MAX_NODES = 50
Chris Lattner3785a662002-01-26 21:16:41 +00001374
Tanya Lattner7102b702011-10-21 20:51:54 +00001375# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1376# graphs generated by dot. A depth value of 3 means that only nodes reachable
1377# from the root by following a path via at most 3 edges will be shown. Nodes
1378# that lay further from the root node will be omitted. Note that setting this
1379# option to 1 or 2 may greatly reduce the computation time needed for large
1380# code bases. Also note that the size of a graph can be further restricted by
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001381# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Reid Spencer80626a72006-05-15 21:36:13 +00001382
1383MAX_DOT_GRAPH_DEPTH = 0
1384
Tanya Lattner7102b702011-10-21 20:51:54 +00001385# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1386# background. This is enabled by default, which results in a transparent
1387# background. Warning: Depending on the platform used, enabling this option
1388# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1389# become hard to read).
Reid Spencer80626a72006-05-15 21:36:13 +00001390
Tanya Lattner6a0fd932008-09-18 16:32:28 +00001391DOT_TRANSPARENT = YES
Reid Spencer80626a72006-05-15 21:36:13 +00001392
Tanya Lattner7102b702011-10-21 20:51:54 +00001393# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1394# files in one run (i.e. multiple -o and -T options on the command line). This
1395# makes dot run faster, but since only newer versions of dot (>1.8.10)
Reid Spencer80626a72006-05-15 21:36:13 +00001396# support this, this feature is disabled by default.
1397
mike-me2c3a492010-05-07 00:28:04 +00001398DOT_MULTI_TARGETS = NO
Reid Spencer80626a72006-05-15 21:36:13 +00001399
Tanya Lattner7102b702011-10-21 20:51:54 +00001400# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1401# generate a legend page explaining the meaning of the various boxes and
Chris Lattner3785a662002-01-26 21:16:41 +00001402# arrows in the dot generated graphs.
1403
1404GENERATE_LEGEND = YES
1405
Tanya Lattner7102b702011-10-21 20:51:54 +00001406# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1407# remove the intermediate dot files that are used to generate
Chris Lattner3785a662002-01-26 21:16:41 +00001408# the various graphs.
1409
1410DOT_CLEANUP = YES
Tanya Lattner7102b702011-10-21 20:51:54 +00001411
1412#---------------------------------------------------------------------------
1413# Configuration::additions related to the search engine
1414#---------------------------------------------------------------------------
1415
1416# The SEARCHENGINE tag specifies whether or not a search engine should be
1417# used. If set to NO the values of all tags below this one will be ignored.
1418
1419SEARCHENGINE = NO