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