Merge from mainline (165734:167278).
[official-gcc/graphite-test-results.git] / libstdc++-v3 / doc / doxygen / user.cfg.in
blob6d167ac81520619e4d1d9eb24188908687148bbd
1 # Doxyfile 1.7.1
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
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.
23 DOXYFILE_ENCODING      = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME           = libstdc++
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.
34 PROJECT_NUMBER         =
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.
41 OUTPUT_DIRECTORY       = @outdir@
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.
50 CREATE_SUBDIRS         = NO
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.
63 OUTPUT_LANGUAGE        = English
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.
70 BRIEF_MEMBER_DESC      = NO
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.
77 REPEAT_BRIEF           = YES
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"
89 ABBREVIATE_BRIEF       =
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.
95 ALWAYS_DETAILED_SEC    = YES
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.
102 INLINE_INHERITED_MEMB  = YES
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.
108 FULL_PATH_NAMES        = NO
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.
117 STRIP_FROM_PATH        =
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.
126 STRIP_FROM_INC_PATH    =
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.
132 SHORT_NAMES            = @shortname@
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.)
140 JAVADOC_AUTOBRIEF      = NO
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.)
148 QT_AUTOBRIEF           = NO
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.
156 MULTILINE_CPP_IS_BRIEF = YES
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.
162 INHERIT_DOCS           = YES
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.
168 SEPARATE_MEMBER_PAGES  = NO
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.
173 TAB_SIZE               = 4
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.
182 ALIASES                = "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"
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.
190 OPTIMIZE_OUTPUT_FOR_C  = NO
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.
197 OPTIMIZE_OUTPUT_JAVA   = NO
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.
203 OPTIMIZE_FOR_FORTRAN   = NO
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.
209 OPTIMIZE_OUTPUT_VHDL   = NO
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.
221 EXTENSION_MAPPING      =
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.
230 BUILTIN_STL_SUPPORT    = NO
232 # If you use Microsoft's C++/CLI language, you should set this option to YES to
233 # enable parsing support.
235 CPP_CLI_SUPPORT        = NO
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.
241 SIP_SUPPORT            = NO
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.
250 IDL_PROPERTY_SUPPORT   = NO
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.
257 DISTRIBUTE_GROUP_DOC   = YES
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.
265 SUBGROUPING            = YES
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.
275 TYPEDEF_HIDES_STRUCT   = NO
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
291 SYMBOL_CACHE_SIZE      = 0
293 #---------------------------------------------------------------------------
294 # Build related configuration options
295 #---------------------------------------------------------------------------
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
302 EXTRACT_ALL            = NO
304 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
305 # will be included in the documentation.
307 EXTRACT_PRIVATE        = NO
309 # If the EXTRACT_STATIC tag is set to YES all static members of a file
310 # will be included in the documentation.
312 EXTRACT_STATIC         = YES
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.
318 EXTRACT_LOCAL_CLASSES  = YES
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.
325 EXTRACT_LOCAL_METHODS  = YES
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.
333 EXTRACT_ANON_NSPACES   = NO
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.
341 HIDE_UNDOC_MEMBERS     = NO
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.
348 HIDE_UNDOC_CLASSES     = YES
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.
355 HIDE_FRIEND_COMPOUNDS  = NO
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.
362 HIDE_IN_BODY_DOCS      = NO
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.
369 INTERNAL_DOCS          = NO
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.
377 CASE_SENSE_NAMES       = NO
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.
383 HIDE_SCOPE_NAMES       = NO
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.
389 SHOW_INCLUDE_FILES     = NO
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.
395 FORCE_LOCAL_INCLUDES   = NO
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.
400 INLINE_INFO            = YES
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.
407 SORT_MEMBER_DOCS       = YES
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.
414 SORT_BRIEF_DOCS        = YES
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.
424 SORT_MEMBERS_CTORS_1ST = YES
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.
430 SORT_GROUP_NAMES       = YES
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.
440 SORT_BY_SCOPE_NAME     = YES
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.
446 GENERATE_TODOLIST      = YES
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.
452 GENERATE_TESTLIST      = NO
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.
458 GENERATE_BUGLIST       = YES
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.
464 GENERATE_DEPRECATEDLIST= YES
466 # The ENABLED_SECTIONS tag can be used to enable conditional
467 # documentation sections, marked by \if sectionname ... \endif.
469 ENABLED_SECTIONS       = @enabled_sections@
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.
479 MAX_INITIALIZER_LINES  = 0
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.
485 SHOW_USED_FILES        = YES
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.
491 SHOW_DIRECTORIES       = YES
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.
497 SHOW_FILES             = YES
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.
504 SHOW_NAMESPACES        = YES
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.
514 FILE_VERSION_FILTER    =
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.
523 LAYOUT_FILE            =
525 #---------------------------------------------------------------------------
526 # configuration options related to warning and progress messages
527 #---------------------------------------------------------------------------
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.
532 QUIET                  = NO
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.
538 WARNINGS               = YES
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.
544 WARN_IF_UNDOCUMENTED   = NO
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.
551 WARN_IF_DOC_ERROR      = YES
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.
559 WARN_NO_PARAMDOC       = NO
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)
568 WARN_FORMAT            = "$file:$line: $text  "
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.
574 WARN_LOGFILE           =
576 #---------------------------------------------------------------------------
577 # configuration options related to the input files
578 #---------------------------------------------------------------------------
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.
585 INPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
586                          @srcdir@/libsupc++/cxxabi.h \
587                          @srcdir@/libsupc++/cxxabi-forced.h \
588                          @srcdir@/libsupc++/exception \
589                          @srcdir@/libsupc++/exception_defines.h \
590                          @srcdir@/libsupc++/exception_ptr.h \
591                          @srcdir@/libsupc++/initializer_list \
592                          @srcdir@/libsupc++/nested_exception.h \
593                          @srcdir@/libsupc++/new \
594                          @srcdir@/libsupc++/typeinfo \
595                          include/algorithm \
596                          include/array \
597                          include/atomic \
598                          include/bitset \
599                          include/chrono \
600                          include/complex \
601                          include/condition_variable \
602                          include/deque \
603                          include/forward_list \
604                          include/fstream \
605                          include/functional \
606                          include/future \
607                          include/iomanip \
608                          include/ios \
609                          include/iosfwd \
610                          include/iostream \
611                          include/istream \
612                          include/iterator \
613                          include/limits \
614                          include/list \
615                          include/locale \
616                          include/map \
617                          include/memory \
618                          include/mutex \
619                          include/numeric \
620                          include/ostream \
621                          include/queue \
622                          include/random \
623                          include/ratio \
624                          include/regex \
625                          include/set \
626                          include/sstream \
627                          include/stack \
628                          include/stdexcept \
629                          include/streambuf \
630                          include/string \
631                          include/system_error \
632                          include/thread \
633                          include/tuple \
634                          include/typeindex \
635                          include/type_traits \
636                          include/unordered_map \
637                          include/unordered_set \
638                          include/utility \
639                          include/valarray \
640                          include/vector \
641                          include/cassert \
642                          include/ccomplex \
643                          include/cctype \
644                          include/cerrno \
645                          include/cfenv \
646                          include/cfloat \
647                          include/cinttypes \
648                          include/ciso646 \
649                          include/climits \
650                          include/clocale \
651                          include/cmath \
652                          include/csetjmp \
653                          include/csignal \
654                          include/cstdarg \
655                          include/cstdbool \
656                          include/cstddef \
657                          include/cstdint \
658                          include/cstdio \
659                          include/cstdlib \
660                          include/cstring \
661                          include/ctgmath \
662                          include/ctime \
663                          include/cwchar \
664                          include/cwctype \
665                          include/backward/hash_map \
666                          include/backward/hash_set \
667                          include/backward/strstream \
668                          include/debug/bitset \
669                          include/debug/deque \
670                          include/debug/forward_list \
671                          include/debug/list \
672                          include/debug/map \
673                          include/debug/set \
674                          include/debug/string \
675                          include/debug/unordered_map \
676                          include/debug/unordered_set \
677                          include/debug/vector \
678                          include/profile/bitset \
679                          include/profile/deque \
680                          include/profile/forward_list \
681                          include/profile/list \
682                          include/profile/map \
683                          include/profile/set \
684                          include/profile/unordered_map \
685                          include/profile/unordered_set \
686                          include/profile/vector \
687                          include/ext/algorithm \
688                          include/ext/functional \
689                          include/ext/iterator \
690                          include/ext/memory \
691                          include/ext/numeric \
692                          include/ext/rb_tree \
693                          include/ext/rope \
694                          include/ext/slist \
695                          include/parallel/algorithm \
696                          include/parallel/numeric \
697                          include/tr1/ccomplex \
698                          include/tr1/cctype \
699                          include/tr1/cfenv \
700                          include/tr1/cfloat \
701                          include/tr1/cinttypes \
702                          include/tr1/climits \
703                          include/tr1/cmath \
704                          include/tr1/complex \
705                          include/tr1/cstdarg \
706                          include/tr1/cstdbool \
707                          include/tr1/cstdint \
708                          include/tr1/cstdio \
709                          include/tr1/cstdlib \
710                          include/tr1/ctgmath \
711                          include/tr1/ctime \
712                          include/tr1/cwchar \
713                          include/tr1/cwctype \
714                          include/decimal/decimal \
715                          include/ \
716                          include/@host_alias@/bits \
717                          include/backward \
718                          include/bits \
719                          include/debug \
720                          include/parallel \
721                          include/profile \
722                          include/profile/impl \
723                          include/ext \
724                          include/ext/pb_ds \
725                          include/ext/pb_ds/detail
727 # This tag can be used to specify the character encoding of the source files
728 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
729 # also the default input encoding. Doxygen uses libiconv (or the iconv built
730 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
731 # the list of possible encodings.
733 INPUT_ENCODING         = UTF-8
735 # If the value of the INPUT tag contains directories, you can use the
736 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
737 # and *.h) to filter out the source-files in the directories. If left
738 # blank the following patterns are tested:
739 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
740 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
742 FILE_PATTERNS          = *.h \
743                          *.hpp \
744                          *.tcc
746 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
747 # should be searched for input files as well. Possible values are YES and NO.
748 # If left blank NO is used.
750 RECURSIVE              = NO
752 # The EXCLUDE tag can be used to specify files and/or directories that should
753 # excluded from the INPUT source files. This way you can easily exclude a
754 # subdirectory from a directory tree whose root is specified with the INPUT tag.
756 EXCLUDE                = Makefile
758 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
759 # directories that are symbolic links (a Unix filesystem feature) are excluded
760 # from the input.
762 EXCLUDE_SYMLINKS       = NO
764 # If the value of the INPUT tag contains directories, you can use the
765 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
766 # certain files from those directories. Note that the wildcards are matched
767 # against the file with absolute path, so to exclude all test directories
768 # for example use the pattern */test/*
770 EXCLUDE_PATTERNS       = stamp-* \
771                          *.gch \
772                          */.svn/*
774 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
775 # (namespaces, classes, functions, etc.) that should be excluded from the
776 # output. The symbol name can be a fully qualified name, a word, or if the
777 # wildcard * is used, a substring. Examples: ANamespace, AClass,
778 # AClass::ANamespace, ANamespace::*Test
780 EXCLUDE_SYMBOLS        =
782 # The EXAMPLE_PATH tag can be used to specify one or more files or
783 # directories that contain example code fragments that are included (see
784 # the \include command).
786 EXAMPLE_PATH           =
788 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
789 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
790 # and *.h) to filter out the source-files in the directories. If left
791 # blank all files are included.
793 EXAMPLE_PATTERNS       =
795 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
796 # searched for input files to be used with the \include or \dontinclude
797 # commands irrespective of the value of the RECURSIVE tag.
798 # Possible values are YES and NO. If left blank NO is used.
800 EXAMPLE_RECURSIVE      = NO
802 # The IMAGE_PATH tag can be used to specify one or more files or
803 # directories that contain image that are included in the documentation (see
804 # the \image command).
806 IMAGE_PATH             =
808 # The INPUT_FILTER tag can be used to specify a program that doxygen should
809 # invoke to filter for each input file. Doxygen will invoke the filter program
810 # by executing (via popen()) the command <filter> <input-file>, where <filter>
811 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
812 # input file. Doxygen will then use the output that the filter program writes
813 # to standard output.
814 # If FILTER_PATTERNS is specified, this tag will be
815 # ignored.
817 INPUT_FILTER           =
819 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
820 # basis.
821 # Doxygen will compare the file name with each pattern and apply the
822 # filter if there is a match.
823 # The filters are a list of the form:
824 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
825 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
826 # is applied to all files.
828 FILTER_PATTERNS        =
830 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
831 # INPUT_FILTER) will be used to filter the input files when producing source
832 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
834 FILTER_SOURCE_FILES    = NO
836 #---------------------------------------------------------------------------
837 # configuration options related to source browsing
838 #---------------------------------------------------------------------------
840 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
841 # be generated. Documented entities will be cross-referenced with these sources.
842 # Note: To get rid of all source code in the generated output, make sure also
843 # VERBATIM_HEADERS is set to NO.
845 SOURCE_BROWSER         = YES
847 # Setting the INLINE_SOURCES tag to YES will include the body
848 # of functions and classes directly in the documentation.
850 INLINE_SOURCES         = NO
852 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
853 # doxygen to hide any special comment blocks from generated source code
854 # fragments. Normal C and C++ comments will always remain visible.
856 STRIP_CODE_COMMENTS    = NO
858 # If the REFERENCED_BY_RELATION tag is set to YES
859 # then for each documented function all documented
860 # functions referencing it will be listed.
862 REFERENCED_BY_RELATION = YES
864 # If the REFERENCES_RELATION tag is set to YES
865 # then for each documented function all documented entities
866 # called/used by that function will be listed.
868 REFERENCES_RELATION    = YES
870 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
871 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
872 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
873 # link to the source code.
874 # Otherwise they will link to the documentation.
876 REFERENCES_LINK_SOURCE = YES
878 # If the USE_HTAGS tag is set to YES then the references to source code
879 # will point to the HTML generated by the htags(1) tool instead of doxygen
880 # built-in source browser. The htags tool is part of GNU's global source
881 # tagging system (see http://www.gnu.org/software/global/global.html). You
882 # will need version 4.8.6 or higher.
884 USE_HTAGS              = NO
886 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
887 # will generate a verbatim copy of the header file for each class for
888 # which an include is specified. Set to NO to disable this.
890 VERBATIM_HEADERS       = NO
892 #---------------------------------------------------------------------------
893 # configuration options related to the alphabetical class index
894 #---------------------------------------------------------------------------
896 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
897 # of all compounds will be generated. Enable this if the project
898 # contains a lot of classes, structs, unions or interfaces.
900 ALPHABETICAL_INDEX     = YES
902 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
903 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
904 # in which this list will be split (can be a number in the range [1..20])
906 COLS_IN_ALPHA_INDEX    = 2
908 # In case all classes in a project start with a common prefix, all
909 # classes will be put under the same header in the alphabetical index.
910 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
911 # should be ignored while generating the index headers.
913 IGNORE_PREFIX          =
915 #---------------------------------------------------------------------------
916 # configuration options related to the HTML output
917 #---------------------------------------------------------------------------
919 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
920 # generate HTML output.
922 GENERATE_HTML          = @do_html@
924 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
925 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
926 # put in front of it. If left blank `html' will be used as the default path.
928 HTML_OUTPUT            = html
930 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
931 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
932 # doxygen will generate files with .html extension.
934 HTML_FILE_EXTENSION    = .html
936 # The HTML_HEADER tag can be used to specify a personal HTML header for
937 # each generated HTML page. If it is left blank doxygen will generate a
938 # standard header.
940 HTML_HEADER            =
942 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
943 # each generated HTML page. If it is left blank doxygen will generate a
944 # standard footer.
946 HTML_FOOTER            =
948 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
949 # style sheet that is used by each HTML page. It can be used to
950 # fine-tune the look of the HTML output. If the tag is left blank doxygen
951 # will generate a default style sheet. Note that doxygen will try to copy
952 # the style sheet file to the HTML output directory, so don't put your own
953 # stylesheet in the HTML output directory as well, or it will be erased!
955 HTML_STYLESHEET        =
957 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
958 # Doxygen will adjust the colors in the stylesheet and background images
959 # according to this color. Hue is specified as an angle on a colorwheel,
960 # see http://en.wikipedia.org/wiki/Hue for more information.
961 # For instance the value 0 represents red, 60 is yellow, 120 is green,
962 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
963 # The allowed range is 0 to 359.
965 HTML_COLORSTYLE_HUE    = 220
967 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
968 # the colors in the HTML output. For a value of 0 the output will use
969 # grayscales only. A value of 255 will produce the most vivid colors.
971 HTML_COLORSTYLE_SAT    = 100
973 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
974 # the luminance component of the colors in the HTML output. Values below
975 # 100 gradually make the output lighter, whereas values above 100 make
976 # the output darker. The value divided by 100 is the actual gamma applied,
977 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
978 # and 100 does not change the gamma.
980 HTML_COLORSTYLE_GAMMA  = 80
982 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
983 # page will contain the date and time when the page was generated. Setting
984 # this to NO can help when comparing the output of multiple runs.
986 HTML_TIMESTAMP         = NO
988 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
989 # files or namespaces will be aligned in HTML using tables. If set to
990 # NO a bullet list will be used.
992 HTML_ALIGN_MEMBERS     = NO
994 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
995 # documentation will contain sections that can be hidden and shown after the
996 # page has loaded. For this to work a browser that supports
997 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
998 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1000 HTML_DYNAMIC_SECTIONS  = NO
1002 # If the GENERATE_DOCSET tag is set to YES, additional index files
1003 # will be generated that can be used as input for Apple's Xcode 3
1004 # integrated development environment, introduced with OSX 10.5 (Leopard).
1005 # To create a documentation set, doxygen will generate a Makefile in the
1006 # HTML output directory. Running make will produce the docset in that
1007 # directory and running "make install" will install the docset in
1008 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1009 # it at startup.
1010 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1011 # for more information.
1013 GENERATE_DOCSET        = NO
1015 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1016 # feed. A documentation feed provides an umbrella under which multiple
1017 # documentation sets from a single provider (such as a company or product suite)
1018 # can be grouped.
1020 DOCSET_FEEDNAME        = "Doxygen generated docs"
1022 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1023 # should uniquely identify the documentation set bundle. This should be a
1024 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1025 # will append .docset to the name.
1027 DOCSET_BUNDLE_ID       = org.gnu.libstdc++
1029 # When GENERATE_PUBLISHER_ID tag specifies a string that should
1030 # uniquely identify the documentation publisher. This should be a
1031 # reverse domain-name style string,
1032 # e.g. com.mycompany.MyDocSet.documentation.
1034 DOCSET_PUBLISHER_ID    = org.fsf
1036 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1038 DOCSET_PUBLISHER_NAME  = libstdc++
1040 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1041 # will be generated that can be used as input for tools like the
1042 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1043 # of the generated HTML documentation.
1045 GENERATE_HTMLHELP      = NO
1047 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1048 # be used to specify the file name of the resulting .chm file. You
1049 # can add a path in front of the file if the result should not be
1050 # written to the html output directory.
1052 CHM_FILE               =
1054 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1055 # be used to specify the location (absolute path including file name) of
1056 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1057 # the HTML help compiler on the generated index.hhp.
1059 HHC_LOCATION           =
1061 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1062 # controls if a separate .chi index file is generated (YES) or that
1063 # it should be included in the master .chm file (NO).
1065 GENERATE_CHI           = NO
1067 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1068 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1069 # content.
1071 CHM_INDEX_ENCODING     =
1073 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1074 # controls whether a binary table of contents is generated (YES) or a
1075 # normal table of contents (NO) in the .chm file.
1077 BINARY_TOC             = NO
1079 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1080 # to the contents of the HTML help documentation and to the tree view.
1082 TOC_EXPAND             = NO
1084 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1085 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1086 # that can be used as input for Qt's qhelpgenerator to generate a
1087 # Qt Compressed Help (.qch) of the generated HTML documentation.
1089 GENERATE_QHP           = NO
1091 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1092 # be used to specify the file name of the resulting .qch file.
1093 # The path specified is relative to the HTML output folder.
1095 QCH_FILE               =
1097 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1098 # Qt Help Project output. For more information please see
1099 # http://doc.trolltech.com/qthelpproject.html#namespace
1101 QHP_NAMESPACE          = org.doxygen.Project
1103 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1104 # Qt Help Project output. For more information please see
1105 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1107 QHP_VIRTUAL_FOLDER     = doc
1109 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1110 # add. For more information please see
1111 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1113 QHP_CUST_FILTER_NAME   =
1115 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1116 # custom filter to add. For more information please see
1117 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1118 # Qt Help Project / Custom Filters</a>.
1120 QHP_CUST_FILTER_ATTRS  =
1122 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1123 # project's
1124 # filter section matches.
1125 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1126 # Qt Help Project / Filter Attributes</a>.
1128 QHP_SECT_FILTER_ATTRS  =
1130 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1131 # be used to specify the location of Qt's qhelpgenerator.
1132 # If non-empty doxygen will try to run qhelpgenerator on the generated
1133 # .qhp file.
1135 QHG_LOCATION           =
1137 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1138 #  will be generated, which together with the HTML files, form an Eclipse help
1139 # plugin. To install this plugin and make it available under the help contents
1140 # menu in Eclipse, the contents of the directory containing the HTML and XML
1141 # files needs to be copied into the plugins directory of eclipse. The name of
1142 # the directory within the plugins directory should be the same as
1143 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1144 # the help appears.
1146 GENERATE_ECLIPSEHELP   = NO
1148 # A unique identifier for the eclipse help plugin. When installing the plugin
1149 # the directory name containing the HTML and XML files should also have
1150 # this name.
1152 ECLIPSE_DOC_ID         = org.doxygen.Project
1154 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1155 # top of each HTML page. The value NO (the default) enables the index and
1156 # the value YES disables it.
1158 DISABLE_INDEX          = YES
1160 # This tag can be used to set the number of enum values (range [1..20])
1161 # that doxygen will group on one line in the generated HTML documentation.
1163 ENUM_VALUES_PER_LINE   = 4
1165 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1166 # structure should be generated to display hierarchical information.
1167 # If the tag value is set to YES, a side panel will be generated
1168 # containing a tree-like index structure (just like the one that
1169 # is generated for HTML Help). For this to work a browser that supports
1170 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1171 # Windows users are probably better off using the HTML help feature.
1173 GENERATE_TREEVIEW      = YES
1175 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1176 # and Class Hierarchy pages using a tree view instead of an ordered list.
1178 USE_INLINE_TREES       = NO
1180 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1181 # used to set the initial width (in pixels) of the frame in which the tree
1182 # is shown.
1184 TREEVIEW_WIDTH         = 250
1186 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1187 # links to external symbols imported via tag files in a separate window.
1189 EXT_LINKS_IN_WINDOW    = NO
1191 # Use this tag to change the font size of Latex formulas included
1192 # as images in the HTML documentation. The default is 10. Note that
1193 # when you change the font size after a successful doxygen run you need
1194 # to manually remove any form_*.png images from the HTML output directory
1195 # to force them to be regenerated.
1197 FORMULA_FONTSIZE       = 10
1199 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1200 # generated for formulas are transparent PNGs. Transparent PNGs are
1201 # not supported properly for IE 6.0, but are supported on all modern browsers.
1202 # Note that when changing this option you need to delete any form_*.png files
1203 # in the HTML output before the changes have effect.
1205 FORMULA_TRANSPARENT    = YES
1207 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1208 # for the HTML output. The underlying search engine uses javascript
1209 # and DHTML and should work on any modern browser. Note that when using
1210 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1211 # (GENERATE_DOCSET) there is already a search function so this one should
1212 # typically be disabled. For large projects the javascript based search engine
1213 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1215 SEARCHENGINE           = NO
1217 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1218 # implemented using a PHP enabled web server instead of at the web client
1219 # using Javascript. Doxygen will generate the search PHP script and index
1220 # file to put on the web server. The advantage of the server
1221 # based approach is that it scales better to large projects and allows
1222 # full text search. The disadvances is that it is more difficult to setup
1223 # and does not have live searching capabilities.
1225 SERVER_BASED_SEARCH    = NO
1227 #---------------------------------------------------------------------------
1228 # configuration options related to the LaTeX output
1229 #---------------------------------------------------------------------------
1231 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1232 # generate Latex output.
1234 GENERATE_LATEX         = @do_latex@
1236 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1237 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1238 # put in front of it. If left blank `latex' will be used as the default path.
1240 LATEX_OUTPUT           = latex
1242 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1243 # invoked. If left blank `latex' will be used as the default command name.
1244 # Note that when enabling USE_PDFLATEX this option is only used for
1245 # generating bitmaps for formulas in the HTML output, but not in the
1246 # Makefile that is written to the output directory.
1248 LATEX_CMD_NAME         = latex
1250 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1251 # generate index for LaTeX. If left blank `makeindex' will be used as the
1252 # default command name.
1254 MAKEINDEX_CMD_NAME     = makeindex
1256 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1257 # LaTeX documents. This may be useful for small projects and may help to
1258 # save some trees in general.
1260 COMPACT_LATEX          = NO
1262 # The PAPER_TYPE tag can be used to set the paper type that is used
1263 # by the printer. Possible values are: a4, a4wide, letter, legal and
1264 # executive. If left blank a4wide will be used.
1266 PAPER_TYPE             = letter
1268 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1269 # packages that should be included in the LaTeX output.
1271 EXTRA_PACKAGES         = amsmath
1273 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1274 # the generated latex document. The header should contain everything until
1275 # the first chapter. If it is left blank doxygen will generate a
1276 # standard header. Notice: only use this tag if you know what you are doing!
1278 LATEX_HEADER           =
1280 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1281 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1282 # contain links (just like the HTML output) instead of page references
1283 # This makes the output suitable for online browsing using a pdf viewer.
1285 PDF_HYPERLINKS         = YES
1287 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1288 # plain latex in the generated Makefile. Set this option to YES to get a
1289 # higher quality PDF documentation.
1291 USE_PDFLATEX           = YES
1293 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1294 # command to the generated LaTeX files. This will instruct LaTeX to keep
1295 # running if errors occur, instead of asking the user for help.
1296 # This option is also used when generating formulas in HTML.
1298 LATEX_BATCHMODE        = YES
1300 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1301 # include the index chapters (such as File Index, Compound Index, etc.)
1302 # in the output.
1304 LATEX_HIDE_INDICES     = YES
1306 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1307 # source code with syntax highlighting in the LaTeX output.
1308 # Note that which sources are shown also depends on other settings
1309 # such as SOURCE_BROWSER.
1311 LATEX_SOURCE_CODE      = NO
1313 #---------------------------------------------------------------------------
1314 # configuration options related to the RTF output
1315 #---------------------------------------------------------------------------
1317 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1318 # The RTF output is optimized for Word 97 and may not look very pretty with
1319 # other RTF readers or editors.
1321 GENERATE_RTF           = NO
1323 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1324 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1325 # put in front of it. If left blank `rtf' will be used as the default path.
1327 RTF_OUTPUT             = rtf
1329 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1330 # RTF documents. This may be useful for small projects and may help to
1331 # save some trees in general.
1333 COMPACT_RTF            = NO
1335 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1336 # will contain hyperlink fields. The RTF file will
1337 # contain links (just like the HTML output) instead of page references.
1338 # This makes the output suitable for online browsing using WORD or other
1339 # programs which support those fields.
1340 # Note: wordpad (write) and others do not support links.
1342 RTF_HYPERLINKS         = NO
1344 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1345 # config file, i.e. a series of assignments. You only have to provide
1346 # replacements, missing definitions are set to their default value.
1348 RTF_STYLESHEET_FILE    =
1350 # Set optional variables used in the generation of an rtf document.
1351 # Syntax is similar to doxygen's config file.
1353 RTF_EXTENSIONS_FILE    =
1355 #---------------------------------------------------------------------------
1356 # configuration options related to the man page output
1357 #---------------------------------------------------------------------------
1359 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1360 # generate man pages
1362 GENERATE_MAN           = @do_man@
1364 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1365 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1366 # put in front of it. If left blank `man' will be used as the default path.
1368 MAN_OUTPUT             = man
1370 # The MAN_EXTENSION tag determines the extension that is added to
1371 # the generated man pages (default is the subroutine's section .3)
1373 MAN_EXTENSION          = .3
1375 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1376 # then it will generate one additional man file for each entity
1377 # documented in the real man page(s). These additional files
1378 # only source the real man page, but without them the man command
1379 # would be unable to find the correct page. The default is NO.
1381 MAN_LINKS              = NO
1383 #---------------------------------------------------------------------------
1384 # configuration options related to the XML output
1385 #---------------------------------------------------------------------------
1387 # If the GENERATE_XML tag is set to YES Doxygen will
1388 # generate an XML file that captures the structure of
1389 # the code including all documentation.
1391 GENERATE_XML           = @do_xml@
1393 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1394 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1395 # put in front of it. If left blank `xml' will be used as the default path.
1397 XML_OUTPUT             = xml
1399 # The XML_SCHEMA tag can be used to specify an XML schema,
1400 # which can be used by a validating XML parser to check the
1401 # syntax of the XML files.
1403 XML_SCHEMA             =
1405 # The XML_DTD tag can be used to specify an XML DTD,
1406 # which can be used by a validating XML parser to check the
1407 # syntax of the XML files.
1409 XML_DTD                =
1411 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1412 # dump the program listings (including syntax highlighting
1413 # and cross-referencing information) to the XML output. Note that
1414 # enabling this will significantly increase the size of the XML output.
1416 XML_PROGRAMLISTING     = NO
1418 #---------------------------------------------------------------------------
1419 # configuration options for the AutoGen Definitions output
1420 #---------------------------------------------------------------------------
1422 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1423 # generate an AutoGen Definitions (see autogen.sf.net) file
1424 # that captures the structure of the code including all
1425 # documentation. Note that this feature is still experimental
1426 # and incomplete at the moment.
1428 GENERATE_AUTOGEN_DEF   = NO
1430 #---------------------------------------------------------------------------
1431 # configuration options related to the Perl module output
1432 #---------------------------------------------------------------------------
1434 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1435 # generate a Perl module file that captures the structure of
1436 # the code including all documentation. Note that this
1437 # feature is still experimental and incomplete at the
1438 # moment.
1440 GENERATE_PERLMOD       = NO
1442 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1443 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1444 # to generate PDF and DVI output from the Perl module output.
1446 PERLMOD_LATEX          = NO
1448 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1449 # nicely formatted so it can be parsed by a human reader.
1450 # This is useful
1451 # if you want to understand what is going on.
1452 # On the other hand, if this
1453 # tag is set to NO the size of the Perl module output will be much smaller
1454 # and Perl will parse it just the same.
1456 PERLMOD_PRETTY         = YES
1458 # The names of the make variables in the generated doxyrules.make file
1459 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1460 # This is useful so different doxyrules.make files included by the same
1461 # Makefile don't overwrite each other's variables.
1463 PERLMOD_MAKEVAR_PREFIX =
1465 #---------------------------------------------------------------------------
1466 # Configuration options related to the preprocessor
1467 #---------------------------------------------------------------------------
1469 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1470 # evaluate all C-preprocessor directives found in the sources and include
1471 # files.
1473 ENABLE_PREPROCESSING   = YES
1475 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1476 # names in the source code. If set to NO (the default) only conditional
1477 # compilation will be performed. Macro expansion can be done in a controlled
1478 # way by setting EXPAND_ONLY_PREDEF to YES.
1480 MACRO_EXPANSION        = YES
1482 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1483 # then the macro expansion is limited to the macros specified with the
1484 # PREDEFINED and EXPAND_AS_DEFINED tags.
1486 EXPAND_ONLY_PREDEF     = NO
1488 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1489 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1491 SEARCH_INCLUDES        = YES
1493 # The INCLUDE_PATH tag can be used to specify one or more directories that
1494 # contain include files that are not input files but should be processed by
1495 # the preprocessor.
1497 INCLUDE_PATH           =
1499 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1500 # patterns (like *.h and *.hpp) to filter out the header-files in the
1501 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1502 # be used.
1504 INCLUDE_FILE_PATTERNS  =
1506 # The PREDEFINED tag can be used to specify one or more macro names that
1507 # are defined before the preprocessor is started (similar to the -D option of
1508 # gcc). The argument of the tag is a list of macros of the form: name
1509 # or name=definition (no spaces). If the definition and the = are
1510 # omitted =1 is assumed. To prevent a macro definition from being
1511 # undefined via #undef or recursively expanded use the := operator
1512 # instead of the = operator.
1514 PREDEFINED             = __cplusplus \
1515                          __GTHREADS \
1516                          _GLIBCXX_HAS_GTHREADS \
1517                          __GXX_EXPERIMENTAL_CXX0X__ \
1518                          _GLIBCXX_INCLUDE_AS_CXX0X \
1519                          "_GLIBCXX_PURE= " \
1520                          "_GLIBCXX_CONST= " \
1521                          "_GLIBCXX_NORETURN= " \
1522                          "_GLIBCXX_NOTHROW= " \
1523                          "_GLIBCXX_STD_D= " \
1524                          "_GLIBCXX_STD_P= " \
1525                          "_GLIBCXX_STD_PR= " \
1526                          _GLIBCXX_STD=std \
1527                          "_GLIBCXX_TR1= " \
1528                          "_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
1529                          "_GLIBCXX_END_NAMESPACE_TR1= " \
1530                          "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name {  " \
1531                          "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name {  " \
1532                          _GLIBCXX_END_NAMESPACE=} \
1533                          _GLIBCXX_END_NESTED_NAMESPACE=} \
1534                          "_GLIBCXX_TEMPLATE_ARGS=...  " \
1535                          _GLIBCXX_DEPRECATED \
1536                          _GLIBCXX_CONSTEXPR=constexpr \
1537                          _GLIBCXX_USE_CONSTEXPR=constexpr \
1538                          _GLIBCXX_USE_WCHAR_T \
1539                          _GLIBCXX_USE_LONG_LONG \
1540                          _GLIBCXX_USE_C99_STDINT_TR1 \
1541                          _GLIBCXX_ATOMIC_BUILTINS_1 \
1542                          _GLIBCXX_ATOMIC_BUILTINS_2 \
1543                          _GLIBCXX_ATOMIC_BUILTINS_4 \
1544                          _GLIBCXX_ATOMIC_BUILTINS_8 \
1545                          _GLIBCXX_USE_SCHED_YIELD \
1546                          _GLIBCXX_USE_NANOSLEEP \
1547                          __GXX_RTTI \
1548                          __glibcxx_function_requires=// \
1549                          __glibcxx_class_requires=// \
1550                          __glibcxx_class_requires2=// \
1551                          __glibcxx_class_requires3=// \
1552                          __glibcxx_class_requires4=//
1554 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1555 # this tag can be used to specify a list of macro names that should be expanded.
1556 # The macro definition that is found in the sources will be used.
1557 # Use the PREDEFINED tag if you want to use a different macro definition.
1559 EXPAND_AS_DEFINED      =
1561 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1562 # doxygen's preprocessor will remove all function-like macros that are alone
1563 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1564 # function macros are typically used for boiler-plate code, and will confuse
1565 # the parser if not removed.
1567 SKIP_FUNCTION_MACROS   = YES
1569 #---------------------------------------------------------------------------
1570 # Configuration::additions related to external references
1571 #---------------------------------------------------------------------------
1573 # The TAGFILES option can be used to specify one or more tagfiles.
1574 # Optionally an initial location of the external documentation
1575 # can be added for each tagfile. The format of a tag file without
1576 # this location is as follows:
1578 # TAGFILES = file1 file2 ...
1579 # Adding location for the tag files is done as follows:
1581 # TAGFILES = file1=loc1 "file2 = loc2" ...
1582 # where "loc1" and "loc2" can be relative or absolute paths or
1583 # URLs. If a location is present for each tag, the installdox tool
1584 # does not have to be run to correct the links.
1585 # Note that each tag file must have a unique name
1586 # (where the name does NOT include the path)
1587 # If a tag file is not located in the directory in which doxygen
1588 # is run, you must also specify the path to the tagfile here.
1590 TAGFILES               =
1592 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1593 # a tag file that is based on the input files it reads.
1595 GENERATE_TAGFILE       = @generate_tagfile@
1597 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1598 # in the class index. If set to NO only the inherited external classes
1599 # will be listed.
1601 ALLEXTERNALS           = YES
1603 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1604 # in the modules index. If set to NO, only the current project's groups will
1605 # be listed.
1607 EXTERNAL_GROUPS        = YES
1609 # The PERL_PATH should be the absolute path and name of the perl script
1610 # interpreter (i.e. the result of `which perl').
1612 PERL_PATH              = /usr/bin/perl
1614 #---------------------------------------------------------------------------
1615 # Configuration options related to the dot tool
1616 #---------------------------------------------------------------------------
1618 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1619 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1620 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1621 # this option is superseded by the HAVE_DOT option below. This is only a
1622 # fallback. It is recommended to install and use dot, since it yields more
1623 # powerful graphs.
1625 CLASS_DIAGRAMS         = YES
1627 # You can define message sequence charts within doxygen comments using the \msc
1628 # command. Doxygen will then run the mscgen tool (see
1629 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1630 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1631 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1632 # default search path.
1634 MSCGEN_PATH            =
1636 # If set to YES, the inheritance and collaboration graphs will hide
1637 # inheritance and usage relations if the target is undocumented
1638 # or is not a class.
1640 HIDE_UNDOC_RELATIONS   = NO
1642 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1643 # available from the path. This tool is part of Graphviz, a graph visualization
1644 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1645 # have no effect if this option is set to NO (the default)
1647 HAVE_DOT               = YES
1649 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1650 # allowed to run in parallel. When set to 0 (the default) doxygen will
1651 # base this on the number of processors available in the system. You can set it
1652 # explicitly to a value larger than 0 to get control over the balance
1653 # between CPU load and processing speed.
1655 DOT_NUM_THREADS        = 0
1657 # By default doxygen will write a font called FreeSans.ttf to the
1658 # output directory and reference it in all dot files that doxygen
1659 # generates. This font does not include all possible unicode
1660 # characters however, so when you need these (or just want a
1661 # differently looking font) you can specify the font name using
1662 # DOT_FONTNAME. You need need to make sure dot is able to find the
1663 # font, which can be done by putting it in a standard location or by
1664 # setting the DOTFONTPATH environment variable or by setting
1665 # DOT_FONTPATH to the directory containing the font.
1667 DOT_FONTNAME           = FreeSans
1669 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1670 # The default size is 10pt.
1672 DOT_FONTSIZE           = 9
1674 # By default doxygen will tell dot to use the output directory to look for the
1675 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1676 # different font using DOT_FONTNAME you can set the path where dot
1677 # can find it using this tag.
1679 DOT_FONTPATH           =
1681 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1682 # will generate a graph for each documented class showing the direct and
1683 # indirect inheritance relations. Setting this tag to YES will force the
1684 # the CLASS_DIAGRAMS tag to NO.
1686 CLASS_GRAPH            = YES
1688 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1689 # will generate a graph for each documented class showing the direct and
1690 # indirect implementation dependencies (inheritance, containment, and
1691 # class references variables) of the class with other documented classes.
1693 COLLABORATION_GRAPH    = NO
1695 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1696 # will generate a graph for groups, showing the direct groups dependencies
1698 GROUP_GRAPHS           = YES
1700 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1701 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1702 # Language.
1704 UML_LOOK               = NO
1706 # If set to YES, the inheritance and collaboration graphs will show the
1707 # relations between templates and their instances.
1709 TEMPLATE_RELATIONS     = YES
1711 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1712 # tags are set to YES then doxygen will generate a graph for each documented
1713 # file showing the direct and indirect include dependencies of the file with
1714 # other documented files.
1716 INCLUDE_GRAPH          = NO
1718 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1719 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1720 # documented header file showing the documented files that directly or
1721 # indirectly include this file.
1723 INCLUDED_BY_GRAPH      = NO
1725 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1726 # doxygen will generate a call dependency graph for every global function
1727 # or class method. Note that enabling this option will significantly increase
1728 # the time of a run. So in most cases it will be better to enable call graphs
1729 # for selected functions only using the \callgraph command.
1731 CALL_GRAPH             = NO
1733 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1734 # doxygen will generate a caller dependency graph for every global function
1735 # or class method. Note that enabling this option will significantly increase
1736 # the time of a run. So in most cases it will be better to enable caller
1737 # graphs for selected functions only using the \callergraph command.
1739 CALLER_GRAPH           = NO
1741 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1742 # will graphical hierarchy of all classes instead of a textual one.
1744 GRAPHICAL_HIERARCHY    = YES
1746 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1747 # then doxygen will show the dependencies a directory has on other directories
1748 # in a graphical way. The dependency relations are determined by the #include
1749 # relations between the files in the directories.
1751 DIRECTORY_GRAPH        = YES
1753 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1754 # generated by dot. Possible values are png, jpg, or gif
1755 # If left blank png will be used.
1757 DOT_IMAGE_FORMAT       = png
1759 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1760 # found. If left blank, it is assumed the dot tool can be found in the path.
1762 DOT_PATH               =
1764 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1765 # contain dot files that are included in the documentation (see the
1766 # \dotfile command).
1768 DOTFILE_DIRS           =
1770 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1771 # nodes that will be shown in the graph. If the number of nodes in a graph
1772 # becomes larger than this value, doxygen will truncate the graph, which is
1773 # visualized by representing a node as a red box. Note that doxygen if the
1774 # number of direct children of the root node in a graph is already larger than
1775 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1776 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1778 DOT_GRAPH_MAX_NODES    = 50
1780 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1781 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1782 # from the root by following a path via at most 3 edges will be shown. Nodes
1783 # that lay further from the root node will be omitted. Note that setting this
1784 # option to 1 or 2 may greatly reduce the computation time needed for large
1785 # code bases. Also note that the size of a graph can be further restricted by
1786 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1788 MAX_DOT_GRAPH_DEPTH    = 0
1790 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1791 # background. This is disabled by default, because dot on Windows does not
1792 # seem to support this out of the box. Warning: Depending on the platform used,
1793 # enabling this option may lead to badly anti-aliased labels on the edges of
1794 # a graph (i.e. they become hard to read).
1796 DOT_TRANSPARENT        = NO
1798 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1799 # files in one run (i.e. multiple -o and -T options on the command line). This
1800 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1801 # support this, this feature is disabled by default.
1803 DOT_MULTI_TARGETS      = YES
1805 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1806 # generate a legend page explaining the meaning of the various boxes and
1807 # arrows in the dot generated graphs.
1809 GENERATE_LEGEND        = YES
1811 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1812 # remove the intermediate dot files that are used to generate
1813 # the various graphs.
1815 DOT_CLEANUP            = YES