Lines Matching full:the
3 # This file describes the settings to be used by the documentation system
7 # front of the TAG it is preceding.
10 # The format is:
20 # This tag specifies the encoding used for all characters in the config file
21 # that follow. The default is UTF-8 which is also the encoding used for all text
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24 # for the list of possible encodings.
25 # The default value is: UTF-8.
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
33 # The default value is: My Project.
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
77 # The default value is: NO.
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
83 # information to generate all constant output in the proper language.
92 # The default value is: English.
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97 # descriptions after the members that are listed in the file and class
99 # The default value is: YES.
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104 # description of a member or function before the detailed description
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
108 # The default value is: YES.
113 # used to form the text in various listings. Each string in this list, if found
114 # as the leading text of the brief description, will be stripped from the text
115 # and the result, after processing the whole list, is used as the annotated
116 # text. Otherwise, the brief description is used as-is. If left blank, the
117 # following values are used ($name is automatically replaced with the name of
118 # the entity):The $name class, The $name widget, The $name file, is, provides,
119 # specifies, contains, represents, a, an and the.
121 ABBREVIATE_BRIEF = "The $name class " \
122 "The $name widget " \
123 "The $name file " \
131 the
133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
136 # The default value is: NO.
140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141 # inherited members of a class in the documentation of that class as if those
143 # operators of the base classes will not be shown.
144 # The default value is: NO.
148 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149 # before files name in the file list and in the header files. If set to NO the
150 # shortest path that makes the file name unique will be used
151 # The default value is: YES.
155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156 # Stripping is only done if one of the specified strings matches the left-hand
157 # part of the path. The tag can be used to show relative paths in the file list.
158 # If left blank the directory from which doxygen is run is used as the path to
162 # will be relative from the directory where doxygen is started.
163 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168 # path mentioned in the documentation of a class, which tells the reader which
169 # header file to include in order to use a class. If left blank only the name of
170 # the header file containing the class definition is used. Otherwise one should
171 # specify the list of include paths that are normally passed to the compiler
172 # using the -I flag.
176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
179 # The default value is: NO.
183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184 # first line (until the first dot) of a Javadoc-style comment as the brief
185 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
188 # The default value is: NO.
192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193 # line (until the first dot) of a Qt-style comment as the brief description. If
194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
196 # The default value is: NO.
200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
202 # a brief description. This used to be the default behavior. The new default is
204 # tag to YES if you prefer the old behavior instead.
208 # The default value is: NO.
212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
214 # The default value is: YES.
218 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
219 # page for each member. If set to NO, the documentation of a member will be part
220 # of the file/class/namespace that contains it.
221 # The default value is: NO.
225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
232 # the documentation. An alias has the form:
236 # will allow you to put the command \sideeffect (or @sideeffect) in the
238 # "Side Effects:". You can put \n's in the value part of an alias to insert
244 # A mapping has the form "name=value". For example adding "class=itcl::class"
245 # will allow you to use the command class in the itcl::class meaning.
249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
251 # instance, some of the names that are used will be different. The list of all
253 # The default value is: NO.
257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
261 # The default value is: NO.
265 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
267 # The default value is: NO.
271 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
273 # The default value is: NO.
277 # Doxygen selects the parser to use depending on the extension of the files it
280 # using this tag. The format is ext=language, where ext is a file extension, and
281 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
284 # Fortran. In the later case the parser tries to guess whether the code is fixed
285 # or free formatted code, this is the default for Fortran type files), VHDL. For
292 # the files are not read by doxygen.
296 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
297 # according to the Markdown format, which allows for more readable
299 # The output of markdown processing is further processed by doxygen, so you can
302 # The default value is: YES.
308 # be prevented in individual cases by putting a % sign in front of the word or
310 # The default value is: YES.
315 # to include (a tag file for) the STL sources as input, then you should set this
318 # versus func(std::string) {}). This also make the inheritance and collaboration
320 # The default value is: NO.
326 # The default value is: NO.
330 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
334 # The default value is: NO.
340 # doxygen to replace the get and set methods by a property in the documentation.
341 # This will only work if the methods are indeed getting or setting a simple
342 # type. If this is not the case, or you want to show the methods anyway, you
344 # The default value is: YES.
348 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
349 # tag is set to YES then doxygen will reuse the documentation of the first
350 # member in the group (if any) for the other members of the group. By default
352 # The default value is: NO.
357 # any nested class or struct is added to the same group. By default this option
359 # The default value is: NO.
363 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
365 # type (e.g. under the Public Functions section). Set it to NO to prevent
366 # subgrouping. Alternatively, this can be done per class using the
368 # The default value is: YES.
372 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
373 # are shown inside the group in which they are included (e.g. using \ingroup)
379 # The default value is: NO.
383 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
385 # the documentation of the scope in which they are defined (i.e. file,
389 # The default value is: NO.
394 # enum is documented as struct, union, or enum with the name of the typedef. So
395 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
396 # with name TypeT. When disabled the typedef will appear as a member of a file,
397 # namespace, or class. And the struct will be named TypeS. This can typically be
398 # useful for C code in case the coding convention dictates that all compound
399 # types are typedef'ed and only the typedef is referenced, never the tag name.
400 # The default value is: NO.
404 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
406 # an expensive process and often the same symbol appears multiple times in the
407 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
408 # doxygen will become slower. If the cache is too large, memory is wasted. The
409 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
410 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
411 # symbols. At the end of a run doxygen will report the cache usage and suggest
412 # the optimal cache size from a speed point of view.
421 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
423 # class members and static file members will be hidden unless the
425 # Note: This will also disable the warnings about undocumented members that are
427 # The default value is: NO.
431 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
432 # be included in the documentation.
433 # The default value is: NO.
437 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
438 # scope will be included in the documentation.
439 # The default value is: NO.
443 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
444 # included in the documentation.
445 # The default value is: NO.
449 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
450 # locally in source files will be included in the documentation. If set to NO,
453 # The default value is: YES.
458 # which are defined in the implementation section but not in the interface are
459 # included in the documentation. If set to NO, only methods in the interface are
461 # The default value is: NO.
465 # If this flag is set to YES, the members of anonymous namespaces will be
466 # extracted and appear in the documentation as a namespace called
467 # 'anonymous_namespace{file}', where file will be replaced with the base name of
468 # the file that contains the anonymous namespace. By default anonymous namespace
470 # The default value is: NO.
474 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
476 # members will be included in the various overviews, but no documentation
478 # The default value is: NO.
482 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
483 # undocumented classes that are normally visible in the class hierarchy. If set
484 # to NO, these classes will be included in the various overviews. This option
486 # The default value is: NO.
490 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
492 # included in the documentation.
493 # The default value is: NO.
497 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
498 # documentation blocks found inside the body of a function. If set to NO, these
499 # blocks will be appended to the function's detailed documentation block.
500 # The default value is: NO.
504 # The INTERNAL_DOCS tag determines if documentation that is typed after a
505 # \internal command is included. If the tag is set to NO then the documentation
506 # will be excluded. Set it to YES to include the internal documentation.
507 # The default value is: NO.
511 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
516 # The default value is: system dependent.
520 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
521 # their full class and namespace scopes in the documentation. If set to YES, the
523 # The default value is: NO.
527 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
529 # YES the compound reference will be hidden.
530 # The default value is: NO.
534 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
535 # the files that are included by a file in the documentation of that file.
536 # The default value is: YES.
540 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
541 # grouped member an include statement to the documentation, telling the reader
542 # which file to include in order to use the member.
543 # The default value is: NO.
547 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
548 # files with double quotes in the documentation rather than with sharp brackets.
549 # The default value is: NO.
553 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
555 # The default value is: YES.
559 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
561 # name. If set to NO, the members will appear in declaration order.
562 # The default value is: YES.
566 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
568 # name. If set to NO, the members will appear in declaration order. Note that
569 # this will also influence the order of the classes in the class list.
570 # The default value is: NO.
574 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
576 # destructors are listed first. If set to NO the constructors will appear in the
582 # The default value is: NO.
586 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
587 # of group names into alphabetical order. If set to NO the group names will
589 # The default value is: NO.
593 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
594 # fully-qualified names, including namespaces. If set to NO, the class list will
595 # be sorted only by class name, not including the namespace part.
597 # Note: This option applies only to the class list, not to the alphabetical
599 # The default value is: NO.
603 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
605 # the prototype and the implementation of a member function even if there is
609 # The default value is: NO.
613 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
614 # list. This list is created by putting \todo commands in the documentation.
615 # The default value is: YES.
619 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
620 # list. This list is created by putting \test commands in the documentation.
621 # The default value is: YES.
625 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
626 # list. This list is created by putting \bug commands in the documentation.
627 # The default value is: YES.
631 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
632 # the deprecated list. This list is created by putting \deprecated commands in
633 # the documentation.
634 # The default value is: YES.
638 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
644 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
645 # initial value of a variable or macro / define can have for it to appear in the
646 # documentation. If the initializer consists of more lines than specified here
647 # it will be hidden. Use a value of 0 to hide initializers completely. The
648 # appearance of the value of individual variables and macros / defines can be
649 # controlled using \showinitializer or \hideinitializer command in the
655 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
656 # the bottom of the documentation of classes and structs. If set to YES, the
657 # list will mention the files that were used to generate the documentation.
658 # The default value is: YES.
662 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
663 # will remove the Files entry from the Quick Index and from the Folder Tree View
665 # The default value is: YES.
669 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
670 # page. This will remove the Namespaces entry from the Quick Index and from the
672 # The default value is: YES.
676 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
677 # doxygen should invoke to get the current version for each file (typically from
678 # the version control system). Doxygen will invoke the program by executing (via
679 # popen()) the command command input-file, where command is the value of the
680 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
681 # by doxygen. Whatever the program writes to standard output is used as the file
682 # version. For an example see the documentation.
686 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
687 # by doxygen. The layout file controls the global structure of the generated
688 # output files in an output format independent way. To create the layout file
689 # that represents doxygen's defaults, run doxygen with the -l option. You can
690 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
691 # will be used as the name of the layout file.
694 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
699 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
700 # the reference definitions. This must be a list of .bib files. The .bib
701 # extension is automatically appended if omitted. This requires the bibtex tool
703 # For LaTeX the style of the bibliography can be controlled using
704 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
713 # The QUIET tag can be used to turn on/off the messages that are generated to
714 # standard output by doxygen. If QUIET is set to YES this implies that the
716 # The default value is: NO.
720 # The WARNINGS tag can be used to turn on/off the warning messages that are
722 # this implies that the warnings are on.
724 # Tip: Turn warnings on while writing the documentation.
725 # The default value is: YES.
729 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
732 # The default value is: YES.
736 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
737 # potential errors in the documentation, such as not documenting some parameters
740 # The default value is: YES.
747 # parameter documentation, but not about the absence of documentation.
748 # The default value is: NO.
752 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
754 # The default value is: NO.
758 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
759 # can produce. The string should contain the $file, $line, and $text tags, which
760 # will be replaced by the file and line number from which the warning originated
761 # and the warning text. Optionally the format may contain $version, which will
762 # be replaced by the version of the file (if it could be obtained via
764 # The default value is: $file:$line: $text.
768 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
769 # messages should be written. If left blank the output is written to standard
775 # Configuration options related to the input files
778 # The INPUT tag is used to specify the files and/or directories that contain
780 # directories like /usr/src/myproject. Separate the files or directories with
782 # Note: If this tag is empty the current directory is searched.
786 # This tag can be used to specify the character encoding of the source files
787 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
788 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
789 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
791 # The default value is: UTF-8.
795 # If the value of the INPUT tag contains directories, you can use the
797 # *.h) to filter out the source-files in the directories.
800 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
803 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
832 # The RECURSIVE tag can be used to specify whether or not subdirectories should
834 # The default value is: NO.
838 # The EXCLUDE tag can be used to specify files and/or directories that should be
839 # excluded from the INPUT source files. This way you can easily exclude a
840 # subdirectory from a directory tree whose root is specified with the INPUT tag.
842 # Note that relative paths are relative to the directory from which doxygen is
847 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
849 # from the input.
850 # The default value is: NO.
854 # If the value of the INPUT tag contains directories, you can use the
858 # Note that the wildcards are matched against the file with absolute path, so to
859 # exclude all test directories for example use the pattern */test/*
863 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
864 # (namespaces, classes, functions, etc.) that should be excluded from the
865 # output. The symbol name can be a fully qualified name, a word, or if the
869 # Note that the wildcards are matched against the file with absolute path, so to
870 # exclude all test directories use the pattern */test/*
874 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
875 # that contain example code fragments that are included (see the \include
880 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
882 # *.h) to filter out the source-files in the directories. If left blank all
887 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
888 # searched for input files to be used with the \include or \dontinclude commands
889 # irrespective of the value of the RECURSIVE tag.
890 # The default value is: NO.
894 # The IMAGE_PATH tag can be used to specify one or more files or directories
895 # that contain images that are to be included in the documentation (see the
900 # The INPUT_FILTER tag can be used to specify a program that doxygen should
901 # invoke to filter for each input file. Doxygen will invoke the filter program
902 # by executing (via popen()) the command:
906 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
907 # name of an input file. Doxygen will then use the output that the filter
911 # Note that the filter must not add or remove lines; it is applied before the
912 # code is scanned, but not when the output code is generated. If lines are added
913 # or removed, the anchors will not be placed correctly.
916 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
921 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
922 # basis. Doxygen will compare the file name with each pattern and apply the
923 # filter if there is a match. The filters are a list of the form: pattern=filter
925 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
926 # patterns match the file name, INPUT_FILTER is applied.
929 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
934 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
935 # INPUT_FILTER) will also be used to filter the input files that are used for
936 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
937 # The default value is: NO.
941 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
942 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
945 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
949 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
950 # is part of the input, its contents will be placed on the main page
952 # and want to reuse the introduction page also for the doxygen output.
960 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
963 # Note: To get rid of all source code in the generated output, make sure that
965 # The default value is: NO.
969 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
970 # classes and enums directly into the documentation.
971 # The default value is: NO.
975 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
978 # The default value is: YES.
982 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
984 # The default value is: NO.
988 # If the REFERENCES_RELATION tag is set to YES then for each documented function
990 # The default value is: NO.
994 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
995 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
996 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
997 # link to the documentation.
998 # The default value is: YES.
1002 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1004 # brief description and links to the definition and documentation. Since this
1005 # will make the HTML file larger and loading of large files a bit slower, you
1007 # The default value is: YES.
1008 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1012 # If the USE_HTAGS tag is set to YES then the references to source code will
1013 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1014 # source browser. The htags tool is part of GNU's global source tagging system
1018 # To use it do the following:
1019 # - Install the latest version of global
1020 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1021 # - Make sure the INPUT points to the root of the source tree
1025 # tools must be available from the command line (i.e. in the search path).
1027 # The result: instead of the source browser generated by doxygen, the links to
1028 # source code will now point to the output of htags.
1029 # The default value is: NO.
1030 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1034 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1035 # verbatim copy of the header file for each class for which an include is
1038 # The default value is: YES.
1042 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1043 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1045 # rich C++ code for which doxygen's built-in parser lacks the necessary type
1047 # Note: The availability of this option depends on whether or not doxygen was
1048 # generated with the -Duse-libclang=ON option for CMake.
1049 # The default value is: NO.
1053 # If clang assisted parsing is enabled you can provide the compiler with command
1054 # line options that you would normally use when invoking the compiler. Note that
1055 # the include paths will already be set by doxygen for the files and directories
1057 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1062 # Configuration options related to the alphabetical class index
1065 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1066 # compounds will be generated. Enable this if the project contains a lot of
1068 # The default value is: YES.
1072 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1073 # which the alphabetical index list will be split.
1075 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1080 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1082 # while generating the index headers.
1083 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1088 # Configuration options related to the HTML output
1091 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1092 # The default value is: YES.
1096 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1097 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1099 # The default directory is: html.
1100 # This tag requires that the tag GENERATE_HTML is set to YES.
1104 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1106 # The default value is: .html.
1107 # This tag requires that the tag GENERATE_HTML is set to YES.
1111 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1112 # each generated HTML page. If the tag is left blank doxygen will generate a
1115 # To get valid HTML the header file that includes any scripts and style sheets
1116 # that doxygen needs, which is dependent on the configuration options used (e.g.
1117 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1121 # and then modify the file new_header.html. See also section "Doxygen usage"
1122 # for information on how to generate the default header that doxygen normally
1124 # Note: The header is subject to change so you typically have to regenerate the
1126 # of the possible markers and block names see the documentation.
1127 # This tag requires that the tag GENERATE_HTML is set to YES.
1131 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1132 # generated HTML page. If the tag is left blank doxygen will generate a standard
1134 # footer and what special commands can be used inside the footer. See also
1135 # section "Doxygen usage" for information on how to generate the default footer
1137 # This tag requires that the tag GENERATE_HTML is set to YES.
1141 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1142 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1143 # the HTML output. If left blank doxygen will generate a default style sheet.
1144 # See also section "Doxygen usage" for information on how to generate the style
1147 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1149 # This tag requires that the tag GENERATE_HTML is set to YES.
1153 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1154 # cascading style sheets that are included after the standard style sheets
1156 # This is preferred over using HTML_STYLESHEET since it does not replace the
1158 # Doxygen will copy the style sheet files to the output directory.
1159 # Note: The order of the extra style sheet files is of importance (e.g. the last
1160 # style sheet in the list overrules the setting of the previous ones in the
1161 # list). For an example see the documentation.
1162 # This tag requires that the tag GENERATE_HTML is set to YES.
1166 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1167 # other source files which should be copied to the HTML output directory. Note
1168 # that these files will be copied to the base HTML output directory. Use the
1169 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1170 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1172 # This tag requires that the tag GENERATE_HTML is set to YES.
1176 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1177 # will adjust the colors in the style sheet and background images according to
1179 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1183 # This tag requires that the tag GENERATE_HTML is set to YES.
1187 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1188 # in the HTML output. For a value of 0 the output will use grayscales only. A
1189 # value of 255 will produce the most vivid colors.
1191 # This tag requires that the tag GENERATE_HTML is set to YES.
1195 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1196 # luminance component of the colors in the HTML output. Values below 100
1197 # gradually make the output lighter, whereas values above 100 make the output
1198 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1199 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1200 # change the gamma.
1202 # This tag requires that the tag GENERATE_HTML is set to YES.
1206 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1207 # page will contain the date and time when the page was generated. Setting this
1208 # to YES can help to show when doxygen was last run and thus if the
1210 # The default value is: NO.
1211 # This tag requires that the tag GENERATE_HTML is set to YES.
1215 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1216 # documentation will contain sections that can be hidden and shown after the
1218 # The default value is: NO.
1219 # This tag requires that the tag GENERATE_HTML is set to YES.
1223 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1224 # shown in the various tree structured indices initially; the user can expand
1225 # and collapse entries dynamically later on. Doxygen will expand the tree to
1226 # such a level that at most the specified number of entries are visible (unless
1227 # a fully collapsed tree already exceeds this amount). So setting the number of
1232 # This tag requires that the tag GENERATE_HTML is set to YES.
1236 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1240 # Makefile in the HTML output directory. Running make will produce the docset in
1241 # that directory and running make install will install the docset in
1245 # The default value is: NO.
1246 # This tag requires that the tag GENERATE_HTML is set to YES.
1250 # This tag determines the name of the docset feed. A documentation feed provides
1253 # The default value is: Doxygen generated docs.
1254 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1258 # This tag specifies a string that should uniquely identify the documentation
1260 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1261 # The default value is: org.doxygen.Project.
1262 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1266 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1267 # the documentation publisher. This should be a reverse domain-name style
1269 # The default value is: org.doxygen.Publisher.
1270 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1274 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1275 # The default value is: Publisher.
1276 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1280 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1281 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1286 # The HTML Help Workshop contains a compiler that can convert all HTML output
1288 # files are now used as the Windows 98 help format, and will replace the old
1289 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1291 # words in the documentation. The HTML workshop also contains a viewer for
1293 # The default value is: NO.
1294 # This tag requires that the tag GENERATE_HTML is set to YES.
1298 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1299 # file. You can add a path in front of the file if the result should not be
1300 # written to the html output directory.
1301 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1305 # The HHC_LOCATION tag can be used to specify the location (absolute path
1306 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1307 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1308 # The file has to be specified with full path.
1309 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1313 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1314 # (YES) or that it should be included in the master .chm file (NO).
1315 # The default value is: NO.
1316 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1320 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1322 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1326 # The BINARY_TOC flag controls whether a binary table of contents is generated
1327 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1328 # enables the Previous and Next buttons.
1329 # The default value is: NO.
1330 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1334 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1335 # the table of contents of the HTML help documentation and to the tree view.
1336 # The default value is: NO.
1337 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1341 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1344 # (.qch) of the generated HTML documentation.
1345 # The default value is: NO.
1346 # This tag requires that the tag GENERATE_HTML is set to YES.
1350 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1351 # the file name of the resulting .qch file. The path specified is relative to
1352 # the HTML output folder.
1353 # This tag requires that the tag GENERATE_QHP is set to YES.
1357 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1360 # The default value is: org.doxygen.Project.
1361 # This tag requires that the tag GENERATE_QHP is set to YES.
1365 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1369 # The default value is: doc.
1370 # This tag requires that the tag GENERATE_QHP is set to YES.
1374 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1378 # This tag requires that the tag GENERATE_QHP is set to YES.
1382 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1386 # This tag requires that the tag GENERATE_QHP is set to YES.
1390 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1393 # This tag requires that the tag GENERATE_QHP is set to YES.
1397 # The QHG_LOCATION tag can be used to specify the location of Qt's
1398 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1400 # This tag requires that the tag GENERATE_QHP is set to YES.
1404 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1405 # generated, together with the HTML files, they form an Eclipse help plugin. To
1406 # install this plugin and make it available under the help contents menu in
1407 # Eclipse, the contents of the directory containing the HTML and XML files needs
1408 # to be copied into the plugins directory of eclipse. The name of the directory
1409 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1410 # After copying Eclipse needs to be restarted before the help appears.
1411 # The default value is: NO.
1412 # This tag requires that the tag GENERATE_HTML is set to YES.
1416 # A unique identifier for the Eclipse help plugin. When installing the plugin
1417 # the directory name containing the HTML and XML files should also have this
1419 # The default value is: org.doxygen.Project.
1420 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1424 # If you want full control over the layout of the generated HTML pages it might
1425 # be necessary to disable the index and replace it with your own. The
1426 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1427 # of each HTML page. A value of NO enables the index and the value YES disables
1428 # it. Since the tabs in the index contain the same information as the navigation
1430 # The default value is: NO.
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1435 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1436 # structure should be generated to display hierarchical information. If the tag
1438 # index structure (just like the one that is generated for HTML Help). For this
1440 # (i.e. any modern browser). Windows users are probably better off using the
1442 # further fine-tune the look of the index. As an example, the default style
1444 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1445 # the same information as the tab index, you could consider setting
1447 # The default value is: NO.
1448 # This tag requires that the tag GENERATE_HTML is set to YES.
1452 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1453 # doxygen will group on one line in the generated HTML documentation.
1455 # Note that a value of 0 will completely suppress the enum values from appearing
1456 # in the overview section.
1458 # This tag requires that the tag GENERATE_HTML is set to YES.
1462 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1463 # to set the initial width (in pixels) of the frame in which the tree is shown.
1465 # This tag requires that the tag GENERATE_HTML is set to YES.
1469 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1471 # The default value is: NO.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1476 # Use this tag to change the font size of LaTeX formulas included as images in
1477 # the HTML documentation. When you change the font size after a successful
1478 # doxygen run you need to manually remove any form_*.png images from the HTML
1481 # This tag requires that the tag GENERATE_HTML is set to YES.
1485 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1490 # the HTML output directory before the changes have effect.
1491 # The default value is: YES.
1492 # This tag requires that the tag GENERATE_HTML is set to YES.
1496 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1497 # http://www.mathjax.org) which uses client side Javascript for the rendering
1499 # installed or if you want to formulas look prettier in the HTML output. When
1500 # enabled you may also need to install MathJax separately and configure the path
1501 # to it using the MATHJAX_RELPATH option.
1502 # The default value is: NO.
1503 # This tag requires that the tag GENERATE_HTML is set to YES.
1507 # When MathJax is enabled you can set the default output format to be used for
1508 # the MathJax output. See the MathJax site (see:
1510 # Possible values are: HTML-CSS (which is slower, but has the best
1512 # The default value is: HTML-CSS.
1513 # This tag requires that the tag USE_MATHJAX is set to YES.
1517 # When MathJax is enabled you need to specify the location relative to the HTML
1518 # output directory using the MATHJAX_RELPATH option. The destination directory
1519 # should contain the MathJax.js script. For instance, if the mathjax directory
1520 # is located at the same level as the HTML output directory, then
1521 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1522 # Content Delivery Network so you can quickly see the result without installing
1525 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1526 # This tag requires that the tag USE_MATHJAX is set to YES.
1530 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1533 # This tag requires that the tag USE_MATHJAX is set to YES.
1537 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1538 # of code that will be used on startup of the MathJax code. See the MathJax site
1540 # example see the documentation.
1541 # This tag requires that the tag USE_MATHJAX is set to YES.
1545 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1546 # the HTML output. The underlying search engine uses javascript and DHTML and
1550 # For large projects the javascript based search engine can be slow, then
1552 # search using the keyboard; to jump to the search box use <access key> + S
1553 # (what the <access key> is depends on the OS and browser, but it is typically
1554 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1555 # key> to jump into the search results window, the results can be navigated
1556 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1557 # the search. The filter options can be selected when the cursor is inside the
1558 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1559 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1561 # The default value is: YES.
1562 # This tag requires that the tag GENERATE_HTML is set to YES.
1566 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1568 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1570 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1571 # and searching needs to be provided by external tools. See the section
1573 # The default value is: NO.
1574 # This tag requires that the tag SEARCHENGINE is set to YES.
1578 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1579 # script for searching. Instead the search results are written to an XML file
1581 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1585 # (doxysearch.cgi) which are based on the open source search engine library
1588 # See the section "External Indexing and Searching" for details.
1589 # The default value is: NO.
1590 # This tag requires that the tag SEARCHENGINE is set to YES.
1594 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1595 # which will return the search results when EXTERNAL_SEARCH is enabled.
1598 # (doxysearch.cgi) which are based on the open source search engine library
1599 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1601 # This tag requires that the tag SEARCHENGINE is set to YES.
1605 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1606 # search data is written to a file for indexing by an external tool. With the
1607 # SEARCHDATA_FILE tag the name of this file can be specified.
1608 # The default file is: searchdata.xml.
1609 # This tag requires that the tag SEARCHENGINE is set to YES.
1613 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1614 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1616 # projects and redirect the results back to the right project.
1617 # This tag requires that the tag SEARCHENGINE is set to YES.
1621 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1622 # projects other than the one defined by this configuration file, but that are
1623 # all added to the same external search index. Each project needs to have a
1624 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1625 # to a relative location where the documentation can be found. The format is:
1627 # This tag requires that the tag SEARCHENGINE is set to YES.
1632 # Configuration options related to the LaTeX output
1635 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1636 # The default value is: YES.
1640 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1641 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1643 # The default directory is: latex.
1644 # This tag requires that the tag GENERATE_LATEX is set to YES.
1648 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1652 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1653 # written to the output directory.
1654 # The default file is: latex.
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1659 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1661 # The default file is: makeindex.
1662 # This tag requires that the tag GENERATE_LATEX is set to YES.
1666 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1669 # The default value is: NO.
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
1674 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1678 # The default value is: a4.
1679 # This tag requires that the tag GENERATE_LATEX is set to YES.
1683 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1684 # that should be included in the LaTeX output. The package can be specified just
1685 # by its name or with the correct syntax as to be used with the LaTeX
1686 # \usepackage command. To get the times font for instance you can specify :
1688 # To use the option intlimits with the amsmath package you can specify:
1691 # This tag requires that the tag GENERATE_LATEX is set to YES.
1695 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1696 # generated LaTeX document. The header should contain everything until the first
1698 # section "Doxygen usage" for information on how to let doxygen write the
1701 # Note: Only use a user-defined header if you know what you are doing! The
1702 # following commands have a special meaning inside the header: $title,
1704 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1705 # string, for the replacement values of the other commands the user is referred
1707 # This tag requires that the tag GENERATE_LATEX is set to YES.
1711 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1712 # generated LaTeX document. The footer should contain everything after the last
1715 # special commands can be used inside the footer.
1718 # This tag requires that the tag GENERATE_LATEX is set to YES.
1722 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1723 # LaTeX style sheets that are included after the standard style sheets created
1725 # will copy the style sheet files to the output directory.
1726 # Note: The order of the extra style sheet files is of importance (e.g. the last
1727 # style sheet in the list overrules the setting of the previous ones in the
1729 # This tag requires that the tag GENERATE_LATEX is set to YES.
1733 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1734 # other source files which should be copied to the LATEX_OUTPUT output
1735 # directory. Note that the files will be copied as-is; there are no commands or
1737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1741 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1742 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1743 # contain links (just like the HTML output) instead of page references. This
1744 # makes the output suitable for online browsing using a PDF viewer.
1745 # The default value is: YES.
1746 # This tag requires that the tag GENERATE_LATEX is set to YES.
1750 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1751 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1753 # The default value is: YES.
1754 # This tag requires that the tag GENERATE_LATEX is set to YES.
1758 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1759 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1760 # if errors occur, instead of asking the user for help. This option is also used
1762 # The default value is: NO.
1763 # This tag requires that the tag GENERATE_LATEX is set to YES.
1767 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1768 # index chapters (such as File Index, Compound Index, etc.) in the output.
1769 # The default value is: NO.
1770 # This tag requires that the tag GENERATE_LATEX is set to YES.
1774 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1775 # code with syntax highlighting in the LaTeX output.
1779 # The default value is: NO.
1780 # This tag requires that the tag GENERATE_LATEX is set to YES.
1784 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1787 # The default value is: plain.
1788 # This tag requires that the tag GENERATE_LATEX is set to YES.
1792 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1793 # page will contain the date and time when the page was generated. Setting this
1794 # to NO can help when comparing the output of multiple runs.
1795 # The default value is: NO.
1796 # This tag requires that the tag GENERATE_LATEX is set to YES.
1801 # Configuration options related to the RTF output
1804 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1807 # The default value is: NO.
1811 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1812 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1814 # The default directory is: rtf.
1815 # This tag requires that the tag GENERATE_RTF is set to YES.
1819 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1822 # The default value is: NO.
1823 # This tag requires that the tag GENERATE_RTF is set to YES.
1827 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1828 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1829 # output) instead of page references. This makes the output suitable for online
1834 # The default value is: NO.
1835 # This tag requires that the tag GENERATE_RTF is set to YES.
1843 # See also section "Doxygen usage" for information on how to generate the
1845 # This tag requires that the tag GENERATE_RTF is set to YES.
1849 # Set optional variables used in the generation of an RTF document. Syntax is
1852 # This tag requires that the tag GENERATE_RTF is set to YES.
1856 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1857 # with syntax highlighting in the RTF output.
1861 # The default value is: NO.
1862 # This tag requires that the tag GENERATE_RTF is set to YES.
1867 # Configuration options related to the man page output
1870 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1872 # The default value is: NO.
1876 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1877 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1878 # it. A directory man3 will be created inside the directory specified by
1880 # The default directory is: man.
1881 # This tag requires that the tag GENERATE_MAN is set to YES.
1885 # The MAN_EXTENSION tag determines the extension that is added to the generated
1886 # man pages. In case the manual section does not start with a number, the number
1887 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1889 # The default value is: .3.
1890 # This tag requires that the tag GENERATE_MAN is set to YES.
1894 # The MAN_SUBDIR tag determines the name of the directory created within
1895 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1896 # MAN_EXTENSION with the initial . removed.
1897 # This tag requires that the tag GENERATE_MAN is set to YES.
1901 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1902 # will generate one additional man file for each entity documented in the real
1903 # man page(s). These additional files only source the real man page, but without
1904 # them the man command would be unable to find the correct page.
1905 # The default value is: NO.
1906 # This tag requires that the tag GENERATE_MAN is set to YES.
1911 # Configuration options related to the XML output
1914 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1915 # captures the structure of the code including all documentation.
1916 # The default value is: NO.
1920 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1921 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1923 # The default directory is: xml.
1924 # This tag requires that the tag GENERATE_XML is set to YES.
1928 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1930 # the XML output. Note that enabling this will significantly increase the size
1931 # of the XML output.
1932 # The default value is: YES.
1933 # This tag requires that the tag GENERATE_XML is set to YES.
1938 # Configuration options related to the DOCBOOK output
1941 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1943 # The default value is: NO.
1947 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1948 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1950 # The default directory is: docbook.
1951 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1955 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1957 # information) to the DOCBOOK output. Note that enabling this will significantly
1958 # increase the size of the DOCBOOK output.
1959 # The default value is: NO.
1960 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1965 # Configuration options for the AutoGen Definitions output
1968 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1969 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1970 # structure of the code including all documentation. Note that this feature is
1971 # still experimental and incomplete at the moment.
1972 # The default value is: NO.
1977 # Configuration options related to the Perl module output
1980 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1981 # file that captures the structure of the code including all documentation.
1983 # Note that this feature is still experimental and incomplete at the moment.
1984 # The default value is: NO.
1988 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1990 # output from the Perl module output.
1991 # The default value is: NO.
1992 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1996 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1998 # understand what is going on. On the other hand, if this tag is set to NO, the
1999 # size of the Perl module output will be much smaller and Perl will parse it
2000 # just the same.
2001 # The default value is: YES.
2002 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2006 # The names of the make variables in the generated doxyrules.make file are
2007 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2008 # so different doxyrules.make files included by the same Makefile don't
2010 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2015 # Configuration options related to the preprocessor
2018 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2019 # C-preprocessor directives found in the sources and include files.
2020 # The default value is: YES.
2024 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2025 # in the source code. If set to NO, only conditional compilation will be
2028 # The default value is: NO.
2029 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2033 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2034 # the macro expansion is limited to the macros specified with the PREDEFINED and
2036 # The default value is: NO.
2037 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2041 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2043 # The default value is: YES.
2044 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2048 # The INCLUDE_PATH tag can be used to specify one or more directories that
2049 # contain include files that are not input files but should be processed by the
2051 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2055 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2056 # patterns (like *.h and *.hpp) to filter out the header-files in the
2057 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2059 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2063 # The PREDEFINED tag can be used to specify one or more macro names that are
2064 # defined before the preprocessor is started (similar to the -D option of e.g.
2065 # gcc). The argument of the tag is a list of macros of the form: name or
2066 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2068 # recursively expanded use the := operator instead of the = operator.
2069 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2120 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2121 # tag can be used to specify a list of macro names that should be expanded. The
2122 # macro definition that is found in the sources will be used. Use the PREDEFINED
2123 # tag if you want to use a different macro definition that overrules the
2124 # definition found in the source code.
2125 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2129 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2132 # are typically used for boiler-plate code, and will confuse the parser if not
2134 # The default value is: YES.
2135 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2143 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2144 # file the location of the external documentation should be added. The format of
2147 # Adding location for the tag files is done as follows:
2149 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2150 # section "Linking to external documentation" for more information about the use
2152 # Note: Each tag file must have a unique name (where the name does NOT include
2153 # the path). If a tag file is not located in the directory in which doxygen is
2154 # run, you must also specify the path to the tagfile here.
2159 # tag file that is based on the input files it reads. See section "Linking to
2160 # external documentation" for more information about the usage of tag files.
2164 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2165 # the class index. If set to NO, only the inherited external classes will be
2167 # The default value is: NO.
2171 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2172 # in the modules index. If set to NO, only the current project's groups will be
2174 # The default value is: YES.
2178 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2179 # the related pages index. If set to NO, only the current project's pages will
2181 # The default value is: YES.
2185 # The PERL_PATH should be the absolute path and name of the perl script
2186 # interpreter (i.e. the result of 'which perl').
2187 # The default file (with absolute path) is: /usr/bin/perl.
2192 # Configuration options related to the dot tool
2195 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2196 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2197 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2200 # The default value is: YES.
2204 # You can define message sequence charts within doxygen comments using the \msc
2205 # command. Doxygen will then run the mscgen tool (see:
2206 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2207 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2208 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2214 # then run dia to produce the diagram and insert it in the documentation. The
2215 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2216 # If left empty dia is assumed to be found in the default search path.
2220 # If set to YES the inheritance and collaboration graphs will hide inheritance
2221 # and usage relations if the target is undocumented or is not a class.
2222 # The default value is: YES.
2226 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2227 # available from the path. This tool is part of Graphviz (see:
2229 # Bell Labs. The other options in this section have no effect if this option is
2231 # The default value is: YES.
2235 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2236 # to run in parallel. When set to 0 doxygen will base this on the number of
2237 # processors available in the system. You can set it explicitly to a value
2238 # larger than 0 to get control over the balance between CPU load and processing
2241 # This tag requires that the tag HAVE_DOT is set to YES.
2245 # When you want a differently looking font in the dot files that doxygen
2246 # generates you can specify the font name using DOT_FONTNAME. You need to make
2247 # sure dot is able to find the font, which can be done by putting it in a
2248 # standard location or by setting the DOTFONTPATH environment variable or by
2249 # setting DOT_FONTPATH to the directory containing the font.
2250 # The default value is: Helvetica.
2251 # This tag requires that the tag HAVE_DOT is set to YES.
2255 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2258 # This tag requires that the tag HAVE_DOT is set to YES.
2262 # By default doxygen will tell dot to use the default font as specified with
2264 # the path where dot can find it using this tag.
2265 # This tag requires that the tag HAVE_DOT is set to YES.
2269 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2270 # each documented class showing the direct and indirect inheritance relations.
2271 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2272 # The default value is: YES.
2273 # This tag requires that the tag HAVE_DOT is set to YES.
2277 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2278 # graph for each documented class showing the direct and indirect implementation
2279 # dependencies (inheritance, containment, and class references variables) of the
2281 # The default value is: YES.
2282 # This tag requires that the tag HAVE_DOT is set to YES.
2286 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2287 # groups, showing the direct groups dependencies.
2288 # The default value is: YES.
2289 # This tag requires that the tag HAVE_DOT is set to YES.
2293 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2294 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2296 # The default value is: NO.
2297 # This tag requires that the tag HAVE_DOT is set to YES.
2301 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2302 # class node. If there are many fields or methods and many nodes the graph may
2303 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2304 # number of items for each type to make the size more manageable. Set this to 0
2305 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2306 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2307 # but if the number exceeds 15, the total amount of fields shown is limited to
2310 # This tag requires that the tag HAVE_DOT is set to YES.
2314 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2315 # collaboration graphs will show the relations between templates and their
2317 # The default value is: NO.
2318 # This tag requires that the tag HAVE_DOT is set to YES.
2322 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2323 # YES then doxygen will generate a graph for each documented file showing the
2324 # direct and indirect include dependencies of the file with other documented
2326 # The default value is: YES.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2331 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2333 # the direct and indirect include dependencies of the file with other documented
2335 # The default value is: YES.
2336 # This tag requires that the tag HAVE_DOT is set to YES.
2340 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2343 # Note that enabling this option will significantly increase the time of a run.
2345 # functions only using the \callgraph command. Disabling a call graph can be
2346 # accomplished by means of the command \hidecallgraph.
2347 # The default value is: NO.
2348 # This tag requires that the tag HAVE_DOT is set to YES.
2352 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2355 # Note that enabling this option will significantly increase the time of a run.
2357 # functions only using the \callergraph command. Disabling a caller graph can be
2358 # accomplished by means of the command \hidecallergraph.
2359 # The default value is: NO.
2360 # This tag requires that the tag HAVE_DOT is set to YES.
2364 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2366 # The default value is: YES.
2367 # This tag requires that the tag HAVE_DOT is set to YES.
2371 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2372 # dependencies a directory has on other directories in a graphical way. The
2373 # dependency relations are determined by the #include relations between the
2374 # files in the directories.
2375 # The default value is: YES.
2376 # This tag requires that the tag HAVE_DOT is set to YES.
2380 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2381 # generated by dot. For an explanation of the image formats see the section
2382 # output formats in the documentation of the dot tool (Graphviz (see:
2385 # to make the SVG files visible in IE 9+ (other browsers do not have this
2392 # The default value is: png.
2393 # This tag requires that the tag HAVE_DOT is set to YES.
2403 # the SVG files visible. Older versions of IE do not have SVG support.
2404 # The default value is: NO.
2405 # This tag requires that the tag HAVE_DOT is set to YES.
2409 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2410 # found. If left blank, it is assumed the dot tool can be found in the path.
2411 # This tag requires that the tag HAVE_DOT is set to YES.
2415 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2416 # contain dot files that are included in the documentation (see the \dotfile
2418 # This tag requires that the tag HAVE_DOT is set to YES.
2422 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2423 # contain msc files that are included in the documentation (see the \mscfile
2428 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2429 # contain dia files that are included in the documentation (see the \diafile
2434 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2435 # path where java can find the plantuml.jar file. If left blank, it is assumed
2438 # will not generate output for the diagram.
2442 # When using plantuml, the specified paths are searched for files specified by
2443 # the !include statement in a plantuml block.
2447 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2448 # that will be shown in the graph. If the number of nodes in a graph becomes
2449 # larger than this value, doxygen will truncate the graph, which is visualized
2450 # by representing a node as a red box. Note that doxygen if the number of direct
2451 # children of the root node in a graph is already larger than
2452 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2453 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2455 # This tag requires that the tag HAVE_DOT is set to YES.
2459 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2460 # generated by dot. A depth value of 3 means that only nodes reachable from the
2462 # further from the root node will be omitted. Note that setting this option to 1
2463 # or 2 may greatly reduce the computation time needed for large code bases. Also
2464 # note that the size of a graph can be further restricted by
2467 # This tag requires that the tag HAVE_DOT is set to YES.
2471 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2473 # to support this out of the box.
2475 # Warning: Depending on the platform used, enabling this option may lead to
2476 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2478 # The default value is: NO.
2479 # This tag requires that the tag HAVE_DOT is set to YES.
2483 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2484 # files in one run (i.e. multiple -o and -T options on the command line). This
2487 # The default value is: NO.
2488 # This tag requires that the tag HAVE_DOT is set to YES.
2492 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2493 # explaining the meaning of the various boxes and arrows in the dot generated
2495 # The default value is: YES.
2496 # This tag requires that the tag HAVE_DOT is set to YES.
2500 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2501 # files that are used to generate the various graphs.
2502 # The default value is: YES.
2503 # This tag requires that the tag HAVE_DOT is set to YES.