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.
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
126 # The default value is: NO.
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131 # inherited members of a class in the documentation of that class as if those
133 # operators of the base classes will not be shown.
134 # The default value is: NO.
138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139 # before files name in the file list and in the header files. If set to NO the
140 # shortest path that makes the file name unique will be used
141 # The default value is: YES.
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146 # Stripping is only done if one of the specified strings matches the left-hand
147 # part of the path. The tag can be used to show relative paths in the file list.
148 # If left blank the directory from which doxygen is run is used as the path to
152 # will be relative from the directory where doxygen is started.
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158 # path mentioned in the documentation of a class, which tells the reader which
159 # header file to include in order to use a class. If left blank only the name of
160 # the header file containing the class definition is used. Otherwise one should
161 # specify the list of include paths that are normally passed to the compiler
162 # using the -I flag.
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
169 # The default value is: NO.
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174 # first line (until the first dot) of a Javadoc-style comment as the brief
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
178 # The default value is: NO.
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183 # line (until the first dot) of a Qt-style comment as the brief description. If
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
186 # The default value is: NO.
190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
192 # a brief description. This used to be the default behavior. The new default is
194 # tag to YES if you prefer the old behavior instead.
198 # The default value is: NO.
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
204 # The default value is: YES.
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209 # page for each member. If set to NO, the documentation of a member will be part
210 # of the file/class/namespace that contains it.
211 # The default value is: NO.
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
222 # the documentation. An alias has the form:
226 # will allow you to put the command \sideeffect (or @sideeffect) in the
228 # "Side Effects:". You can put \n's in the value part of an alias to insert
234 # A mapping has the form "name=value". For example adding "class=itcl::class"
235 # will allow you to use the command class in the itcl::class meaning.
239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
241 # instance, some of the names that are used will be different. The list of all
243 # The default value is: NO.
247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
251 # The default value is: NO.
255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
257 # The default value is: NO.
261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
263 # The default value is: NO.
267 # Doxygen selects the parser to use depending on the extension of the files it
270 # using this tag. The format is ext=language, where ext is a file extension, and
271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
274 # Fortran. In the later case the parser tries to guess whether the code is fixed
275 # or free formatted code, this is the default for Fortran type files), VHDL. For
282 # the files are not read by doxygen.
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287 # according to the Markdown format, which allows for more readable
289 # The output of markdown processing is further processed by doxygen, so you can
292 # The default value is: YES.
298 # be prevented in individual cases by putting a % sign in front of the word or
300 # The default value is: YES.
305 # to include (a tag file for) the STL sources as input, then you should set this
308 # versus func(std::string) {}). This also make the inheritance and collaboration
310 # The default value is: NO.
316 # The default value is: NO.
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
324 # The default value is: NO.
330 # doxygen to replace the get and set methods by a property in the documentation.
331 # This will only work if the methods are indeed getting or setting a simple
332 # type. If this is not the case, or you want to show the methods anyway, you
334 # The default value is: YES.
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339 # tag is set to YES then doxygen will reuse the documentation of the first
340 # member in the group (if any) for the other members of the group. By default
342 # The default value is: NO.
346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
348 # type (e.g. under the Public Functions section). Set it to NO to prevent
349 # subgrouping. Alternatively, this can be done per class using the
351 # The default value is: YES.
355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356 # are shown inside the group in which they are included (e.g. using \ingroup)
362 # The default value is: NO.
366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
368 # the documentation of the scope in which they are defined (i.e. file,
372 # The default value is: NO.
377 # enum is documented as struct, union, or enum with the name of the typedef. So
378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379 # with name TypeT. When disabled the typedef will appear as a member of a file,
380 # namespace, or class. And the struct will be named TypeS. This can typically be
381 # useful for C code in case the coding convention dictates that all compound
382 # types are typedef'ed and only the typedef is referenced, never the tag name.
383 # The default value is: NO.
387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
389 # an expensive process and often the same symbol appears multiple times in the
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391 # doxygen will become slower. If the cache is too large, memory is wasted. The
392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394 # symbols. At the end of a run doxygen will report the cache usage and suggest
395 # the optimal cache size from a speed point of view.
404 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
406 # class members and static file members will be hidden unless the
408 # Note: This will also disable the warnings about undocumented members that are
410 # The default value is: NO.
414 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
415 # be included in the documentation.
416 # The default value is: NO.
420 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
421 # scope will be included in the documentation.
422 # The default value is: NO.
426 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
427 # included in the documentation.
428 # The default value is: NO.
432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
433 # locally in source files will be included in the documentation. If set to NO,
436 # The default value is: YES.
441 # which are defined in the implementation section but not in the interface are
442 # included in the documentation. If set to NO, only methods in the interface are
444 # The default value is: NO.
448 # If this flag is set to YES, the members of anonymous namespaces will be
449 # extracted and appear in the documentation as a namespace called
450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
451 # the file that contains the anonymous namespace. By default anonymous namespace
453 # The default value is: NO.
457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
459 # members will be included in the various overviews, but no documentation
461 # The default value is: NO.
465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466 # undocumented classes that are normally visible in the class hierarchy. If set
467 # to NO, these classes will be included in the various overviews. This option
469 # The default value is: NO.
473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
475 # included in the documentation.
476 # The default value is: NO.
480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481 # documentation blocks found inside the body of a function. If set to NO, these
482 # blocks will be appended to the function's detailed documentation block.
483 # The default value is: NO.
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
488 # \internal command is included. If the tag is set to NO then the documentation
489 # will be excluded. Set it to YES to include the internal documentation.
490 # The default value is: NO.
494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
499 # The default value is: system dependent.
503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504 # their full class and namespace scopes in the documentation. If set to YES, the
506 # The default value is: NO.
510 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
512 # YES the compound reference will be hidden.
513 # The default value is: NO.
517 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
518 # the files that are included by a file in the documentation of that file.
519 # The default value is: YES.
523 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
524 # grouped member an include statement to the documentation, telling the reader
525 # which file to include in order to use the member.
526 # The default value is: NO.
530 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
531 # files with double quotes in the documentation rather than with sharp brackets.
532 # The default value is: NO.
536 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
538 # The default value is: YES.
542 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
544 # name. If set to NO, the members will appear in declaration order.
545 # The default value is: YES.
549 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
551 # name. If set to NO, the members will appear in declaration order. Note that
552 # this will also influence the order of the classes in the class list.
553 # The default value is: NO.
557 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
559 # destructors are listed first. If set to NO the constructors will appear in the
565 # The default value is: NO.
569 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
570 # of group names into alphabetical order. If set to NO the group names will
572 # The default value is: NO.
576 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
577 # fully-qualified names, including namespaces. If set to NO, the class list will
578 # be sorted only by class name, not including the namespace part.
580 # Note: This option applies only to the class list, not to the alphabetical
582 # The default value is: NO.
586 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
588 # the prototype and the implementation of a member function even if there is
592 # The default value is: NO.
596 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
597 # list. This list is created by putting \todo commands in the documentation.
598 # The default value is: YES.
602 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
603 # list. This list is created by putting \test commands in the documentation.
604 # The default value is: YES.
608 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
609 # list. This list is created by putting \bug commands in the documentation.
610 # The default value is: YES.
614 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
615 # the deprecated list. This list is created by putting \deprecated commands in
616 # the documentation.
617 # The default value is: YES.
621 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
627 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
628 # initial value of a variable or macro / define can have for it to appear in the
629 # documentation. If the initializer consists of more lines than specified here
630 # it will be hidden. Use a value of 0 to hide initializers completely. The
631 # appearance of the value of individual variables and macros / defines can be
632 # controlled using \showinitializer or \hideinitializer command in the
638 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
639 # the bottom of the documentation of classes and structs. If set to YES, the
640 # list will mention the files that were used to generate the documentation.
641 # The default value is: YES.
645 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
646 # will remove the Files entry from the Quick Index and from the Folder Tree View
648 # The default value is: YES.
652 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
653 # page. This will remove the Namespaces entry from the Quick Index and from the
655 # The default value is: YES.
659 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
660 # doxygen should invoke to get the current version for each file (typically from
661 # the version control system). Doxygen will invoke the program by executing (via
662 # popen()) the command command input-file, where command is the value of the
663 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
664 # by doxygen. Whatever the program writes to standard output is used as the file
665 # version. For an example see the documentation.
669 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
670 # by doxygen. The layout file controls the global structure of the generated
671 # output files in an output format independent way. To create the layout file
672 # that represents doxygen's defaults, run doxygen with the -l option. You can
673 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
674 # will be used as the name of the layout file.
677 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
682 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
683 # the reference definitions. This must be a list of .bib files. The .bib
684 # extension is automatically appended if omitted. This requires the bibtex tool
686 # For LaTeX the style of the bibliography can be controlled using
687 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
696 # The QUIET tag can be used to turn on/off the messages that are generated to
697 # standard output by doxygen. If QUIET is set to YES this implies that the
699 # The default value is: NO.
703 # The WARNINGS tag can be used to turn on/off the warning messages that are
705 # this implies that the warnings are on.
707 # Tip: Turn warnings on while writing the documentation.
708 # The default value is: YES.
712 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
715 # The default value is: YES.
719 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
720 # potential errors in the documentation, such as not documenting some parameters
723 # The default value is: YES.
730 # parameter documentation, but not about the absence of documentation.
731 # The default value is: NO.
735 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
736 # can produce. The string should contain the $file, $line, and $text tags, which
737 # will be replaced by the file and line number from which the warning originated
738 # and the warning text. Optionally the format may contain $version, which will
739 # be replaced by the version of the file (if it could be obtained via
741 # The default value is: $file:$line: $text.
745 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
746 # messages should be written. If left blank the output is written to standard
752 # Configuration options related to the input files
755 # The INPUT tag is used to specify the files and/or directories that contain
757 # directories like /usr/src/myproject. Separate the files or directories with
759 # Note: If this tag is empty the current directory is searched.
772 # This tag can be used to specify the character encoding of the source files
773 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
774 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
775 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
777 # The default value is: UTF-8.
781 # If the value of the INPUT tag contains directories, you can use the
783 # *.h) to filter out the source-files in the directories. If left blank the
792 # The RECURSIVE tag can be used to specify whether or not subdirectories should
794 # The default value is: NO.
798 # The EXCLUDE tag can be used to specify files and/or directories that should be
799 # excluded from the INPUT source files. This way you can easily exclude a
800 # subdirectory from a directory tree whose root is specified with the INPUT tag.
802 # Note that relative paths are relative to the directory from which doxygen is
807 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
809 # from the input.
810 # The default value is: NO.
814 # If the value of the INPUT tag contains directories, you can use the
818 # Note that the wildcards are matched against the file with absolute path, so to
819 # exclude all test directories for example use the pattern */test/*
823 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
824 # (namespaces, classes, functions, etc.) that should be excluded from the
825 # output. The symbol name can be a fully qualified name, a word, or if the
829 # Note that the wildcards are matched against the file with absolute path, so to
830 # exclude all test directories use the pattern */test/*
834 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
835 # that contain example code fragments that are included (see the \include
840 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
842 # *.h) to filter out the source-files in the directories. If left blank all
847 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
848 # searched for input files to be used with the \include or \dontinclude commands
849 # irrespective of the value of the RECURSIVE tag.
850 # The default value is: NO.
854 # The IMAGE_PATH tag can be used to specify one or more files or directories
855 # that contain images that are to be included in the documentation (see the
860 # The INPUT_FILTER tag can be used to specify a program that doxygen should
861 # invoke to filter for each input file. Doxygen will invoke the filter program
862 # by executing (via popen()) the command:
866 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
867 # name of an input file. Doxygen will then use the output that the filter
871 # Note that the filter must not add or remove lines; it is applied before the
872 # code is scanned, but not when the output code is generated. If lines are added
873 # or removed, the anchors will not be placed correctly.
877 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
878 # basis. Doxygen will compare the file name with each pattern and apply the
879 # filter if there is a match. The filters are a list of the form: pattern=filter
881 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
882 # patterns match the file name, INPUT_FILTER is applied.
886 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
887 # INPUT_FILTER) will also be used to filter the input files that are used for
888 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
889 # The default value is: NO.
893 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
894 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
897 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
901 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
902 # is part of the input, its contents will be placed on the main page
904 # and want to reuse the introduction page also for the doxygen output.
912 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
915 # Note: To get rid of all source code in the generated output, make sure that
917 # The default value is: NO.
921 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
922 # classes and enums directly into the documentation.
923 # The default value is: NO.
927 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
930 # The default value is: YES.
934 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
936 # The default value is: NO.
940 # If the REFERENCES_RELATION tag is set to YES then for each documented function
942 # The default value is: NO.
946 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
947 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
948 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
949 # link to the documentation.
950 # The default value is: YES.
954 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
956 # brief description and links to the definition and documentation. Since this
957 # will make the HTML file larger and loading of large files a bit slower, you
959 # The default value is: YES.
960 # This tag requires that the tag SOURCE_BROWSER is set to YES.
964 # If the USE_HTAGS tag is set to YES then the references to source code will
965 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
966 # source browser. The htags tool is part of GNU's global source tagging system
970 # To use it do the following:
971 # - Install the latest version of global
972 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
973 # - Make sure the INPUT points to the root of the source tree
977 # tools must be available from the command line (i.e. in the search path).
979 # The result: instead of the source browser generated by doxygen, the links to
980 # source code will now point to the output of htags.
981 # The default value is: NO.
982 # This tag requires that the tag SOURCE_BROWSER is set to YES.
986 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
987 # verbatim copy of the header file for each class for which an include is
990 # The default value is: YES.
994 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
995 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
997 # rich C++ code for which doxygen's built-in parser lacks the necessary type
999 # Note: The availability of this option depends on whether or not doxygen was
1000 # compiled with the --with-libclang option.
1001 # The default value is: NO.
1005 # If clang assisted parsing is enabled you can provide the compiler with command
1006 # line options that you would normally use when invoking the compiler. Note that
1007 # the include paths will already be set by doxygen for the files and directories
1009 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1017 # Configuration options related to the alphabetical class index
1020 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1021 # compounds will be generated. Enable this if the project contains a lot of
1023 # The default value is: YES.
1027 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1028 # which the alphabetical index list will be split.
1030 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1035 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1037 # while generating the index headers.
1038 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1043 # Configuration options related to the HTML output
1046 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1047 # The default value is: YES.
1051 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1052 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1054 # The default directory is: html.
1055 # This tag requires that the tag GENERATE_HTML is set to YES.
1059 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1061 # The default value is: .html.
1062 # This tag requires that the tag GENERATE_HTML is set to YES.
1066 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1067 # each generated HTML page. If the tag is left blank doxygen will generate a
1070 # To get valid HTML the header file that includes any scripts and style sheets
1071 # that doxygen needs, which is dependent on the configuration options used (e.g.
1072 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1076 # and then modify the file new_header.html. See also section "Doxygen usage"
1077 # for information on how to generate the default header that doxygen normally
1079 # Note: The header is subject to change so you typically have to regenerate the
1081 # of the possible markers and block names see the documentation.
1082 # This tag requires that the tag GENERATE_HTML is set to YES.
1086 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1087 # generated HTML page. If the tag is left blank doxygen will generate a standard
1089 # footer and what special commands can be used inside the footer. See also
1090 # section "Doxygen usage" for information on how to generate the default footer
1092 # This tag requires that the tag GENERATE_HTML is set to YES.
1096 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1097 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1098 # the HTML output. If left blank doxygen will generate a default style sheet.
1099 # See also section "Doxygen usage" for information on how to generate the style
1102 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1104 # This tag requires that the tag GENERATE_HTML is set to YES.
1108 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1109 # cascading style sheets that are included after the standard style sheets
1111 # This is preferred over using HTML_STYLESHEET since it does not replace the
1113 # Doxygen will copy the style sheet files to the output directory.
1114 # Note: The order of the extra style sheet files is of importance (e.g. the last
1115 # style sheet in the list overrules the setting of the previous ones in the
1116 # list). For an example see the documentation.
1117 # This tag requires that the tag GENERATE_HTML is set to YES.
1121 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1122 # other source files which should be copied to the HTML output directory. Note
1123 # that these files will be copied to the base HTML output directory. Use the
1124 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1125 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1127 # This tag requires that the tag GENERATE_HTML is set to YES.
1131 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1132 # will adjust the colors in the style sheet and background images according to
1134 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1138 # This tag requires that the tag GENERATE_HTML is set to YES.
1142 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1143 # in the HTML output. For a value of 0 the output will use grayscales only. A
1144 # value of 255 will produce the most vivid colors.
1146 # This tag requires that the tag GENERATE_HTML is set to YES.
1150 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1151 # luminance component of the colors in the HTML output. Values below 100
1152 # gradually make the output lighter, whereas values above 100 make the output
1153 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1154 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1155 # change the gamma.
1157 # This tag requires that the tag GENERATE_HTML is set to YES.
1161 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1162 # page will contain the date and time when the page was generated. Setting this
1163 # to YES can help to show when doxygen was last run and thus if the
1165 # The default value is: NO.
1166 # This tag requires that the tag GENERATE_HTML is set to YES.
1170 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1171 # documentation will contain sections that can be hidden and shown after the
1173 # The default value is: NO.
1174 # This tag requires that the tag GENERATE_HTML is set to YES.
1178 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1179 # shown in the various tree structured indices initially; the user can expand
1180 # and collapse entries dynamically later on. Doxygen will expand the tree to
1181 # such a level that at most the specified number of entries are visible (unless
1182 # a fully collapsed tree already exceeds this amount). So setting the number of
1187 # This tag requires that the tag GENERATE_HTML is set to YES.
1191 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1195 # Makefile in the HTML output directory. Running make will produce the docset in
1196 # that directory and running make install will install the docset in
1200 # The default value is: NO.
1201 # This tag requires that the tag GENERATE_HTML is set to YES.
1205 # This tag determines the name of the docset feed. A documentation feed provides
1208 # The default value is: Doxygen generated docs.
1209 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1213 # This tag specifies a string that should uniquely identify the documentation
1215 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1216 # The default value is: org.doxygen.Project.
1217 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1221 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1222 # the documentation publisher. This should be a reverse domain-name style
1224 # The default value is: org.doxygen.Publisher.
1225 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1229 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1230 # The default value is: Publisher.
1231 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1235 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1236 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1241 # The HTML Help Workshop contains a compiler that can convert all HTML output
1243 # files are now used as the Windows 98 help format, and will replace the old
1244 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1246 # words in the documentation. The HTML workshop also contains a viewer for
1248 # The default value is: NO.
1249 # This tag requires that the tag GENERATE_HTML is set to YES.
1253 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1254 # file. You can add a path in front of the file if the result should not be
1255 # written to the html output directory.
1256 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1260 # The HHC_LOCATION tag can be used to specify the location (absolute path
1261 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1262 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1263 # The file has to be specified with full path.
1264 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1268 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1269 # (YES) or that it should be included in the master .chm file (NO).
1270 # The default value is: NO.
1271 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1275 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1277 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1281 # The BINARY_TOC flag controls whether a binary table of contents is generated
1282 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1283 # enables the Previous and Next buttons.
1284 # The default value is: NO.
1285 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1289 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1290 # the table of contents of the HTML help documentation and to the tree view.
1291 # The default value is: NO.
1292 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1296 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1299 # (.qch) of the generated HTML documentation.
1300 # The default value is: NO.
1301 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1306 # the file name of the resulting .qch file. The path specified is relative to
1307 # the HTML output folder.
1308 # This tag requires that the tag GENERATE_QHP is set to YES.
1312 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1315 # The default value is: org.doxygen.Project.
1316 # This tag requires that the tag GENERATE_QHP is set to YES.
1320 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1324 # The default value is: doc.
1325 # This tag requires that the tag GENERATE_QHP is set to YES.
1329 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1333 # This tag requires that the tag GENERATE_QHP is set to YES.
1337 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1341 # This tag requires that the tag GENERATE_QHP is set to YES.
1345 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1348 # This tag requires that the tag GENERATE_QHP is set to YES.
1352 # The QHG_LOCATION tag can be used to specify the location of Qt's
1353 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1355 # This tag requires that the tag GENERATE_QHP is set to YES.
1359 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1360 # generated, together with the HTML files, they form an Eclipse help plugin. To
1361 # install this plugin and make it available under the help contents menu in
1362 # Eclipse, the contents of the directory containing the HTML and XML files needs
1363 # to be copied into the plugins directory of eclipse. The name of the directory
1364 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1365 # After copying Eclipse needs to be restarted before the help appears.
1366 # The default value is: NO.
1367 # This tag requires that the tag GENERATE_HTML is set to YES.
1371 # A unique identifier for the Eclipse help plugin. When installing the plugin
1372 # the directory name containing the HTML and XML files should also have this
1374 # The default value is: org.doxygen.Project.
1375 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1379 # If you want full control over the layout of the generated HTML pages it might
1380 # be necessary to disable the index and replace it with your own. The
1381 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1382 # of each HTML page. A value of NO enables the index and the value YES disables
1383 # it. Since the tabs in the index contain the same information as the navigation
1385 # The default value is: NO.
1386 # This tag requires that the tag GENERATE_HTML is set to YES.
1390 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1391 # structure should be generated to display hierarchical information. If the tag
1393 # index structure (just like the one that is generated for HTML Help). For this
1395 # (i.e. any modern browser). Windows users are probably better off using the
1397 # further fine-tune the look of the index. As an example, the default style
1399 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1400 # the same information as the tab index, you could consider setting
1402 # The default value is: NO.
1403 # This tag requires that the tag GENERATE_HTML is set to YES.
1407 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1408 # doxygen will group on one line in the generated HTML documentation.
1410 # Note that a value of 0 will completely suppress the enum values from appearing
1411 # in the overview section.
1413 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1418 # to set the initial width (in pixels) of the frame in which the tree is shown.
1420 # This tag requires that the tag GENERATE_HTML is set to YES.
1424 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1426 # The default value is: NO.
1427 # This tag requires that the tag GENERATE_HTML is set to YES.
1431 # Use this tag to change the font size of LaTeX formulas included as images in
1432 # the HTML documentation. When you change the font size after a successful
1433 # doxygen run you need to manually remove any form_*.png images from the HTML
1436 # This tag requires that the tag GENERATE_HTML is set to YES.
1440 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1445 # the HTML output directory before the changes have effect.
1446 # The default value is: YES.
1447 # This tag requires that the tag GENERATE_HTML is set to YES.
1451 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1452 # http://www.mathjax.org) which uses client side Javascript for the rendering
1454 # installed or if you want to formulas look prettier in the HTML output. When
1455 # enabled you may also need to install MathJax separately and configure the path
1456 # to it using the MATHJAX_RELPATH option.
1457 # The default value is: NO.
1458 # This tag requires that the tag GENERATE_HTML is set to YES.
1462 # When MathJax is enabled you can set the default output format to be used for
1463 # the MathJax output. See the MathJax site (see:
1465 # Possible values are: HTML-CSS (which is slower, but has the best
1467 # The default value is: HTML-CSS.
1468 # This tag requires that the tag USE_MATHJAX is set to YES.
1472 # When MathJax is enabled you need to specify the location relative to the HTML
1473 # output directory using the MATHJAX_RELPATH option. The destination directory
1474 # should contain the MathJax.js script. For instance, if the mathjax directory
1475 # is located at the same level as the HTML output directory, then
1476 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1477 # Content Delivery Network so you can quickly see the result without installing
1480 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1481 # This tag requires that the tag USE_MATHJAX is set to YES.
1485 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1488 # This tag requires that the tag USE_MATHJAX is set to YES.
1492 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1493 # of code that will be used on startup of the MathJax code. See the MathJax site
1495 # example see the documentation.
1496 # This tag requires that the tag USE_MATHJAX is set to YES.
1500 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1501 # the HTML output. The underlying search engine uses javascript and DHTML and
1505 # For large projects the javascript based search engine can be slow, then
1507 # search using the keyboard; to jump to the search box use <access key> + S
1508 # (what the <access key> is depends on the OS and browser, but it is typically
1509 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1510 # key> to jump into the search results window, the results can be navigated
1511 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1512 # the search. The filter options can be selected when the cursor is inside the
1513 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1514 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1516 # The default value is: YES.
1517 # This tag requires that the tag GENERATE_HTML is set to YES.
1521 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1523 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1525 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1526 # and searching needs to be provided by external tools. See the section
1528 # The default value is: NO.
1529 # This tag requires that the tag SEARCHENGINE is set to YES.
1533 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1534 # script for searching. Instead the search results are written to an XML file
1536 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1540 # (doxysearch.cgi) which are based on the open source search engine library
1543 # See the section "External Indexing and Searching" for details.
1544 # The default value is: NO.
1545 # This tag requires that the tag SEARCHENGINE is set to YES.
1549 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1550 # which will return the search results when EXTERNAL_SEARCH is enabled.
1553 # (doxysearch.cgi) which are based on the open source search engine library
1554 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1556 # This tag requires that the tag SEARCHENGINE is set to YES.
1560 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1561 # search data is written to a file for indexing by an external tool. With the
1562 # SEARCHDATA_FILE tag the name of this file can be specified.
1563 # The default file is: searchdata.xml.
1564 # This tag requires that the tag SEARCHENGINE is set to YES.
1568 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1569 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1571 # projects and redirect the results back to the right project.
1572 # This tag requires that the tag SEARCHENGINE is set to YES.
1576 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1577 # projects other than the one defined by this configuration file, but that are
1578 # all added to the same external search index. Each project needs to have a
1579 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1580 # to a relative location where the documentation can be found. The format is:
1582 # This tag requires that the tag SEARCHENGINE is set to YES.
1587 # Configuration options related to the LaTeX output
1590 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1591 # The default value is: YES.
1595 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1596 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1598 # The default directory is: latex.
1599 # This tag requires that the tag GENERATE_LATEX is set to YES.
1603 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1607 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1608 # written to the output directory.
1609 # The default file is: latex.
1610 # This tag requires that the tag GENERATE_LATEX is set to YES.
1614 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1616 # The default file is: makeindex.
1617 # This tag requires that the tag GENERATE_LATEX is set to YES.
1621 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1624 # The default value is: NO.
1625 # This tag requires that the tag GENERATE_LATEX is set to YES.
1629 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1633 # The default value is: a4.
1634 # This tag requires that the tag GENERATE_LATEX is set to YES.
1638 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1639 # that should be included in the LaTeX output. To get the times font for
1643 # This tag requires that the tag GENERATE_LATEX is set to YES.
1647 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1648 # generated LaTeX document. The header should contain everything until the first
1650 # section "Doxygen usage" for information on how to let doxygen write the
1653 # Note: Only use a user-defined header if you know what you are doing! The
1654 # following commands have a special meaning inside the header: $title,
1656 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1657 # string, for the replacement values of the other commands the user is referred
1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
1663 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1664 # generated LaTeX document. The footer should contain everything after the last
1667 # special commands can be used inside the footer.
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
1674 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1675 # LaTeX style sheets that are included after the standard style sheets created
1677 # will copy the style sheet files to the output directory.
1678 # Note: The order of the extra style sheet files is of importance (e.g. the last
1679 # style sheet in the list overrules the setting of the previous ones in the
1681 # This tag requires that the tag GENERATE_LATEX is set to YES.
1685 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1686 # other source files which should be copied to the LATEX_OUTPUT output
1687 # directory. Note that the files will be copied as-is; there are no commands or
1689 # This tag requires that the tag GENERATE_LATEX is set to YES.
1693 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1694 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1695 # contain links (just like the HTML output) instead of page references. This
1696 # makes the output suitable for online browsing using a PDF viewer.
1697 # The default value is: YES.
1698 # This tag requires that the tag GENERATE_LATEX is set to YES.
1702 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1703 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1705 # The default value is: YES.
1706 # This tag requires that the tag GENERATE_LATEX is set to YES.
1710 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1711 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1712 # if errors occur, instead of asking the user for help. This option is also used
1714 # The default value is: NO.
1715 # This tag requires that the tag GENERATE_LATEX is set to YES.
1719 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1720 # index chapters (such as File Index, Compound Index, etc.) in the output.
1721 # The default value is: NO.
1722 # This tag requires that the tag GENERATE_LATEX is set to YES.
1726 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1727 # code with syntax highlighting in the LaTeX output.
1731 # The default value is: NO.
1732 # This tag requires that the tag GENERATE_LATEX is set to YES.
1736 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1739 # The default value is: plain.
1740 # This tag requires that the tag GENERATE_LATEX is set to YES.
1745 # Configuration options related to the RTF output
1748 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1751 # The default value is: NO.
1755 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1756 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1758 # The default directory is: rtf.
1759 # This tag requires that the tag GENERATE_RTF is set to YES.
1763 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1766 # The default value is: NO.
1767 # This tag requires that the tag GENERATE_RTF is set to YES.
1771 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1772 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1773 # output) instead of page references. This makes the output suitable for online
1778 # The default value is: NO.
1779 # This tag requires that the tag GENERATE_RTF is set to YES.
1787 # See also section "Doxygen usage" for information on how to generate the
1789 # This tag requires that the tag GENERATE_RTF is set to YES.
1793 # Set optional variables used in the generation of an RTF document. Syntax is
1796 # This tag requires that the tag GENERATE_RTF is set to YES.
1800 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1801 # with syntax highlighting in the RTF output.
1805 # The default value is: NO.
1806 # This tag requires that the tag GENERATE_RTF is set to YES.
1811 # Configuration options related to the man page output
1814 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1816 # The default value is: NO.
1820 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1821 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1822 # it. A directory man3 will be created inside the directory specified by
1824 # The default directory is: man.
1825 # This tag requires that the tag GENERATE_MAN is set to YES.
1829 # The MAN_EXTENSION tag determines the extension that is added to the generated
1830 # man pages. In case the manual section does not start with a number, the number
1831 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1833 # The default value is: .3.
1834 # This tag requires that the tag GENERATE_MAN is set to YES.
1838 # The MAN_SUBDIR tag determines the name of the directory created within
1839 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1840 # MAN_EXTENSION with the initial . removed.
1841 # This tag requires that the tag GENERATE_MAN is set to YES.
1845 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1846 # will generate one additional man file for each entity documented in the real
1847 # man page(s). These additional files only source the real man page, but without
1848 # them the man command would be unable to find the correct page.
1849 # The default value is: NO.
1850 # This tag requires that the tag GENERATE_MAN is set to YES.
1855 # Configuration options related to the XML output
1858 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1859 # captures the structure of the code including all documentation.
1860 # The default value is: NO.
1864 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1865 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1867 # The default directory is: xml.
1868 # This tag requires that the tag GENERATE_XML is set to YES.
1872 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1874 # the XML output. Note that enabling this will significantly increase the size
1875 # of the XML output.
1876 # The default value is: YES.
1877 # This tag requires that the tag GENERATE_XML is set to YES.
1882 # Configuration options related to the DOCBOOK output
1885 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1887 # The default value is: NO.
1891 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1892 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1894 # The default directory is: docbook.
1895 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1899 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1901 # information) to the DOCBOOK output. Note that enabling this will significantly
1902 # increase the size of the DOCBOOK output.
1903 # The default value is: NO.
1904 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1909 # Configuration options for the AutoGen Definitions output
1912 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1913 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1914 # structure of the code including all documentation. Note that this feature is
1915 # still experimental and incomplete at the moment.
1916 # The default value is: NO.
1921 # Configuration options related to the Perl module output
1924 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1925 # file that captures the structure of the code including all documentation.
1927 # Note that this feature is still experimental and incomplete at the moment.
1928 # The default value is: NO.
1932 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1934 # output from the Perl module output.
1935 # The default value is: NO.
1936 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1940 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1942 # understand what is going on. On the other hand, if this tag is set to NO, the
1943 # size of the Perl module output will be much smaller and Perl will parse it
1944 # just the same.
1945 # The default value is: YES.
1946 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1950 # The names of the make variables in the generated doxyrules.make file are
1951 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1952 # so different doxyrules.make files included by the same Makefile don't
1954 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1959 # Configuration options related to the preprocessor
1962 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1963 # C-preprocessor directives found in the sources and include files.
1964 # The default value is: YES.
1968 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1969 # in the source code. If set to NO, only conditional compilation will be
1972 # The default value is: NO.
1973 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1977 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1978 # the macro expansion is limited to the macros specified with the PREDEFINED and
1980 # The default value is: NO.
1981 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1985 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
1987 # The default value is: YES.
1988 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1992 # The INCLUDE_PATH tag can be used to specify one or more directories that
1993 # contain include files that are not input files but should be processed by the
1995 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1999 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2000 # patterns (like *.h and *.hpp) to filter out the header-files in the
2001 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2003 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2007 # The PREDEFINED tag can be used to specify one or more macro names that are
2008 # defined before the preprocessor is started (similar to the -D option of e.g.
2009 # gcc). The argument of the tag is a list of macros of the form: name or
2010 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2012 # recursively expanded use the := operator instead of the = operator.
2013 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2017 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2018 # tag can be used to specify a list of macro names that should be expanded. The
2019 # macro definition that is found in the sources will be used. Use the PREDEFINED
2020 # tag if you want to use a different macro definition that overrules the
2021 # definition found in the source code.
2022 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2026 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2029 # are typically used for boiler-plate code, and will confuse the parser if not
2031 # The default value is: YES.
2032 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2040 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2041 # file the location of the external documentation should be added. The format of
2044 # Adding location for the tag files is done as follows:
2046 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2047 # section "Linking to external documentation" for more information about the use
2049 # Note: Each tag file must have a unique name (where the name does NOT include
2050 # the path). If a tag file is not located in the directory in which doxygen is
2051 # run, you must also specify the path to the tagfile here.
2056 # tag file that is based on the input files it reads. See section "Linking to
2057 # external documentation" for more information about the usage of tag files.
2061 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2062 # the class index. If set to NO, only the inherited external classes will be
2064 # The default value is: NO.
2068 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2069 # in the modules index. If set to NO, only the current project's groups will be
2071 # The default value is: YES.
2075 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2076 # the related pages index. If set to NO, only the current project's pages will
2078 # The default value is: YES.
2082 # The PERL_PATH should be the absolute path and name of the perl script
2083 # interpreter (i.e. the result of 'which perl').
2084 # The default file (with absolute path) is: /usr/bin/perl.
2089 # Configuration options related to the dot tool
2092 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2093 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2094 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2097 # The default value is: YES.
2101 # You can define message sequence charts within doxygen comments using the \msc
2102 # command. Doxygen will then run the mscgen tool (see:
2103 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2104 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2105 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2111 # then run dia to produce the diagram and insert it in the documentation. The
2112 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2113 # If left empty dia is assumed to be found in the default search path.
2117 # If set to YES the inheritance and collaboration graphs will hide inheritance
2118 # and usage relations if the target is undocumented or is not a class.
2119 # The default value is: YES.
2123 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2124 # available from the path. This tool is part of Graphviz (see:
2126 # Bell Labs. The other options in this section have no effect if this option is
2128 # The default value is: YES.
2132 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2133 # to run in parallel. When set to 0 doxygen will base this on the number of
2134 # processors available in the system. You can set it explicitly to a value
2135 # larger than 0 to get control over the balance between CPU load and processing
2138 # This tag requires that the tag HAVE_DOT is set to YES.
2142 # When you want a differently looking font in the dot files that doxygen
2143 # generates you can specify the font name using DOT_FONTNAME. You need to make
2144 # sure dot is able to find the font, which can be done by putting it in a
2145 # standard location or by setting the DOTFONTPATH environment variable or by
2146 # setting DOT_FONTPATH to the directory containing the font.
2147 # The default value is: Helvetica.
2148 # This tag requires that the tag HAVE_DOT is set to YES.
2152 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2155 # This tag requires that the tag HAVE_DOT is set to YES.
2159 # By default doxygen will tell dot to use the default font as specified with
2161 # the path where dot can find it using this tag.
2162 # This tag requires that the tag HAVE_DOT is set to YES.
2166 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2167 # each documented class showing the direct and indirect inheritance relations.
2168 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2169 # The default value is: YES.
2170 # This tag requires that the tag HAVE_DOT is set to YES.
2174 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2175 # graph for each documented class showing the direct and indirect implementation
2176 # dependencies (inheritance, containment, and class references variables) of the
2178 # The default value is: YES.
2179 # This tag requires that the tag HAVE_DOT is set to YES.
2183 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2184 # groups, showing the direct groups dependencies.
2185 # The default value is: YES.
2186 # This tag requires that the tag HAVE_DOT is set to YES.
2190 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2191 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2193 # The default value is: NO.
2194 # This tag requires that the tag HAVE_DOT is set to YES.
2198 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2199 # class node. If there are many fields or methods and many nodes the graph may
2200 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2201 # number of items for each type to make the size more manageable. Set this to 0
2202 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2203 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2204 # but if the number exceeds 15, the total amount of fields shown is limited to
2207 # This tag requires that the tag HAVE_DOT is set to YES.
2211 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2212 # collaboration graphs will show the relations between templates and their
2214 # The default value is: NO.
2215 # This tag requires that the tag HAVE_DOT is set to YES.
2219 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2220 # YES then doxygen will generate a graph for each documented file showing the
2221 # direct and indirect include dependencies of the file with other documented
2223 # The default value is: YES.
2224 # This tag requires that the tag HAVE_DOT is set to YES.
2228 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2230 # the direct and indirect include dependencies of the file with other documented
2232 # The default value is: YES.
2233 # This tag requires that the tag HAVE_DOT is set to YES.
2237 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2240 # Note that enabling this option will significantly increase the time of a run.
2242 # functions only using the \callgraph command.
2243 # The default value is: NO.
2244 # This tag requires that the tag HAVE_DOT is set to YES.
2248 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2251 # Note that enabling this option will significantly increase the time of a run.
2253 # functions only using the \callergraph command.
2254 # The default value is: NO.
2255 # This tag requires that the tag HAVE_DOT is set to YES.
2259 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2261 # The default value is: YES.
2262 # This tag requires that the tag HAVE_DOT is set to YES.
2266 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2267 # dependencies a directory has on other directories in a graphical way. The
2268 # dependency relations are determined by the #include relations between the
2269 # files in the directories.
2270 # The default value is: YES.
2271 # This tag requires that the tag HAVE_DOT is set to YES.
2275 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2278 # to make the SVG files visible in IE 9+ (other browsers do not have this
2283 # The default value is: png.
2284 # This tag requires that the tag HAVE_DOT is set to YES.
2294 # the SVG files visible. Older versions of IE do not have SVG support.
2295 # The default value is: NO.
2296 # This tag requires that the tag HAVE_DOT is set to YES.
2300 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2301 # found. If left blank, it is assumed the dot tool can be found in the path.
2302 # This tag requires that the tag HAVE_DOT is set to YES.
2306 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2307 # contain dot files that are included in the documentation (see the \dotfile
2309 # This tag requires that the tag HAVE_DOT is set to YES.
2313 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2314 # contain msc files that are included in the documentation (see the \mscfile
2319 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2320 # contain dia files that are included in the documentation (see the \diafile
2325 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2326 # path where java can find the plantuml.jar file. If left blank, it is assumed
2329 # will not generate output for the diagram.
2333 # When using plantuml, the specified paths are searched for files specified by
2334 # the !include statement in a plantuml block.
2338 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2339 # that will be shown in the graph. If the number of nodes in a graph becomes
2340 # larger than this value, doxygen will truncate the graph, which is visualized
2341 # by representing a node as a red box. Note that doxygen if the number of direct
2342 # children of the root node in a graph is already larger than
2343 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2344 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2346 # This tag requires that the tag HAVE_DOT is set to YES.
2350 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2351 # generated by dot. A depth value of 3 means that only nodes reachable from the
2353 # further from the root node will be omitted. Note that setting this option to 1
2354 # or 2 may greatly reduce the computation time needed for large code bases. Also
2355 # note that the size of a graph can be further restricted by
2358 # This tag requires that the tag HAVE_DOT is set to YES.
2362 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2364 # to support this out of the box.
2366 # Warning: Depending on the platform used, enabling this option may lead to
2367 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2369 # The default value is: NO.
2370 # This tag requires that the tag HAVE_DOT is set to YES.
2374 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2375 # files in one run (i.e. multiple -o and -T options on the command line). This
2378 # The default value is: NO.
2379 # This tag requires that the tag HAVE_DOT is set to YES.
2383 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2384 # explaining the meaning of the various boxes and arrows in the dot generated
2386 # The default value is: YES.
2387 # This tag requires that the tag HAVE_DOT is set to YES.
2391 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2392 # files that are used to generate the various graphs.
2393 # The default value is: YES.
2394 # This tag requires that the tag HAVE_DOT is set to YES.