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.
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
41 OUTPUT_DIRECTORY = doc/reference
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63 OUTPUT_LANGUAGE = English
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
70 BRIEF_MEMBER_DESC = 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 # Doxygen selects the parser to use depending on the extension of the files it parses.
211 # With this tag you can assign which parser to use for a given extension.
212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
213 # The format is ext=language, where ext is a file extension, and language is one of
214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set
218 # FILE_PATTERNS otherwise the files are not read by doxygen.
222 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223 # to include (a tag file for) the STL sources as input, then you should
224 # set this tag to YES in order to let doxygen match functions declarations and
225 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226 # func(std::string) {}). This also make the inheritance and collaboration
227 # diagrams that involve STL classes more complete and accurate.
229 BUILTIN_STL_SUPPORT = YES
231 # If you use Microsoft's C++/CLI language, you should set this option to YES to
232 # enable parsing support.
236 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237 # Doxygen will parse them like normal C++ but will assume all classes use public
238 # instead of private inheritance when no explicit protection keyword is present.
242 # For Microsoft's IDL there are propget and propput attributes to indicate getter
243 # and setter methods for a property. Setting this option to YES (the default)
244 # will make doxygen to replace the get and set methods by a property in the
245 # documentation. This will only work if the methods are indeed getting or
246 # setting a simple type. If this is not the case, or you want to show the
247 # methods anyway, you should set this option to NO.
249 IDL_PROPERTY_SUPPORT = YES
251 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
252 # tag is set to YES, then doxygen will reuse the documentation of the first
253 # member in the group (if any) for the other members of the group. By default
254 # all members of a group must be documented explicitly.
256 DISTRIBUTE_GROUP_DOC = NO
258 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259 # the same type (for instance a group of public functions) to be put as a
260 # subgroup of that type (e.g. under the Public Functions section). Set it to
261 # NO to prevent subgrouping. Alternatively, this can be done per class using
262 # the \nosubgrouping command.
266 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267 # is documented as struct, union, or enum with the name of the typedef. So
268 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
269 # with name TypeT. When disabled the typedef will appear as a member of a file,
270 # namespace, or class. And the struct will be named TypeS. This can typically
271 # be useful for C code in case the coding convention dictates that all compound
272 # types are typedef'ed and only the typedef is referenced, never the tag name.
274 TYPEDEF_HIDES_STRUCT = NO
276 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277 # determine which symbols to keep in memory and which to flush to disk.
278 # When the cache is full, less often used symbols will be written to disk.
279 # For small to medium size projects (<1000 input files) the default value is
280 # probably good enough. For larger projects a too small cache size can cause
281 # doxygen to be busy swapping symbols to and from disk most of the time
282 # causing a significant performance penality.
283 # If the system has enough physical memory increasing the cache will improve the
284 # performance by keeping more symbols in memory. Note that the value works on
285 # a logarithmic scale so increasing the size by one will rougly double the
286 # memory usage. The cache size is given by this formula:
287 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288 # corresponding to a cache size of 2^16 = 65536 symbols
290 SYMBOL_CACHE_SIZE = 0
292 #---------------------------------------------------------------------------
293 # Build related configuration options
294 #---------------------------------------------------------------------------
296 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297 # documentation are documented, even if no documentation was available.
298 # Private class members and static file members will be hidden unless
299 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
303 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
304 # will be included in the documentation.
306 EXTRACT_PRIVATE = YES
308 # If the EXTRACT_STATIC tag is set to YES all static members of a file
309 # will be included in the documentation.
313 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314 # defined locally in source files will be included in the documentation.
315 # If set to NO only classes defined in header files are included.
317 EXTRACT_LOCAL_CLASSES = YES
319 # This flag is only useful for Objective-C code. When set to YES local
320 # methods, which are defined in the implementation section but not in
321 # the interface are included in the documentation.
322 # If set to NO (the default) only methods in the interface are included.
324 EXTRACT_LOCAL_METHODS = NO
326 # If this flag is set to YES, the members of anonymous namespaces will be
327 # extracted and appear in the documentation as a namespace called
328 # 'anonymous_namespace{file}', where file will be replaced with the base
329 # name of the file that contains the anonymous namespace. By default
330 # anonymous namespace are hidden.
332 EXTRACT_ANON_NSPACES = NO
334 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335 # undocumented members of documented classes, files or namespaces.
336 # If set to NO (the default) these members will be included in the
337 # various overviews, but no documentation section is generated.
338 # This option has no effect if EXTRACT_ALL is enabled.
340 HIDE_UNDOC_MEMBERS = YES
342 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343 # undocumented classes that are normally visible in the class hierarchy.
344 # If set to NO (the default) these classes will be included in the various
345 # overviews. This option has no effect if EXTRACT_ALL is enabled.
347 HIDE_UNDOC_CLASSES = YES
349 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350 # friend (class|struct|union) declarations.
351 # If set to NO (the default) these declarations will be included in the
354 HIDE_FRIEND_COMPOUNDS = NO
356 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357 # documentation blocks found inside the body of a function.
358 # If set to NO (the default) these blocks will be appended to the
359 # function's detailed documentation block.
361 HIDE_IN_BODY_DOCS = NO
363 # The INTERNAL_DOCS tag determines if documentation
364 # that is typed after a \internal command is included. If the tag is set
365 # to NO (the default) then the documentation will be excluded.
366 # Set it to YES to include the internal documentation.
370 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
371 # file names in lower-case letters. If set to YES upper-case letters are also
372 # allowed. This is useful if you have classes or files whose names only differ
373 # in case and if your file system supports case sensitive file names. Windows
374 # and Mac users are advised to set this option to NO.
376 CASE_SENSE_NAMES = YES
378 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379 # will show members with their full class and namespace scopes in the
380 # documentation. If set to YES the scope will be hidden.
382 HIDE_SCOPE_NAMES = NO
384 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
385 # will put a list of the files that are included by a file in the documentation
388 SHOW_INCLUDE_FILES = YES
390 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
391 # is inserted in the documentation for inline members.
395 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
396 # will sort the (detailed) documentation of file and class members
397 # alphabetically by member name. If set to NO the members will appear in
400 SORT_MEMBER_DOCS = YES
402 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
403 # brief documentation of file, namespace and class members alphabetically
404 # by member name. If set to NO (the default) the members will appear in
409 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
410 # hierarchy of group names into alphabetical order. If set to NO (the default)
411 # the group names will appear in their defined order.
413 SORT_GROUP_NAMES = NO
415 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
416 # sorted by fully-qualified names, including namespaces. If set to
417 # NO (the default), the class list will be sorted only by class name,
418 # not including the namespace part.
419 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
420 # Note: This option applies only to the class list, not to the
423 SORT_BY_SCOPE_NAME = NO
425 # The GENERATE_TODOLIST tag can be used to enable (YES) or
426 # disable (NO) the todo list. This list is created by putting \todo
427 # commands in the documentation.
429 GENERATE_TODOLIST = NO
431 # The GENERATE_TESTLIST tag can be used to enable (YES) or
432 # disable (NO) the test list. This list is created by putting \test
433 # commands in the documentation.
435 GENERATE_TESTLIST = NO
437 # The GENERATE_BUGLIST tag can be used to enable (YES) or
438 # disable (NO) the bug list. This list is created by putting \bug
439 # commands in the documentation.
441 GENERATE_BUGLIST = NO
443 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
444 # disable (NO) the deprecated list. This list is created by putting
445 # \deprecated commands in the documentation.
447 GENERATE_DEPRECATEDLIST= YES
449 # The ENABLED_SECTIONS tag can be used to enable conditional
450 # documentation sections, marked by \if sectionname ... \endif.
454 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
455 # the initial value of a variable or define consists of for it to appear in
456 # the documentation. If the initializer consists of more lines than specified
457 # here it will be hidden. Use a value of 0 to hide initializers completely.
458 # The appearance of the initializer of individual variables and defines in the
459 # documentation can be controlled using \showinitializer or \hideinitializer
460 # command in the documentation regardless of this setting.
462 MAX_INITIALIZER_LINES = 30
464 # If the sources in your project are distributed over multiple directories
465 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
466 # in the documentation. The default is NO.
468 SHOW_DIRECTORIES = YES
470 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
471 # This will remove the Files entry from the Quick Index and from the
472 # Folder Tree View (if specified). The default is YES.
476 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
477 # Namespaces page. This will remove the Namespaces entry from the Quick Index
478 # and from the Folder Tree View (if specified). The default is YES.
482 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
483 # doxygen should invoke to get the current version for each file (typically from
484 # the version control system). Doxygen will invoke the program by executing (via
485 # popen()) the command <command> <input-file>, where <command> is the value of
486 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
487 # provided by doxygen. Whatever the program writes to standard output
488 # is used as the file version. See the manual for examples.
490 FILE_VERSION_FILTER =
492 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
493 # doxygen. The layout file controls the global structure of the generated output files
494 # in an output format independent way. The create the layout file that represents
495 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
496 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
497 # of the layout file.
501 #---------------------------------------------------------------------------
502 # configuration options related to warning and progress messages
503 #---------------------------------------------------------------------------
505 # The QUIET tag can be used to turn on/off the messages that are generated
506 # by doxygen. Possible values are YES and NO. If left blank NO is used.
510 # The WARNINGS tag can be used to turn on/off the warning messages that are
511 # generated by doxygen. Possible values are YES and NO. If left blank
516 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
517 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
518 # automatically be disabled.
520 WARN_IF_UNDOCUMENTED = NO
522 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
523 # potential errors in the documentation, such as not documenting some
524 # parameters in a documented function, or documenting parameters that
525 # don't exist or using markup commands wrongly.
527 WARN_IF_DOC_ERROR = YES
529 # This WARN_NO_PARAMDOC option can be abled to get warnings for
530 # functions that are documented, but have no documentation for their parameters
531 # or return value. If set to NO (the default) doxygen will only warn about
532 # wrong or incomplete parameter documentation, but not about the absence of
535 WARN_NO_PARAMDOC = NO
537 # The WARN_FORMAT tag determines the format of the warning messages that
538 # doxygen can produce. The string should contain the $file, $line, and $text
539 # tags, which will be replaced by the file and line number from which the
540 # warning originated and the warning text. Optionally the format may contain
541 # $version, which will be replaced by the version of the file (if it could
542 # be obtained via FILE_VERSION_FILTER)
544 WARN_FORMAT = "$file:$line: $text"
546 # The WARN_LOGFILE tag can be used to specify a file to which warning
547 # and error messages should be written. If left blank the output is written
552 #---------------------------------------------------------------------------
553 # configuration options related to the input files
554 #---------------------------------------------------------------------------
556 # The INPUT tag can be used to specify the files and/or directories that contain
557 # documented source files. You may enter file names like "myfile.cpp" or
558 # directories like "/usr/src/myproject". Separate the files or directories
563 # This tag can be used to specify the character encoding of the source files
564 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
565 # also the default input encoding. Doxygen uses libiconv (or the iconv built
566 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
567 # the list of possible encodings.
569 INPUT_ENCODING = UTF-8
571 # If the value of the INPUT tag contains directories, you can use the
572 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
573 # and *.h) to filter out the source-files in the directories. If left
574 # blank the following patterns are tested:
575 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
576 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
578 FILE_PATTERNS = *.h \
582 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
583 # should be searched for input files as well. Possible values are YES and NO.
584 # If left blank NO is used.
588 # The EXCLUDE tag can be used to specify files and/or directories that should
589 # excluded from the INPUT source files. This way you can easily exclude a
590 # subdirectory from a directory tree whose root is specified with the INPUT tag.
598 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
599 # directories that are symbolic links (a Unix filesystem feature) are excluded
602 EXCLUDE_SYMLINKS = NO
604 # If the value of the INPUT tag contains directories, you can use the
605 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
606 # certain files from those directories. Note that the wildcards are matched
607 # against the file with absolute path, so to exclude all test directories
608 # for example use the pattern */test/*
610 EXCLUDE_PATTERNS = *_test.* \
613 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
614 # (namespaces, classes, functions, etc.) that should be excluded from the
615 # output. The symbol name can be a fully qualified name, a word, or if the
616 # wildcard * is used, a substring. Examples: ANamespace, AClass,
617 # AClass::ANamespace, ANamespace::*Test
621 # The EXAMPLE_PATH tag can be used to specify one or more files or
622 # directories that contain example code fragments that are included (see
623 # the \include command).
627 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
628 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
629 # and *.h) to filter out the source-files in the directories. If left
630 # blank all files are included.
634 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
635 # searched for input files to be used with the \include or \dontinclude
636 # commands irrespective of the value of the RECURSIVE tag.
637 # Possible values are YES and NO. If left blank NO is used.
639 EXAMPLE_RECURSIVE = NO
641 # The IMAGE_PATH tag can be used to specify one or more files or
642 # directories that contain image that are included in the documentation (see
643 # the \image command).
647 # The INPUT_FILTER tag can be used to specify a program that doxygen should
648 # invoke to filter for each input file. Doxygen will invoke the filter program
649 # by executing (via popen()) the command <filter> <input-file>, where <filter>
650 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
651 # input file. Doxygen will then use the output that the filter program writes
652 # to standard output. If FILTER_PATTERNS is specified, this tag will be
655 INPUT_FILTER = "python doc/wizard-tag-filter.py"
657 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
658 # basis. Doxygen will compare the file name with each pattern and apply the
659 # filter if there is a match. The filters are a list of the form:
660 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
661 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
662 # is applied to all files.
666 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
667 # INPUT_FILTER) will be used to filter the input files when producing source
668 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
670 FILTER_SOURCE_FILES = NO
672 #---------------------------------------------------------------------------
673 # configuration options related to source browsing
674 #---------------------------------------------------------------------------
676 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
677 # be generated. Documented entities will be cross-referenced with these sources.
678 # Note: To get rid of all source code in the generated output, make sure also
679 # VERBATIM_HEADERS is set to NO.
683 # Setting the INLINE_SOURCES tag to YES will include the body
684 # of functions and classes directly in the documentation.
688 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
689 # doxygen to hide any special comment blocks from generated source code
690 # fragments. Normal C and C++ comments will always remain visible.
692 STRIP_CODE_COMMENTS = YES
694 # If the REFERENCED_BY_RELATION tag is set to YES
695 # then for each documented function all documented
696 # functions referencing it will be listed.
698 REFERENCED_BY_RELATION = NO
700 # If the REFERENCES_RELATION tag is set to YES
701 # then for each documented function all documented entities
702 # called/used by that function will be listed.
704 REFERENCES_RELATION = NO
706 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
707 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
708 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
709 # link to the source code. Otherwise they will link to the documentation.
711 REFERENCES_LINK_SOURCE = YES
713 # If the USE_HTAGS tag is set to YES then the references to source code
714 # will point to the HTML generated by the htags(1) tool instead of doxygen
715 # built-in source browser. The htags tool is part of GNU's global source
716 # tagging system (see http://www.gnu.org/software/global/global.html). You
717 # will need version 4.8.6 or higher.
721 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
722 # will generate a verbatim copy of the header file for each class for
723 # which an include is specified. Set to NO to disable this.
725 VERBATIM_HEADERS = YES
727 #---------------------------------------------------------------------------
728 # configuration options related to the alphabetical class index
729 #---------------------------------------------------------------------------
731 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
732 # of all compounds will be generated. Enable this if the project
733 # contains a lot of classes, structs, unions or interfaces.
735 ALPHABETICAL_INDEX = YES
737 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
738 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
739 # in which this list will be split (can be a number in the range [1..20])
741 COLS_IN_ALPHA_INDEX = 1
743 # In case all classes in a project start with a common prefix, all
744 # classes will be put under the same header in the alphabetical index.
745 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
746 # should be ignored while generating the index headers.
750 #---------------------------------------------------------------------------
751 # configuration options related to the HTML output
752 #---------------------------------------------------------------------------
754 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
755 # generate HTML output.
759 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
760 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
761 # put in front of it. If left blank `html' will be used as the default path.
765 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
766 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
767 # doxygen will generate files with .html extension.
769 HTML_FILE_EXTENSION = .html
771 # The HTML_HEADER tag can be used to specify a personal HTML header for
772 # each generated HTML page. If it is left blank doxygen will generate a
775 HTML_HEADER = doc/TracHeader.html
777 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
778 # each generated HTML page. If it is left blank doxygen will generate a
781 HTML_FOOTER = doc/TracFooter.html
783 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
784 # style sheet that is used by each HTML page. It can be used to
785 # fine-tune the look of the HTML output. If the tag is left blank doxygen
786 # will generate a default style sheet. Note that doxygen will try to copy
787 # the style sheet file to the HTML output directory, so don't put your own
788 # stylesheet in the HTML output directory as well, or it will be erased!
790 HTML_STYLESHEET = doc/doxygen.css
792 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
793 # files or namespaces will be aligned in HTML using tables. If set to
794 # NO a bullet list will be used.
796 HTML_ALIGN_MEMBERS = YES
798 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
799 # documentation will contain sections that can be hidden and shown after the
800 # page has loaded. For this to work a browser that supports
801 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
802 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
804 HTML_DYNAMIC_SECTIONS = NO
806 # If the GENERATE_DOCSET tag is set to YES, additional index files
807 # will be generated that can be used as input for Apple's Xcode 3
808 # integrated development environment, introduced with OSX 10.5 (Leopard).
809 # To create a documentation set, doxygen will generate a Makefile in the
810 # HTML output directory. Running make will produce the docset in that
811 # directory and running "make install" will install the docset in
812 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
814 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
818 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
819 # feed. A documentation feed provides an umbrella under which multiple
820 # documentation sets from a single provider (such as a company or product suite)
823 DOCSET_FEEDNAME = "Doxygen generated docs"
825 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
826 # should uniquely identify the documentation set bundle. This should be a
827 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
828 # will append .docset to the name.
830 DOCSET_BUNDLE_ID = org.doxygen.Project
832 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
833 # will be generated that can be used as input for tools like the
834 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
835 # of the generated HTML documentation.
837 GENERATE_HTMLHELP = NO
839 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
840 # be used to specify the file name of the resulting .chm file. You
841 # can add a path in front of the file if the result should not be
842 # written to the html output directory.
846 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
847 # be used to specify the location (absolute path including file name) of
848 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
849 # the HTML help compiler on the generated index.hhp.
853 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
854 # controls if a separate .chi index file is generated (YES) or that
855 # it should be included in the master .chm file (NO).
859 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
860 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
865 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
866 # controls whether a binary table of contents is generated (YES) or a
867 # normal table of contents (NO) in the .chm file.
871 # The TOC_EXPAND flag can be set to YES to add extra items for group members
872 # to the contents of the HTML help documentation and to the tree view.
876 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
877 # are set, an additional index file will be generated that can be used as input for
878 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
879 # HTML documentation.
883 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
884 # be used to specify the file name of the resulting .qch file.
885 # The path specified is relative to the HTML output folder.
889 # The QHP_NAMESPACE tag specifies the namespace to use when generating
890 # Qt Help Project output. For more information please see
891 # http://doc.trolltech.com/qthelpproject.html#namespace
893 QHP_NAMESPACE = org.doxygen.Project
895 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
896 # Qt Help Project output. For more information please see
897 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
899 QHP_VIRTUAL_FOLDER = doc
901 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
902 # For more information please see
903 # http://doc.trolltech.com/qthelpproject.html#custom-filters
905 QHP_CUST_FILTER_NAME =
907 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
908 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
910 QHP_CUST_FILTER_ATTRS =
912 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
913 # filter section matches.
914 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
916 QHP_SECT_FILTER_ATTRS =
918 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
919 # be used to specify the location of Qt's qhelpgenerator.
920 # If non-empty doxygen will try to run qhelpgenerator on the generated
925 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
926 # top of each HTML page. The value NO (the default) enables the index and
927 # the value YES disables it.
931 # This tag can be used to set the number of enum values (range [1..20])
932 # that doxygen will group on one line in the generated HTML documentation.
934 ENUM_VALUES_PER_LINE = 4
936 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
937 # structure should be generated to display hierarchical information.
938 # If the tag value is set to FRAME, a side panel will be generated
939 # containing a tree-like index structure (just like the one that
940 # is generated for HTML Help). For this to work a browser that supports
941 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
942 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
943 # probably better off using the HTML help feature. Other possible values
944 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
945 # and Class Hierarchy pages using a tree view instead of an ordered list;
946 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
947 # disables this behavior completely. For backwards compatibility with previous
948 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
951 GENERATE_TREEVIEW = NONE
953 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
954 # used to set the initial width (in pixels) of the frame in which the tree
959 # Use this tag to change the font size of Latex formulas included
960 # as images in the HTML documentation. The default is 10. Note that
961 # when you change the font size after a successful doxygen run you need
962 # to manually remove any form_*.png images from the HTML output directory
963 # to force them to be regenerated.
965 FORMULA_FONTSIZE = 10
967 #---------------------------------------------------------------------------
968 # configuration options related to the LaTeX output
969 #---------------------------------------------------------------------------
971 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
972 # generate Latex output.
976 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
977 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
978 # put in front of it. If left blank `latex' will be used as the default path.
982 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
983 # invoked. If left blank `latex' will be used as the default command name.
985 LATEX_CMD_NAME = latex
987 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
988 # generate index for LaTeX. If left blank `makeindex' will be used as the
989 # default command name.
991 MAKEINDEX_CMD_NAME = makeindex
993 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
994 # LaTeX documents. This may be useful for small projects and may help to
995 # save some trees in general.
999 # The PAPER_TYPE tag can be used to set the paper type that is used
1000 # by the printer. Possible values are: a4, a4wide, letter, legal and
1001 # executive. If left blank a4wide will be used.
1005 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1006 # packages that should be included in the LaTeX output.
1010 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1011 # the generated latex document. The header should contain everything until
1012 # the first chapter. If it is left blank doxygen will generate a
1013 # standard header. Notice: only use this tag if you know what you are doing!
1017 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1018 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1019 # contain links (just like the HTML output) instead of page references
1020 # This makes the output suitable for online browsing using a pdf viewer.
1022 PDF_HYPERLINKS = YES
1024 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1025 # plain latex in the generated Makefile. Set this option to YES to get a
1026 # higher quality PDF documentation.
1030 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1031 # command to the generated LaTeX files. This will instruct LaTeX to keep
1032 # running if errors occur, instead of asking the user for help.
1033 # This option is also used when generating formulas in HTML.
1035 LATEX_BATCHMODE = YES
1037 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1038 # include the index chapters (such as File Index, Compound Index, etc.)
1041 LATEX_HIDE_INDICES = NO
1043 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1044 # source code with syntax highlighting in the LaTeX output.
1045 # Note that which sources are shown also depends on other settings
1046 # such as SOURCE_BROWSER.
1048 LATEX_SOURCE_CODE = NO
1050 #---------------------------------------------------------------------------
1051 # configuration options related to the RTF output
1052 #---------------------------------------------------------------------------
1054 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1055 # The RTF output is optimized for Word 97 and may not look very pretty with
1056 # other RTF readers or editors.
1060 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1061 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1062 # put in front of it. If left blank `rtf' will be used as the default path.
1066 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1067 # RTF documents. This may be useful for small projects and may help to
1068 # save some trees in general.
1072 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1073 # will contain hyperlink fields. The RTF file will
1074 # contain links (just like the HTML output) instead of page references.
1075 # This makes the output suitable for online browsing using WORD or other
1076 # programs which support those fields.
1077 # Note: wordpad (write) and others do not support links.
1081 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1082 # config file, i.e. a series of assignments. You only have to provide
1083 # replacements, missing definitions are set to their default value.
1085 RTF_STYLESHEET_FILE =
1087 # Set optional variables used in the generation of an rtf document.
1088 # Syntax is similar to doxygen's config file.
1090 RTF_EXTENSIONS_FILE =
1092 #---------------------------------------------------------------------------
1093 # configuration options related to the man page output
1094 #---------------------------------------------------------------------------
1096 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1097 # generate man pages
1101 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1102 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1103 # put in front of it. If left blank `man' will be used as the default path.
1107 # The MAN_EXTENSION tag determines the extension that is added to
1108 # the generated man pages (default is the subroutine's section .3)
1112 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1113 # then it will generate one additional man file for each entity
1114 # documented in the real man page(s). These additional files
1115 # only source the real man page, but without them the man command
1116 # would be unable to find the correct page. The default is NO.
1120 #---------------------------------------------------------------------------
1121 # configuration options related to the XML output
1122 #---------------------------------------------------------------------------
1124 # If the GENERATE_XML tag is set to YES Doxygen will
1125 # generate an XML file that captures the structure of
1126 # the code including all documentation.
1130 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1131 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1132 # put in front of it. If left blank `xml' will be used as the default path.
1136 # The XML_SCHEMA tag can be used to specify an XML schema,
1137 # which can be used by a validating XML parser to check the
1138 # syntax of the XML files.
1142 # The XML_DTD tag can be used to specify an XML DTD,
1143 # which can be used by a validating XML parser to check the
1144 # syntax of the XML files.
1148 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1149 # dump the program listings (including syntax highlighting
1150 # and cross-referencing information) to the XML output. Note that
1151 # enabling this will significantly increase the size of the XML output.
1153 XML_PROGRAMLISTING = YES
1155 #---------------------------------------------------------------------------
1156 # configuration options for the AutoGen Definitions output
1157 #---------------------------------------------------------------------------
1159 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1160 # generate an AutoGen Definitions (see autogen.sf.net) file
1161 # that captures the structure of the code including all
1162 # documentation. Note that this feature is still experimental
1163 # and incomplete at the moment.
1165 GENERATE_AUTOGEN_DEF = NO
1167 #---------------------------------------------------------------------------
1168 # configuration options related to the Perl module output
1169 #---------------------------------------------------------------------------
1171 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1172 # generate a Perl module file that captures the structure of
1173 # the code including all documentation. Note that this
1174 # feature is still experimental and incomplete at the
1177 GENERATE_PERLMOD = NO
1179 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1180 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1181 # to generate PDF and DVI output from the Perl module output.
1185 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1186 # nicely formatted so it can be parsed by a human reader. This is useful
1187 # if you want to understand what is going on. On the other hand, if this
1188 # tag is set to NO the size of the Perl module output will be much smaller
1189 # and Perl will parse it just the same.
1191 PERLMOD_PRETTY = YES
1193 # The names of the make variables in the generated doxyrules.make file
1194 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1195 # This is useful so different doxyrules.make files included by the same
1196 # Makefile don't overwrite each other's variables.
1198 PERLMOD_MAKEVAR_PREFIX =
1200 #---------------------------------------------------------------------------
1201 # Configuration options related to the preprocessor
1202 #---------------------------------------------------------------------------
1204 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1205 # evaluate all C-preprocessor directives found in the sources and include
1208 ENABLE_PREPROCESSING = YES
1210 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1211 # names in the source code. If set to NO (the default) only conditional
1212 # compilation will be performed. Macro expansion can be done in a controlled
1213 # way by setting EXPAND_ONLY_PREDEF to YES.
1215 MACRO_EXPANSION = YES
1217 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1218 # then the macro expansion is limited to the macros specified with the
1219 # PREDEFINED and EXPAND_AS_DEFINED tags.
1221 EXPAND_ONLY_PREDEF = YES
1223 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1224 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1226 SEARCH_INCLUDES = YES
1228 # The INCLUDE_PATH tag can be used to specify one or more directories that
1229 # contain include files that are not input files but should be processed by
1234 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1235 # patterns (like *.h and *.hpp) to filter out the header-files in the
1236 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1239 INCLUDE_FILE_PATTERNS =
1241 # The PREDEFINED tag can be used to specify one or more macro names that
1242 # are defined before the preprocessor is started (similar to the -D option of
1243 # gcc). The argument of the tag is a list of macros of the form: name
1244 # or name=definition (no spaces). If the definition and the = are
1245 # omitted =1 is assumed. To prevent a macro definition from being
1246 # undefined via #undef or recursively expanded use the := operator
1247 # instead of the = operator.
1249 PREDEFINED = __doxygen__ \
1259 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1260 # this tag can be used to specify a list of macro names that should be expanded.
1261 # The macro definition that is found in the sources will be used.
1262 # Use the PREDEFINED tag if you want to use a different macro definition.
1266 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1267 # doxygen's preprocessor will remove all function-like macros that are alone
1268 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1269 # function macros are typically used for boiler-plate code, and will confuse
1270 # the parser if not removed.
1272 SKIP_FUNCTION_MACROS = YES
1274 #---------------------------------------------------------------------------
1275 # Configuration::additions related to external references
1276 #---------------------------------------------------------------------------
1278 # The TAGFILES option can be used to specify one or more tagfiles.
1279 # Optionally an initial location of the external documentation
1280 # can be added for each tagfile. The format of a tag file without
1281 # this location is as follows:
1282 # TAGFILES = file1 file2 ...
1283 # Adding location for the tag files is done as follows:
1284 # TAGFILES = file1=loc1 "file2 = loc2" ...
1285 # where "loc1" and "loc2" can be relative or absolute paths or
1286 # URLs. If a location is present for each tag, the installdox tool
1287 # does not have to be run to correct the links.
1288 # Note that each tag file must have a unique name
1289 # (where the name does NOT include the path)
1290 # If a tag file is not located in the directory in which doxygen
1291 # is run, you must also specify the path to the tagfile here.
1295 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1296 # a tag file that is based on the input files it reads.
1300 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1301 # in the class index. If set to NO only the inherited external classes
1306 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1307 # in the modules index. If set to NO, only the current project's groups will
1310 EXTERNAL_GROUPS = YES
1312 # The PERL_PATH should be the absolute path and name of the perl script
1313 # interpreter (i.e. the result of `which perl').
1315 PERL_PATH = /usr/bin/perl
1317 #---------------------------------------------------------------------------
1318 # Configuration options related to the dot tool
1319 #---------------------------------------------------------------------------
1321 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1322 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1323 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1324 # this option is superseded by the HAVE_DOT option below. This is only a
1325 # fallback. It is recommended to install and use dot, since it yields more
1330 # You can define message sequence charts within doxygen comments using the \msc
1331 # command. Doxygen will then run the mscgen tool (see
1332 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1333 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1334 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1335 # default search path.
1339 # If set to YES, the inheritance and collaboration graphs will hide
1340 # inheritance and usage relations if the target is undocumented
1341 # or is not a class.
1343 HIDE_UNDOC_RELATIONS = YES
1345 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1346 # available from the path. This tool is part of Graphviz, a graph visualization
1347 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1348 # have no effect if this option is set to NO (the default)
1352 # By default doxygen will write a font called FreeSans.ttf to the output
1353 # directory and reference it in all dot files that doxygen generates. This
1354 # font does not include all possible unicode characters however, so when you need
1355 # these (or just want a differently looking font) you can specify the font name
1356 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1357 # which can be done by putting it in a standard location or by setting the
1358 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1359 # containing the font.
1361 DOT_FONTNAME = FreeSans
1363 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1364 # The default size is 10pt.
1368 # By default doxygen will tell dot to use the output directory to look for the
1369 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1370 # different font using DOT_FONTNAME you can set the path where dot
1371 # can find it using this tag.
1375 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1376 # will generate a graph for each documented class showing the direct and
1377 # indirect inheritance relations. Setting this tag to YES will force the
1378 # the CLASS_DIAGRAMS tag to NO.
1382 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1383 # will generate a graph for each documented class showing the direct and
1384 # indirect implementation dependencies (inheritance, containment, and
1385 # class references variables) of the class with other documented classes.
1387 COLLABORATION_GRAPH = YES
1389 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1390 # will generate a graph for groups, showing the direct groups dependencies
1394 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1395 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1400 # If set to YES, the inheritance and collaboration graphs will show the
1401 # relations between templates and their instances.
1403 TEMPLATE_RELATIONS = YES
1405 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1406 # tags are set to YES then doxygen will generate a graph for each documented
1407 # file showing the direct and indirect include dependencies of the file with
1408 # other documented files.
1412 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1413 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1414 # documented header file showing the documented files that directly or
1415 # indirectly include this file.
1417 INCLUDED_BY_GRAPH = NO
1419 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1420 # doxygen will generate a call dependency graph for every global function
1421 # or class method. Note that enabling this option will significantly increase
1422 # the time of a run. So in most cases it will be better to enable call graphs
1423 # for selected functions only using the \callgraph command.
1427 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1428 # doxygen will generate a caller dependency graph for every global function
1429 # or class method. Note that enabling this option will significantly increase
1430 # the time of a run. So in most cases it will be better to enable caller
1431 # graphs for selected functions only using the \callergraph command.
1435 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1436 # will graphical hierarchy of all classes instead of a textual one.
1438 GRAPHICAL_HIERARCHY = YES
1440 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1441 # then doxygen will show the dependencies a directory has on other directories
1442 # in a graphical way. The dependency relations are determined by the #include
1443 # relations between the files in the directories.
1445 DIRECTORY_GRAPH = YES
1447 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1448 # generated by dot. Possible values are png, jpg, or gif
1449 # If left blank png will be used.
1451 DOT_IMAGE_FORMAT = png
1453 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1454 # found. If left blank, it is assumed the dot tool can be found in the path.
1458 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1459 # contain dot files that are included in the documentation (see the
1460 # \dotfile command).
1464 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1465 # nodes that will be shown in the graph. If the number of nodes in a graph
1466 # becomes larger than this value, doxygen will truncate the graph, which is
1467 # visualized by representing a node as a red box. Note that doxygen if the
1468 # number of direct children of the root node in a graph is already larger than
1469 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1470 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1472 DOT_GRAPH_MAX_NODES = 50
1474 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1475 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1476 # from the root by following a path via at most 3 edges will be shown. Nodes
1477 # that lay further from the root node will be omitted. Note that setting this
1478 # option to 1 or 2 may greatly reduce the computation time needed for large
1479 # code bases. Also note that the size of a graph can be further restricted by
1480 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1482 MAX_DOT_GRAPH_DEPTH = 0
1484 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1485 # background. This is disabled by default, because dot on Windows does not
1486 # seem to support this out of the box. Warning: Depending on the platform used,
1487 # enabling this option may lead to badly anti-aliased labels on the edges of
1488 # a graph (i.e. they become hard to read).
1490 DOT_TRANSPARENT = NO
1492 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1493 # files in one run (i.e. multiple -o and -T options on the command line). This
1494 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1495 # support this, this feature is disabled by default.
1497 DOT_MULTI_TARGETS = NO
1499 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1500 # generate a legend page explaining the meaning of the various boxes and
1501 # arrows in the dot generated graphs.
1503 GENERATE_LEGEND = YES
1505 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1506 # remove the intermediate dot files that are used to generate
1507 # the various graphs.
1511 #---------------------------------------------------------------------------
1512 # Options related to the search engine
1513 #---------------------------------------------------------------------------
1515 # The SEARCHENGINE tag specifies whether or not a search engine should be
1516 # used. If set to NO the values of all tags below this one will be ignored.