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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = libstdc++
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
33 OUTPUT_DIRECTORY = @outdir@
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of
39 # source files, where putting all generated files in the same directory would
40 # otherwise cause performance problems for the file system.
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are:
48 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
50 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
51 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
52 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
54 OUTPUT_LANGUAGE = English
56 # This tag can be used to specify the encoding used in the generated output.
57 # The encoding is not always determined by the language that is chosen,
58 # but also whether or not the output is meant for Windows or non-Windows users.
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60 # forces the Windows encoding (this is the default for the Windows binary),
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
62 # all platforms other than Windows).
64 USE_WINDOWS_ENCODING = NO
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this.
71 BRIEF_MEMBER_DESC = NO
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # the brief description of a member or function before the detailed description.
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76 # brief descriptions will be completely suppressed.
80 # This tag implements a quasi-intelligent brief description abbreviator
81 # that is used to form the text in various listings. Each string
82 # in this list, if found as the leading text of the brief description, will be
83 # stripped from the text and the result after processing the whole list, is
84 # used as the annotated text. Otherwise, the brief description is used as-is.
85 # If left blank, the following values are used ("$name" is automatically
86 # replaced with the name of the entity): "The $name class" "The $name widget"
87 # "The $name file" "is" "provides" "specifies" "contains"
88 # "represents" "a" "an" "the"
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93 # Doxygen will generate a detailed section even if there is only a brief
96 ALWAYS_DETAILED_SEC = YES
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99 # inherited members of a class in the documentation of that class as if those
100 # members were ordinary class members. Constructors, destructors and assignment
101 # operators of the base classes will not be shown.
103 INLINE_INHERITED_MEMB = YES
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106 # path before files name in the file list and in the header files. If set
107 # to NO the shortest path that makes the file name unique will be used.
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112 # can be used to strip a user-defined part of the path. Stripping is
113 # only done if one of the specified strings matches the left-hand part of
114 # the path. The tag can be used to show relative paths in the file list.
115 # If left blank the directory from which doxygen is run is used as the
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121 # the path mentioned in the documentation of a class, which tells
122 # the reader which header file to include in order to use a class.
123 # If left blank only the name of the header file containing the class
124 # definition is used. Otherwise one should specify the include paths that
125 # are normally passed to the compiler using the -I flag.
127 STRIP_FROM_INC_PATH =
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130 # (but less readable) file names. This can be useful is your file systems
131 # doesn't support long names like on DOS, Mac, or CD-ROM.
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136 # will interpret the first line (until the first dot) of a JavaDoc-style
137 # comment as the brief description. If set to NO, the JavaDoc
138 # comments will behave just like the Qt-style comments (thus requiring an
139 # explicit @brief command for a brief description.
141 JAVADOC_AUTOBRIEF = NO
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
145 # comments) as a brief description. This used to be the default behaviour.
146 # The new default is to treat a multi-line C++ comment block as a detailed
147 # description. Set this tag to YES if you prefer the old behaviour instead.
149 MULTILINE_CPP_IS_BRIEF = YES
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
152 # will output the detailed description near the top, like JavaDoc.
153 # If set to NO, the detailed description appears after the member
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\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 s27_2_iosfwd I/O forward declarations @endlink "
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 Java.
194 # For instance, namespaces will be presented as packages, qualified scopes
195 # will look different, etc.
197 OPTIMIZE_OUTPUT_JAVA = NO
199 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
200 # include (a tag file for) the STL sources as input, then you should
201 # set this tag to YES in order to let doxygen match functions declarations and
202 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
203 # func(std::string) {}). This also make the inheritance and collaboration
204 # diagrams that involve STL classes more complete and accurate.
206 BUILTIN_STL_SUPPORT = NO
208 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
209 # tag is set to YES, then doxygen will reuse the documentation of the first
210 # member in the group (if any) for the other members of the group. By default
211 # all members of a group must be documented explicitly.
213 DISTRIBUTE_GROUP_DOC = YES
215 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
216 # the same type (for instance a group of public functions) to be put as a
217 # subgroup of that type (e.g. under the Public Functions section). Set it to
218 # NO to prevent subgrouping. Alternatively, this can be done per class using
219 # the \nosubgrouping command.
223 #---------------------------------------------------------------------------
224 # Build related configuration options
225 #---------------------------------------------------------------------------
227 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
228 # documentation are documented, even if no documentation was available.
229 # Private class members and static file members will be hidden unless
230 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
234 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
235 # will be included in the documentation.
239 # If the EXTRACT_STATIC tag is set to YES all static members of a file
240 # will be included in the documentation.
244 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
245 # defined locally in source files will be included in the documentation.
246 # If set to NO only classes defined in header files are included.
248 EXTRACT_LOCAL_CLASSES = YES
250 # This flag is only useful for Objective-C code. When set to YES local
251 # methods, which are defined in the implementation section but not in
252 # the interface are included in the documentation.
253 # If set to NO (the default) only methods in the interface are included.
255 EXTRACT_LOCAL_METHODS = YES
257 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
258 # undocumented members of documented classes, files or namespaces.
259 # If set to NO (the default) these members will be included in the
260 # various overviews, but no documentation section is generated.
261 # This option has no effect if EXTRACT_ALL is enabled.
263 HIDE_UNDOC_MEMBERS = NO
265 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
266 # undocumented classes that are normally visible in the class hierarchy.
267 # If set to NO (the default) these classes will be included in the various
268 # overviews. This option has no effect if EXTRACT_ALL is enabled.
270 HIDE_UNDOC_CLASSES = YES
272 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
273 # friend (class|struct|union) declarations.
274 # If set to NO (the default) these declarations will be included in the
277 HIDE_FRIEND_COMPOUNDS = NO
279 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
280 # documentation blocks found inside the body of a function.
281 # If set to NO (the default) these blocks will be appended to the
282 # function's detailed documentation block.
284 HIDE_IN_BODY_DOCS = NO
286 # The INTERNAL_DOCS tag determines if documentation
287 # that is typed after a \internal command is included. If the tag is set
288 # to NO (the default) then the documentation will be excluded.
289 # Set it to YES to include the internal documentation.
293 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
294 # file names in lower-case letters. If set to YES upper-case letters are also
295 # allowed. This is useful if you have classes or files whose names only differ
296 # in case and if your file system supports case sensitive file names. Windows
297 # and Mac users are advised to set this option to NO.
299 CASE_SENSE_NAMES = NO
301 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
302 # will show members with their full class and namespace scopes in the
303 # documentation. If set to YES the scope will be hidden.
305 HIDE_SCOPE_NAMES = NO
307 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
308 # will put a list of the files that are included by a file in the documentation
311 SHOW_INCLUDE_FILES = NO
313 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
314 # is inserted in the documentation for inline members.
318 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
319 # will sort the (detailed) documentation of file and class members
320 # alphabetically by member name. If set to NO the members will appear in
323 SORT_MEMBER_DOCS = YES
325 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
326 # brief documentation of file, namespace and class members alphabetically
327 # by member name. If set to NO (the default) the members will appear in
330 SORT_BRIEF_DOCS = YES
332 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
333 # sorted by fully-qualified names, including namespaces. If set to
334 # NO (the default), the class list will be sorted only by class name,
335 # not including the namespace part.
336 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
337 # Note: This option applies only to the class list, not to the
340 SORT_BY_SCOPE_NAME = YES
342 # The GENERATE_TODOLIST tag can be used to enable (YES) or
343 # disable (NO) the todo list. This list is created by putting \todo
344 # commands in the documentation.
346 GENERATE_TODOLIST = YES
348 # The GENERATE_TESTLIST tag can be used to enable (YES) or
349 # disable (NO) the test list. This list is created by putting \test
350 # commands in the documentation.
352 GENERATE_TESTLIST = NO
354 # The GENERATE_BUGLIST tag can be used to enable (YES) or
355 # disable (NO) the bug list. This list is created by putting \bug
356 # commands in the documentation.
358 GENERATE_BUGLIST = YES
360 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
361 # disable (NO) the deprecated list. This list is created by putting
362 # \deprecated commands in the documentation.
364 GENERATE_DEPRECATEDLIST= YES
366 # The ENABLED_SECTIONS tag can be used to enable conditional
367 # documentation sections, marked by \if sectionname ... \endif.
369 ENABLED_SECTIONS = @enabled_sections@
371 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
372 # the initial value of a variable or define consists of for it to appear in
373 # the documentation. If the initializer consists of more lines than specified
374 # here it will be hidden. Use a value of 0 to hide initializers completely.
375 # The appearance of the initializer of individual variables and defines in the
376 # documentation can be controlled using \showinitializer or \hideinitializer
377 # command in the documentation regardless of this setting.
379 MAX_INITIALIZER_LINES = 0
381 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
382 # at the bottom of the documentation of classes and structs. If set to YES the
383 # list will mention the files that were used to generate the documentation.
385 SHOW_USED_FILES = YES
387 # If the sources in your project are distributed over multiple directories
388 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
389 # in the documentation. The default is NO.
391 SHOW_DIRECTORIES = YES
393 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
394 # doxygen should invoke to get the current version for each file (typically from the
395 # version control system). Doxygen will invoke the program by executing (via
396 # popen()) the command <command> <input-file>, where <command> is the value of
397 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
398 # provided by doxygen. Whatever the program writes to standard output
399 # is used as the file version. See the manual for examples.
401 FILE_VERSION_FILTER =
403 #---------------------------------------------------------------------------
404 # configuration options related to warning and progress messages
405 #---------------------------------------------------------------------------
407 # The QUIET tag can be used to turn on/off the messages that are generated
408 # by doxygen. Possible values are YES and NO. If left blank NO is used.
412 # The WARNINGS tag can be used to turn on/off the warning messages that are
413 # generated by doxygen. Possible values are YES and NO. If left blank
418 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
419 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
420 # automatically be disabled.
422 WARN_IF_UNDOCUMENTED = NO
424 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
425 # potential errors in the documentation, such as not documenting some
426 # parameters in a documented function, or documenting parameters that
427 # don't exist or using markup commands wrongly.
429 WARN_IF_DOC_ERROR = NO
431 # This WARN_NO_PARAMDOC option can be abled to get warnings for
432 # functions that are documented, but have no documentation for their parameters
433 # or return value. If set to NO (the default) doxygen will only warn about
434 # wrong or incomplete parameter documentation, but not about the absence of
437 WARN_NO_PARAMDOC = NO
439 # The WARN_FORMAT tag determines the format of the warning messages that
440 # doxygen can produce. The string should contain the $file, $line, and $text
441 # tags, which will be replaced by the file and line number from which the
442 # warning originated and the warning text. Optionally the format may contain
443 # $version, which will be replaced by the version of the file (if it could
444 # be obtained via FILE_VERSION_FILTER)
446 WARN_FORMAT = "$file:$line: $text "
448 # The WARN_LOGFILE tag can be used to specify a file to which warning
449 # and error messages should be written. If left blank the output is written
454 #---------------------------------------------------------------------------
455 # configuration options related to the input files
456 #---------------------------------------------------------------------------
458 # The INPUT tag can be used to specify the files and/or directories that contain
459 # documented source files. You may enter file names like "myfile.cpp" or
460 # directories like "/usr/src/myproject". Separate the files or directories
463 INPUT = @srcdir@/libsupc++/cxxabi.h \
464 @srcdir@/libsupc++/cxxabi-forced.h \
465 @srcdir@/libsupc++/exception \
466 @srcdir@/libsupc++/new \
467 @srcdir@/libsupc++/typeinfo \
471 include/condition_variable \
499 include/system_error \
502 include/type_traits \
503 include/unordered_map \
504 include/unordered_set \
533 include/backward/hash_map \
534 include/backward/hash_set \
535 include/backward/strstream \
536 include/debug/bitset \
537 include/debug/deque \
541 include/debug/string \
542 include/debug/unordered_map \
543 include/debug/unordered_set \
544 include/debug/vector \
545 include/ext/algorithm \
546 include/ext/functional \
547 include/ext/iterator \
549 include/ext/numeric \
550 include/ext/rb_tree \
553 include/parallel/algorithm \
554 include/parallel/numeric \
556 include/tr1/ccomplex \
560 include/tr1/cinttypes \
561 include/tr1/climits \
563 include/tr1/complex \
564 include/tr1/cstdarg \
565 include/tr1/cstdbool \
566 include/tr1/cstdint \
568 include/tr1/cstdlib \
569 include/tr1/ctgmath \
572 include/tr1/cwctype \
573 include/tr1/functional \
578 include/tr1/type_traits \
579 include/tr1/unordered_map \
580 include/tr1/unordered_set \
581 include/tr1_impl/array \
582 include/tr1_impl/cctype \
583 include/tr1_impl/cfenv \
584 include/tr1_impl/cinttypes \
585 include/tr1_impl/cmath \
586 include/tr1_impl/complex \
587 include/tr1_impl/cstdint \
588 include/tr1_impl/cstdio \
589 include/tr1_impl/cstdlib \
590 include/tr1_impl/cwchar \
591 include/tr1_impl/cwctype \
592 include/tr1_impl/functional \
593 include/tr1_impl/hashtable \
594 include/tr1_impl/random \
595 include/tr1_impl/regex \
596 include/tr1_impl/type_traits \
597 include/tr1_impl/unordered_map \
598 include/tr1_impl/unordered_set \
599 include/tr1_impl/utility \
600 include/@host_alias@/bits \
609 include/ext/pb_ds/detail \
610 @srcdir@/doc/doxygen/doxygroups.cc
612 # If the value of the INPUT tag contains directories, you can use the
613 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
614 # and *.h) to filter out the source-files in the directories. If left
615 # blank the following patterns are tested:
616 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
617 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
619 FILE_PATTERNS = *.h \
623 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
624 # should be searched for input files as well. Possible values are YES and NO.
625 # If left blank NO is used.
629 # The EXCLUDE tag can be used to specify files and/or directories that should
630 # excluded from the INPUT source files. This way you can easily exclude a
631 # subdirectory from a directory tree whose root is specified with the INPUT tag.
635 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
636 # directories that are symbolic links (a Unix filesystem feature) are excluded
639 EXCLUDE_SYMLINKS = NO
641 # If the value of the INPUT tag contains directories, you can use the
642 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
643 # certain files from those directories. Note that the wildcards are matched
644 # against the file with absolute path, so to exclude all test directories
645 # for example use the pattern */test/*
647 EXCLUDE_PATTERNS = stamp-* \
653 # The EXAMPLE_PATH tag can be used to specify one or more files or
654 # directories that contain example code fragments that are included (see
655 # the \include command).
659 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
660 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
661 # and *.h) to filter out the source-files in the directories. If left
662 # blank all files are included.
666 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
667 # searched for input files to be used with the \include or \dontinclude
668 # commands irrespective of the value of the RECURSIVE tag.
669 # Possible values are YES and NO. If left blank NO is used.
671 EXAMPLE_RECURSIVE = NO
673 # The IMAGE_PATH tag can be used to specify one or more files or
674 # directories that contain image that are included in the documentation (see
675 # the \image command).
679 # The INPUT_FILTER tag can be used to specify a program that doxygen should
680 # invoke to filter for each input file. Doxygen will invoke the filter program
681 # by executing (via popen()) the command <filter> <input-file>, where <filter>
682 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
683 # input file. Doxygen will then use the output that the filter program writes
684 # to standard output. If FILTER_PATTERNS is specified, this tag will be
689 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
690 # basis. Doxygen will compare the file name with each pattern and apply the
691 # filter if there is a match. The filters are a list of the form:
692 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
693 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
694 # is applied to all files.
698 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
699 # INPUT_FILTER) will be used to filter the input files when producing source
700 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
702 FILTER_SOURCE_FILES = NO
704 #---------------------------------------------------------------------------
705 # configuration options related to source browsing
706 #---------------------------------------------------------------------------
708 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
709 # be generated. Documented entities will be cross-referenced with these sources.
710 # Note: To get rid of all source code in the generated output, make sure also
711 # VERBATIM_HEADERS is set to NO.
715 # Setting the INLINE_SOURCES tag to YES will include the body
716 # of functions and classes directly in the documentation.
720 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
721 # doxygen to hide any special comment blocks from generated source code
722 # fragments. Normal C and C++ comments will always remain visible.
724 STRIP_CODE_COMMENTS = NO
726 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
727 # then for each documented function all documented
728 # functions referencing it will be listed.
730 REFERENCED_BY_RELATION = YES
732 # If the REFERENCES_RELATION tag is set to YES (the default)
733 # then for each documented function all documented entities
734 # called/used by that function will be listed.
736 REFERENCES_RELATION = YES
738 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
739 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
740 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
741 # link to the source code. Otherwise they will link to the documentstion.
743 REFERENCES_LINK_SOURCE = YES
745 # If the USE_HTAGS tag is set to YES then the references to source code
746 # will point to the HTML generated by the htags(1) tool instead of doxygen
747 # built-in source browser. The htags tool is part of GNU's global source
748 # tagging system (see http://www.gnu.org/software/global/global.html). You
749 # will need version 4.8.6 or higher.
753 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
754 # will generate a verbatim copy of the header file for each class for
755 # which an include is specified. Set to NO to disable this.
757 VERBATIM_HEADERS = NO
759 #---------------------------------------------------------------------------
760 # configuration options related to the alphabetical class index
761 #---------------------------------------------------------------------------
763 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
764 # of all compounds will be generated. Enable this if the project
765 # contains a lot of classes, structs, unions or interfaces.
767 ALPHABETICAL_INDEX = YES
769 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
770 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
771 # in which this list will be split (can be a number in the range [1..20])
773 COLS_IN_ALPHA_INDEX = 2
775 # In case all classes in a project start with a common prefix, all
776 # classes will be put under the same header in the alphabetical index.
777 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
778 # should be ignored while generating the index headers.
782 #---------------------------------------------------------------------------
783 # configuration options related to the HTML output
784 #---------------------------------------------------------------------------
786 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
787 # generate HTML output.
789 GENERATE_HTML = @do_html@
791 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
792 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
793 # put in front of it. If left blank `html' will be used as the default path.
797 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
798 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
799 # doxygen will generate files with .html extension.
801 HTML_FILE_EXTENSION = .html
803 # The HTML_HEADER tag can be used to specify a personal HTML header for
804 # each generated HTML page. If it is left blank doxygen will generate a
809 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
810 # each generated HTML page. If it is left blank doxygen will generate a
815 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
816 # style sheet that is used by each HTML page. It can be used to
817 # fine-tune the look of the HTML output. If the tag is left blank doxygen
818 # will generate a default style sheet. Note that doxygen will try to copy
819 # the style sheet file to the HTML output directory, so don't put your own
820 # stylesheet in the HTML output directory as well, or it will be erased!
824 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
825 # files or namespaces will be aligned in HTML using tables. If set to
826 # NO a bullet list will be used.
828 HTML_ALIGN_MEMBERS = NO
830 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
831 # will be generated that can be used as input for tools like the
832 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
833 # of the generated HTML documentation.
835 GENERATE_HTMLHELP = NO
837 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
838 # be used to specify the file name of the resulting .chm file. You
839 # can add a path in front of the file if the result should not be
840 # written to the html output directory.
844 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
845 # be used to specify the location (absolute path including file name) of
846 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
847 # the HTML help compiler on the generated index.hhp.
851 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
852 # controls if a separate .chi index file is generated (YES) or that
853 # it should be included in the master .chm file (NO).
857 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
858 # controls whether a binary table of contents is generated (YES) or a
859 # normal table of contents (NO) in the .chm file.
863 # The TOC_EXPAND flag can be set to YES to add extra items for group members
864 # to the contents of the HTML help documentation and to the tree view.
868 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
869 # top of each HTML page. The value NO (the default) enables the index and
870 # the value YES disables it.
874 # This tag can be used to set the number of enum values (range [1..20])
875 # that doxygen will group on one line in the generated HTML documentation.
877 ENUM_VALUES_PER_LINE = 4
879 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
880 # generated containing a tree-like index structure (just like the one that
881 # is generated for HTML Help). For this to work a browser that supports
882 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
883 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
884 # probably better off using the HTML help feature.
886 GENERATE_TREEVIEW = YES
888 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
889 # used to set the initial width (in pixels) of the frame in which the tree
894 #---------------------------------------------------------------------------
895 # configuration options related to the LaTeX output
896 #---------------------------------------------------------------------------
898 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
899 # generate Latex output.
903 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
904 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
905 # put in front of it. If left blank `latex' will be used as the default path.
909 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
910 # invoked. If left blank `latex' will be used as the default command name.
912 LATEX_CMD_NAME = latex
914 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
915 # generate index for LaTeX. If left blank `makeindex' will be used as the
916 # default command name.
918 MAKEINDEX_CMD_NAME = makeindex
920 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
921 # LaTeX documents. This may be useful for small projects and may help to
922 # save some trees in general.
926 # The PAPER_TYPE tag can be used to set the paper type that is used
927 # by the printer. Possible values are: a4, a4wide, letter, legal and
928 # executive. If left blank a4wide will be used.
932 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
933 # packages that should be included in the LaTeX output.
935 EXTRA_PACKAGES = amsmath
937 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
938 # the generated latex document. The header should contain everything until
939 # the first chapter. If it is left blank doxygen will generate a
940 # standard header. Notice: only use this tag if you know what you are doing!
944 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
945 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
946 # contain links (just like the HTML output) instead of page references
947 # This makes the output suitable for online browsing using a pdf viewer.
951 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
952 # plain latex in the generated Makefile. Set this option to YES to get a
953 # higher quality PDF documentation.
957 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
958 # command to the generated LaTeX files. This will instruct LaTeX to keep
959 # running if errors occur, instead of asking the user for help.
960 # This option is also used when generating formulas in HTML.
964 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
965 # include the index chapters (such as File Index, Compound Index, etc.)
968 LATEX_HIDE_INDICES = NO
970 #---------------------------------------------------------------------------
971 # configuration options related to the RTF output
972 #---------------------------------------------------------------------------
974 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
975 # The RTF output is optimized for Word 97 and may not look very pretty with
976 # other RTF readers or editors.
980 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
981 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
982 # put in front of it. If left blank `rtf' will be used as the default path.
986 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
987 # RTF documents. This may be useful for small projects and may help to
988 # save some trees in general.
992 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
993 # will contain hyperlink fields. The RTF file will
994 # contain links (just like the HTML output) instead of page references.
995 # This makes the output suitable for online browsing using WORD or other
996 # programs which support those fields.
997 # Note: wordpad (write) and others do not support links.
1001 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1002 # config file, i.e. a series of assignments. You only have to provide
1003 # replacements, missing definitions are set to their default value.
1005 RTF_STYLESHEET_FILE =
1007 # Set optional variables used in the generation of an rtf document.
1008 # Syntax is similar to doxygen's config file.
1010 RTF_EXTENSIONS_FILE =
1012 #---------------------------------------------------------------------------
1013 # configuration options related to the man page output
1014 #---------------------------------------------------------------------------
1016 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1017 # generate man pages
1019 GENERATE_MAN = @do_man@
1021 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1022 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1023 # put in front of it. If left blank `man' will be used as the default path.
1027 # The MAN_EXTENSION tag determines the extension that is added to
1028 # the generated man pages (default is the subroutine's section .3)
1032 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1033 # then it will generate one additional man file for each entity
1034 # documented in the real man page(s). These additional files
1035 # only source the real man page, but without them the man command
1036 # would be unable to find the correct page. The default is NO.
1040 #---------------------------------------------------------------------------
1041 # configuration options related to the XML output
1042 #---------------------------------------------------------------------------
1044 # If the GENERATE_XML tag is set to YES Doxygen will
1045 # generate an XML file that captures the structure of
1046 # the code including all documentation.
1048 GENERATE_XML = @do_xml@
1050 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1051 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1052 # put in front of it. If left blank `xml' will be used as the default path.
1056 # The XML_SCHEMA tag can be used to specify an XML schema,
1057 # which can be used by a validating XML parser to check the
1058 # syntax of the XML files.
1062 # The XML_DTD tag can be used to specify an XML DTD,
1063 # which can be used by a validating XML parser to check the
1064 # syntax of the XML files.
1068 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1069 # dump the program listings (including syntax highlighting
1070 # and cross-referencing information) to the XML output. Note that
1071 # enabling this will significantly increase the size of the XML output.
1073 XML_PROGRAMLISTING = YES
1075 #---------------------------------------------------------------------------
1076 # configuration options for the AutoGen Definitions output
1077 #---------------------------------------------------------------------------
1079 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1080 # generate an AutoGen Definitions (see autogen.sf.net) file
1081 # that captures the structure of the code including all
1082 # documentation. Note that this feature is still experimental
1083 # and incomplete at the moment.
1085 GENERATE_AUTOGEN_DEF = NO
1087 #---------------------------------------------------------------------------
1088 # configuration options related to the Perl module output
1089 #---------------------------------------------------------------------------
1091 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1092 # generate a Perl module file that captures the structure of
1093 # the code including all documentation. Note that this
1094 # feature is still experimental and incomplete at the
1097 GENERATE_PERLMOD = NO
1099 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1100 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1101 # to generate PDF and DVI output from the Perl module output.
1105 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1106 # nicely formatted so it can be parsed by a human reader. This is useful
1107 # if you want to understand what is going on. On the other hand, if this
1108 # tag is set to NO the size of the Perl module output will be much smaller
1109 # and Perl will parse it just the same.
1111 PERLMOD_PRETTY = YES
1113 # The names of the make variables in the generated doxyrules.make file
1114 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1115 # This is useful so different doxyrules.make files included by the same
1116 # Makefile don't overwrite each other's variables.
1118 PERLMOD_MAKEVAR_PREFIX =
1120 #---------------------------------------------------------------------------
1121 # Configuration options related to the preprocessor
1122 #---------------------------------------------------------------------------
1124 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1125 # evaluate all C-preprocessor directives found in the sources and include
1128 ENABLE_PREPROCESSING = YES
1130 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1131 # names in the source code. If set to NO (the default) only conditional
1132 # compilation will be performed. Macro expansion can be done in a controlled
1133 # way by setting EXPAND_ONLY_PREDEF to YES.
1135 MACRO_EXPANSION = YES
1137 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1138 # then the macro expansion is limited to the macros specified with the
1139 # PREDEFINED and EXPAND_AS_DEFINED tags.
1141 EXPAND_ONLY_PREDEF = NO
1143 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1144 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1146 SEARCH_INCLUDES = YES
1148 # The INCLUDE_PATH tag can be used to specify one or more directories that
1149 # contain include files that are not input files but should be processed by
1154 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1155 # patterns (like *.h and *.hpp) to filter out the header-files in the
1156 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1159 INCLUDE_FILE_PATTERNS =
1161 # The PREDEFINED tag can be used to specify one or more macro names that
1162 # are defined before the preprocessor is started (similar to the -D option of
1163 # gcc). The argument of the tag is a list of macros of the form: name
1164 # or name=definition (no spaces). If the definition and the = are
1165 # omitted =1 is assumed. To prevent a macro definition from being
1166 # undefined via #undef or recursively expanded use the := operator
1167 # instead of the = operator.
1169 PREDEFINED = __cplusplus \
1171 "_GLIBCXX_STD_P= " \
1172 "_GLIBCXX_STD_D= " \
1175 "_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
1176 "_GLIBCXX_END_NAMESPACE_TR1= " \
1177 "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name { " \
1178 "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name { " \
1179 _GLIBCXX_END_NAMESPACE=} \
1180 _GLIBCXX_END_NESTED_NAMESPACE=} \
1181 "_GLIBCXX_TEMPLATE_ARGS=... " \
1182 _GLIBCXX_INCLUDE_AS_CXX0X \
1183 _GLIBCXX_DEPRECATED \
1184 _GLIBCXX_USE_WCHAR_T \
1185 _GLIBCXX_USE_LONG_LONG \
1186 __glibcxx_function_requires=// \
1187 __glibcxx_class_requires=// \
1188 __glibcxx_class_requires2=// \
1189 __glibcxx_class_requires3=// \
1190 __glibcxx_class_requires4=//
1192 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1193 # this tag can be used to specify a list of macro names that should be expanded.
1194 # The macro definition that is found in the sources will be used.
1195 # Use the PREDEFINED tag if you want to use a different macro definition.
1199 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1200 # doxygen's preprocessor will remove all function-like macros that are alone
1201 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1202 # function macros are typically used for boiler-plate code, and will confuse
1203 # the parser if not removed.
1205 SKIP_FUNCTION_MACROS = YES
1207 #---------------------------------------------------------------------------
1208 # Configuration::additions related to external references
1209 #---------------------------------------------------------------------------
1211 # The TAGFILES option can be used to specify one or more tagfiles.
1212 # Optionally an initial location of the external documentation
1213 # can be added for each tagfile. The format of a tag file without
1214 # this location is as follows:
1215 # TAGFILES = file1 file2 ...
1216 # Adding location for the tag files is done as follows:
1217 # TAGFILES = file1=loc1 "file2 = loc2" ...
1218 # where "loc1" and "loc2" can be relative or absolute paths or
1219 # URLs. If a location is present for each tag, the installdox tool
1220 # does not have to be run to correct the links.
1221 # Note that each tag file must have a unique name
1222 # (where the name does NOT include the path)
1223 # If a tag file is not located in the directory in which doxygen
1224 # is run, you must also specify the path to the tagfile here.
1228 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1229 # a tag file that is based on the input files it reads.
1231 GENERATE_TAGFILE = @generate_tagfile@
1233 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1234 # in the class index. If set to NO only the inherited external classes
1239 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1240 # in the modules index. If set to NO, only the current project's groups will
1243 EXTERNAL_GROUPS = YES
1245 # The PERL_PATH should be the absolute path and name of the perl script
1246 # interpreter (i.e. the result of `which perl').
1248 PERL_PATH = /usr/bin/perl
1250 #---------------------------------------------------------------------------
1251 # Configuration options related to the dot tool
1252 #---------------------------------------------------------------------------
1254 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1255 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1256 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1257 # this option is superseded by the HAVE_DOT option below. This is only a
1258 # fallback. It is recommended to install and use dot, since it yields more
1261 CLASS_DIAGRAMS = YES
1263 # If set to YES, the inheritance and collaboration graphs will hide
1264 # inheritance and usage relations if the target is undocumented
1265 # or is not a class.
1267 HIDE_UNDOC_RELATIONS = NO
1269 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1270 # available from the path. This tool is part of Graphviz, a graph visualization
1271 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1272 # have no effect if this option is set to NO (the default)
1276 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1277 # will generate a graph for each documented class showing the direct and
1278 # indirect inheritance relations. Setting this tag to YES will force the
1279 # the CLASS_DIAGRAMS tag to NO.
1283 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1284 # will generate a graph for each documented class showing the direct and
1285 # indirect implementation dependencies (inheritance, containment, and
1286 # class references variables) of the class with other documented classes.
1288 COLLABORATION_GRAPH = NO
1290 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1291 # will generate a graph for groups, showing the direct groups dependencies
1295 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1296 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1301 # If set to YES, the inheritance and collaboration graphs will show the
1302 # relations between templates and their instances.
1304 TEMPLATE_RELATIONS = YES
1306 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1307 # tags are set to YES then doxygen will generate a graph for each documented
1308 # file showing the direct and indirect include dependencies of the file with
1309 # other documented files.
1313 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1314 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1315 # documented header file showing the documented files that directly or
1316 # indirectly include this file.
1318 INCLUDED_BY_GRAPH = NO
1320 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1321 # generate a call dependency graph for every global function or class method.
1322 # Note that enabling this option will significantly increase the time of a run.
1323 # So in most cases it will be better to enable call graphs for selected
1324 # functions only using the \callgraph command.
1328 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1329 # generate a caller dependency graph for every global function or class method.
1330 # Note that enabling this option will significantly increase the time of a run.
1331 # So in most cases it will be better to enable caller graphs for selected
1332 # functions only using the \callergraph command.
1336 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1337 # will graphical hierarchy of all classes instead of a textual one.
1339 GRAPHICAL_HIERARCHY = YES
1341 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1342 # then doxygen will show the dependencies a directory has on other directories
1343 # in a graphical way. The dependency relations are determined by the #include
1344 # relations between the files in the directories.
1346 DIRECTORY_GRAPH = YES
1348 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1349 # generated by dot. Possible values are png, jpg, or gif
1350 # If left blank png will be used.
1352 DOT_IMAGE_FORMAT = png
1354 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1355 # found. If left blank, it is assumed the dot tool can be found in the path.
1359 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1360 # contain dot files that are included in the documentation (see the
1361 # \dotfile command).
1365 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1366 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1367 # this value, doxygen will try to truncate the graph, so that it fits within
1368 # the specified constraint. Beware that most browsers cannot cope with very
1371 MAX_DOT_GRAPH_WIDTH = 1024
1373 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1374 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1375 # this value, doxygen will try to truncate the graph, so that it fits within
1376 # the specified constraint. Beware that most browsers cannot cope with very
1379 MAX_DOT_GRAPH_HEIGHT = 1024
1381 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1382 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1383 # from the root by following a path via at most 3 edges will be shown. Nodes
1384 # that lay further from the root node will be omitted. Note that setting this
1385 # option to 1 or 2 may greatly reduce the computation time needed for large
1386 # code bases. Also note that a graph may be further truncated if the graph's
1387 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1388 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1389 # the graph is not depth-constrained.
1391 MAX_DOT_GRAPH_DEPTH = 0
1393 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1394 # background. This is disabled by default, which results in a white background.
1395 # Warning: Depending on the platform used, enabling this option may lead to
1396 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1399 DOT_TRANSPARENT = NO
1401 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1402 # files in one run (i.e. multiple -o and -T options on the command line). This
1403 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1404 # support this, this feature is disabled by default.
1406 DOT_MULTI_TARGETS = YES
1408 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1409 # generate a legend page explaining the meaning of the various boxes and
1410 # arrows in the dot generated graphs.
1412 GENERATE_LEGEND = NO
1414 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1415 # remove the intermediate dot files that are used to generate
1416 # the various graphs.
1420 #---------------------------------------------------------------------------
1421 # Configuration::additions related to the search engine
1422 #---------------------------------------------------------------------------
1424 # The SEARCHENGINE tag specifies whether or not a search engine should be
1425 # used. If set to NO the values of all tags below this one will be ignored.