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.
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.
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.
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.
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"
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
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.
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
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 if your file system
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.)
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
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.
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\nNeeds documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html"
184 ALIASES += headername{1}="Instead, include <\1>."
185 ALIASES += headername{2}="Instead, include <\1> or <\2>."
187 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
188 # sources only. Doxygen will then generate output that is more tailored for C.
189 # For instance, some of the names that are used will be different. The list
190 # of all members will be omitted, etc.
192 OPTIMIZE_OUTPUT_FOR_C = NO
194 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
195 # sources only. Doxygen will then generate output that is more tailored for
196 # Java. For instance, namespaces will be presented as packages, qualified
197 # scopes will look different, etc.
199 OPTIMIZE_OUTPUT_JAVA = NO
201 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
202 # sources only. Doxygen will then generate output that is more tailored for
205 OPTIMIZE_FOR_FORTRAN = NO
207 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
208 # sources. Doxygen will then generate output that is tailored for
211 OPTIMIZE_OUTPUT_VHDL = NO
213 # Doxygen selects the parser to use depending on the extension of the files it
214 # parses. With this tag you can assign which parser to use for a given extension.
215 # Doxygen has a built-in mapping, but you can override or extend it using this
216 # tag. The format is ext=language, where ext is a file extension, and language
217 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
218 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
219 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
220 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
221 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
225 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
226 # to include (a tag file for) the STL sources as input, then you should
227 # set this tag to YES in order to let doxygen match functions declarations and
228 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
229 # func(std::string) {}). This also makes the inheritance and collaboration
230 # diagrams that involve STL classes more complete and accurate.
232 BUILTIN_STL_SUPPORT = NO
234 # If you use Microsoft's C++/CLI language, you should set this option to YES to
235 # enable parsing support.
239 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
240 # Doxygen will parse them like normal C++ but will assume all classes use public
241 # instead of private inheritance when no explicit protection keyword is present.
245 # For Microsoft's IDL there are propget and propput attributes to indicate getter
246 # and setter methods for a property. Setting this option to YES (the default)
247 # will make doxygen replace the get and set methods by a property in the
248 # documentation. This will only work if the methods are indeed getting or
249 # setting a simple type. If this is not the case, or you want to show the
250 # methods anyway, you should set this option to NO.
252 IDL_PROPERTY_SUPPORT = NO
254 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
255 # tag is set to YES, then doxygen will reuse the documentation of the first
256 # member in the group (if any) for the other members of the group. By default
257 # all members of a group must be documented explicitly.
259 DISTRIBUTE_GROUP_DOC = YES
261 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
262 # the same type (for instance a group of public functions) to be put as a
263 # subgroup of that type (e.g. under the Public Functions section). Set it to
264 # NO to prevent subgrouping. Alternatively, this can be done per class using
265 # the \nosubgrouping command.
269 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
270 # is documented as struct, union, or enum with the name of the typedef. So
271 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
272 # with name TypeT. When disabled the typedef will appear as a member of a file,
273 # namespace, or class. And the struct will be named TypeS. This can typically
274 # be useful for C code in case the coding convention dictates that all compound
275 # types are typedef'ed and only the typedef is referenced, never the tag name.
277 TYPEDEF_HIDES_STRUCT = NO
279 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
280 # determine which symbols to keep in memory and which to flush to disk.
281 # When the cache is full, less often used symbols will be written to disk.
282 # For small to medium size projects (<1000 input files) the default value is
283 # probably good enough. For larger projects a too small cache size can cause
284 # doxygen to be busy swapping symbols to and from disk most of the time
285 # causing a significant performance penality.
286 # If the system has enough physical memory increasing the cache will improve the
287 # performance by keeping more symbols in memory. Note that the value works on
288 # a logarithmic scale so increasing the size by one will roughly double the
289 # memory usage. The cache size is given by this formula:
290 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
291 # corresponding to a cache size of 2^16 = 65536 symbols
293 SYMBOL_CACHE_SIZE = 0
295 #---------------------------------------------------------------------------
296 # Build related configuration options
297 #---------------------------------------------------------------------------
299 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
300 # documentation are documented, even if no documentation was available.
301 # Private class members and static file members will be hidden unless
302 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
306 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
307 # will be included in the documentation.
311 # If the EXTRACT_STATIC tag is set to YES all static members of a file
312 # will be included in the documentation.
316 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
317 # defined locally in source files will be included in the documentation.
318 # If set to NO only classes defined in header files are included.
320 EXTRACT_LOCAL_CLASSES = YES
322 # This flag is only useful for Objective-C code. When set to YES local
323 # methods, which are defined in the implementation section but not in
324 # the interface are included in the documentation.
325 # If set to NO (the default) only methods in the interface are included.
327 EXTRACT_LOCAL_METHODS = YES
329 # If this flag is set to YES, the members of anonymous namespaces will be
330 # extracted and appear in the documentation as a namespace called
331 # 'anonymous_namespace{file}', where file will be replaced with the base
332 # name of the file that contains the anonymous namespace. By default
333 # anonymous namespaces are hidden.
335 EXTRACT_ANON_NSPACES = NO
337 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
338 # undocumented members of documented classes, files or namespaces.
339 # If set to NO (the default) these members will be included in the
340 # various overviews, but no documentation section is generated.
341 # This option has no effect if EXTRACT_ALL is enabled.
343 HIDE_UNDOC_MEMBERS = NO
345 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
346 # undocumented classes that are normally visible in the class hierarchy.
347 # If set to NO (the default) these classes will be included in the various
348 # overviews. This option has no effect if EXTRACT_ALL is enabled.
350 HIDE_UNDOC_CLASSES = YES
352 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
353 # friend (class|struct|union) declarations.
354 # If set to NO (the default) these declarations will be included in the
357 HIDE_FRIEND_COMPOUNDS = NO
359 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
360 # documentation blocks found inside the body of a function.
361 # If set to NO (the default) these blocks will be appended to the
362 # function's detailed documentation block.
364 HIDE_IN_BODY_DOCS = NO
366 # The INTERNAL_DOCS tag determines if documentation
367 # that is typed after a \internal command is included. If the tag is set
368 # to NO (the default) then the documentation will be excluded.
369 # Set it to YES to include the internal documentation.
373 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
374 # file names in lower-case letters. If set to YES upper-case letters are also
375 # allowed. This is useful if you have classes or files whose names only differ
376 # in case and if your file system supports case sensitive file names. Windows
377 # and Mac users are advised to set this option to NO.
379 CASE_SENSE_NAMES = NO
381 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
382 # will show members with their full class and namespace scopes in the
383 # documentation. If set to YES the scope will be hidden.
385 HIDE_SCOPE_NAMES = NO
387 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
388 # will put a list of the files that are included by a file in the documentation
391 SHOW_INCLUDE_FILES = NO
393 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
394 # will list include files with double quotes in the documentation
395 # rather than with sharp brackets.
397 FORCE_LOCAL_INCLUDES = NO
399 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
400 # is inserted in the documentation for inline members.
404 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
405 # will sort the (detailed) documentation of file and class members
406 # alphabetically by member name. If set to NO the members will appear in
409 SORT_MEMBER_DOCS = YES
411 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
412 # brief documentation of file, namespace and class members alphabetically
413 # by member name. If set to NO (the default) the members will appear in
416 SORT_BRIEF_DOCS = YES
418 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
419 # will sort the (brief and detailed) documentation of class members so that
420 # constructors and destructors are listed first. If set to NO (the default)
421 # the constructors will appear in the respective orders defined by
422 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
423 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
424 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
426 SORT_MEMBERS_CTORS_1ST = YES
428 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
429 # hierarchy of group names into alphabetical order. If set to NO (the default)
430 # the group names will appear in their defined order.
432 SORT_GROUP_NAMES = YES
434 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
435 # sorted by fully-qualified names, including namespaces. If set to
436 # NO (the default), the class list will be sorted only by class name,
437 # not including the namespace part.
438 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
439 # Note: This option applies only to the class list, not to the
442 SORT_BY_SCOPE_NAME = YES
444 # The GENERATE_TODOLIST tag can be used to enable (YES) or
445 # disable (NO) the todo list. This list is created by putting \todo
446 # commands in the documentation.
448 GENERATE_TODOLIST = YES
450 # The GENERATE_TESTLIST tag can be used to enable (YES) or
451 # disable (NO) the test list. This list is created by putting \test
452 # commands in the documentation.
454 GENERATE_TESTLIST = NO
456 # The GENERATE_BUGLIST tag can be used to enable (YES) or
457 # disable (NO) the bug list. This list is created by putting \bug
458 # commands in the documentation.
460 GENERATE_BUGLIST = YES
462 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
463 # disable (NO) the deprecated list. This list is created by putting
464 # \deprecated commands in the documentation.
466 GENERATE_DEPRECATEDLIST= YES
468 # The ENABLED_SECTIONS tag can be used to enable conditional
469 # documentation sections, marked by \if sectionname ... \endif.
471 ENABLED_SECTIONS = @enabled_sections@
473 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
474 # the initial value of a variable or macro consists of for it to appear in
475 # the documentation. If the initializer consists of more lines than specified
476 # here it will be hidden. Use a value of 0 to hide initializers completely.
477 # The appearance of the initializer of individual variables and macros in the
478 # documentation can be controlled using \showinitializer or \hideinitializer
479 # command in the documentation regardless of this setting.
481 MAX_INITIALIZER_LINES = 0
483 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
484 # at the bottom of the documentation of classes and structs. If set to YES the
485 # list will mention the files that were used to generate the documentation.
487 SHOW_USED_FILES = YES
489 # If the sources in your project are distributed over multiple directories
490 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
491 # in the documentation. The default is NO.
493 SHOW_DIRECTORIES = YES
495 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
496 # This will remove the Files entry from the Quick Index and from the
497 # Folder Tree View (if specified). The default is YES.
501 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
503 # This will remove the Namespaces entry from the Quick Index
504 # and from the Folder Tree View (if specified). The default is YES.
506 SHOW_NAMESPACES = YES
508 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
509 # doxygen should invoke to get the current version for each file (typically from
510 # the version control system). Doxygen will invoke the program by executing (via
511 # popen()) the command <command> <input-file>, where <command> is the value of
512 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
513 # provided by doxygen. Whatever the program writes to standard output
514 # is used as the file version. See the manual for examples.
516 FILE_VERSION_FILTER =
518 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
519 # by doxygen. The layout file controls the global structure of the generated
520 # output files in an output format independent way. The create the layout file
521 # that represents doxygen's defaults, run doxygen with the -l option.
522 # You can optionally specify a file name after the option, if omitted
523 # DoxygenLayout.xml will be used as the name of the layout file.
527 #---------------------------------------------------------------------------
528 # configuration options related to warning and progress messages
529 #---------------------------------------------------------------------------
531 # The QUIET tag can be used to turn on/off the messages that are generated
532 # by doxygen. Possible values are YES and NO. If left blank NO is used.
536 # The WARNINGS tag can be used to turn on/off the warning messages that are
537 # generated by doxygen. Possible values are YES and NO. If left blank
542 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
543 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
544 # automatically be disabled.
546 WARN_IF_UNDOCUMENTED = NO
548 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
549 # potential errors in the documentation, such as not documenting some
550 # parameters in a documented function, or documenting parameters that
551 # don't exist or using markup commands wrongly.
553 WARN_IF_DOC_ERROR = YES
555 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
556 # functions that are documented, but have no documentation for their parameters
557 # or return value. If set to NO (the default) doxygen will only warn about
558 # wrong or incomplete parameter documentation, but not about the absence of
561 WARN_NO_PARAMDOC = NO
563 # The WARN_FORMAT tag determines the format of the warning messages that
564 # doxygen can produce. The string should contain the $file, $line, and $text
565 # tags, which will be replaced by the file and line number from which the
566 # warning originated and the warning text. Optionally the format may contain
567 # $version, which will be replaced by the version of the file (if it could
568 # be obtained via FILE_VERSION_FILTER)
570 WARN_FORMAT = "$file:$line: $text "
572 # The WARN_LOGFILE tag can be used to specify a file to which warning
573 # and error messages should be written. If left blank the output is written
578 #---------------------------------------------------------------------------
579 # configuration options related to the input files
580 #---------------------------------------------------------------------------
582 # The INPUT tag can be used to specify the files and/or directories that contain
583 # documented source files. You may enter file names like "myfile.cpp" or
584 # directories like "/usr/src/myproject". Separate the files or directories
587 INPUT = @srcdir@/doc/doxygen/doxygroups.cc \
588 @srcdir@/libsupc++/cxxabi.h \
589 @srcdir@/libsupc++/cxxabi-forced.h \
590 @srcdir@/libsupc++/exception \
591 @srcdir@/libsupc++/exception_defines.h \
592 @srcdir@/libsupc++/exception_ptr.h \
593 @srcdir@/libsupc++/initializer_list \
594 @srcdir@/libsupc++/nested_exception.h \
595 @srcdir@/libsupc++/new \
596 @srcdir@/libsupc++/typeinfo \
603 include/condition_variable \
605 include/forward_list \
633 include/system_error \
637 include/type_traits \
638 include/unordered_map \
639 include/unordered_set \
667 include/backward/hash_map \
668 include/backward/hash_set \
669 include/backward/strstream \
670 include/debug/bitset \
671 include/debug/deque \
672 include/debug/forward_list \
676 include/debug/string \
677 include/debug/unordered_map \
678 include/debug/unordered_set \
679 include/debug/vector \
680 include/profile/bitset \
681 include/profile/deque \
682 include/profile/forward_list \
683 include/profile/list \
684 include/profile/map \
685 include/profile/set \
686 include/profile/unordered_map \
687 include/profile/unordered_set \
688 include/profile/vector \
689 include/ext/algorithm \
690 include/ext/functional \
691 include/ext/iterator \
693 include/ext/numeric \
694 include/ext/rb_tree \
697 include/parallel/algorithm \
698 include/parallel/numeric \
699 include/tr1/ccomplex \
703 include/tr1/cinttypes \
704 include/tr1/climits \
706 include/tr1/complex \
707 include/tr1/cstdarg \
708 include/tr1/cstdbool \
709 include/tr1/cstdint \
711 include/tr1/cstdlib \
712 include/tr1/ctgmath \
715 include/tr1/cwctype \
716 include/decimal/decimal \
718 include/@host_alias@/bits \
724 include/profile/impl \
727 include/ext/pb_ds/detail
729 # This tag can be used to specify the character encoding of the source files
730 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
731 # also the default input encoding. Doxygen uses libiconv (or the iconv built
732 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
733 # the list of possible encodings.
735 INPUT_ENCODING = UTF-8
737 # If the value of the INPUT tag contains directories, you can use the
738 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
739 # and *.h) to filter out the source-files in the directories. If left
740 # blank the following patterns are tested:
741 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
742 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
743 # *.f90 *.f *.vhd *.vhdl
745 FILE_PATTERNS = *.h \
749 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
750 # should be searched for input files as well. Possible values are YES and NO.
751 # If left blank NO is used.
755 # The EXCLUDE tag can be used to specify files and/or directories that should
756 # excluded from the INPUT source files. This way you can easily exclude a
757 # subdirectory from a directory tree whose root is specified with the INPUT tag.
761 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
762 # directories that are symbolic links (a Unix filesystem feature) are excluded
765 EXCLUDE_SYMLINKS = NO
767 # If the value of the INPUT tag contains directories, you can use the
768 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
769 # certain files from those directories. Note that the wildcards are matched
770 # against the file with absolute path, so to exclude all test directories
771 # for example use the pattern */test/*
773 EXCLUDE_PATTERNS = stamp-* doxygroups.cc \
777 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
778 # (namespaces, classes, functions, etc.) that should be excluded from the
779 # output. The symbol name can be a fully qualified name, a word, or if the
780 # wildcard * is used, a substring. Examples: ANamespace, AClass,
781 # AClass::ANamespace, ANamespace::*Test
785 # The EXAMPLE_PATH tag can be used to specify one or more files or
786 # directories that contain example code fragments that are included (see
787 # the \include command).
791 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
792 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
793 # and *.h) to filter out the source-files in the directories. If left
794 # blank all files are included.
798 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
799 # searched for input files to be used with the \include or \dontinclude
800 # commands irrespective of the value of the RECURSIVE tag.
801 # Possible values are YES and NO. If left blank NO is used.
803 EXAMPLE_RECURSIVE = NO
805 # The IMAGE_PATH tag can be used to specify one or more files or
806 # directories that contain image that are included in the documentation (see
807 # the \image command).
811 # The INPUT_FILTER tag can be used to specify a program that doxygen should
812 # invoke to filter for each input file. Doxygen will invoke the filter program
813 # by executing (via popen()) the command <filter> <input-file>, where <filter>
814 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
815 # input file. Doxygen will then use the output that the filter program writes
816 # to standard output.
817 # If FILTER_PATTERNS is specified, this tag will be
822 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
824 # Doxygen will compare the file name with each pattern and apply the
825 # filter if there is a match.
826 # The filters are a list of the form:
827 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
828 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
829 # is applied to all files.
833 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
834 # INPUT_FILTER) will be used to filter the input files when producing source
835 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
837 FILTER_SOURCE_FILES = NO
839 #---------------------------------------------------------------------------
840 # configuration options related to source browsing
841 #---------------------------------------------------------------------------
843 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
844 # be generated. Documented entities will be cross-referenced with these sources.
845 # Note: To get rid of all source code in the generated output, make sure also
846 # VERBATIM_HEADERS is set to NO.
850 # Setting the INLINE_SOURCES tag to YES will include the body
851 # of functions and classes directly in the documentation.
855 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
856 # doxygen to hide any special comment blocks from generated source code
857 # fragments. Normal C and C++ comments will always remain visible.
859 STRIP_CODE_COMMENTS = NO
861 # If the REFERENCED_BY_RELATION tag is set to YES
862 # then for each documented function all documented
863 # functions referencing it will be listed.
865 REFERENCED_BY_RELATION = YES
867 # If the REFERENCES_RELATION tag is set to YES
868 # then for each documented function all documented entities
869 # called/used by that function will be listed.
871 REFERENCES_RELATION = YES
873 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
874 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
875 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
876 # link to the source code.
877 # Otherwise they will link to the documentation.
879 REFERENCES_LINK_SOURCE = YES
881 # If the USE_HTAGS tag is set to YES then the references to source code
882 # will point to the HTML generated by the htags(1) tool instead of doxygen
883 # built-in source browser. The htags tool is part of GNU's global source
884 # tagging system (see http://www.gnu.org/software/global/global.html). You
885 # will need version 4.8.6 or higher.
889 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
890 # will generate a verbatim copy of the header file for each class for
891 # which an include is specified. Set to NO to disable this.
893 VERBATIM_HEADERS = NO
895 #---------------------------------------------------------------------------
896 # configuration options related to the alphabetical class index
897 #---------------------------------------------------------------------------
899 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
900 # of all compounds will be generated. Enable this if the project
901 # contains a lot of classes, structs, unions or interfaces.
903 ALPHABETICAL_INDEX = YES
905 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
906 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
907 # in which this list will be split (can be a number in the range [1..20])
909 COLS_IN_ALPHA_INDEX = 2
911 # In case all classes in a project start with a common prefix, all
912 # classes will be put under the same header in the alphabetical index.
913 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
914 # should be ignored while generating the index headers.
918 #---------------------------------------------------------------------------
919 # configuration options related to the HTML output
920 #---------------------------------------------------------------------------
922 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
923 # generate HTML output.
925 GENERATE_HTML = @do_html@
927 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
928 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
929 # put in front of it. If left blank `html' will be used as the default path.
933 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
934 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
935 # doxygen will generate files with .html extension.
937 HTML_FILE_EXTENSION = .html
939 # The HTML_HEADER tag can be used to specify a personal HTML header for
940 # each generated HTML page. If it is left blank doxygen will generate a
945 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
946 # each generated HTML page. If it is left blank doxygen will generate a
951 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
952 # style sheet that is used by each HTML page. It can be used to
953 # fine-tune the look of the HTML output. If the tag is left blank doxygen
954 # will generate a default style sheet. Note that doxygen will try to copy
955 # the style sheet file to the HTML output directory, so don't put your own
956 # stylesheet in the HTML output directory as well, or it will be erased!
960 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
961 # Doxygen will adjust the colors in the stylesheet and background images
962 # according to this color. Hue is specified as an angle on a colorwheel,
963 # see http://en.wikipedia.org/wiki/Hue for more information.
964 # For instance the value 0 represents red, 60 is yellow, 120 is green,
965 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
966 # The allowed range is 0 to 359.
968 HTML_COLORSTYLE_HUE = 220
970 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
971 # the colors in the HTML output. For a value of 0 the output will use
972 # grayscales only. A value of 255 will produce the most vivid colors.
974 HTML_COLORSTYLE_SAT = 100
976 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
977 # the luminance component of the colors in the HTML output. Values below
978 # 100 gradually make the output lighter, whereas values above 100 make
979 # the output darker. The value divided by 100 is the actual gamma applied,
980 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
981 # and 100 does not change the gamma.
983 HTML_COLORSTYLE_GAMMA = 80
985 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
986 # page will contain the date and time when the page was generated. Setting
987 # this to NO can help when comparing the output of multiple runs.
991 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
992 # files or namespaces will be aligned in HTML using tables. If set to
993 # NO a bullet list will be used.
995 HTML_ALIGN_MEMBERS = NO
997 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
998 # documentation will contain sections that can be hidden and shown after the
999 # page has loaded. For this to work a browser that supports
1000 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
1001 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1003 HTML_DYNAMIC_SECTIONS = NO
1005 # If the GENERATE_DOCSET tag is set to YES, additional index files
1006 # will be generated that can be used as input for Apple's Xcode 3
1007 # integrated development environment, introduced with OSX 10.5 (Leopard).
1008 # To create a documentation set, doxygen will generate a Makefile in the
1009 # HTML output directory. Running make will produce the docset in that
1010 # directory and running "make install" will install the docset in
1011 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1013 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1014 # for more information.
1016 GENERATE_DOCSET = NO
1018 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1019 # feed. A documentation feed provides an umbrella under which multiple
1020 # documentation sets from a single provider (such as a company or product suite)
1023 DOCSET_FEEDNAME = "Doxygen generated docs"
1025 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1026 # should uniquely identify the documentation set bundle. This should be a
1027 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1028 # will append .docset to the name.
1030 DOCSET_BUNDLE_ID = org.gnu.libstdc++
1032 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1033 # the documentation publisher. This should be a reverse domain-name style
1034 # string, e.g. com.mycompany.MyDocSet.documentation.
1036 DOCSET_PUBLISHER_ID = org.fsf
1038 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1040 DOCSET_PUBLISHER_NAME = libstdc++
1042 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1043 # will be generated that can be used as input for tools like the
1044 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1045 # of the generated HTML documentation.
1047 GENERATE_HTMLHELP = NO
1049 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1050 # be used to specify the file name of the resulting .chm file. You
1051 # can add a path in front of the file if the result should not be
1052 # written to the html output directory.
1056 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1057 # be used to specify the location (absolute path including file name) of
1058 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1059 # the HTML help compiler on the generated index.hhp.
1063 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1064 # controls if a separate .chi index file is generated (YES) or that
1065 # it should be included in the master .chm file (NO).
1069 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1070 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1073 CHM_INDEX_ENCODING =
1075 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1076 # controls whether a binary table of contents is generated (YES) or a
1077 # normal table of contents (NO) in the .chm file.
1081 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1082 # to the contents of the HTML help documentation and to the tree view.
1086 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1087 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1088 # that can be used as input for Qt's qhelpgenerator to generate a
1089 # Qt Compressed Help (.qch) of the generated HTML documentation.
1093 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1094 # be used to specify the file name of the resulting .qch file.
1095 # The path specified is relative to the HTML output folder.
1099 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1100 # Qt Help Project output. For more information please see
1101 # http://doc.trolltech.com/qthelpproject.html#namespace
1103 QHP_NAMESPACE = org.doxygen.Project
1105 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1106 # Qt Help Project output. For more information please see
1107 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1109 QHP_VIRTUAL_FOLDER = doc
1111 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1112 # add. For more information please see
1113 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1115 QHP_CUST_FILTER_NAME =
1117 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1118 # custom filter to add. For more information please see
1119 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1120 # Qt Help Project / Custom Filters</a>.
1122 QHP_CUST_FILTER_ATTRS =
1124 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1126 # filter section matches.
1127 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1128 # Qt Help Project / Filter Attributes</a>.
1130 QHP_SECT_FILTER_ATTRS =
1132 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1133 # be used to specify the location of Qt's qhelpgenerator.
1134 # If non-empty doxygen will try to run qhelpgenerator on the generated
1139 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1140 # will be generated, which together with the HTML files, form an Eclipse help
1141 # plugin. To install this plugin and make it available under the help contents
1142 # menu in Eclipse, the contents of the directory containing the HTML and XML
1143 # files needs to be copied into the plugins directory of eclipse. The name of
1144 # the directory within the plugins directory should be the same as
1145 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1148 GENERATE_ECLIPSEHELP = NO
1150 # A unique identifier for the eclipse help plugin. When installing the plugin
1151 # the directory name containing the HTML and XML files should also have
1154 ECLIPSE_DOC_ID = org.doxygen.Project
1156 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1157 # top of each HTML page. The value NO (the default) enables the index and
1158 # the value YES disables it.
1162 # This tag can be used to set the number of enum values (range [0,1..20])
1163 # that doxygen will group on one line in the generated HTML documentation.
1164 # Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
1166 ENUM_VALUES_PER_LINE = 4
1168 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1169 # structure should be generated to display hierarchical information.
1170 # If the tag value is set to YES, a side panel will be generated
1171 # containing a tree-like index structure (just like the one that
1172 # is generated for HTML Help). For this to work a browser that supports
1173 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1174 # Windows users are probably better off using the HTML help feature.
1176 GENERATE_TREEVIEW = YES
1178 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1179 # and Class Hierarchy pages using a tree view instead of an ordered list.
1181 USE_INLINE_TREES = NO
1183 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1184 # used to set the initial width (in pixels) of the frame in which the tree
1187 TREEVIEW_WIDTH = 250
1189 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1190 # links to external symbols imported via tag files in a separate window.
1192 EXT_LINKS_IN_WINDOW = NO
1194 # Use this tag to change the font size of Latex formulas included
1195 # as images in the HTML documentation. The default is 10. Note that
1196 # when you change the font size after a successful doxygen run you need
1197 # to manually remove any form_*.png images from the HTML output directory
1198 # to force them to be regenerated.
1200 FORMULA_FONTSIZE = 10
1202 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1203 # generated for formulas are transparent PNGs. Transparent PNGs are
1204 # not supported properly for IE 6.0, but are supported on all modern browsers.
1205 # Note that when changing this option you need to delete any form_*.png files
1206 # in the HTML output before the changes have effect.
1208 FORMULA_TRANSPARENT = YES
1210 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1211 # (see http://www.mathjax.org) which uses client side Javascript for the
1212 # rendering instead of using prerendered bitmaps. Use this if you do not
1213 # have LaTeX installed or if you want to formulas look prettier in the HTML
1214 # output. When enabled you also need to install MathJax separately and
1215 # configure the path to it using the MATHJAX_RELPATH option.
1219 # When MathJax is enabled you need to specify the location relative to the
1220 # HTML output directory using the MATHJAX_RELPATH option. The destination
1221 # directory should contain the MathJax.js script. For instance, if the mathjax
1222 # directory is located at the same level as the HTML output directory, then
1223 # MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
1224 # MathJax, but it is strongly recommended to install a local copy of MathJax
1225 # before deployment.
1227 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1229 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1230 # for the HTML output. The underlying search engine uses javascript
1231 # and DHTML and should work on any modern browser. Note that when using
1232 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1233 # (GENERATE_DOCSET) there is already a search function so this one should
1234 # typically be disabled. For large projects the javascript based search engine
1235 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1239 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1240 # implemented using a PHP enabled web server instead of at the web client
1241 # using Javascript. Doxygen will generate the search PHP script and index
1242 # file to put on the web server. The advantage of the server
1243 # based approach is that it scales better to large projects and allows
1244 # full text search. The disadvantages are that it is more difficult to setup
1245 # and does not have live searching capabilities.
1247 SERVER_BASED_SEARCH = NO
1249 #---------------------------------------------------------------------------
1250 # configuration options related to the LaTeX output
1251 #---------------------------------------------------------------------------
1253 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1254 # generate Latex output.
1256 GENERATE_LATEX = @do_latex@
1258 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1259 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1260 # put in front of it. If left blank `latex' will be used as the default path.
1262 LATEX_OUTPUT = latex
1264 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1265 # invoked. If left blank `latex' will be used as the default command name.
1266 # Note that when enabling USE_PDFLATEX this option is only used for
1267 # generating bitmaps for formulas in the HTML output, but not in the
1268 # Makefile that is written to the output directory.
1270 LATEX_CMD_NAME = latex
1272 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1273 # generate index for LaTeX. If left blank `makeindex' will be used as the
1274 # default command name.
1276 MAKEINDEX_CMD_NAME = makeindex
1278 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1279 # LaTeX documents. This may be useful for small projects and may help to
1280 # save some trees in general.
1284 # The PAPER_TYPE tag can be used to set the paper type that is used
1285 # by the printer. Possible values are: a4, letter, legal and
1286 # executive. If left blank a4wide will be used.
1290 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1291 # packages that should be included in the LaTeX output.
1293 EXTRA_PACKAGES = amsmath
1295 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1296 # the generated latex document. The header should contain everything until
1297 # the first chapter. If it is left blank doxygen will generate a
1298 # standard header. Notice: only use this tag if you know what you are doing!
1302 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1303 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1304 # contain links (just like the HTML output) instead of page references
1305 # This makes the output suitable for online browsing using a pdf viewer.
1307 PDF_HYPERLINKS = YES
1309 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1310 # plain latex in the generated Makefile. Set this option to YES to get a
1311 # higher quality PDF documentation.
1315 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1316 # command to the generated LaTeX files. This will instruct LaTeX to keep
1317 # running if errors occur, instead of asking the user for help.
1318 # This option is also used when generating formulas in HTML.
1320 LATEX_BATCHMODE = YES
1322 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1323 # include the index chapters (such as File Index, Compound Index, etc.)
1326 LATEX_HIDE_INDICES = YES
1328 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1329 # source code with syntax highlighting in the LaTeX output.
1330 # Note that which sources are shown also depends on other settings
1331 # such as SOURCE_BROWSER.
1333 LATEX_SOURCE_CODE = NO
1335 #---------------------------------------------------------------------------
1336 # configuration options related to the RTF output
1337 #---------------------------------------------------------------------------
1339 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1340 # The RTF output is optimized for Word 97 and may not look very pretty with
1341 # other RTF readers or editors.
1345 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1346 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1347 # put in front of it. If left blank `rtf' will be used as the default path.
1351 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1352 # RTF documents. This may be useful for small projects and may help to
1353 # save some trees in general.
1357 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1358 # will contain hyperlink fields. The RTF file will
1359 # contain links (just like the HTML output) instead of page references.
1360 # This makes the output suitable for online browsing using WORD or other
1361 # programs which support those fields.
1362 # Note: wordpad (write) and others do not support links.
1366 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1367 # config file, i.e. a series of assignments. You only have to provide
1368 # replacements, missing definitions are set to their default value.
1370 RTF_STYLESHEET_FILE =
1372 # Set optional variables used in the generation of an rtf document.
1373 # Syntax is similar to doxygen's config file.
1375 RTF_EXTENSIONS_FILE =
1377 #---------------------------------------------------------------------------
1378 # configuration options related to the man page output
1379 #---------------------------------------------------------------------------
1381 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1382 # generate man pages
1384 GENERATE_MAN = @do_man@
1386 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1387 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1388 # put in front of it. If left blank `man' will be used as the default path.
1392 # The MAN_EXTENSION tag determines the extension that is added to
1393 # the generated man pages (default is the subroutine's section .3)
1397 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1398 # then it will generate one additional man file for each entity
1399 # documented in the real man page(s). These additional files
1400 # only source the real man page, but without them the man command
1401 # would be unable to find the correct page. The default is NO.
1405 #---------------------------------------------------------------------------
1406 # configuration options related to the XML output
1407 #---------------------------------------------------------------------------
1409 # If the GENERATE_XML tag is set to YES Doxygen will
1410 # generate an XML file that captures the structure of
1411 # the code including all documentation.
1413 GENERATE_XML = @do_xml@
1415 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1416 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1417 # put in front of it. If left blank `xml' will be used as the default path.
1421 # The XML_SCHEMA tag can be used to specify an XML schema,
1422 # which can be used by a validating XML parser to check the
1423 # syntax of the XML files.
1427 # The XML_DTD tag can be used to specify an XML DTD,
1428 # which can be used by a validating XML parser to check the
1429 # syntax of the XML files.
1433 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1434 # dump the program listings (including syntax highlighting
1435 # and cross-referencing information) to the XML output. Note that
1436 # enabling this will significantly increase the size of the XML output.
1438 XML_PROGRAMLISTING = NO
1440 #---------------------------------------------------------------------------
1441 # configuration options for the AutoGen Definitions output
1442 #---------------------------------------------------------------------------
1444 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1445 # generate an AutoGen Definitions (see autogen.sf.net) file
1446 # that captures the structure of the code including all
1447 # documentation. Note that this feature is still experimental
1448 # and incomplete at the moment.
1450 GENERATE_AUTOGEN_DEF = NO
1452 #---------------------------------------------------------------------------
1453 # configuration options related to the Perl module output
1454 #---------------------------------------------------------------------------
1456 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1457 # generate a Perl module file that captures the structure of
1458 # the code including all documentation. Note that this
1459 # feature is still experimental and incomplete at the
1462 GENERATE_PERLMOD = NO
1464 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1465 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1466 # to generate PDF and DVI output from the Perl module output.
1470 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1471 # nicely formatted so it can be parsed by a human reader.
1473 # if you want to understand what is going on.
1474 # On the other hand, if this
1475 # tag is set to NO the size of the Perl module output will be much smaller
1476 # and Perl will parse it just the same.
1478 PERLMOD_PRETTY = YES
1480 # The names of the make variables in the generated doxyrules.make file
1481 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1482 # This is useful so different doxyrules.make files included by the same
1483 # Makefile don't overwrite each other's variables.
1485 PERLMOD_MAKEVAR_PREFIX =
1487 #---------------------------------------------------------------------------
1488 # Configuration options related to the preprocessor
1489 #---------------------------------------------------------------------------
1491 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1492 # evaluate all C-preprocessor directives found in the sources and include
1495 ENABLE_PREPROCESSING = YES
1497 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1498 # names in the source code. If set to NO (the default) only conditional
1499 # compilation will be performed. Macro expansion can be done in a controlled
1500 # way by setting EXPAND_ONLY_PREDEF to YES.
1502 MACRO_EXPANSION = YES
1504 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1505 # then the macro expansion is limited to the macros specified with the
1506 # PREDEFINED and EXPAND_AS_DEFINED tags.
1508 EXPAND_ONLY_PREDEF = NO
1510 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1511 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1513 SEARCH_INCLUDES = YES
1515 # The INCLUDE_PATH tag can be used to specify one or more directories that
1516 # contain include files that are not input files but should be processed by
1521 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1522 # patterns (like *.h and *.hpp) to filter out the header-files in the
1523 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1526 INCLUDE_FILE_PATTERNS =
1528 # The PREDEFINED tag can be used to specify one or more macro names that
1529 # are defined before the preprocessor is started (similar to the -D option of
1530 # gcc). The argument of the tag is a list of macros of the form: name
1531 # or name=definition (no spaces). If the definition and the = are
1532 # omitted =1 is assumed. To prevent a macro definition from being
1533 # undefined via #undef or recursively expanded use the := operator
1534 # instead of the = operator.
1536 PREDEFINED = __cplusplus \
1538 _GLIBCXX_HAS_GTHREADS \
1539 __GXX_EXPERIMENTAL_CXX0X__ \
1540 _GLIBCXX_INCLUDE_AS_CXX0X \
1542 "_GLIBCXX_CONST= " \
1543 "_GLIBCXX_NORETURN= " \
1544 "_GLIBCXX_NOTHROW= " \
1545 "_GLIBCXX_STD_D= " \
1546 "_GLIBCXX_STD_P= " \
1547 "_GLIBCXX_STD_PR= " \
1550 "_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
1551 "_GLIBCXX_END_NAMESPACE_TR1= " \
1552 "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name { " \
1553 "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name { " \
1554 _GLIBCXX_END_NAMESPACE=} \
1555 _GLIBCXX_END_NESTED_NAMESPACE=} \
1556 "_GLIBCXX_TEMPLATE_ARGS=... " \
1557 _GLIBCXX_DEPRECATED \
1558 _GLIBCXX_CONSTEXPR=constexpr \
1559 _GLIBCXX_USE_CONSTEXPR=constexpr \
1560 _GLIBCXX_USE_WCHAR_T \
1561 _GLIBCXX_USE_LONG_LONG \
1562 _GLIBCXX_USE_C99_STDINT_TR1 \
1563 _GLIBCXX_ATOMIC_BUILTINS_1 \
1564 _GLIBCXX_ATOMIC_BUILTINS_2 \
1565 _GLIBCXX_ATOMIC_BUILTINS_4 \
1566 _GLIBCXX_ATOMIC_BUILTINS_8 \
1567 _GLIBCXX_USE_SCHED_YIELD \
1568 _GLIBCXX_USE_NANOSLEEP \
1570 __glibcxx_function_requires=// \
1571 __glibcxx_class_requires=// \
1572 __glibcxx_class_requires2=// \
1573 __glibcxx_class_requires3=// \
1574 __glibcxx_class_requires4=//
1576 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1577 # this tag can be used to specify a list of macro names that should be expanded.
1578 # The macro definition that is found in the sources will be used.
1579 # Use the PREDEFINED tag if you want to use a different macro definition.
1583 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1584 # doxygen's preprocessor will remove all function-like macros that are alone
1585 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1586 # function macros are typically used for boiler-plate code, and will confuse
1587 # the parser if not removed.
1589 SKIP_FUNCTION_MACROS = YES
1591 #---------------------------------------------------------------------------
1592 # Configuration::additions related to external references
1593 #---------------------------------------------------------------------------
1595 # The TAGFILES option can be used to specify one or more tagfiles.
1596 # Optionally an initial location of the external documentation
1597 # can be added for each tagfile. The format of a tag file without
1598 # this location is as follows:
1600 # TAGFILES = file1 file2 ...
1601 # Adding location for the tag files is done as follows:
1603 # TAGFILES = file1=loc1 "file2 = loc2" ...
1604 # where "loc1" and "loc2" can be relative or absolute paths or
1605 # URLs. If a location is present for each tag, the installdox tool
1606 # does not have to be run to correct the links.
1607 # Note that each tag file must have a unique name
1608 # (where the name does NOT include the path)
1609 # If a tag file is not located in the directory in which doxygen
1610 # is run, you must also specify the path to the tagfile here.
1614 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1615 # a tag file that is based on the input files it reads.
1617 GENERATE_TAGFILE = @generate_tagfile@
1619 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1620 # in the class index. If set to NO only the inherited external classes
1625 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1626 # in the modules index. If set to NO, only the current project's groups will
1629 EXTERNAL_GROUPS = YES
1631 # The PERL_PATH should be the absolute path and name of the perl script
1632 # interpreter (i.e. the result of `which perl').
1634 PERL_PATH = /usr/bin/perl
1636 #---------------------------------------------------------------------------
1637 # Configuration options related to the dot tool
1638 #---------------------------------------------------------------------------
1640 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1641 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1642 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1643 # this option also works with HAVE_DOT disabled, but it is recommended to
1644 # install and use dot, since it yields more powerful graphs.
1646 CLASS_DIAGRAMS = YES
1648 # You can define message sequence charts within doxygen comments using the \msc
1649 # command. Doxygen will then run the mscgen tool (see
1650 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1651 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1652 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1653 # default search path.
1657 # If set to YES, the inheritance and collaboration graphs will hide
1658 # inheritance and usage relations if the target is undocumented
1659 # or is not a class.
1661 HIDE_UNDOC_RELATIONS = NO
1663 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1664 # available from the path. This tool is part of Graphviz, a graph visualization
1665 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1666 # have no effect if this option is set to NO (the default)
1670 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1671 # allowed to run in parallel. When set to 0 (the default) doxygen will
1672 # base this on the number of processors available in the system. You can set it
1673 # explicitly to a value larger than 0 to get control over the balance
1674 # between CPU load and processing speed.
1678 # By default doxygen will write a font called FreeSans.ttf to the output
1679 # directory and reference it in all dot files that doxygen generates. This
1680 # font does not include all possible unicode characters however, so when you need
1681 # these (or just want a differently looking font) you can specify the font name
1682 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1683 # which can be done by putting it in a standard location or by setting the
1684 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1685 # containing the font.
1687 DOT_FONTNAME = FreeSans
1689 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1690 # The default size is 10pt.
1694 # By default doxygen will tell dot to use the output directory to look for the
1695 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1696 # different font using DOT_FONTNAME you can set the path where dot
1697 # can find it using this tag.
1701 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1702 # will generate a graph for each documented class showing the direct and
1703 # indirect inheritance relations. Setting this tag to YES will force the
1704 # the CLASS_DIAGRAMS tag to NO.
1708 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1709 # will generate a graph for each documented class showing the direct and
1710 # indirect implementation dependencies (inheritance, containment, and
1711 # class references variables) of the class with other documented classes.
1713 COLLABORATION_GRAPH = NO
1715 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1716 # will generate a graph for groups, showing the direct groups dependencies
1720 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1721 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1726 # If set to YES, the inheritance and collaboration graphs will show the
1727 # relations between templates and their instances.
1729 TEMPLATE_RELATIONS = YES
1731 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1732 # tags are set to YES then doxygen will generate a graph for each documented
1733 # file showing the direct and indirect include dependencies of the file with
1734 # other documented files.
1738 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1739 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1740 # documented header file showing the documented files that directly or
1741 # indirectly include this file.
1743 INCLUDED_BY_GRAPH = NO
1745 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1746 # doxygen will generate a call dependency graph for every global function
1747 # or class method. Note that enabling this option will significantly increase
1748 # the time of a run. So in most cases it will be better to enable call graphs
1749 # for selected functions only using the \callgraph command.
1753 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1754 # doxygen will generate a caller dependency graph for every global function
1755 # or class method. Note that enabling this option will significantly increase
1756 # the time of a run. So in most cases it will be better to enable caller
1757 # graphs for selected functions only using the \callergraph command.
1761 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1762 # will generate a graphical hierarchy of all classes instead of a textual one.
1764 GRAPHICAL_HIERARCHY = YES
1766 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1767 # then doxygen will show the dependencies a directory has on other directories
1768 # in a graphical way. The dependency relations are determined by the #include
1769 # relations between the files in the directories.
1771 DIRECTORY_GRAPH = YES
1773 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1774 # generated by dot. Possible values are png, jpg, or gif.
1775 # If left blank png will be used.
1777 DOT_IMAGE_FORMAT = png
1779 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1780 # found. If left blank, it is assumed the dot tool can be found in the path.
1784 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1785 # contain dot files that are included in the documentation (see the
1786 # \dotfile command).
1790 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1791 # contain msc files that are included in the documentation (see the
1792 # \mscfile command).
1796 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1797 # nodes that will be shown in the graph. If the number of nodes in a graph
1798 # becomes larger than this value, doxygen will truncate the graph, which is
1799 # visualized by representing a node as a red box. Note that doxygen if the
1800 # number of direct children of the root node in a graph is already larger than
1801 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1802 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1804 DOT_GRAPH_MAX_NODES = 50
1806 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1807 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1808 # from the root by following a path via at most 3 edges will be shown. Nodes
1809 # that lay further from the root node will be omitted. Note that setting this
1810 # option to 1 or 2 may greatly reduce the computation time needed for large
1811 # code bases. Also note that the size of a graph can be further restricted by
1812 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1814 MAX_DOT_GRAPH_DEPTH = 0
1816 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1817 # background. This is disabled by default, because dot on Windows does not
1818 # seem to support this out of the box. Warning: Depending on the platform used,
1819 # enabling this option may lead to badly anti-aliased labels on the edges of
1820 # a graph (i.e. they become hard to read).
1822 DOT_TRANSPARENT = NO
1824 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1825 # files in one run (i.e. multiple -o and -T options on the command line). This
1826 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1827 # support this, this feature is disabled by default.
1829 DOT_MULTI_TARGETS = YES
1831 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1832 # generate a legend page explaining the meaning of the various boxes and
1833 # arrows in the dot generated graphs.
1835 GENERATE_LEGEND = YES
1837 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1838 # remove the intermediate dot files that are used to generate
1839 # the various graphs.