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.
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
34 PROJECT_NUMBER = @PACKAGE_VERSION@
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.
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, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
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 = YES
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 = NO
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 = NO
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 is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
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 = YES
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 = NO
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.
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185 # sources only. Doxygen will then generate output that is more tailored for C.
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
189 OPTIMIZE_OUTPUT_FOR_C = YES
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192 # sources only. Doxygen will then generate output that is more tailored for
193 # Java. For instance, namespaces will be presented as packages, qualified
194 # scopes will look different, etc.
196 OPTIMIZE_OUTPUT_JAVA = NO
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199 # sources only. Doxygen will then generate output that is more tailored for
202 OPTIMIZE_FOR_FORTRAN = NO
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205 # sources. Doxygen will then generate output that is tailored for
208 OPTIMIZE_OUTPUT_VHDL = NO
210 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
211 # to include (a tag file for) the STL sources as input, then you should
212 # set this tag to YES in order to let doxygen match functions declarations and
213 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
214 # func(std::string) {}). This also make the inheritance and collaboration
215 # diagrams that involve STL classes more complete and accurate.
217 BUILTIN_STL_SUPPORT = NO
219 # If you use Microsoft's C++/CLI language, you should set this option to YES to
220 # enable parsing support.
224 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
225 # Doxygen will parse them like normal C++ but will assume all classes use public
226 # instead of private inheritance when no explicit protection keyword is present.
230 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
231 # tag is set to YES, then doxygen will reuse the documentation of the first
232 # member in the group (if any) for the other members of the group. By default
233 # all members of a group must be documented explicitly.
235 DISTRIBUTE_GROUP_DOC = NO
237 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
238 # the same type (for instance a group of public functions) to be put as a
239 # subgroup of that type (e.g. under the Public Functions section). Set it to
240 # NO to prevent subgrouping. Alternatively, this can be done per class using
241 # the \nosubgrouping command.
245 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
246 # is documented as struct, union, or enum with the name of the typedef. So
247 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
248 # with name TypeT. When disabled the typedef will appear as a member of a file,
249 # namespace, or class. And the struct will be named TypeS. This can typically
250 # be useful for C code in case the coding convention dictates that all compound
251 # types are typedef'ed and only the typedef is referenced, never the tag name.
253 TYPEDEF_HIDES_STRUCT = NO
255 #---------------------------------------------------------------------------
256 # Build related configuration options
257 #---------------------------------------------------------------------------
259 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
260 # documentation are documented, even if no documentation was available.
261 # Private class members and static file members will be hidden unless
262 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
266 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
267 # will be included in the documentation.
271 # If the EXTRACT_STATIC tag is set to YES all static members of a file
272 # will be included in the documentation.
276 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
277 # defined locally in source files will be included in the documentation.
278 # If set to NO only classes defined in header files are included.
280 EXTRACT_LOCAL_CLASSES = NO
282 # This flag is only useful for Objective-C code. When set to YES local
283 # methods, which are defined in the implementation section but not in
284 # the interface are included in the documentation.
285 # If set to NO (the default) only methods in the interface are included.
287 EXTRACT_LOCAL_METHODS = NO
289 # If this flag is set to YES, the members of anonymous namespaces will be
290 # extracted and appear in the documentation as a namespace called
291 # 'anonymous_namespace{file}', where file will be replaced with the base
292 # name of the file that contains the anonymous namespace. By default
293 # anonymous namespace are hidden.
295 EXTRACT_ANON_NSPACES = NO
297 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
298 # undocumented members of documented classes, files or namespaces.
299 # If set to NO (the default) these members will be included in the
300 # various overviews, but no documentation section is generated.
301 # This option has no effect if EXTRACT_ALL is enabled.
303 HIDE_UNDOC_MEMBERS = NO
305 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
306 # undocumented classes that are normally visible in the class hierarchy.
307 # If set to NO (the default) these classes will be included in the various
308 # overviews. This option has no effect if EXTRACT_ALL is enabled.
310 HIDE_UNDOC_CLASSES = NO
312 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
313 # friend (class|struct|union) declarations.
314 # If set to NO (the default) these declarations will be included in the
317 HIDE_FRIEND_COMPOUNDS = NO
319 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
320 # documentation blocks found inside the body of a function.
321 # If set to NO (the default) these blocks will be appended to the
322 # function's detailed documentation block.
324 HIDE_IN_BODY_DOCS = NO
326 # The INTERNAL_DOCS tag determines if documentation
327 # that is typed after a \internal command is included. If the tag is set
328 # to NO (the default) then the documentation will be excluded.
329 # Set it to YES to include the internal documentation.
333 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
334 # file names in lower-case letters. If set to YES upper-case letters are also
335 # allowed. This is useful if you have classes or files whose names only differ
336 # in case and if your file system supports case sensitive file names. Windows
337 # and Mac users are advised to set this option to NO.
339 CASE_SENSE_NAMES = YES
341 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
342 # will show members with their full class and namespace scopes in the
343 # documentation. If set to YES the scope will be hidden.
345 HIDE_SCOPE_NAMES = NO
347 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
348 # will put a list of the files that are included by a file in the documentation
351 SHOW_INCLUDE_FILES = NO
353 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
354 # is inserted in the documentation for inline members.
358 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
359 # will sort the (detailed) documentation of file and class members
360 # alphabetically by member name. If set to NO the members will appear in
363 SORT_MEMBER_DOCS = NO
365 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
366 # brief documentation of file, namespace and class members alphabetically
367 # by member name. If set to NO (the default) the members will appear in
372 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
373 # hierarchy of group names into alphabetical order. If set to NO (the default)
374 # the group names will appear in their defined order.
376 SORT_GROUP_NAMES = NO
378 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
379 # sorted by fully-qualified names, including namespaces. If set to
380 # NO (the default), the class list will be sorted only by class name,
381 # not including the namespace part.
382 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
383 # Note: This option applies only to the class list, not to the
386 SORT_BY_SCOPE_NAME = NO
388 # The GENERATE_TODOLIST tag can be used to enable (YES) or
389 # disable (NO) the todo list. This list is created by putting \todo
390 # commands in the documentation.
392 GENERATE_TODOLIST = YES
394 # The GENERATE_TESTLIST tag can be used to enable (YES) or
395 # disable (NO) the test list. This list is created by putting \test
396 # commands in the documentation.
398 GENERATE_TESTLIST = YES
400 # The GENERATE_BUGLIST tag can be used to enable (YES) or
401 # disable (NO) the bug list. This list is created by putting \bug
402 # commands in the documentation.
404 GENERATE_BUGLIST = YES
406 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
407 # disable (NO) the deprecated list. This list is created by putting
408 # \deprecated commands in the documentation.
410 GENERATE_DEPRECATEDLIST= YES
412 # The ENABLED_SECTIONS tag can be used to enable conditional
413 # documentation sections, marked by \if sectionname ... \endif.
417 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
418 # the initial value of a variable or define consists of for it to appear in
419 # the documentation. If the initializer consists of more lines than specified
420 # here it will be hidden. Use a value of 0 to hide initializers completely.
421 # The appearance of the initializer of individual variables and defines in the
422 # documentation can be controlled using \showinitializer or \hideinitializer
423 # command in the documentation regardless of this setting.
425 MAX_INITIALIZER_LINES = 30
427 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
428 # at the bottom of the documentation of classes and structs. If set to YES the
429 # list will mention the files that were used to generate the documentation.
433 # If the sources in your project are distributed over multiple directories
434 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
435 # in the documentation. The default is NO.
437 SHOW_DIRECTORIES = NO
439 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
440 # doxygen should invoke to get the current version for each file (typically from
441 # the version control system). Doxygen will invoke the program by executing (via
442 # popen()) the command <command> <input-file>, where <command> is the value of
443 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
444 # provided by doxygen. Whatever the program writes to standard output
445 # is used as the file version. See the manual for examples.
447 FILE_VERSION_FILTER =
449 #---------------------------------------------------------------------------
450 # configuration options related to warning and progress messages
451 #---------------------------------------------------------------------------
453 # The QUIET tag can be used to turn on/off the messages that are generated
454 # by doxygen. Possible values are YES and NO. If left blank NO is used.
458 # The WARNINGS tag can be used to turn on/off the warning messages that are
459 # generated by doxygen. Possible values are YES and NO. If left blank
464 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
465 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
466 # automatically be disabled.
468 WARN_IF_UNDOCUMENTED = YES
470 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
471 # potential errors in the documentation, such as not documenting some
472 # parameters in a documented function, or documenting parameters that
473 # don't exist or using markup commands wrongly.
475 WARN_IF_DOC_ERROR = YES
477 # This WARN_NO_PARAMDOC option can be abled to get warnings for
478 # functions that are documented, but have no documentation for their parameters
479 # or return value. If set to NO (the default) doxygen will only warn about
480 # wrong or incomplete parameter documentation, but not about the absence of
483 WARN_NO_PARAMDOC = YES
485 # The WARN_FORMAT tag determines the format of the warning messages that
486 # doxygen can produce. The string should contain the $file, $line, and $text
487 # tags, which will be replaced by the file and line number from which the
488 # warning originated and the warning text. Optionally the format may contain
489 # $version, which will be replaced by the version of the file (if it could
490 # be obtained via FILE_VERSION_FILTER)
492 WARN_FORMAT = "$file:$line: $text"
494 # The WARN_LOGFILE tag can be used to specify a file to which warning
495 # and error messages should be written. If left blank the output is written
500 #---------------------------------------------------------------------------
501 # configuration options related to the input files
502 #---------------------------------------------------------------------------
504 # The INPUT tag can be used to specify the files and/or directories that contain
505 # documented source files. You may enter file names like "myfile.cpp" or
506 # directories like "/usr/src/myproject". Separate the files or directories
509 INPUT = @top_srcdir@/src/lib
511 # This tag can be used to specify the character encoding of the source files
512 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
513 # also the default input encoding. Doxygen uses libiconv (or the iconv built
514 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
515 # the list of possible encodings.
517 INPUT_ENCODING = UTF-8
519 # If the value of the INPUT tag contains directories, you can use the
520 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
521 # and *.h) to filter out the source-files in the directories. If left
522 # blank the following patterns are tested:
523 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
524 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
526 FILE_PATTERNS = *.c *.h *.x
528 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
529 # should be searched for input files as well. Possible values are YES and NO.
530 # If left blank NO is used.
534 # The EXCLUDE tag can be used to specify files and/or directories that should
535 # excluded from the INPUT source files. This way you can easily exclude a
536 # subdirectory from a directory tree whose root is specified with the INPUT tag.
540 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
541 # directories that are symbolic links (a Unix filesystem feature) are excluded
544 EXCLUDE_SYMLINKS = NO
546 # If the value of the INPUT tag contains directories, you can use the
547 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
548 # certain files from those directories. Note that the wildcards are matched
549 # against the file with absolute path, so to exclude all test directories
550 # for example use the pattern */test/*
554 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
555 # (namespaces, classes, functions, etc.) that should be excluded from the
556 # output. The symbol name can be a fully qualified name, a word, or if the
557 # wildcard * is used, a substring. Examples: ANamespace, AClass,
558 # AClass::ANamespace, ANamespace::*Test
562 # The EXAMPLE_PATH tag can be used to specify one or more files or
563 # directories that contain example code fragments that are included (see
564 # the \include command).
568 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
569 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
570 # and *.h) to filter out the source-files in the directories. If left
571 # blank all files are included.
575 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
576 # searched for input files to be used with the \include or \dontinclude
577 # commands irrespective of the value of the RECURSIVE tag.
578 # Possible values are YES and NO. If left blank NO is used.
580 EXAMPLE_RECURSIVE = NO
582 # The IMAGE_PATH tag can be used to specify one or more files or
583 # directories that contain image that are included in the documentation (see
584 # the \image command).
588 # The INPUT_FILTER tag can be used to specify a program that doxygen should
589 # invoke to filter for each input file. Doxygen will invoke the filter program
590 # by executing (via popen()) the command <filter> <input-file>, where <filter>
591 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
592 # input file. Doxygen will then use the output that the filter program writes
593 # to standard output. If FILTER_PATTERNS is specified, this tag will be
598 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
599 # basis. Doxygen will compare the file name with each pattern and apply the
600 # filter if there is a match. The filters are a list of the form:
601 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
602 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
603 # is applied to all files.
607 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
608 # INPUT_FILTER) will be used to filter the input files when producing source
609 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
611 FILTER_SOURCE_FILES = NO
613 #---------------------------------------------------------------------------
614 # configuration options related to source browsing
615 #---------------------------------------------------------------------------
617 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
618 # be generated. Documented entities will be cross-referenced with these sources.
619 # Note: To get rid of all source code in the generated output, make sure also
620 # VERBATIM_HEADERS is set to NO.
624 # Setting the INLINE_SOURCES tag to YES will include the body
625 # of functions and classes directly in the documentation.
629 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
630 # doxygen to hide any special comment blocks from generated source code
631 # fragments. Normal C and C++ comments will always remain visible.
633 STRIP_CODE_COMMENTS = YES
635 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
636 # then for each documented function all documented
637 # functions referencing it will be listed.
639 REFERENCED_BY_RELATION = YES
641 # If the REFERENCES_RELATION tag is set to YES (the default)
642 # then for each documented function all documented entities
643 # called/used by that function will be listed.
645 REFERENCES_RELATION = YES
647 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
648 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
649 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
650 # link to the source code. Otherwise they will link to the documentstion.
652 REFERENCES_LINK_SOURCE = YES
654 # If the USE_HTAGS tag is set to YES then the references to source code
655 # will point to the HTML generated by the htags(1) tool instead of doxygen
656 # built-in source browser. The htags tool is part of GNU's global source
657 # tagging system (see http://www.gnu.org/software/global/global.html). You
658 # will need version 4.8.6 or higher.
662 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
663 # will generate a verbatim copy of the header file for each class for
664 # which an include is specified. Set to NO to disable this.
666 VERBATIM_HEADERS = NO
668 #---------------------------------------------------------------------------
669 # configuration options related to the alphabetical class index
670 #---------------------------------------------------------------------------
672 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
673 # of all compounds will be generated. Enable this if the project
674 # contains a lot of classes, structs, unions or interfaces.
676 ALPHABETICAL_INDEX = YES
678 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
679 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
680 # in which this list will be split (can be a number in the range [1..20])
682 COLS_IN_ALPHA_INDEX = 2
684 # In case all classes in a project start with a common prefix, all
685 # classes will be put under the same header in the alphabetical index.
686 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
687 # should be ignored while generating the index headers.
691 #---------------------------------------------------------------------------
692 # configuration options related to the HTML output
693 #---------------------------------------------------------------------------
695 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
696 # generate HTML output.
700 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
701 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
702 # put in front of it. If left blank `html' will be used as the default path.
706 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
707 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
708 # doxygen will generate files with .html extension.
710 HTML_FILE_EXTENSION = .html
712 # The HTML_HEADER tag can be used to specify a personal HTML header for
713 # each generated HTML page. If it is left blank doxygen will generate a
716 HTML_HEADER = @srcdir@/head.html
718 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
719 # each generated HTML page. If it is left blank doxygen will generate a
722 HTML_FOOTER = @srcdir@/foot.html
724 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
725 # style sheet that is used by each HTML page. It can be used to
726 # fine-tune the look of the HTML output. If the tag is left blank doxygen
727 # will generate a default style sheet. Note that doxygen will try to copy
728 # the style sheet file to the HTML output directory, so don't put your own
729 # stylesheet in the HTML output directory as well, or it will be erased!
731 HTML_STYLESHEET = @srcdir@/e.css
733 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
734 # files or namespaces will be aligned in HTML using tables. If set to
735 # NO a bullet list will be used.
737 HTML_ALIGN_MEMBERS = YES
739 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
740 # will be generated that can be used as input for tools like the
741 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
742 # of the generated HTML documentation.
744 GENERATE_HTMLHELP = NO
746 # If the GENERATE_DOCSET tag is set to YES, additional index files
747 # will be generated that can be used as input for Apple's Xcode 3
748 # integrated development environment, introduced with OSX 10.5 (Leopard).
749 # To create a documentation set, doxygen will generate a Makefile in the
750 # HTML output directory. Running make will produce the docset in that
751 # directory and running "make install" will install the docset in
752 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
757 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
758 # feed. A documentation feed provides an umbrella under which multiple
759 # documentation sets from a single provider (such as a company or product suite)
762 DOCSET_FEEDNAME = "Doxygen generated docs"
764 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
765 # should uniquely identify the documentation set bundle. This should be a
766 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
767 # will append .docset to the name.
769 DOCSET_BUNDLE_ID = org.doxygen.Project
771 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
772 # documentation will contain sections that can be hidden and shown after the
773 # page has loaded. For this to work a browser that supports
774 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
775 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
777 HTML_DYNAMIC_SECTIONS = NO
779 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
780 # be used to specify the file name of the resulting .chm file. You
781 # can add a path in front of the file if the result should not be
782 # written to the html output directory.
786 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
787 # be used to specify the location (absolute path including file name) of
788 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
789 # the HTML help compiler on the generated index.hhp.
793 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
794 # controls if a separate .chi index file is generated (YES) or that
795 # it should be included in the master .chm file (NO).
799 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
800 # controls whether a binary table of contents is generated (YES) or a
801 # normal table of contents (NO) in the .chm file.
805 # The TOC_EXPAND flag can be set to YES to add extra items for group members
806 # to the contents of the HTML help documentation and to the tree view.
810 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
811 # top of each HTML page. The value NO (the default) enables the index and
812 # the value YES disables it.
816 # This tag can be used to set the number of enum values (range [1..20])
817 # that doxygen will group on one line in the generated HTML documentation.
819 ENUM_VALUES_PER_LINE = 1
821 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
822 # generated containing a tree-like index structure (just like the one that
823 # is generated for HTML Help). For this to work a browser that supports
824 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
825 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
826 # probably better off using the HTML help feature.
828 GENERATE_TREEVIEW = NO
830 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
831 # used to set the initial width (in pixels) of the frame in which the tree
836 #---------------------------------------------------------------------------
837 # configuration options related to the LaTeX output
838 #---------------------------------------------------------------------------
840 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
841 # generate Latex output.
845 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
846 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
847 # put in front of it. If left blank `latex' will be used as the default path.
851 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
852 # invoked. If left blank `latex' will be used as the default command name.
854 LATEX_CMD_NAME = latex
856 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
857 # generate index for LaTeX. If left blank `makeindex' will be used as the
858 # default command name.
860 MAKEINDEX_CMD_NAME = makeindex
862 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
863 # LaTeX documents. This may be useful for small projects and may help to
864 # save some trees in general.
868 # The PAPER_TYPE tag can be used to set the paper type that is used
869 # by the printer. Possible values are: a4, a4wide, letter, legal and
870 # executive. If left blank a4wide will be used.
874 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
875 # packages that should be included in the LaTeX output.
879 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
880 # the generated latex document. The header should contain everything until
881 # the first chapter. If it is left blank doxygen will generate a
882 # standard header. Notice: only use this tag if you know what you are doing!
886 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
887 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
888 # contain links (just like the HTML output) instead of page references
889 # This makes the output suitable for online browsing using a pdf viewer.
893 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
894 # plain latex in the generated Makefile. Set this option to YES to get a
895 # higher quality PDF documentation.
899 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
900 # command to the generated LaTeX files. This will instruct LaTeX to keep
901 # running if errors occur, instead of asking the user for help.
902 # This option is also used when generating formulas in HTML.
906 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
907 # include the index chapters (such as File Index, Compound Index, etc.)
910 LATEX_HIDE_INDICES = NO
912 #---------------------------------------------------------------------------
913 # configuration options related to the RTF output
914 #---------------------------------------------------------------------------
916 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
917 # The RTF output is optimized for Word 97 and may not look very pretty with
918 # other RTF readers or editors.
922 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
923 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
924 # put in front of it. If left blank `rtf' will be used as the default path.
928 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
929 # RTF documents. This may be useful for small projects and may help to
930 # save some trees in general.
934 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
935 # will contain hyperlink fields. The RTF file will
936 # contain links (just like the HTML output) instead of page references.
937 # This makes the output suitable for online browsing using WORD or other
938 # programs which support those fields.
939 # Note: wordpad (write) and others do not support links.
943 # Load stylesheet definitions from file. Syntax is similar to doxygen's
944 # config file, i.e. a series of assignments. You only have to provide
945 # replacements, missing definitions are set to their default value.
947 RTF_STYLESHEET_FILE =
949 # Set optional variables used in the generation of an rtf document.
950 # Syntax is similar to doxygen's config file.
952 RTF_EXTENSIONS_FILE =
954 #---------------------------------------------------------------------------
955 # configuration options related to the man page output
956 #---------------------------------------------------------------------------
958 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
963 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
964 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
965 # put in front of it. If left blank `man' will be used as the default path.
969 # The MAN_EXTENSION tag determines the extension that is added to
970 # the generated man pages (default is the subroutine's section .3)
974 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
975 # then it will generate one additional man file for each entity
976 # documented in the real man page(s). These additional files
977 # only source the real man page, but without them the man command
978 # would be unable to find the correct page. The default is NO.
982 #---------------------------------------------------------------------------
983 # configuration options related to the XML output
984 #---------------------------------------------------------------------------
986 # If the GENERATE_XML tag is set to YES Doxygen will
987 # generate an XML file that captures the structure of
988 # the code including all documentation.
992 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
993 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
994 # put in front of it. If left blank `xml' will be used as the default path.
998 # The XML_SCHEMA tag can be used to specify an XML schema,
999 # which can be used by a validating XML parser to check the
1000 # syntax of the XML files.
1004 # The XML_DTD tag can be used to specify an XML DTD,
1005 # which can be used by a validating XML parser to check the
1006 # syntax of the XML files.
1010 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1011 # dump the program listings (including syntax highlighting
1012 # and cross-referencing information) to the XML output. Note that
1013 # enabling this will significantly increase the size of the XML output.
1015 XML_PROGRAMLISTING = YES
1017 #---------------------------------------------------------------------------
1018 # configuration options for the AutoGen Definitions output
1019 #---------------------------------------------------------------------------
1021 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1022 # generate an AutoGen Definitions (see autogen.sf.net) file
1023 # that captures the structure of the code including all
1024 # documentation. Note that this feature is still experimental
1025 # and incomplete at the moment.
1027 GENERATE_AUTOGEN_DEF = NO
1029 #---------------------------------------------------------------------------
1030 # configuration options related to the Perl module output
1031 #---------------------------------------------------------------------------
1033 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1034 # generate a Perl module file that captures the structure of
1035 # the code including all documentation. Note that this
1036 # feature is still experimental and incomplete at the
1039 GENERATE_PERLMOD = NO
1041 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1042 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1043 # to generate PDF and DVI output from the Perl module output.
1047 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1048 # nicely formatted so it can be parsed by a human reader. This is useful
1049 # if you want to understand what is going on. On the other hand, if this
1050 # tag is set to NO the size of the Perl module output will be much smaller
1051 # and Perl will parse it just the same.
1053 PERLMOD_PRETTY = YES
1055 # The names of the make variables in the generated doxyrules.make file
1056 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1057 # This is useful so different doxyrules.make files included by the same
1058 # Makefile don't overwrite each other's variables.
1060 PERLMOD_MAKEVAR_PREFIX =
1062 #---------------------------------------------------------------------------
1063 # Configuration options related to the preprocessor
1064 #---------------------------------------------------------------------------
1066 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1067 # evaluate all C-preprocessor directives found in the sources and include
1070 ENABLE_PREPROCESSING = YES
1072 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1073 # names in the source code. If set to NO (the default) only conditional
1074 # compilation will be performed. Macro expansion can be done in a controlled
1075 # way by setting EXPAND_ONLY_PREDEF to YES.
1077 MACRO_EXPANSION = YES
1079 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1080 # then the macro expansion is limited to the macros specified with the
1081 # PREDEFINED and EXPAND_AS_DEFINED tags.
1083 EXPAND_ONLY_PREDEF = YES
1085 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1086 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1088 SEARCH_INCLUDES = NO
1090 # The INCLUDE_PATH tag can be used to specify one or more directories that
1091 # contain include files that are not input files but should be processed by
1096 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1097 # patterns (like *.h and *.hpp) to filter out the header-files in the
1098 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1101 INCLUDE_FILE_PATTERNS =
1103 # The PREDEFINED tag can be used to specify one or more macro names that
1104 # are defined before the preprocessor is started (similar to the -D option of
1105 # gcc). The argument of the tag is a list of macros of the form: name
1106 # or name=definition (no spaces). If the definition and the = are
1107 # omitted =1 is assumed. To prevent a macro definition from being
1108 # undefined via #undef or recursively expanded use the := operator
1109 # instead of the = operator.
1111 PREDEFINED = __UNUSED__=
1113 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1114 # this tag can be used to specify a list of macro names that should be expanded.
1115 # The macro definition that is found in the sources will be used.
1116 # Use the PREDEFINED tag if you want to use a different macro definition.
1120 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1121 # doxygen's preprocessor will remove all function-like macros that are alone
1122 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1123 # function macros are typically used for boiler-plate code, and will confuse
1124 # the parser if not removed.
1126 SKIP_FUNCTION_MACROS = YES
1128 #---------------------------------------------------------------------------
1129 # Configuration::additions related to external references
1130 #---------------------------------------------------------------------------
1132 # The TAGFILES option can be used to specify one or more tagfiles.
1133 # Optionally an initial location of the external documentation
1134 # can be added for each tagfile. The format of a tag file without
1135 # this location is as follows:
1136 # TAGFILES = file1 file2 ...
1137 # Adding location for the tag files is done as follows:
1138 # TAGFILES = file1=loc1 "file2 = loc2" ...
1139 # where "loc1" and "loc2" can be relative or absolute paths or
1140 # URLs. If a location is present for each tag, the installdox tool
1141 # does not have to be run to correct the links.
1142 # Note that each tag file must have a unique name
1143 # (where the name does NOT include the path)
1144 # If a tag file is not located in the directory in which doxygen
1145 # is run, you must also specify the path to the tagfile here.
1149 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1150 # a tag file that is based on the input files it reads.
1154 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1155 # in the class index. If set to NO only the inherited external classes
1160 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1161 # in the modules index. If set to NO, only the current project's groups will
1164 EXTERNAL_GROUPS = YES
1166 # The PERL_PATH should be the absolute path and name of the perl script
1167 # interpreter (i.e. the result of `which perl').
1169 PERL_PATH = /usr/bin/perl
1171 #---------------------------------------------------------------------------
1172 # Configuration options related to the dot tool
1173 #---------------------------------------------------------------------------
1175 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1176 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1177 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1178 # this option is superseded by the HAVE_DOT option below. This is only a
1179 # fallback. It is recommended to install and use dot, since it yields more
1184 # You can define message sequence charts within doxygen comments using the \msc
1185 # command. Doxygen will then run the mscgen tool (see
1186 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1187 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1188 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1189 # default search path.
1193 # If set to YES, the inheritance and collaboration graphs will hide
1194 # inheritance and usage relations if the target is undocumented
1195 # or is not a class.
1197 HIDE_UNDOC_RELATIONS = YES
1199 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1200 # available from the path. This tool is part of Graphviz, a graph visualization
1201 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1202 # have no effect if this option is set to NO (the default)
1206 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1207 # will generate a graph for each documented class showing the direct and
1208 # indirect inheritance relations. Setting this tag to YES will force the
1209 # the CLASS_DIAGRAMS tag to NO.
1213 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1214 # will generate a graph for each documented class showing the direct and
1215 # indirect implementation dependencies (inheritance, containment, and
1216 # class references variables) of the class with other documented classes.
1218 COLLABORATION_GRAPH = NO
1220 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1221 # will generate a graph for groups, showing the direct groups dependencies
1225 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1226 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1231 # If set to YES, the inheritance and collaboration graphs will show the
1232 # relations between templates and their instances.
1234 TEMPLATE_RELATIONS = NO
1236 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1237 # tags are set to YES then doxygen will generate a graph for each documented
1238 # file showing the direct and indirect include dependencies of the file with
1239 # other documented files.
1243 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1244 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1245 # documented header file showing the documented files that directly or
1246 # indirectly include this file.
1248 INCLUDED_BY_GRAPH = NO
1250 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1251 # doxygen will generate a call dependency graph for every global function
1252 # or class method. Note that enabling this option will significantly increase
1253 # the time of a run. So in most cases it will be better to enable call graphs
1254 # for selected functions only using the \callgraph command.
1258 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1259 # doxygen will generate a caller dependency graph for every global function
1260 # or class method. Note that enabling this option will significantly increase
1261 # the time of a run. So in most cases it will be better to enable caller
1262 # graphs for selected functions only using the \callergraph command.
1266 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1267 # will graphical hierarchy of all classes instead of a textual one.
1269 GRAPHICAL_HIERARCHY = NO
1271 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1272 # then doxygen will show the dependencies a directory has on other directories
1273 # in a graphical way. The dependency relations are determined by the #include
1274 # relations between the files in the directories.
1276 DIRECTORY_GRAPH = YES
1278 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1279 # generated by dot. Possible values are png, jpg, or gif
1280 # If left blank png will be used.
1282 DOT_IMAGE_FORMAT = png
1284 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1285 # found. If left blank, it is assumed the dot tool can be found in the path.
1289 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1290 # contain dot files that are included in the documentation (see the
1291 # \dotfile command).
1295 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1296 # nodes that will be shown in the graph. If the number of nodes in a graph
1297 # becomes larger than this value, doxygen will truncate the graph, which is
1298 # visualized by representing a node as a red box. Note that doxygen if the
1299 # number of direct children of the root node in a graph is already larger than
1300 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1301 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1303 DOT_GRAPH_MAX_NODES = 50
1305 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1306 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1307 # from the root by following a path via at most 3 edges will be shown. Nodes
1308 # that lay further from the root node will be omitted. Note that setting this
1309 # option to 1 or 2 may greatly reduce the computation time needed for large
1310 # code bases. Also note that the size of a graph can be further restricted by
1311 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1313 MAX_DOT_GRAPH_DEPTH = 0
1315 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1316 # background. This is enabled by default, which results in a transparent
1317 # background. Warning: Depending on the platform used, enabling this option
1318 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1319 # become hard to read).
1321 DOT_TRANSPARENT = YES
1323 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1324 # files in one run (i.e. multiple -o and -T options on the command line). This
1325 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1326 # support this, this feature is disabled by default.
1328 DOT_MULTI_TARGETS = NO
1330 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1331 # generate a legend page explaining the meaning of the various boxes and
1332 # arrows in the dot generated graphs.
1334 GENERATE_LEGEND = YES
1336 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1337 # remove the intermediate dot files that are used to generate
1338 # the various graphs.
1342 #---------------------------------------------------------------------------
1343 # Configuration::additions related to the search engine
1344 #---------------------------------------------------------------------------
1346 # The SEARCHENGINE tag specifies whether or not a search engine should be
1347 # used. If set to NO the values of all tags below this one will be ignored.