dmx/doxygen/doxygen.conf.in

3 # This file describes the settings to be used by the documentation system
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
52 # the logo to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
58 # entered, it will be relative to the location where doxygen was started. If
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
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
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.
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
98 # documentation (similar to Javadoc). Set to NO to disable this.
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
113 # used to form the text in various listings. Each string in this list, if found
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
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
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
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
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
159 # header file to include in order to use a class. If left blank only the name of
161 # specify the list of include paths that are normally passed to the compiler
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
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
193 # to treat a multi-line C++ comment block as a detailed description. Set this
194 # tag to YES if you prefer the old behavior instead.
196 # Note that setting this tag to YES also means that rational rose comments are
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
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
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216 # uses this value to replace tabs by spaces in code fragments.
221 # This tag can be used to specify a number of aliases that act as commands in
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
233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
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
247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
267 # Doxygen selects the parser to use depending on the extension of the files it
268 # parses. With this tag you can assign which parser to use for a given
274 # Fortran. In the later case the parser tries to guess whether the code is fixed
276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
287 # according to the Markdown format, which allows for more readable
296 # When enabled doxygen tries to link words that correspond to documented
297 # classes, or namespaces to their corresponding documentation. Such a link can
299 # globally by setting AUTOLINK_SUPPORT to NO.
305 # to include (a tag file for) the STL sources as input, then you should set this
306 # tag to YES in order to let doxygen match functions declarations and
314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
328 # For Microsoft's IDL there are propget and propput attributes to indicate
329 # getter and setter methods for a property. Setting this option to YES will make
330 # doxygen to replace the get and set methods by a property in the documentation.
332 # type. If this is not the case, or you want to show the methods anyway, you
333 # should set this option to NO.
339 # tag is set to YES then doxygen will reuse the documentation of the first
346 # If one adds a struct or class to a group and this option is enabled, then also
347 # any nested class or struct is added to the same group. By default this option
348 # is disabled and one has to add nested compounds explicitly via \ingroup.
353 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
354 # (for instance a group of public functions) to be put as a subgroup of that
355 # type (e.g. under the Public Functions section). Set it to NO to prevent
362 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
373 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
377 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
395 # cache is used to resolve symbols given their name and scope. Since this can be
400 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
411 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
414 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
416 # normally produced when WARNINGS is set to YES.
421 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
427 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
433 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
439 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
440 # locally in source files will be included in the documentation. If set to NO,
447 # This flag is only useful for Objective-C code. If set to YES, local methods,
449 # included in the documentation. If set to NO, only methods in the interface are
455 # If this flag is set to YES, the members of anonymous namespaces will be
464 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
465 # undocumented members inside documented classes or files. If set to NO these
472 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
474 # to NO, these classes will be included in the various overviews. This option
480 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
481 # (class|struct|union) declarations. If set to NO, these declarations will be
487 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
488 # documentation blocks found inside the body of a function. If set to NO, these
489 # blocks will be appended to the function's detailed documentation block.
495 # \internal command is included. If the tag is set to NO then the documentation
496 # will be excluded. Set it to YES to include the internal documentation.
501 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
502 # names in lower-case letters. If set to YES, upper-case letters are also
505 # and Mac users are advised to set this option to NO.
510 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
511 # their full class and namespace scopes in the documentation. If set to YES, the
517 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
518 # append additional text to a page's title, such as Class Reference. If set to
524 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
530 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
531 # grouped member an include statement to the documentation, telling the reader
532 # which file to include in order to use the member.
537 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
543 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
549 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
551 # name. If set to NO, the members will appear in declaration order.
556 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
558 # name. If set to NO, the members will appear in declaration order. Note that
564 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
566 # destructors are listed first. If set to NO the constructors will appear in the
568 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
570 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
576 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
577 # of group names into alphabetical order. If set to NO the group names will
583 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
584 # fully-qualified names, including namespaces. If set to NO, the class list will
586 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
587 # Note: This option applies only to the class list, not to the alphabetical
593 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
596 # only one candidate or it is obvious which candidate to choose by doing a
603 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
609 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
615 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
621 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
628 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
635 # initial value of a variable or macro / define can have for it to appear in the
637 # it will be hidden. Use a value of 0 to hide initializers completely. The
645 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
646 # the bottom of the documentation of classes and structs. If set to YES, the
647 # list will mention the files that were used to generate the documentation.
652 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
659 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
666 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
667 # doxygen should invoke to get the current version for each file (typically from
671 # by doxygen. Whatever the program writes to standard output is used as the file
676 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
678 # output files in an output format independent way. To create the layout file
689 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
692 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
694 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
695 # search path. See also \cite for info how to create references.
700 # Configuration options related to warning and progress messages
703 # The QUIET tag can be used to turn on/off the messages that are generated to
704 # standard output by doxygen. If QUIET is set to YES this implies that the
710 # The WARNINGS tag can be used to turn on/off the warning messages that are
711 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
719 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
720 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
726 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
734 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
736 # value. If set to NO, doxygen will only warn about wrong or incomplete
752 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
753 # messages should be written. If left blank the output is written to standard
759 # Configuration options related to the input files
762 # The INPUT tag is used to specify the files and/or directories that contain
772 # This tag can be used to specify the character encoding of the source files
782 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
783 # *.h) to filter out the source-files in the directories.
786 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
797 # The RECURSIVE tag can be used to specify whether or not subdirectories should
803 # The EXCLUDE tag can be used to specify files and/or directories that should be
807 # Note that relative paths are relative to the directory from which doxygen is
814 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
822 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
825 # Note that the wildcards are matched against the file with absolute path, so to
831 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
837 # Note that the wildcards are matched against the file with absolute path, so to
842 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
849 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
850 # *.h) to filter out the source-files in the directories. If left blank all
855 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
856 # searched for input files to be used with the \include or \dontinclude commands
862 # The IMAGE_PATH tag can be used to specify one or more files or directories
863 # that contain images that are to be included in the documentation (see the
868 # The INPUT_FILTER tag can be used to specify a program that doxygen should
869 # invoke to filter for each input file. Doxygen will invoke the filter program
876 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
885 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
894 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
895 # INPUT_FILTER) will also be used to filter the input files that are used for
896 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
901 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
903 # it is also possible to disable source filtering for a specific pattern using
905 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
909 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
912 # and want to reuse the introduction page also for the doxygen output.
917 # Configuration options related to source browsing
920 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
923 # Note: To get rid of all source code in the generated output, make sure that
924 # also VERBATIM_HEADERS is set to NO.
929 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
935 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
942 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
948 # If the REFERENCES_RELATION tag is set to YES then for each documented function
954 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
955 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
956 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
957 # link to the documentation.
964 # brief description and links to the definition and documentation. Since this
966 # can opt to disable this feature.
968 # This tag requires that the tag SOURCE_BROWSER is set to YES.
972 # If the USE_HTAGS tag is set to YES then the references to source code will
973 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
978 # To use it do the following:
981 # - Make sure the INPUT points to the root of the source tree
987 # The result: instead of the source browser generated by doxygen, the links to
988 # source code will now point to the output of htags.
990 # This tag requires that the tag SOURCE_BROWSER is set to YES.
996 # specified. Set to NO to disable this.
1003 # Configuration options related to the alphabetical class index
1006 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1013 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1016 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1022 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1024 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1029 # Configuration options related to the HTML output
1032 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1037 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1041 # This tag requires that the tag GENERATE_HTML is set to YES.
1045 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1048 # This tag requires that the tag GENERATE_HTML is set to YES.
1052 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1056 # To get valid HTML the header file that includes any scripts and style sheets
1058 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1063 # for information on how to generate the default header that doxygen normally
1065 # Note: The header is subject to change so you typically have to regenerate the
1066 # default header when upgrading to a newer version of doxygen. For a description
1068 # This tag requires that the tag GENERATE_HTML is set to YES.
1072 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1074 # footer. See HTML_HEADER for more information on how to generate a default
1076 # section "Doxygen usage" for information on how to generate the default footer
1078 # This tag requires that the tag GENERATE_HTML is set to YES.
1082 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1083 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1085 # See also section "Doxygen usage" for information on how to generate the style
1087 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1090 # This tag requires that the tag GENERATE_HTML is set to YES.
1094 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1099 # Doxygen will copy the style sheet files to the output directory.
1103 # This tag requires that the tag GENERATE_HTML is set to YES.
1107 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1108 # other source files which should be copied to the HTML output directory. Note
1109 # that these files will be copied to the base HTML output directory. Use the
1110 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1113 # This tag requires that the tag GENERATE_HTML is set to YES.
1118 # will adjust the colors in the style sheet and background images according to
1124 # This tag requires that the tag GENERATE_HTML is set to YES.
1132 # This tag requires that the tag GENERATE_HTML is set to YES.
1136 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1143 # This tag requires that the tag GENERATE_HTML is set to YES.
1147 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1149 # to YES can help to show when doxygen was last run and thus if the
1150 # documentation is up to date.
1152 # This tag requires that the tag GENERATE_HTML is set to YES.
1156 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1160 # This tag requires that the tag GENERATE_HTML is set to YES.
1166 # and collapse entries dynamically later on. Doxygen will expand the tree to
1173 # This tag requires that the tag GENERATE_HTML is set to YES.
1177 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1180 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1187 # This tag requires that the tag GENERATE_HTML is set to YES.
1195 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1201 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1203 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1211 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1217 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1221 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1235 # This tag requires that the tag GENERATE_HTML is set to YES.
1239 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1241 # written to the html output directory.
1242 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1246 # The HHC_LOCATION tag can be used to specify the location (absolute path
1248 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1249 # The file has to be specified with full path.
1250 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1257 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1261 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1263 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1275 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1276 # the table of contents of the HTML help documentation and to the tree view.
1278 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1282 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1284 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1287 # This tag requires that the tag GENERATE_HTML is set to YES.
1291 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1292 # the file name of the resulting .qch file. The path specified is relative to
1294 # This tag requires that the tag GENERATE_QHP is set to YES.
1298 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1302 # This tag requires that the tag GENERATE_QHP is set to YES.
1306 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1311 # This tag requires that the tag GENERATE_QHP is set to YES.
1316 # filter to add. For more information please see Qt Help Project / Custom
1319 # This tag requires that the tag GENERATE_QHP is set to YES.
1324 # custom filter to add. For more information please see Qt Help Project / Custom
1327 # This tag requires that the tag GENERATE_QHP is set to YES.
1334 # This tag requires that the tag GENERATE_QHP is set to YES.
1338 # The QHG_LOCATION tag can be used to specify the location of Qt's
1339 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1341 # This tag requires that the tag GENERATE_QHP is set to YES.
1345 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1346 # generated, together with the HTML files, they form an Eclipse help plugin. To
1349 # to be copied into the plugins directory of eclipse. The name of the directory
1351 # After copying Eclipse needs to be restarted before the help appears.
1353 # This tag requires that the tag GENERATE_HTML is set to YES.
1361 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1366 # be necessary to disable the index and replace it with your own. The
1367 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1370 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1372 # This tag requires that the tag GENERATE_HTML is set to YES.
1376 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1377 # structure should be generated to display hierarchical information. If the tag
1378 # value is set to YES, a side panel will be generated containing a tree-like
1380 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1384 # sheet generated by doxygen has an example that shows how to put an image at
1387 # DISABLE_INDEX to YES when enabling this option.
1389 # This tag requires that the tag GENERATE_HTML is set to YES.
1393 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1399 # This tag requires that the tag GENERATE_HTML is set to YES.
1404 # to set the initial width (in pixels) of the frame in which the tree is shown.
1406 # This tag requires that the tag GENERATE_HTML is set to YES.
1410 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1413 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 # Use this tag to change the font size of LaTeX formulas included as images in
1419 # doxygen run you need to manually remove any form_*.png images from the HTML
1420 # output directory to force them to be regenerated.
1422 # This tag requires that the tag GENERATE_HTML is set to YES.
1426 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1430 # Note that when changing this option you need to delete any form_*.png files in
1433 # This tag requires that the tag GENERATE_HTML is set to YES.
1437 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1440 # installed or if you want to formulas look prettier in the HTML output. When
1441 # enabled you may also need to install MathJax separately and configure the path
1442 # to it using the MATHJAX_RELPATH option.
1444 # This tag requires that the tag GENERATE_HTML is set to YES.
1448 # When MathJax is enabled you can set the default output format to be used for
1454 # This tag requires that the tag USE_MATHJAX is set to YES.
1458 # When MathJax is enabled you need to specify the location relative to the HTML
1462 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1464 # MathJax. However, it is strongly recommended to install a local copy of
1467 # This tag requires that the tag USE_MATHJAX is set to YES.
1471 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1474 # This tag requires that the tag USE_MATHJAX is set to YES.
1478 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1482 # This tag requires that the tag USE_MATHJAX is set to YES.
1492 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1493 # search using the keyboard; to jump to the search box use <access key> + S
1496 # key> to jump into the search results window, the results can be navigated
1497 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1500 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1503 # This tag requires that the tag GENERATE_HTML is set to YES.
1512 # and searching needs to be provided by external tools. See the section
1515 # This tag requires that the tag SEARCHENGINE is set to YES.
1520 # script for searching. Instead the search results are written to an XML file
1521 # which needs to be processed by an external indexer. Doxygen will invoke an
1522 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1531 # This tag requires that the tag SEARCHENGINE is set to YES.
1535 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1542 # This tag requires that the tag SEARCHENGINE is set to YES.
1547 # search data is written to a file for indexing by an external tool. With the
1550 # This tag requires that the tag SEARCHENGINE is set to YES.
1556 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1557 # projects and redirect the results back to the right project.
1558 # This tag requires that the tag SEARCHENGINE is set to YES.
1562 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1564 # all added to the same external search index. Each project needs to have a
1566 # to a relative location where the documentation can be found. The format is:
1568 # This tag requires that the tag SEARCHENGINE is set to YES.
1573 # Configuration options related to the LaTeX output
1576 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1581 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1585 # This tag requires that the tag GENERATE_LATEX is set to YES.
1589 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1594 # written to the output directory.
1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
1600 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1603 # This tag requires that the tag GENERATE_LATEX is set to YES.
1607 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1608 # documents. This may be useful for small projects and may help to save some
1611 # This tag requires that the tag GENERATE_LATEX is set to YES.
1615 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1620 # This tag requires that the tag GENERATE_LATEX is set to YES.
1624 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1626 # by its name or with the correct syntax as to be used with the LaTeX
1627 # \usepackage command. To get the times font for instance you can specify :
1629 # To use the option intlimits with the amsmath package you can specify:
1632 # This tag requires that the tag GENERATE_LATEX is set to YES.
1636 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1639 # section "Doxygen usage" for information on how to let doxygen write the
1640 # default header to a separate file.
1647 # to HTML_HEADER.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1655 # LATEX_HEADER for more information on how to generate a default footer and what
1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
1663 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1666 # will copy the style sheet files to the output directory.
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
1674 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1675 # other source files which should be copied to the LATEX_OUTPUT output
1678 # This tag requires that the tag GENERATE_LATEX is set to YES.
1682 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1683 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
1691 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1692 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1695 # This tag requires that the tag GENERATE_LATEX is set to YES.
1699 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1700 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1708 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1715 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1721 # This tag requires that the tag GENERATE_LATEX is set to YES.
1725 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1729 # This tag requires that the tag GENERATE_LATEX is set to YES.
1733 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1735 # to NO can help when comparing the output of multiple runs.
1737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 # Configuration options related to the RTF output
1745 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1752 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1756 # This tag requires that the tag GENERATE_RTF is set to YES.
1760 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1761 # documents. This may be useful for small projects and may help to save some
1764 # This tag requires that the tag GENERATE_RTF is set to YES.
1768 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1776 # This tag requires that the tag GENERATE_RTF is set to YES.
1780 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1781 # file, i.e. a series of assignments. You only have to provide replacements,
1782 # missing definitions are set to their default value.
1784 # See also section "Doxygen usage" for information on how to generate the
1786 # This tag requires that the tag GENERATE_RTF is set to YES.
1791 # similar to doxygen's config file. A template extensions file can be generated
1793 # This tag requires that the tag GENERATE_RTF is set to YES.
1797 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1803 # This tag requires that the tag GENERATE_RTF is set to YES.
1808 # Configuration options related to the man page output
1811 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1817 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1822 # This tag requires that the tag GENERATE_MAN is set to YES.
1826 # The MAN_EXTENSION tag determines the extension that is added to the generated
1831 # This tag requires that the tag GENERATE_MAN is set to YES.
1836 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1838 # This tag requires that the tag GENERATE_MAN is set to YES.
1842 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1845 # them the man command would be unable to find the correct page.
1847 # This tag requires that the tag GENERATE_MAN is set to YES.
1852 # Configuration options related to the XML output
1855 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1861 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1865 # This tag requires that the tag GENERATE_XML is set to YES.
1869 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1870 # listings (including syntax highlighting and cross-referencing information) to
1874 # This tag requires that the tag GENERATE_XML is set to YES.
1879 # Configuration options related to the DOCBOOK output
1882 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1883 # that can be used to generate PDF.
1888 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1892 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1896 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1898 # information) to the DOCBOOK output. Note that enabling this will significantly
1901 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1909 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1918 # Configuration options related to the Perl module output
1921 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1929 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1930 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1933 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1937 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1938 # formatted so it can be parsed by a human reader. This is useful if you want to
1939 # understand what is going on. On the other hand, if this tag is set to NO, the
1943 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1951 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1956 # Configuration options related to the preprocessor
1959 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1965 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1966 # in the source code. If set to NO, only conditional compilation will be
1968 # EXPAND_ONLY_PREDEF to YES.
1970 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1974 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1975 # the macro expansion is limited to the macros specified with the PREDEFINED and
1978 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1982 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
1985 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1989 # The INCLUDE_PATH tag can be used to specify one or more directories that
1992 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1996 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1997 # patterns (like *.h and *.hpp) to filter out the header-files in the
2000 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2004 # The PREDEFINED tag can be used to specify one or more macro names that are
2005 # defined before the preprocessor is started (similar to the -D option of e.g.
2008 # is assumed. To prevent a macro definition from being undefined via #undef or
2010 # 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
2020 # tag if you want to use a different macro definition that overrules the
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
2027 # remove all references to function-like macros that are alone on a line, have
2032 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2037 # Configuration options related to external references
2040 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2047 # section "Linking to external documentation" for more information about the use
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
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
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
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
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
2095 # disabled, but it is recommended to install and use dot, since it yields more
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
2123 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2127 # set to NO
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.
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
2146 # setting DOT_FONTPATH to the directory containing the font.
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
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
2168 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
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
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
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
2194 # This tag requires that the tag HAVE_DOT is set to YES.
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
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
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
2224 # This tag requires that the tag HAVE_DOT is set to YES.
2229 # set to YES then doxygen will generate a graph for each documented file showing
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
2241 # So in most cases it will be better to enable call graphs for selected
2245 # This tag requires that the tag HAVE_DOT is set to YES.
2249 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2253 # So in most cases it will be better to enable caller graphs for selected
2257 # This tag requires that the tag HAVE_DOT is set to YES.
2261 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2264 # This tag requires that the tag HAVE_DOT is set to YES.
2268 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2273 # This tag requires that the tag HAVE_DOT is set to YES.
2277 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2281 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2282 # to make the SVG files visible in IE 9+ (other browsers do not have this
2288 # This tag requires that the tag HAVE_DOT is set to YES.
2292 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2297 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2300 # This tag requires that the tag HAVE_DOT is set to YES.
2304 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2306 # This tag requires that the tag HAVE_DOT is set to YES.
2310 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2313 # This tag requires that the tag HAVE_DOT is set to YES.
2317 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2323 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2329 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2342 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2350 # This tag requires that the tag HAVE_DOT is set to YES.
2354 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2357 # further from the root node will be omitted. Note that setting this option to 1
2362 # This tag requires that the tag HAVE_DOT is set to YES.
2366 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2368 # to support this out of the box.
2370 # Warning: Depending on the platform used, enabling this option may lead to
2371 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2374 # This tag requires that the tag HAVE_DOT is set to YES.
2378 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2383 # This tag requires that the tag HAVE_DOT is set to YES.
2387 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2391 # This tag requires that the tag HAVE_DOT is set to YES.
2395 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2396 # files that are used to generate the various graphs.
2398 # This tag requires that the tag HAVE_DOT is set to YES.