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