3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME = tpsession
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 = $(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 = YES
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
102 INLINE_INHERITED_MEMB = 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
117 STRIP_FROM_PATH = $(SRCDIR)
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 = NO
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
156 MULTILINE_CPP_IS_BRIEF = 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 = NO
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 = YES
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 # For Microsoft's IDL there are propget and propput attributes to indicate getter
231 # and setter methods for a property. Setting this option to YES (the default)
232 # will make doxygen to replace the get and set methods by a property in the
233 # documentation. This will only work if the methods are indeed getting or
234 # setting a simple type. If this is not the case, or you want to show the
235 # methods anyway, you should set this option to NO.
237 IDL_PROPERTY_SUPPORT = NO
239 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
240 # tag is set to YES, then doxygen will reuse the documentation of the first
241 # member in the group (if any) for the other members of the group. By default
242 # all members of a group must be documented explicitly.
244 DISTRIBUTE_GROUP_DOC = YES
246 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
247 # the same type (for instance a group of public functions) to be put as a
248 # subgroup of that type (e.g. under the Public Functions section). Set it to
249 # NO to prevent subgrouping. Alternatively, this can be done per class using
250 # the \nosubgrouping command.
254 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
255 # is documented as struct, union, or enum with the name of the typedef. So
256 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
257 # with name TypeT. When disabled the typedef will appear as a member of a file,
258 # namespace, or class. And the struct will be named TypeS. This can typically
259 # be useful for C code in case the coding convention dictates that all compound
260 # types are typedef'ed and only the typedef is referenced, never the tag name.
262 TYPEDEF_HIDES_STRUCT = NO
264 #---------------------------------------------------------------------------
265 # Build related configuration options
266 #---------------------------------------------------------------------------
268 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
269 # documentation are documented, even if no documentation was available.
270 # Private class members and static file members will be hidden unless
271 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
275 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
276 # will be included in the documentation.
280 # If the EXTRACT_STATIC tag is set to YES all static members of a file
281 # will be included in the documentation.
285 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
286 # defined locally in source files will be included in the documentation.
287 # If set to NO only classes defined in header files are included.
289 EXTRACT_LOCAL_CLASSES = NO
291 # This flag is only useful for Objective-C code. When set to YES local
292 # methods, which are defined in the implementation section but not in
293 # the interface are included in the documentation.
294 # If set to NO (the default) only methods in the interface are included.
296 EXTRACT_LOCAL_METHODS = NO
298 # If this flag is set to YES, the members of anonymous namespaces will be
299 # extracted and appear in the documentation as a namespace called
300 # 'anonymous_namespace{file}', where file will be replaced with the base
301 # name of the file that contains the anonymous namespace. By default
302 # anonymous namespace are hidden.
304 EXTRACT_ANON_NSPACES = NO
306 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
307 # undocumented members of documented classes, files or namespaces.
308 # If set to NO (the default) these members will be included in the
309 # various overviews, but no documentation section is generated.
310 # This option has no effect if EXTRACT_ALL is enabled.
312 HIDE_UNDOC_MEMBERS = NO
314 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
315 # undocumented classes that are normally visible in the class hierarchy.
316 # If set to NO (the default) these classes will be included in the various
317 # overviews. This option has no effect if EXTRACT_ALL is enabled.
319 HIDE_UNDOC_CLASSES = NO
321 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
322 # friend (class|struct|union) declarations.
323 # If set to NO (the default) these declarations will be included in the
326 HIDE_FRIEND_COMPOUNDS = YES
328 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
329 # documentation blocks found inside the body of a function.
330 # If set to NO (the default) these blocks will be appended to the
331 # function's detailed documentation block.
333 HIDE_IN_BODY_DOCS = NO
335 # The INTERNAL_DOCS tag determines if documentation
336 # that is typed after a \internal command is included. If the tag is set
337 # to NO (the default) then the documentation will be excluded.
338 # Set it to YES to include the internal documentation.
342 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
343 # file names in lower-case letters. If set to YES upper-case letters are also
344 # allowed. This is useful if you have classes or files whose names only differ
345 # in case and if your file system supports case sensitive file names. Windows
346 # and Mac users are advised to set this option to NO.
348 CASE_SENSE_NAMES = YES
350 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
351 # will show members with their full class and namespace scopes in the
352 # documentation. If set to YES the scope will be hidden.
354 HIDE_SCOPE_NAMES = YES
356 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
357 # will put a list of the files that are included by a file in the documentation
360 SHOW_INCLUDE_FILES = YES
362 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
363 # is inserted in the documentation for inline members.
367 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
368 # will sort the (detailed) documentation of file and class members
369 # alphabetically by member name. If set to NO the members will appear in
372 SORT_MEMBER_DOCS = NO
374 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
375 # brief documentation of file, namespace and class members alphabetically
376 # by member name. If set to NO (the default) the members will appear in
381 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
382 # hierarchy of group names into alphabetical order. If set to NO (the default)
383 # the group names will appear in their defined order.
385 SORT_GROUP_NAMES = NO
387 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
388 # sorted by fully-qualified names, including namespaces. If set to
389 # NO (the default), the class list will be sorted only by class name,
390 # not including the namespace part.
391 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
392 # Note: This option applies only to the class list, not to the
395 SORT_BY_SCOPE_NAME = NO
397 # The GENERATE_TODOLIST tag can be used to enable (YES) or
398 # disable (NO) the todo list. This list is created by putting \todo
399 # commands in the documentation.
401 GENERATE_TODOLIST = NO
403 # The GENERATE_TESTLIST tag can be used to enable (YES) or
404 # disable (NO) the test list. This list is created by putting \test
405 # commands in the documentation.
407 GENERATE_TESTLIST = NO
409 # The GENERATE_BUGLIST tag can be used to enable (YES) or
410 # disable (NO) the bug list. This list is created by putting \bug
411 # commands in the documentation.
413 GENERATE_BUGLIST = NO
415 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
416 # disable (NO) the deprecated list. This list is created by putting
417 # \deprecated commands in the documentation.
419 GENERATE_DEPRECATEDLIST= YES
421 # The ENABLED_SECTIONS tag can be used to enable conditional
422 # documentation sections, marked by \if sectionname ... \endif.
426 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
427 # the initial value of a variable or define consists of for it to appear in
428 # the documentation. If the initializer consists of more lines than specified
429 # here it will be hidden. Use a value of 0 to hide initializers completely.
430 # The appearance of the initializer of individual variables and defines in the
431 # documentation can be controlled using \showinitializer or \hideinitializer
432 # command in the documentation regardless of this setting.
434 MAX_INITIALIZER_LINES = 0
436 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
437 # at the bottom of the documentation of classes and structs. If set to YES the
438 # list will mention the files that were used to generate the documentation.
442 # If the sources in your project are distributed over multiple directories
443 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
444 # in the documentation. The default is NO.
446 SHOW_DIRECTORIES = NO
448 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
449 # This will remove the Files entry from the Quick Index and from the
450 # Folder Tree View (if specified). The default is YES.
454 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
455 # Namespaces page. This will remove the Namespaces entry from the Quick Index
456 # and from the Folder Tree View (if specified). The default is YES.
458 SHOW_NAMESPACES = YES
460 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
461 # doxygen should invoke to get the current version for each file (typically from
462 # the version control system). Doxygen will invoke the program by executing (via
463 # popen()) the command <command> <input-file>, where <command> is the value of
464 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
465 # provided by doxygen. Whatever the program writes to standard output
466 # is used as the file version. See the manual for examples.
468 FILE_VERSION_FILTER =
470 #---------------------------------------------------------------------------
471 # configuration options related to warning and progress messages
472 #---------------------------------------------------------------------------
474 # The QUIET tag can be used to turn on/off the messages that are generated
475 # by doxygen. Possible values are YES and NO. If left blank NO is used.
479 # The WARNINGS tag can be used to turn on/off the warning messages that are
480 # generated by doxygen. Possible values are YES and NO. If left blank
485 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
486 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
487 # automatically be disabled.
489 WARN_IF_UNDOCUMENTED = YES
491 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
492 # potential errors in the documentation, such as not documenting some
493 # parameters in a documented function, or documenting parameters that
494 # don't exist or using markup commands wrongly.
496 WARN_IF_DOC_ERROR = YES
498 # This WARN_NO_PARAMDOC option can be abled to get warnings for
499 # functions that are documented, but have no documentation for their parameters
500 # or return value. If set to NO (the default) doxygen will only warn about
501 # wrong or incomplete parameter documentation, but not about the absence of
504 WARN_NO_PARAMDOC = YES
506 # The WARN_FORMAT tag determines the format of the warning messages that
507 # doxygen can produce. The string should contain the $file, $line, and $text
508 # tags, which will be replaced by the file and line number from which the
509 # warning originated and the warning text. Optionally the format may contain
510 # $version, which will be replaced by the version of the file (if it could
511 # be obtained via FILE_VERSION_FILTER)
513 WARN_FORMAT = "$file:$line: $text"
515 # The WARN_LOGFILE tag can be used to specify a file to which warning
516 # and error messages should be written. If left blank the output is written
519 WARN_LOGFILE = doxygen.log
521 #---------------------------------------------------------------------------
522 # configuration options related to the input files
523 #---------------------------------------------------------------------------
525 # The INPUT tag can be used to specify the files and/or directories that contain
526 # documented source files. You may enter file names like "myfile.cpp" or
527 # directories like "/usr/src/myproject". Separate the files or directories
532 # This tag can be used to specify the character encoding of the source files
533 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
534 # also the default input encoding. Doxygen uses libiconv (or the iconv built
535 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
536 # the list of possible encodings.
538 INPUT_ENCODING = UTF-8
540 # If the value of the INPUT tag contains directories, you can use the
541 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
542 # and *.h) to filter out the source-files in the directories. If left
543 # blank the following patterns are tested:
544 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
545 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
547 FILE_PATTERNS = *.h *.cpp *.dox
549 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
550 # should be searched for input files as well. Possible values are YES and NO.
551 # If left blank NO is used.
555 # The EXCLUDE tag can be used to specify files and/or directories that should
556 # excluded from the INPUT source files. This way you can easily exclude a
557 # subdirectory from a directory tree whose root is specified with the INPUT tag.
561 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
562 # directories that are symbolic links (a Unix filesystem feature) are excluded
565 EXCLUDE_SYMLINKS = NO
567 # If the value of the INPUT tag contains directories, you can use the
568 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
569 # certain files from those directories. Note that the wildcards are matched
570 # against the file with absolute path, so to exclude all test directories
571 # for example use the pattern */test/*
575 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
576 # (namespaces, classes, functions, etc.) that should be excluded from the
577 # output. The symbol name can be a fully qualified name, a word, or if the
578 # wildcard * is used, a substring. Examples: ANamespace, AClass,
579 # AClass::ANamespace, ANamespace::*Test
583 # The EXAMPLE_PATH tag can be used to specify one or more files or
584 # directories that contain example code fragments that are included (see
585 # the \include command).
589 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
590 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
591 # and *.h) to filter out the source-files in the directories. If left
592 # blank all files are included.
596 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
597 # searched for input files to be used with the \include or \dontinclude
598 # commands irrespective of the value of the RECURSIVE tag.
599 # Possible values are YES and NO. If left blank NO is used.
601 EXAMPLE_RECURSIVE = YES
603 # The IMAGE_PATH tag can be used to specify one or more files or
604 # directories that contain image that are included in the documentation (see
605 # the \image command).
609 # The INPUT_FILTER tag can be used to specify a program that doxygen should
610 # invoke to filter for each input file. Doxygen will invoke the filter program
611 # by executing (via popen()) the command <filter> <input-file>, where <filter>
612 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
613 # input file. Doxygen will then use the output that the filter program writes
614 # to standard output. If FILTER_PATTERNS is specified, this tag will be
619 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
620 # basis. Doxygen will compare the file name with each pattern and apply the
621 # filter if there is a match. The filters are a list of the form:
622 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
623 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
624 # is applied to all files.
628 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
629 # INPUT_FILTER) will be used to filter the input files when producing source
630 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
632 FILTER_SOURCE_FILES = NO
634 #---------------------------------------------------------------------------
635 # configuration options related to source browsing
636 #---------------------------------------------------------------------------
638 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
639 # be generated. Documented entities will be cross-referenced with these sources.
640 # Note: To get rid of all source code in the generated output, make sure also
641 # VERBATIM_HEADERS is set to NO.
645 # Setting the INLINE_SOURCES tag to YES will include the body
646 # of functions and classes directly in the documentation.
650 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
651 # doxygen to hide any special comment blocks from generated source code
652 # fragments. Normal C and C++ comments will always remain visible.
654 STRIP_CODE_COMMENTS = YES
656 # If the REFERENCED_BY_RELATION tag is set to YES
657 # then for each documented function all documented
658 # functions referencing it will be listed.
660 REFERENCED_BY_RELATION = NO
662 # If the REFERENCES_RELATION tag is set to YES
663 # then for each documented function all documented entities
664 # called/used by that function will be listed.
666 REFERENCES_RELATION = NO
668 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
669 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
670 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
671 # link to the source code. Otherwise they will link to the documentstion.
673 REFERENCES_LINK_SOURCE = YES
675 # If the USE_HTAGS tag is set to YES then the references to source code
676 # will point to the HTML generated by the htags(1) tool instead of doxygen
677 # built-in source browser. The htags tool is part of GNU's global source
678 # tagging system (see http://www.gnu.org/software/global/global.html). You
679 # will need version 4.8.6 or higher.
683 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
684 # will generate a verbatim copy of the header file for each class for
685 # which an include is specified. Set to NO to disable this.
687 VERBATIM_HEADERS = YES
689 #---------------------------------------------------------------------------
690 # configuration options related to the alphabetical class index
691 #---------------------------------------------------------------------------
693 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
694 # of all compounds will be generated. Enable this if the project
695 # contains a lot of classes, structs, unions or interfaces.
697 ALPHABETICAL_INDEX = NO
699 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
700 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
701 # in which this list will be split (can be a number in the range [1..20])
703 COLS_IN_ALPHA_INDEX = 5
705 # In case all classes in a project start with a common prefix, all
706 # classes will be put under the same header in the alphabetical index.
707 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
708 # should be ignored while generating the index headers.
712 #---------------------------------------------------------------------------
713 # configuration options related to the HTML output
714 #---------------------------------------------------------------------------
716 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
717 # generate HTML output.
721 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
722 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
723 # put in front of it. If left blank `html' will be used as the default path.
727 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
728 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
729 # doxygen will generate files with .html extension.
731 HTML_FILE_EXTENSION = .html
733 # The HTML_HEADER tag can be used to specify a personal HTML header for
734 # each generated HTML page. If it is left blank doxygen will generate a
737 HTML_HEADER = doxygen-header.html
739 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
740 # each generated HTML page. If it is left blank doxygen will generate a
743 HTML_FOOTER = doxygen-footer.html
745 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
746 # style sheet that is used by each HTML page. It can be used to
747 # fine-tune the look of the HTML output. If the tag is left blank doxygen
748 # will generate a default style sheet. Note that doxygen will try to copy
749 # the style sheet file to the HTML output directory, so don't put your own
750 # stylesheet in the HTML output directory as well, or it will be erased!
752 HTML_STYLESHEET = doxygen.css
754 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
755 # files or namespaces will be aligned in HTML using tables. If set to
756 # NO a bullet list will be used.
758 HTML_ALIGN_MEMBERS = NO
760 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
761 # will be generated that can be used as input for tools like the
762 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
763 # of the generated HTML documentation.
765 GENERATE_HTMLHELP = NO
767 # If the GENERATE_DOCSET tag is set to YES, additional index files
768 # will be generated that can be used as input for Apple's Xcode 3
769 # integrated development environment, introduced with OSX 10.5 (Leopard).
770 # To create a documentation set, doxygen will generate a Makefile in the
771 # HTML output directory. Running make will produce the docset in that
772 # directory and running "make install" will install the docset in
773 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
778 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
779 # feed. A documentation feed provides an umbrella under which multiple
780 # documentation sets from a single provider (such as a company or product suite)
783 DOCSET_FEEDNAME = "Doxygen generated docs"
785 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
786 # should uniquely identify the documentation set bundle. This should be a
787 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
788 # will append .docset to the name.
790 DOCSET_BUNDLE_ID = org.doxygen.Project
792 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
793 # documentation will contain sections that can be hidden and shown after the
794 # page has loaded. For this to work a browser that supports
795 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
796 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
798 HTML_DYNAMIC_SECTIONS = NO
800 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
801 # be used to specify the file name of the resulting .chm file. You
802 # can add a path in front of the file if the result should not be
803 # written to the html output directory.
805 CHM_FILE = ../$(PROJECT).chm
807 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
808 # be used to specify the location (absolute path including file name) of
809 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
810 # the HTML help compiler on the generated index.hhp.
812 HHC_LOCATION = $(HHC_PATH)
814 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
815 # controls if a separate .chi index file is generated (YES) or that
816 # it should be included in the master .chm file (NO).
818 GENERATE_CHI = $(GENERATE_CHI)
820 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
821 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
826 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
827 # controls whether a binary table of contents is generated (YES) or a
828 # normal table of contents (NO) in the .chm file.
832 # The TOC_EXPAND flag can be set to YES to add extra items for group members
833 # to the contents of the HTML help documentation and to the tree view.
837 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
838 # top of each HTML page. The value NO (the default) enables the index and
839 # the value YES disables it.
843 # This tag can be used to set the number of enum values (range [1..20])
844 # that doxygen will group on one line in the generated HTML documentation.
846 ENUM_VALUES_PER_LINE = 4
848 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
849 # structure should be generated to display hierarchical information.
850 # If the tag value is set to FRAME, a side panel will be generated
851 # containing a tree-like index structure (just like the one that
852 # is generated for HTML Help). For this to work a browser that supports
853 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
854 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
855 # probably better off using the HTML help feature. Other possible values
856 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
857 # and Class Hiererachy pages using a tree view instead of an ordered list;
858 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
859 # disables this behavior completely. For backwards compatibility with previous
860 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
863 GENERATE_TREEVIEW = NO
865 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
866 # used to set the initial width (in pixels) of the frame in which the tree
871 # Use this tag to change the font size of Latex formulas included
872 # as images in the HTML documentation. The default is 10. Note that
873 # when you change the font size after a successful doxygen run you need
874 # to manually remove any form_*.png images from the HTML output directory
875 # to force them to be regenerated.
877 FORMULA_FONTSIZE = 10
879 #---------------------------------------------------------------------------
880 # configuration options related to the LaTeX output
881 #---------------------------------------------------------------------------
883 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
884 # generate Latex output.
886 GENERATE_LATEX = $(GENERATE_LATEX)
888 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
889 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
890 # put in front of it. If left blank `latex' will be used as the default path.
894 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
895 # invoked. If left blank `latex' will be used as the default command name.
897 LATEX_CMD_NAME = latex
899 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
900 # generate index for LaTeX. If left blank `makeindex' will be used as the
901 # default command name.
903 MAKEINDEX_CMD_NAME = makeindex
905 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
906 # LaTeX documents. This may be useful for small projects and may help to
907 # save some trees in general.
911 # The PAPER_TYPE tag can be used to set the paper type that is used
912 # by the printer. Possible values are: a4, a4wide, letter, legal and
913 # executive. If left blank a4wide will be used.
917 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
918 # packages that should be included in the LaTeX output.
922 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
923 # the generated latex document. The header should contain everything until
924 # the first chapter. If it is left blank doxygen will generate a
925 # standard header. Notice: only use this tag if you know what you are doing!
929 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
930 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
931 # contain links (just like the HTML output) instead of page references
932 # This makes the output suitable for online browsing using a pdf viewer.
936 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
937 # plain latex in the generated Makefile. Set this option to YES to get a
938 # higher quality PDF documentation.
942 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
943 # command to the generated LaTeX files. This will instruct LaTeX to keep
944 # running if errors occur, instead of asking the user for help.
945 # This option is also used when generating formulas in HTML.
947 LATEX_BATCHMODE = YES
949 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
950 # include the index chapters (such as File Index, Compound Index, etc.)
953 LATEX_HIDE_INDICES = NO
955 #---------------------------------------------------------------------------
956 # configuration options related to the RTF output
957 #---------------------------------------------------------------------------
959 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
960 # The RTF output is optimized for Word 97 and may not look very pretty with
961 # other RTF readers or editors.
963 GENERATE_RTF = $(GENERATE_RTF)
965 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
966 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
967 # put in front of it. If left blank `rtf' will be used as the default path.
971 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
972 # RTF documents. This may be useful for small projects and may help to
973 # save some trees in general.
977 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
978 # will contain hyperlink fields. The RTF file will
979 # contain links (just like the HTML output) instead of page references.
980 # This makes the output suitable for online browsing using WORD or other
981 # programs which support those fields.
982 # Note: wordpad (write) and others do not support links.
986 # Load stylesheet definitions from file. Syntax is similar to doxygen's
987 # config file, i.e. a series of assignments. You only have to provide
988 # replacements, missing definitions are set to their default value.
990 RTF_STYLESHEET_FILE =
992 # Set optional variables used in the generation of an rtf document.
993 # Syntax is similar to doxygen's config file.
995 RTF_EXTENSIONS_FILE =
997 #---------------------------------------------------------------------------
998 # configuration options related to the man page output
999 #---------------------------------------------------------------------------
1001 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1002 # generate man pages
1004 GENERATE_MAN = $(GENERATE_MAN)
1006 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1007 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1008 # put in front of it. If left blank `man' will be used as the default path.
1012 # The MAN_EXTENSION tag determines the extension that is added to
1013 # the generated man pages (default is the subroutine's section .3)
1017 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1018 # then it will generate one additional man file for each entity
1019 # documented in the real man page(s). These additional files
1020 # only source the real man page, but without them the man command
1021 # would be unable to find the correct page. The default is NO.
1025 #---------------------------------------------------------------------------
1026 # configuration options related to the XML output
1027 #---------------------------------------------------------------------------
1029 # If the GENERATE_XML tag is set to YES Doxygen will
1030 # generate an XML file that captures the structure of
1031 # the code including all documentation.
1033 GENERATE_XML = $(GENERATE_XML)
1035 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1036 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1037 # put in front of it. If left blank `xml' will be used as the default path.
1041 # The XML_SCHEMA tag can be used to specify an XML schema,
1042 # which can be used by a validating XML parser to check the
1043 # syntax of the XML files.
1047 # The XML_DTD tag can be used to specify an XML DTD,
1048 # which can be used by a validating XML parser to check the
1049 # syntax of the XML files.
1053 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1054 # dump the program listings (including syntax highlighting
1055 # and cross-referencing information) to the XML output. Note that
1056 # enabling this will significantly increase the size of the XML output.
1058 XML_PROGRAMLISTING = YES
1060 #---------------------------------------------------------------------------
1061 # configuration options for the AutoGen Definitions output
1062 #---------------------------------------------------------------------------
1064 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1065 # generate an AutoGen Definitions (see autogen.sf.net) file
1066 # that captures the structure of the code including all
1067 # documentation. Note that this feature is still experimental
1068 # and incomplete at the moment.
1070 GENERATE_AUTOGEN_DEF = NO
1072 #---------------------------------------------------------------------------
1073 # configuration options related to the Perl module output
1074 #---------------------------------------------------------------------------
1076 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1077 # generate a Perl module file that captures the structure of
1078 # the code including all documentation. Note that this
1079 # feature is still experimental and incomplete at the
1082 GENERATE_PERLMOD = NO
1084 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1085 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1086 # to generate PDF and DVI output from the Perl module output.
1090 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1091 # nicely formatted so it can be parsed by a human reader. This is useful
1092 # if you want to understand what is going on. On the other hand, if this
1093 # tag is set to NO the size of the Perl module output will be much smaller
1094 # and Perl will parse it just the same.
1096 PERLMOD_PRETTY = YES
1098 # The names of the make variables in the generated doxyrules.make file
1099 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1100 # This is useful so different doxyrules.make files included by the same
1101 # Makefile don't overwrite each other's variables.
1103 PERLMOD_MAKEVAR_PREFIX =
1105 #---------------------------------------------------------------------------
1106 # Configuration options related to the preprocessor
1107 #---------------------------------------------------------------------------
1109 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1110 # evaluate all C-preprocessor directives found in the sources and include
1113 ENABLE_PREPROCESSING = YES
1115 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1116 # names in the source code. If set to NO (the default) only conditional
1117 # compilation will be performed. Macro expansion can be done in a controlled
1118 # way by setting EXPAND_ONLY_PREDEF to YES.
1120 MACRO_EXPANSION = NO
1122 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1123 # then the macro expansion is limited to the macros specified with the
1124 # PREDEFINED and EXPAND_AS_DEFINED tags.
1126 EXPAND_ONLY_PREDEF = NO
1128 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1129 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1131 SEARCH_INCLUDES = YES
1133 # The INCLUDE_PATH tag can be used to specify one or more directories that
1134 # contain include files that are not input files but should be processed by
1139 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1140 # patterns (like *.h and *.hpp) to filter out the header-files in the
1141 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1144 INCLUDE_FILE_PATTERNS = *
1146 # The PREDEFINED tag can be used to specify one or more macro names that
1147 # are defined before the preprocessor is started (similar to the -D option of
1148 # gcc). The argument of the tag is a list of macros of the form: name
1149 # or name=definition (no spaces). If the definition and the = are
1150 # omitted =1 is assumed. To prevent a macro definition from being
1151 # undefined via #undef or recursively expanded use the := operator
1152 # instead of the = operator.
1156 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1157 # this tag can be used to specify a list of macro names that should be expanded.
1158 # The macro definition that is found in the sources will be used.
1159 # Use the PREDEFINED tag if you want to use a different macro definition.
1163 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1164 # doxygen's preprocessor will remove all function-like macros that are alone
1165 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1166 # function macros are typically used for boiler-plate code, and will confuse
1167 # the parser if not removed.
1169 SKIP_FUNCTION_MACROS = YES
1171 #---------------------------------------------------------------------------
1172 # Configuration::additions related to external references
1173 #---------------------------------------------------------------------------
1175 # The TAGFILES option can be used to specify one or more tagfiles.
1176 # Optionally an initial location of the external documentation
1177 # can be added for each tagfile. The format of a tag file without
1178 # this location is as follows:
1179 # TAGFILES = file1 file2 ...
1180 # Adding location for the tag files is done as follows:
1181 # TAGFILES = file1=loc1 "file2 = loc2" ...
1182 # where "loc1" and "loc2" can be relative or absolute paths or
1183 # URLs. If a location is present for each tag, the installdox tool
1184 # does not have to be run to correct the links.
1185 # Note that each tag file must have a unique name
1186 # (where the name does NOT include the path)
1187 # If a tag file is not located in the directory in which doxygen
1188 # is run, you must also specify the path to the tagfile here.
1192 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1193 # a tag file that is based on the input files it reads.
1197 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1198 # in the class index. If set to NO only the inherited external classes
1203 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1204 # in the modules index. If set to NO, only the current project's groups will
1207 EXTERNAL_GROUPS = YES
1209 # The PERL_PATH should be the absolute path and name of the perl script
1210 # interpreter (i.e. the result of `which perl').
1212 PERL_PATH = $(PERL_PATH)
1214 #---------------------------------------------------------------------------
1215 # Configuration options related to the dot tool
1216 #---------------------------------------------------------------------------
1218 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1219 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1220 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1221 # this option is superseded by the HAVE_DOT option below. This is only a
1222 # fallback. It is recommended to install and use dot, since it yields more
1227 # You can define message sequence charts within doxygen comments using the \msc
1228 # command. Doxygen will then run the mscgen tool (see
1229 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1230 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1231 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1232 # default search path.
1236 # If set to YES, the inheritance and collaboration graphs will hide
1237 # inheritance and usage relations if the target is undocumented
1238 # or is not a class.
1240 HIDE_UNDOC_RELATIONS = YES
1242 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1243 # available from the path. This tool is part of Graphviz, a graph visualization
1244 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1245 # have no effect if this option is set to NO (the default)
1249 # By default doxygen will write a font called FreeSans.ttf to the output
1250 # directory and reference it in all dot files that doxygen generates. This
1251 # font does not include all possible unicode characters however, so when you need
1252 # these (or just want a differently looking font) you can specify the font name
1253 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1254 # which can be done by putting it in a standard location or by setting the
1255 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1256 # containing the font.
1258 DOT_FONTNAME = FreeSans
1260 # By default doxygen will tell dot to use the output directory to look for the
1261 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1262 # different font using DOT_FONTNAME you can set the path where dot
1263 # can find it using this tag.
1267 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1268 # will generate a graph for each documented class showing the direct and
1269 # indirect inheritance relations. Setting this tag to YES will force the
1270 # the CLASS_DIAGRAMS tag to NO.
1274 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1275 # will generate a graph for each documented class showing the direct and
1276 # indirect implementation dependencies (inheritance, containment, and
1277 # class references variables) of the class with other documented classes.
1279 COLLABORATION_GRAPH = NO
1281 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1282 # will generate a graph for groups, showing the direct groups dependencies
1286 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1287 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1292 # If set to YES, the inheritance and collaboration graphs will show the
1293 # relations between templates and their instances.
1295 TEMPLATE_RELATIONS = NO
1297 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1298 # tags are set to YES then doxygen will generate a graph for each documented
1299 # file showing the direct and indirect include dependencies of the file with
1300 # other documented files.
1304 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1305 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1306 # documented header file showing the documented files that directly or
1307 # indirectly include this file.
1309 INCLUDED_BY_GRAPH = YES
1311 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1312 # doxygen will generate a call dependency graph for every global function
1313 # or class method. Note that enabling this option will significantly increase
1314 # the time of a run. So in most cases it will be better to enable call graphs
1315 # for selected functions only using the \callgraph command.
1319 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1320 # doxygen will generate a caller dependency graph for every global function
1321 # or class method. Note that enabling this option will significantly increase
1322 # the time of a run. So in most cases it will be better to enable caller
1323 # graphs for selected functions only using the \callergraph command.
1327 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1328 # will graphical hierarchy of all classes instead of a textual one.
1330 GRAPHICAL_HIERARCHY = YES
1332 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1333 # then doxygen will show the dependencies a directory has on other directories
1334 # in a graphical way. The dependency relations are determined by the #include
1335 # relations between the files in the directories.
1337 DIRECTORY_GRAPH = YES
1339 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1340 # generated by dot. Possible values are png, jpg, or gif
1341 # If left blank png will be used.
1343 DOT_IMAGE_FORMAT = png
1345 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1346 # found. If left blank, it is assumed the dot tool can be found in the path.
1348 DOT_PATH = $(DOT_PATH)
1350 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1351 # contain dot files that are included in the documentation (see the
1352 # \dotfile command).
1356 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1357 # nodes that will be shown in the graph. If the number of nodes in a graph
1358 # becomes larger than this value, doxygen will truncate the graph, which is
1359 # visualized by representing a node as a red box. Note that doxygen if the
1360 # number of direct children of the root node in a graph is already larger than
1361 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1362 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1364 DOT_GRAPH_MAX_NODES = 50
1366 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1367 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1368 # from the root by following a path via at most 3 edges will be shown. Nodes
1369 # that lay further from the root node will be omitted. Note that setting this
1370 # option to 1 or 2 may greatly reduce the computation time needed for large
1371 # code bases. Also note that the size of a graph can be further restricted by
1372 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1374 MAX_DOT_GRAPH_DEPTH = 0
1376 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1377 # background. This is enabled by default, which results in a transparent
1378 # background. Warning: Depending on the platform used, enabling this option
1379 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1380 # become hard to read).
1382 DOT_TRANSPARENT = YES
1384 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1385 # files in one run (i.e. multiple -o and -T options on the command line). This
1386 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1387 # support this, this feature is disabled by default.
1389 DOT_MULTI_TARGETS = NO
1391 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1392 # generate a legend page explaining the meaning of the various boxes and
1393 # arrows in the dot generated graphs.
1395 GENERATE_LEGEND = YES
1397 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1398 # remove the intermediate dot files that are used to generate
1399 # the various graphs.
1403 #---------------------------------------------------------------------------
1404 # Configuration::additions related to the search engine
1405 #---------------------------------------------------------------------------
1407 # The SEARCHENGINE tag specifies whether or not a search engine should be
1408 # used. If set to NO the values of all tags below this one will be ignored.