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