Lines Matching full:the

3 # Licensed to the Apache Software Foundation (ASF) under one
4 # or more contributor license agreements.  See the NOTICE file
6 # regarding copyright ownership.  The ASF licenses this file
7 # to you under the Apache License, Version 2.0 (the
9 # with the License.  You may obtain a copy of the License at
14 # software distributed under the License is distributed on an
16 # KIND, either express or implied.  See the License for the
18 # under the License.
21 # This file describes the settings to be used by the documentation system
25 # front of the TAG it is preceding.
28 # The format is:
38 # This tag specifies the encoding used for all characters in the config file
39 # that follow. The default is UTF-8 which is also the encoding used for all text
40 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
41 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
42 # for the list of possible encodings.
43 # The default value is: UTF-8.
47 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
48 # double-quotes, unless you are using Doxywizard) that should identify the
49 # project for which the documentation is generated. This name is used in the
51 # The default value is: My Project.
55 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
56 # could be handy for archiving the generated documentation or if some version
61 # Using the PROJECT_BRIEF tag one can provide an optional one line description
62 # for a project that appears at the top of each page and should give viewer a
63 # quick idea about the purpose of the project. Keep the description short.
67 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
68 # in the documentation. The maximum height of the logo should not exceed 55
69 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
70 # the logo to the output directory.
74 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
75 # into which the generated documentation will be written. If a relative path is
76 # entered, it will be relative to the location where doxygen was started. If
77 # left blank the current directory will be used.
81 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
82 # directories (in 2 levels) under the output directory of each output format and
83 # will distribute the generated files over these directories. Enabling this
85 # putting all generated files in the same directory would otherwise causes
86 # performance problems for the file system.
87 # The default value is: NO.
91 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
92 # characters to appear in the names of generated files. If set to NO, non-ASCII
95 # The default value is: NO.
99 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
101 # information to generate all constant output in the proper language.
110 # The default value is: English.
114 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
115 # descriptions after the members that are listed in the file and class
117 # The default value is: YES.
121 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
122 # description of a member or function before the detailed description
124 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
126 # The default value is: YES.
131 # used to form the text in various listings. Each string in this list, if found
132 # as the leading text of the brief description, will be stripped from the text
133 # and the result, after processing the whole list, is used as the annotated
134 # text. Otherwise, the brief description is used as-is. If left blank, the
135 # following values are used ($name is automatically replaced with the name of
136 # the entity):The $name class, The $name widget, The $name file, is, provides,
137 # specifies, contains, represents, a, an and the.
141 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
144 # The default value is: NO.
148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149 # inherited members of a class in the documentation of that class as if those
151 # operators of the base classes will not be shown.
152 # The default value is: NO.
156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157 # before files name in the file list and in the header files. If set to NO the
158 # shortest path that makes the file name unique will be used
159 # The default value is: YES.
163 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164 # Stripping is only done if one of the specified strings matches the left-hand
165 # part of the path. The tag can be used to show relative paths in the file list.
166 # If left blank the directory from which doxygen is run is used as the path to
170 # will be relative from the directory where doxygen is started.
171 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
175 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176 # path mentioned in the documentation of a class, which tells the reader which
177 # header file to include in order to use a class. If left blank only the name of
178 # the header file containing the class definition is used. Otherwise one should
179 # specify the list of include paths that are normally passed to the compiler
180 # using the -I flag.
184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
187 # The default value is: NO.
191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192 # first line (until the first dot) of a Javadoc-style comment as the brief
193 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
196 # The default value is: NO.
200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
201 # line (until the first dot) of a Qt-style comment as the brief description. If
202 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
204 # The default value is: NO.
208 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
210 # a brief description. This used to be the default behavior. The new default is
212 # tag to YES if you prefer the old behavior instead.
216 # The default value is: NO.
220 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
222 # The default value is: YES.
226 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
227 # page for each member. If set to NO, the documentation of a member will be part
228 # of the file/class/namespace that contains it.
229 # The default value is: NO.
233 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
240 # the documentation. An alias has the form:
244 # will allow you to put the command \sideeffect (or @sideeffect) in the
246 # "Side Effects:". You can put \n's in the value part of an alias to insert
252 # A mapping has the form "name=value". For example adding "class=itcl::class"
253 # will allow you to use the command class in the itcl::class meaning.
257 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
259 # instance, some of the names that are used will be different. The list of all
261 # The default value is: NO.
265 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
269 # The default value is: NO.
273 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
275 # The default value is: NO.
279 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
281 # The default value is: NO.
285 # Doxygen selects the parser to use depending on the extension of the files it
288 # using this tag. The format is ext=language, where ext is a file extension, and
289 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
292 # Fortran. In the later case the parser tries to guess whether the code is fixed
293 # or free formatted code, this is the default for Fortran type files), VHDL. For
300 # the files are not read by doxygen.
304 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
305 # according to the Markdown format, which allows for more readable
307 # The output of markdown processing is further processed by doxygen, so you can
310 # The default value is: YES.
316 # be prevented in individual cases by putting a % sign in front of the word or
318 # The default value is: YES.
323 # to include (a tag file for) the STL sources as input, then you should set this
326 # versus func(std::string) {}). This also make the inheritance and collaboration
328 # The default value is: NO.
334 # The default value is: NO.
338 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
342 # The default value is: NO.
348 # doxygen to replace the get and set methods by a property in the documentation.
349 # This will only work if the methods are indeed getting or setting a simple
350 # type. If this is not the case, or you want to show the methods anyway, you
352 # The default value is: YES.
356 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
357 # tag is set to YES then doxygen will reuse the documentation of the first
358 # member in the group (if any) for the other members of the group. By default
360 # The default value is: NO.
365 # any nested class or struct is added to the same group. By default this option
367 # The default value is: NO.
371 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
373 # type (e.g. under the Public Functions section). Set it to NO to prevent
374 # subgrouping. Alternatively, this can be done per class using the
376 # The default value is: YES.
380 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
381 # are shown inside the group in which they are included (e.g. using \ingroup)
387 # The default value is: NO.
391 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
393 # the documentation of the scope in which they are defined (i.e. file,
397 # The default value is: NO.
402 # enum is documented as struct, union, or enum with the name of the typedef. So
403 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
404 # with name TypeT. When disabled the typedef will appear as a member of a file,
405 # namespace, or class. And the struct will be named TypeS. This can typically be
406 # useful for C code in case the coding convention dictates that all compound
407 # types are typedef'ed and only the typedef is referenced, never the tag name.
408 # The default value is: NO.
412 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
414 # an expensive process and often the same symbol appears multiple times in the
415 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
416 # doxygen will become slower. If the cache is too large, memory is wasted. The
417 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
418 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
419 # symbols. At the end of a run doxygen will report the cache usage and suggest
420 # the optimal cache size from a speed point of view.
429 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
431 # class members and static file members will be hidden unless the
433 # Note: This will also disable the warnings about undocumented members that are
435 # The default value is: NO.
439 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
440 # be included in the documentation.
441 # The default value is: NO.
445 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
446 # scope will be included in the documentation.
447 # The default value is: NO.
451 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
452 # included in the documentation.
453 # The default value is: NO.
457 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
458 # locally in source files will be included in the documentation. If set to NO,
461 # The default value is: YES.
466 # which are defined in the implementation section but not in the interface are
467 # included in the documentation. If set to NO, only methods in the interface are
469 # The default value is: NO.
473 # If this flag is set to YES, the members of anonymous namespaces will be
474 # extracted and appear in the documentation as a namespace called
475 # 'anonymous_namespace{file}', where file will be replaced with the base name of
476 # the file that contains the anonymous namespace. By default anonymous namespace
478 # The default value is: NO.
482 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
484 # members will be included in the various overviews, but no documentation
486 # The default value is: NO.
490 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
491 # undocumented classes that are normally visible in the class hierarchy. If set
492 # to NO, these classes will be included in the various overviews. This option
494 # The default value is: NO.
498 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
500 # included in the documentation.
501 # The default value is: NO.
505 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
506 # documentation blocks found inside the body of a function. If set to NO, these
507 # blocks will be appended to the function's detailed documentation block.
508 # The default value is: NO.
512 # The INTERNAL_DOCS tag determines if documentation that is typed after a
513 # \internal command is included. If the tag is set to NO then the documentation
514 # will be excluded. Set it to YES to include the internal documentation.
515 # The default value is: NO.
519 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
524 # The default value is: system dependent.
528 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
529 # their full class and namespace scopes in the documentation. If set to YES, the
531 # The default value is: NO.
535 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
537 # YES the compound reference will be hidden.
538 # The default value is: NO.
542 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
543 # the files that are included by a file in the documentation of that file.
544 # The default value is: YES.
548 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
549 # grouped member an include statement to the documentation, telling the reader
550 # which file to include in order to use the member.
551 # The default value is: NO.
555 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
556 # files with double quotes in the documentation rather than with sharp brackets.
557 # The default value is: NO.
561 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
563 # The default value is: YES.
567 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
569 # name. If set to NO, the members will appear in declaration order.
570 # The default value is: YES.
574 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
576 # name. If set to NO, the members will appear in declaration order. Note that
577 # this will also influence the order of the classes in the class list.
578 # The default value is: NO.
582 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
584 # destructors are listed first. If set to NO the constructors will appear in the
590 # The default value is: NO.
594 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
595 # of group names into alphabetical order. If set to NO the group names will
597 # The default value is: NO.
601 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
602 # fully-qualified names, including namespaces. If set to NO, the class list will
603 # be sorted only by class name, not including the namespace part.
605 # Note: This option applies only to the class list, not to the alphabetical
607 # The default value is: NO.
611 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
613 # the prototype and the implementation of a member function even if there is
617 # The default value is: NO.
621 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
622 # list. This list is created by putting \todo commands in the documentation.
623 # The default value is: YES.
627 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
628 # list. This list is created by putting \test commands in the documentation.
629 # The default value is: YES.
633 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
634 # list. This list is created by putting \bug commands in the documentation.
635 # The default value is: YES.
639 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
640 # the deprecated list. This list is created by putting \deprecated commands in
641 # the documentation.
642 # The default value is: YES.
646 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
652 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
653 # initial value of a variable or macro / define can have for it to appear in the
654 # documentation. If the initializer consists of more lines than specified here
655 # it will be hidden. Use a value of 0 to hide initializers completely. The
656 # appearance of the value of individual variables and macros / defines can be
657 # controlled using \showinitializer or \hideinitializer command in the
663 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
664 # the bottom of the documentation of classes and structs. If set to YES, the
665 # list will mention the files that were used to generate the documentation.
666 # The default value is: YES.
670 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
671 # will remove the Files entry from the Quick Index and from the Folder Tree View
673 # The default value is: YES.
677 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
678 # page. This will remove the Namespaces entry from the Quick Index and from the
680 # The default value is: YES.
684 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
685 # doxygen should invoke to get the current version for each file (typically from
686 # the version control system). Doxygen will invoke the program by executing (via
687 # popen()) the command command input-file, where command is the value of the
688 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
689 # by doxygen. Whatever the program writes to standard output is used as the file
690 # version. For an example see the documentation.
694 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
695 # by doxygen. The layout file controls the global structure of the generated
696 # output files in an output format independent way. To create the layout file
697 # that represents doxygen's defaults, run doxygen with the -l option. You can
698 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
699 # will be used as the name of the layout file.
702 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
707 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
708 # the reference definitions. This must be a list of .bib files. The .bib
709 # extension is automatically appended if omitted. This requires the bibtex tool
711 # For LaTeX the style of the bibliography can be controlled using
712 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
721 # The QUIET tag can be used to turn on/off the messages that are generated to
722 # standard output by doxygen. If QUIET is set to YES this implies that the
724 # The default value is: NO.
728 # The WARNINGS tag can be used to turn on/off the warning messages that are
730 # this implies that the warnings are on.
732 # Tip: Turn warnings on while writing the documentation.
733 # The default value is: YES.
737 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
740 # The default value is: YES.
744 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
745 # potential errors in the documentation, such as not documenting some parameters
748 # The default value is: YES.
755 # parameter documentation, but not about the absence of documentation.
756 # The default value is: NO.
760 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
762 # The default value is: NO.
766 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
767 # can produce. The string should contain the $file, $line, and $text tags, which
768 # will be replaced by the file and line number from which the warning originated
769 # and the warning text. Optionally the format may contain $version, which will
770 # be replaced by the version of the file (if it could be obtained via
772 # The default value is: $file:$line: $text.
776 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
777 # messages should be written. If left blank the output is written to standard
783 # Configuration options related to the input files
786 # The INPUT tag is used to specify the files and/or directories that contain
788 # directories like /usr/src/myproject. Separate the files or directories with
790 # Note: If this tag is empty the current directory is searched.
795 # This tag can be used to specify the character encoding of the source files
796 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
797 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
798 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
800 # The default value is: UTF-8.
804 # If the value of the INPUT tag contains directories, you can use the
806 # *.h) to filter out the source-files in the directories.
809 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
812 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
820 # The RECURSIVE tag can be used to specify whether or not subdirectories should
822 # The default value is: NO.
826 # The EXCLUDE tag can be used to specify files and/or directories that should be
827 # excluded from the INPUT source files. This way you can easily exclude a
828 # subdirectory from a directory tree whose root is specified with the INPUT tag.
830 # Note that relative paths are relative to the directory from which doxygen is
835 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
837 # from the input.
838 # The default value is: NO.
842 # If the value of the INPUT tag contains directories, you can use the
846 # Note that the wildcards are matched against the file with absolute path, so to
847 # exclude all test directories for example use the pattern */test/*
857 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
858 # (namespaces, classes, functions, etc.) that should be excluded from the
859 # output. The symbol name can be a fully qualified name, a word, or if the
863 # Note that the wildcards are matched against the file with absolute path, so to
864 # exclude all test directories use the pattern */test/*
868 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
869 # that contain example code fragments that are included (see the \include
874 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
876 # *.h) to filter out the source-files in the directories. If left blank all
881 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
882 # searched for input files to be used with the \include or \dontinclude commands
883 # irrespective of the value of the RECURSIVE tag.
884 # The default value is: NO.
888 # The IMAGE_PATH tag can be used to specify one or more files or directories
889 # that contain images that are to be included in the documentation (see the
894 # The INPUT_FILTER tag can be used to specify a program that doxygen should
895 # invoke to filter for each input file. Doxygen will invoke the filter program
896 # by executing (via popen()) the command:
900 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
901 # name of an input file. Doxygen will then use the output that the filter
905 # Note that the filter must not add or remove lines; it is applied before the
906 # code is scanned, but not when the output code is generated. If lines are added
907 # or removed, the anchors will not be placed correctly.
910 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
915 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
916 # basis. Doxygen will compare the file name with each pattern and apply the
917 # filter if there is a match. The filters are a list of the form: pattern=filter
919 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
920 # patterns match the file name, INPUT_FILTER is applied.
923 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
928 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
929 # INPUT_FILTER) will also be used to filter the input files that are used for
930 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
931 # The default value is: NO.
935 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
936 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
939 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
943 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
944 # is part of the input, its contents will be placed on the main page
946 # and want to reuse the introduction page also for the doxygen output.
954 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
957 # Note: To get rid of all source code in the generated output, make sure that
959 # The default value is: NO.
963 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
964 # classes and enums directly into the documentation.
965 # The default value is: NO.
969 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
972 # The default value is: YES.
976 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
978 # The default value is: NO.
982 # If the REFERENCES_RELATION tag is set to YES then for each documented function
984 # The default value is: NO.
988 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
989 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
990 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
991 # link to the documentation.
992 # The default value is: YES.
996 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
998 # brief description and links to the definition and documentation. Since this
999 # will make the HTML file larger and loading of large files a bit slower, you
1001 # The default value is: YES.
1002 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1006 # If the USE_HTAGS tag is set to YES then the references to source code will
1007 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1008 # source browser. The htags tool is part of GNU's global source tagging system
1012 # To use it do the following:
1013 # - Install the latest version of global
1014 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1015 # - Make sure the INPUT points to the root of the source tree
1019 # tools must be available from the command line (i.e. in the search path).
1021 # The result: instead of the source browser generated by doxygen, the links to
1022 # source code will now point to the output of htags.
1023 # The default value is: NO.
1024 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1028 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1029 # verbatim copy of the header file for each class for which an include is
1032 # The default value is: YES.
1037 # Configuration options related to the alphabetical class index
1040 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1041 # compounds will be generated. Enable this if the project contains a lot of
1043 # The default value is: YES.
1047 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1048 # which the alphabetical index list will be split.
1050 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1055 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1057 # while generating the index headers.
1058 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1063 # Configuration options related to the HTML output
1066 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1067 # The default value is: YES.
1071 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1072 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1074 # The default directory is: html.
1075 # This tag requires that the tag GENERATE_HTML is set to YES.
1079 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1081 # The default value is: .html.
1082 # This tag requires that the tag GENERATE_HTML is set to YES.
1086 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1087 # each generated HTML page. If the tag is left blank doxygen will generate a
1090 # To get valid HTML the header file that includes any scripts and style sheets
1091 # that doxygen needs, which is dependent on the configuration options used (e.g.
1092 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1096 # and then modify the file new_header.html. See also section "Doxygen usage"
1097 # for information on how to generate the default header that doxygen normally
1099 # Note: The header is subject to change so you typically have to regenerate the
1101 # of the possible markers and block names see the documentation.
1102 # This tag requires that the tag GENERATE_HTML is set to YES.
1106 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1107 # generated HTML page. If the tag is left blank doxygen will generate a standard
1109 # footer and what special commands can be used inside the footer. See also
1110 # section "Doxygen usage" for information on how to generate the default footer
1112 # This tag requires that the tag GENERATE_HTML is set to YES.
1116 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1117 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1118 # the HTML output. If left blank doxygen will generate a default style sheet.
1119 # See also section "Doxygen usage" for information on how to generate the style
1122 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1124 # This tag requires that the tag GENERATE_HTML is set to YES.
1128 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1129 # cascading style sheets that are included after the standard style sheets
1131 # This is preferred over using HTML_STYLESHEET since it does not replace the
1133 # Doxygen will copy the style sheet files to the output directory.
1134 # Note: The order of the extra style sheet files is of importance (e.g. the last
1135 # style sheet in the list overrules the setting of the previous ones in the
1136 # list). For an example see the documentation.
1137 # This tag requires that the tag GENERATE_HTML is set to YES.
1141 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1142 # other source files which should be copied to the HTML output directory. Note
1143 # that these files will be copied to the base HTML output directory. Use the
1144 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1145 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1147 # This tag requires that the tag GENERATE_HTML is set to YES.
1151 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1152 # will adjust the colors in the style sheet and background images according to
1154 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1158 # This tag requires that the tag GENERATE_HTML is set to YES.
1162 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1163 # in the HTML output. For a value of 0 the output will use grayscales only. A
1164 # value of 255 will produce the most vivid colors.
1166 # This tag requires that the tag GENERATE_HTML is set to YES.
1170 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1171 # luminance component of the colors in the HTML output. Values below 100
1172 # gradually make the output lighter, whereas values above 100 make the output
1173 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1174 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1175 # change the gamma.
1177 # This tag requires that the tag GENERATE_HTML is set to YES.
1181 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1182 # page will contain the date and time when the page was generated. Setting this
1183 # to YES can help to show when doxygen was last run and thus if the
1185 # The default value is: NO.
1186 # This tag requires that the tag GENERATE_HTML is set to YES.
1190 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1191 # documentation will contain sections that can be hidden and shown after the
1193 # The default value is: NO.
1194 # This tag requires that the tag GENERATE_HTML is set to YES.
1198 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1199 # shown in the various tree structured indices initially; the user can expand
1200 # and collapse entries dynamically later on. Doxygen will expand the tree to
1201 # such a level that at most the specified number of entries are visible (unless
1202 # a fully collapsed tree already exceeds this amount). So setting the number of
1207 # This tag requires that the tag GENERATE_HTML is set to YES.
1211 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1215 # Makefile in the HTML output directory. Running make will produce the docset in
1216 # that directory and running make install will install the docset in
1220 # The default value is: NO.
1221 # This tag requires that the tag GENERATE_HTML is set to YES.
1225 # This tag determines the name of the docset feed. A documentation feed provides
1228 # The default value is: Doxygen generated docs.
1229 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1233 # This tag specifies a string that should uniquely identify the documentation
1235 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1236 # The default value is: org.doxygen.Project.
1237 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1241 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1242 # the documentation publisher. This should be a reverse domain-name style
1244 # The default value is: org.doxygen.Publisher.
1245 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1249 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1250 # The default value is: Publisher.
1251 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1255 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1256 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1261 # The HTML Help Workshop contains a compiler that can convert all HTML output
1263 # files are now used as the Windows 98 help format, and will replace the old
1264 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1266 # words in the documentation. The HTML workshop also contains a viewer for
1268 # The default value is: NO.
1269 # This tag requires that the tag GENERATE_HTML is set to YES.
1273 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1274 # file. You can add a path in front of the file if the result should not be
1275 # written to the html output directory.
1276 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1280 # The HHC_LOCATION tag can be used to specify the location (absolute path
1281 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1282 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1283 # The file has to be specified with full path.
1284 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1288 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1289 # (YES) or that it should be included in the master .chm file (NO).
1290 # The default value is: NO.
1291 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1295 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1297 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1301 # The BINARY_TOC flag controls whether a binary table of contents is generated
1302 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1303 # enables the Previous and Next buttons.
1304 # The default value is: NO.
1305 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1309 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1310 # the table of contents of the HTML help documentation and to the tree view.
1311 # The default value is: NO.
1312 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1316 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1319 # (.qch) of the generated HTML documentation.
1320 # The default value is: NO.
1321 # This tag requires that the tag GENERATE_HTML is set to YES.
1325 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1326 # the file name of the resulting .qch file. The path specified is relative to
1327 # the HTML output folder.
1328 # This tag requires that the tag GENERATE_QHP is set to YES.
1332 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1335 # The default value is: org.doxygen.Project.
1336 # This tag requires that the tag GENERATE_QHP is set to YES.
1340 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1344 # The default value is: doc.
1345 # This tag requires that the tag GENERATE_QHP is set to YES.
1349 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1353 # This tag requires that the tag GENERATE_QHP is set to YES.
1357 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1361 # This tag requires that the tag GENERATE_QHP is set to YES.
1365 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1368 # This tag requires that the tag GENERATE_QHP is set to YES.
1372 # The QHG_LOCATION tag can be used to specify the location of Qt's
1373 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1375 # This tag requires that the tag GENERATE_QHP is set to YES.
1379 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1380 # generated, together with the HTML files, they form an Eclipse help plugin. To
1381 # install this plugin and make it available under the help contents menu in
1382 # Eclipse, the contents of the directory containing the HTML and XML files needs
1383 # to be copied into the plugins directory of eclipse. The name of the directory
1384 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1385 # After copying Eclipse needs to be restarted before the help appears.
1386 # The default value is: NO.
1387 # This tag requires that the tag GENERATE_HTML is set to YES.
1391 # A unique identifier for the Eclipse help plugin. When installing the plugin
1392 # the directory name containing the HTML and XML files should also have this
1394 # The default value is: org.doxygen.Project.
1395 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1399 # If you want full control over the layout of the generated HTML pages it might
1400 # be necessary to disable the index and replace it with your own. The
1401 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1402 # of each HTML page. A value of NO enables the index and the value YES disables
1403 # it. Since the tabs in the index contain the same information as the navigation
1405 # The default value is: NO.
1406 # This tag requires that the tag GENERATE_HTML is set to YES.
1410 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1411 # structure should be generated to display hierarchical information. If the tag
1413 # index structure (just like the one that is generated for HTML Help). For this
1415 # (i.e. any modern browser). Windows users are probably better off using the
1417 # further fine-tune the look of the index. As an example, the default style
1419 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1420 # the same information as the tab index, you could consider setting
1422 # The default value is: NO.
1423 # This tag requires that the tag GENERATE_HTML is set to YES.
1427 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1428 # doxygen will group on one line in the generated HTML documentation.
1430 # Note that a value of 0 will completely suppress the enum values from appearing
1431 # in the overview section.
1433 # This tag requires that the tag GENERATE_HTML is set to YES.
1437 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1438 # to set the initial width (in pixels) of the frame in which the tree is shown.
1440 # This tag requires that the tag GENERATE_HTML is set to YES.
1444 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1446 # The default value is: NO.
1447 # This tag requires that the tag GENERATE_HTML is set to YES.
1451 # Use this tag to change the font size of LaTeX formulas included as images in
1452 # the HTML documentation. When you change the font size after a successful
1453 # doxygen run you need to manually remove any form_*.png images from the HTML
1456 # This tag requires that the tag GENERATE_HTML is set to YES.
1460 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1465 # the HTML output directory before the changes have effect.
1466 # The default value is: YES.
1467 # This tag requires that the tag GENERATE_HTML is set to YES.
1471 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1472 # http://www.mathjax.org) which uses client side Javascript for the rendering
1474 # installed or if you want to formulas look prettier in the HTML output. When
1475 # enabled you may also need to install MathJax separately and configure the path
1476 # to it using the MATHJAX_RELPATH option.
1477 # The default value is: NO.
1478 # This tag requires that the tag GENERATE_HTML is set to YES.
1482 # When MathJax is enabled you can set the default output format to be used for
1483 # the MathJax output. See the MathJax site (see:
1485 # Possible values are: HTML-CSS (which is slower, but has the best
1487 # The default value is: HTML-CSS.
1488 # This tag requires that the tag USE_MATHJAX is set to YES.
1492 # When MathJax is enabled you need to specify the location relative to the HTML
1493 # output directory using the MATHJAX_RELPATH option. The destination directory
1494 # should contain the MathJax.js script. For instance, if the mathjax directory
1495 # is located at the same level as the HTML output directory, then
1496 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1497 # Content Delivery Network so you can quickly see the result without installing
1500 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1501 # This tag requires that the tag USE_MATHJAX is set to YES.
1505 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1508 # This tag requires that the tag USE_MATHJAX is set to YES.
1512 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1513 # of code that will be used on startup of the MathJax code. See the MathJax site
1515 # example see the documentation.
1516 # This tag requires that the tag USE_MATHJAX is set to YES.
1520 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1521 # the HTML output. The underlying search engine uses javascript and DHTML and
1525 # For large projects the javascript based search engine can be slow, then
1527 # search using the keyboard; to jump to the search box use <access key> + S
1528 # (what the <access key> is depends on the OS and browser, but it is typically
1529 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1530 # key> to jump into the search results window, the results can be navigated
1531 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1532 # the search. The filter options can be selected when the cursor is inside the
1533 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1534 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1536 # The default value is: YES.
1537 # This tag requires that the tag GENERATE_HTML is set to YES.
1541 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1543 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1545 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1546 # and searching needs to be provided by external tools. See the section
1548 # The default value is: NO.
1549 # This tag requires that the tag SEARCHENGINE is set to YES.
1553 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1554 # script for searching. Instead the search results are written to an XML file
1556 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1560 # (doxysearch.cgi) which are based on the open source search engine library
1563 # See the section "External Indexing and Searching" for details.
1564 # The default value is: NO.
1565 # This tag requires that the tag SEARCHENGINE is set to YES.
1569 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1570 # which will return the search results when EXTERNAL_SEARCH is enabled.
1573 # (doxysearch.cgi) which are based on the open source search engine library
1574 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1576 # This tag requires that the tag SEARCHENGINE is set to YES.
1580 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1581 # search data is written to a file for indexing by an external tool. With the
1582 # SEARCHDATA_FILE tag the name of this file can be specified.
1583 # The default file is: searchdata.xml.
1584 # This tag requires that the tag SEARCHENGINE is set to YES.
1588 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1589 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1591 # projects and redirect the results back to the right project.
1592 # This tag requires that the tag SEARCHENGINE is set to YES.
1596 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1597 # projects other than the one defined by this configuration file, but that are
1598 # all added to the same external search index. Each project needs to have a
1599 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1600 # to a relative location where the documentation can be found. The format is:
1602 # This tag requires that the tag SEARCHENGINE is set to YES.
1607 # Configuration options related to the LaTeX output
1610 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1611 # The default value is: YES.
1615 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1616 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1618 # The default directory is: latex.
1619 # This tag requires that the tag GENERATE_LATEX is set to YES.
1623 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1627 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1628 # written to the output directory.
1629 # The default file is: latex.
1630 # This tag requires that the tag GENERATE_LATEX is set to YES.
1634 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1636 # The default file is: makeindex.
1637 # This tag requires that the tag GENERATE_LATEX is set to YES.
1641 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1644 # The default value is: NO.
1645 # This tag requires that the tag GENERATE_LATEX is set to YES.
1649 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1653 # The default value is: a4.
1654 # This tag requires that the tag GENERATE_LATEX is set to YES.
1658 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1659 # that should be included in the LaTeX output. The package can be specified just
1660 # by its name or with the correct syntax as to be used with the LaTeX
1661 # \usepackage command. To get the times font for instance you can specify :
1663 # To use the option intlimits with the amsmath package you can specify:
1666 # This tag requires that the tag GENERATE_LATEX is set to YES.
1670 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1671 # generated LaTeX document. The header should contain everything until the first
1673 # section "Doxygen usage" for information on how to let doxygen write the
1676 # Note: Only use a user-defined header if you know what you are doing! The
1677 # following commands have a special meaning inside the header: $title,
1679 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1680 # string, for the replacement values of the other commands the user is referred
1682 # This tag requires that the tag GENERATE_LATEX is set to YES.
1686 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1687 # generated LaTeX document. The footer should contain everything after the last
1690 # special commands can be used inside the footer.
1693 # This tag requires that the tag GENERATE_LATEX is set to YES.
1697 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1698 # LaTeX style sheets that are included after the standard style sheets created
1700 # will copy the style sheet files to the output directory.
1701 # Note: The order of the extra style sheet files is of importance (e.g. the last
1702 # style sheet in the list overrules the setting of the previous ones in the
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1708 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1709 # other source files which should be copied to the LATEX_OUTPUT output
1710 # directory. Note that the files will be copied as-is; there are no commands or
1712 # This tag requires that the tag GENERATE_LATEX is set to YES.
1716 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1717 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1718 # contain links (just like the HTML output) instead of page references. This
1719 # makes the output suitable for online browsing using a PDF viewer.
1720 # The default value is: YES.
1721 # This tag requires that the tag GENERATE_LATEX is set to YES.
1725 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1726 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1728 # The default value is: YES.
1729 # This tag requires that the tag GENERATE_LATEX is set to YES.
1733 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1734 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1735 # if errors occur, instead of asking the user for help. This option is also used
1737 # The default value is: NO.
1738 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1743 # index chapters (such as File Index, Compound Index, etc.) in the output.
1744 # The default value is: NO.
1745 # This tag requires that the tag GENERATE_LATEX is set to YES.
1749 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1750 # code with syntax highlighting in the LaTeX output.
1754 # The default value is: NO.
1755 # This tag requires that the tag GENERATE_LATEX is set to YES.
1759 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1762 # The default value is: plain.
1763 # This tag requires that the tag GENERATE_LATEX is set to YES.
1767 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1768 # page will contain the date and time when the page was generated. Setting this
1769 # to NO can help when comparing the output of multiple runs.
1770 # The default value is: NO.
1771 # This tag requires that the tag GENERATE_LATEX is set to YES.
1776 # Configuration options related to the RTF output
1779 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1782 # The default value is: NO.
1786 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1787 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1789 # The default directory is: rtf.
1790 # This tag requires that the tag GENERATE_RTF is set to YES.
1794 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1797 # The default value is: NO.
1798 # This tag requires that the tag GENERATE_RTF is set to YES.
1802 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1803 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1804 # output) instead of page references. This makes the output suitable for online
1809 # The default value is: NO.
1810 # This tag requires that the tag GENERATE_RTF is set to YES.
1818 # See also section "Doxygen usage" for information on how to generate the
1820 # This tag requires that the tag GENERATE_RTF is set to YES.
1824 # Set optional variables used in the generation of an RTF document. Syntax is
1827 # This tag requires that the tag GENERATE_RTF is set to YES.
1831 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1832 # with syntax highlighting in the RTF output.
1836 # The default value is: NO.
1837 # This tag requires that the tag GENERATE_RTF is set to YES.
1842 # Configuration options related to the man page output
1845 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1847 # The default value is: NO.
1851 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1852 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1853 # it. A directory man3 will be created inside the directory specified by
1855 # The default directory is: man.
1856 # This tag requires that the tag GENERATE_MAN is set to YES.
1860 # The MAN_EXTENSION tag determines the extension that is added to the generated
1861 # man pages. In case the manual section does not start with a number, the number
1862 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1864 # The default value is: .3.
1865 # This tag requires that the tag GENERATE_MAN is set to YES.
1869 # The MAN_SUBDIR tag determines the name of the directory created within
1870 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1871 # MAN_EXTENSION with the initial . removed.
1872 # This tag requires that the tag GENERATE_MAN is set to YES.
1876 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1877 # will generate one additional man file for each entity documented in the real
1878 # man page(s). These additional files only source the real man page, but without
1879 # them the man command would be unable to find the correct page.
1880 # The default value is: NO.
1881 # This tag requires that the tag GENERATE_MAN is set to YES.
1886 # Configuration options related to the XML output
1889 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1890 # captures the structure of the code including all documentation.
1891 # The default value is: NO.
1895 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1896 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1898 # The default directory is: xml.
1899 # This tag requires that the tag GENERATE_XML is set to YES.
1903 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1905 # the XML output. Note that enabling this will significantly increase the size
1906 # of the XML output.
1907 # The default value is: YES.
1908 # This tag requires that the tag GENERATE_XML is set to YES.
1913 # Configuration options related to the DOCBOOK output
1916 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1918 # The default value is: NO.
1922 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1923 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1925 # The default directory is: docbook.
1926 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1930 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1932 # information) to the DOCBOOK output. Note that enabling this will significantly
1933 # increase the size of the DOCBOOK output.
1934 # The default value is: NO.
1935 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1940 # Configuration options for the AutoGen Definitions output
1943 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1944 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1945 # structure of the code including all documentation. Note that this feature is
1946 # still experimental and incomplete at the moment.
1947 # The default value is: NO.
1952 # Configuration options related to the Perl module output
1955 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1956 # file that captures the structure of the code including all documentation.
1958 # Note that this feature is still experimental and incomplete at the moment.
1959 # The default value is: NO.
1963 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1965 # output from the Perl module output.
1966 # The default value is: NO.
1967 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1971 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1973 # understand what is going on. On the other hand, if this tag is set to NO, the
1974 # size of the Perl module output will be much smaller and Perl will parse it
1975 # just the same.
1976 # The default value is: YES.
1977 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1981 # The names of the make variables in the generated doxyrules.make file are
1982 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1983 # so different doxyrules.make files included by the same Makefile don't
1985 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1990 # Configuration options related to the preprocessor
1993 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1994 # C-preprocessor directives found in the sources and include files.
1995 # The default value is: YES.
1999 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2000 # in the source code. If set to NO, only conditional compilation will be
2003 # The default value is: NO.
2004 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2008 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2009 # the macro expansion is limited to the macros specified with the PREDEFINED and
2011 # The default value is: NO.
2012 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2016 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2018 # The default value is: YES.
2019 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2023 # The INCLUDE_PATH tag can be used to specify one or more directories that
2024 # contain include files that are not input files but should be processed by the
2026 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2030 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2031 # patterns (like *.h and *.hpp) to filter out the header-files in the
2032 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2034 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2038 # The PREDEFINED tag can be used to specify one or more macro names that are
2039 # defined before the preprocessor is started (similar to the -D option of e.g.
2040 # gcc). The argument of the tag is a list of macros of the form: name or
2041 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2043 # recursively expanded use the := operator instead of the = operator.
2044 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2050 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2051 # tag can be used to specify a list of macro names that should be expanded. The
2052 # macro definition that is found in the sources will be used. Use the PREDEFINED
2053 # tag if you want to use a different macro definition that overrules the
2054 # definition found in the source code.
2055 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2059 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2062 # are typically used for boiler-plate code, and will confuse the parser if not
2064 # The default value is: YES.
2065 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2073 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2074 # file the location of the external documentation should be added. The format of
2077 # Adding location for the tag files is done as follows:
2079 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2080 # section "Linking to external documentation" for more information about the use
2082 # Note: Each tag file must have a unique name (where the name does NOT include
2083 # the path). If a tag file is not located in the directory in which doxygen is
2084 # run, you must also specify the path to the tagfile here.
2089 # tag file that is based on the input files it reads. See section "Linking to
2090 # external documentation" for more information about the usage of tag files.
2094 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2095 # the class index. If set to NO, only the inherited external classes will be
2097 # The default value is: NO.
2101 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2102 # in the modules index. If set to NO, only the current project's groups will be
2104 # The default value is: YES.
2108 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2109 # the related pages index. If set to NO, only the current project's pages will
2111 # The default value is: YES.
2115 # The PERL_PATH should be the absolute path and name of the perl script
2116 # interpreter (i.e. the result of 'which perl').
2117 # The default file (with absolute path) is: /usr/bin/perl.
2122 # Configuration options related to the dot tool
2125 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2126 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2127 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2130 # The default value is: YES.
2134 # You can define message sequence charts within doxygen comments using the \msc
2135 # command. Doxygen will then run the mscgen tool (see:
2136 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2137 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2138 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2144 # then run dia to produce the diagram and insert it in the documentation. The
2145 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2146 # If left empty dia is assumed to be found in the default search path.
2150 # If set to YES the inheritance and collaboration graphs will hide inheritance
2151 # and usage relations if the target is undocumented or is not a class.
2152 # The default value is: YES.
2156 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2157 # available from the path. This tool is part of Graphviz (see:
2159 # Bell Labs. The other options in this section have no effect if this option is
2161 # The default value is: NO.
2165 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2166 # to run in parallel. When set to 0 doxygen will base this on the number of
2167 # processors available in the system. You can set it explicitly to a value
2168 # larger than 0 to get control over the balance between CPU load and processing
2171 # This tag requires that the tag HAVE_DOT is set to YES.
2175 # When you want a differently looking font in the dot files that doxygen
2176 # generates you can specify the font name using DOT_FONTNAME. You need to make
2177 # sure dot is able to find the font, which can be done by putting it in a
2178 # standard location or by setting the DOTFONTPATH environment variable or by
2179 # setting DOT_FONTPATH to the directory containing the font.
2180 # The default value is: Helvetica.
2181 # This tag requires that the tag HAVE_DOT is set to YES.
2185 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2188 # This tag requires that the tag HAVE_DOT is set to YES.
2192 # By default doxygen will tell dot to use the default font as specified with
2194 # the path where dot can find it using this tag.
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2199 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2200 # each documented class showing the direct and indirect inheritance relations.
2201 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2202 # The default value is: YES.
2203 # This tag requires that the tag HAVE_DOT is set to YES.
2207 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2208 # graph for each documented class showing the direct and indirect implementation
2209 # dependencies (inheritance, containment, and class references variables) of the
2211 # The default value is: YES.
2212 # This tag requires that the tag HAVE_DOT is set to YES.
2216 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2217 # groups, showing the direct groups dependencies.
2218 # The default value is: YES.
2219 # This tag requires that the tag HAVE_DOT is set to YES.
2223 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2224 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2226 # The default value is: NO.
2227 # This tag requires that the tag HAVE_DOT is set to YES.
2231 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2232 # class node. If there are many fields or methods and many nodes the graph may
2233 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2234 # number of items for each type to make the size more manageable. Set this to 0
2235 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2236 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2237 # but if the number exceeds 15, the total amount of fields shown is limited to
2240 # This tag requires that the tag HAVE_DOT is set to YES.
2244 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2245 # collaboration graphs will show the relations between templates and their
2247 # The default value is: NO.
2248 # This tag requires that the tag HAVE_DOT is set to YES.
2252 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2253 # YES then doxygen will generate a graph for each documented file showing the
2254 # direct and indirect include dependencies of the file with other documented
2256 # The default value is: YES.
2257 # This tag requires that the tag HAVE_DOT is set to YES.
2261 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2263 # the direct and indirect include dependencies of the file with other documented
2265 # The default value is: YES.
2266 # This tag requires that the tag HAVE_DOT is set to YES.
2270 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2273 # Note that enabling this option will significantly increase the time of a run.
2275 # functions only using the \callgraph command. Disabling a call graph can be
2276 # accomplished by means of the command \hidecallgraph.
2277 # The default value is: NO.
2278 # This tag requires that the tag HAVE_DOT is set to YES.
2282 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2285 # Note that enabling this option will significantly increase the time of a run.
2287 # functions only using the \callergraph command. Disabling a caller graph can be
2288 # accomplished by means of the command \hidecallergraph.
2289 # The default value is: NO.
2290 # This tag requires that the tag HAVE_DOT is set to YES.
2294 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2296 # The default value is: YES.
2297 # This tag requires that the tag HAVE_DOT is set to YES.
2301 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2302 # dependencies a directory has on other directories in a graphical way. The
2303 # dependency relations are determined by the #include relations between the
2304 # files in the directories.
2305 # The default value is: YES.
2306 # This tag requires that the tag HAVE_DOT is set to YES.
2310 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2311 # generated by dot. For an explanation of the image formats see the section
2312 # output formats in the documentation of the dot tool (Graphviz (see:
2315 # to make the SVG files visible in IE 9+ (other browsers do not have this
2320 # The default value is: png.
2321 # This tag requires that the tag HAVE_DOT is set to YES.
2331 # the SVG files visible. Older versions of IE do not have SVG support.
2332 # The default value is: NO.
2333 # This tag requires that the tag HAVE_DOT is set to YES.
2337 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2338 # found. If left blank, it is assumed the dot tool can be found in the path.
2339 # This tag requires that the tag HAVE_DOT is set to YES.
2343 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2344 # contain dot files that are included in the documentation (see the \dotfile
2346 # This tag requires that the tag HAVE_DOT is set to YES.
2350 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2351 # contain msc files that are included in the documentation (see the \mscfile
2356 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2357 # contain dia files that are included in the documentation (see the \diafile
2362 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2363 # path where java can find the plantuml.jar file. If left blank, it is assumed
2366 # will not generate output for the diagram.
2370 # When using plantuml, the specified paths are searched for files specified by
2371 # the !include statement in a plantuml block.
2375 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2376 # that will be shown in the graph. If the number of nodes in a graph becomes
2377 # larger than this value, doxygen will truncate the graph, which is visualized
2378 # by representing a node as a red box. Note that doxygen if the number of direct
2379 # children of the root node in a graph is already larger than
2380 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2381 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2383 # This tag requires that the tag HAVE_DOT is set to YES.
2387 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2388 # generated by dot. A depth value of 3 means that only nodes reachable from the
2390 # further from the root node will be omitted. Note that setting this option to 1
2391 # or 2 may greatly reduce the computation time needed for large code bases. Also
2392 # note that the size of a graph can be further restricted by
2395 # This tag requires that the tag HAVE_DOT is set to YES.
2399 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2401 # to support this out of the box.
2403 # Warning: Depending on the platform used, enabling this option may lead to
2404 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2406 # The default value is: NO.
2407 # This tag requires that the tag HAVE_DOT is set to YES.
2411 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2412 # files in one run (i.e. multiple -o and -T options on the command line). This
2415 # The default value is: NO.
2416 # This tag requires that the tag HAVE_DOT is set to YES.
2420 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2421 # explaining the meaning of the various boxes and arrows in the dot generated
2423 # The default value is: YES.
2424 # This tag requires that the tag HAVE_DOT is set to YES.
2428 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2429 # files that are used to generate the various graphs.
2430 # The default value is: YES.
2431 # This tag requires that the tag HAVE_DOT is set to YES.