Doxyfile - OpenGrok cross reference for /OK3568_Linux_fs/buildroot/dl/sox/git/Doxyfile

3 # This file describes the settings to be used by the documentation system
27 # to put quotes around the project name if it contains spaces.
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
46 # Doxygen will copy the logo to the output directory.
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
52 # If a relative path is entered, it will be relative to the location
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
68 # information to generate all constant output in the proper language.
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
81 # the file and class documentation (similar to JavaDoc).
82 # Set to NO to disable this.
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
94 # that is used to form the text in various listings. Each string
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
130 # to NO the shortest path that makes the file name unique will be used.
134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135 # can be used to strip a user-defined part of the path. Stripping is
137 # the path. The tag can be used to show relative paths in the file list.
139 # path to strip.
143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
145 # the reader which header file to include in order to use a class.
148 # are normally passed to the compiler using the -I flag.
152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
160 # comment as the brief description. If set to NO, the JavaDoc
166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
168 # comment as the brief description. If set to NO, the comments
174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
176 # comments) as a brief description. This used to be the default behaviour.
177 # The new default is to treat a multi-line C++ comment block as a detailed
178 # description. Set this tag to YES if you prefer the old behaviour instead.
182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
189 # a new page for each member. If set to NO, the documentation of a member will
194 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
195 # Doxygen uses this value to replace tabs by spaces in code fragments.
199 # This tag can be used to specify a number of aliases that acts
201 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
204 # You can put \n's in the value part of an alias to insert newlines.
208 # This tag can be used to specify a number of word-keyword mappings (TCL only).
210 # "class=itcl::class" will allow you to use the command class in the
215 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
222 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
229 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
235 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
241 # Doxygen selects the parser to use depending on the extension of the files it
242 # parses. With this tag you can assign which parser to use for a given extension.
246 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
249 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
254 # to include (a tag file for) the STL sources as input, then you should
255 # set this tag to YES in order to let doxygen match functions declarations and
262 # If you use Microsoft's C++/CLI language, you should set this option to YES to
267 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
273 # For Microsoft's IDL there are propget and propput attributes to indicate getter
274 # and setter methods for a property. Setting this option to YES (the default)
277 # setting a simple type. If this is not the case, or you want to show the
278 # methods anyway, you should set this option to NO.
283 # tag is set to YES, then doxygen will reuse the documentation of the first
289 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
290 # the same type (for instance a group of public functions) to be put as a
291 # subgroup of that type (e.g. under the Public Functions section). Set it to
292 # NO to prevent subgrouping. Alternatively, this can be done per class using
297 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
304 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
307 # documentation), provided this scope is documented. If set to NO (the default),
323 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
324 # determine which symbols to keep in memory and which to flush to disk.
325 # When the cache is full, less often used symbols will be written to disk.
326 # For small to medium size projects (<1000 input files) the default value is
328 # doxygen to be busy swapping symbols to and from disk most of the time
335 # corresponding to a cache size of 2^16 = 65536 symbols.
339 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
340 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
346 # corresponding to a cache size of 2^16 = 65536 symbols.
354 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
357 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
361 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
366 # If the EXTRACT_STATIC tag is set to YES all static members of a file
371 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
373 # If set to NO only classes defined in header files are included.
377 # This flag is only useful for Objective-C code. When set to YES local
380 # If set to NO (the default) only methods in the interface are included.
384 # If this flag is set to YES, the members of anonymous namespaces will be
392 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
394 # If set to NO (the default) these members will be included in the
400 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
402 # If set to NO (the default) these classes will be included in the various
407 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
409 # If set to NO (the default) these declarations will be included in the
414 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
416 # If set to NO (the default) these blocks will be appended to the
423 # to NO (the default) then the documentation will be excluded.
424 # Set it to YES to include the internal documentation.
428 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
429 # file names in lower-case letters. If set to YES upper-case letters are also
432 # and Mac users are advised to set this option to NO.
436 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
438 # documentation. If set to YES the scope will be hidden.
442 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
448 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
454 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
459 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
461 # alphabetically by member name. If set to NO the members will appear in
466 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
468 # by member name. If set to NO (the default) the members will appear in
473 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
475 # constructors and destructors are listed first. If set to NO (the default)
478 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
479 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
483 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
484 # hierarchy of group names into alphabetical order. If set to NO (the default)
489 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
490 # sorted by fully-qualified names, including namespaces. If set to
493 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
494 # Note: This option applies only to the class list, not to the
499 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
502 # if there is only one candidate or it is obvious which candidate to choose
508 # The GENERATE_TODOLIST tag can be used to enable (YES) or
514 # The GENERATE_TESTLIST tag can be used to enable (YES) or
520 # The GENERATE_BUGLIST tag can be used to enable (YES) or
526 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
532 # The ENABLED_SECTIONS tag can be used to enable conditional
538 # the initial value of a variable or macro consists of for it to appear in
540 # here it will be hidden. Use a value of 0 to hide initializers completely.
547 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
548 # at the bottom of the documentation of classes and structs. If set to YES the
549 # list will mention the files that were used to generate the documentation.
554 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
559 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
565 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
571 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
572 # doxygen should invoke to get the current version for each file (typically from
576 # provided by doxygen. Whatever the program writes to standard output
581 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
590 # The CITE_BIB_FILES tag can be used to specify one or more bib files
593 # requires the bibtex tool to be installed. See also
595 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
601 # configuration options related to warning and progress messages
604 # The QUIET tag can be used to turn on/off the messages that are generated
609 # The WARNINGS tag can be used to turn on/off the warning messages that are
615 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
616 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
621 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
628 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
630 # or return value. If set to NO (the default) doxygen will only warn about
645 # The WARN_LOGFILE tag can be used to specify a file to which warning
647 # to stderr.
652 # configuration options related to the input files
655 # The INPUT tag can be used to specify the files and/or directories that contain
662 # This tag can be used to specify the character encoding of the source files
671 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
672 # and *.h) to filter out the source-files in the directories. If left
680 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
686 # The EXCLUDE tag can be used to specify files and/or directories that should be
689 # Note that relative paths are relative to the directory from which doxygen is
694 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
701 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
703 # against the file with absolute path, so to exclude all test directories
708 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
716 # The EXAMPLE_PATH tag can be used to specify one or more files or
723 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
724 # and *.h) to filter out the source-files in the directories. If left
729 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
730 # searched for input files to be used with the \include or \dontinclude
736 # The IMAGE_PATH tag can be used to specify one or more files or
742 # The INPUT_FILTER tag can be used to specify a program that doxygen should
743 # invoke to filter for each input file. Doxygen will invoke the filter program
747 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
752 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
761 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
762 # INPUT_FILTER) will be used to filter the input files when producing source
763 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
767 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
769 # and it is also possible to disable source filtering for a specific pattern
776 # configuration options related to source browsing
779 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
781 # Note: To get rid of all source code in the generated output, make sure also
782 # VERBATIM_HEADERS is set to NO.
786 # Setting the INLINE_SOURCES tag to YES will include the body
791 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
792 # doxygen to hide any special comment blocks from generated source code
797 # If the REFERENCED_BY_RELATION tag is set to YES
803 # If the REFERENCES_RELATION tag is set to YES
809 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
810 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
812 # link to the source code.  Otherwise they will link to the documentation.
816 # If the USE_HTAGS tag is set to YES then the references to source code
817 # will point to the HTML generated by the htags(1) tool instead of doxygen
824 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
826 # which an include is specified. Set to NO to disable this.
831 # configuration options related to the alphabetical class index
834 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
841 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
848 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
854 # configuration options related to the HTML output
857 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
862 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
868 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
874 # The HTML_HEADER tag can be used to specify a personal HTML header for
879 # It is advised to generate a default header using "doxygen -w html
881 # that header. Note that the header is subject to change so you typically
882 # have to redo this when upgrading to a newer version of doxygen or when
887 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
893 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
894 # style sheet that is used by each HTML page. It can be used to
896 # will generate a default style sheet. Note that doxygen will try to copy
897 # the style sheet file to the HTML output directory, so don't put your own
902 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
903 # other source files which should be copied to the HTML output directory. Note
904 # that these files will be copied to the base HTML output directory. Use the
905 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
913 # according to this color. Hue is specified as an angle on a colorwheel,
917 # The allowed range is 0 to 359.
927 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
936 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
938 # this to NO can help when comparing the output of multiple runs.
942 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
943 # files or namespaces will be aligned in HTML using tables. If set to
948 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
950 # page has loaded. For this to work a browser that supports
956 # If the GENERATE_DOCSET tag is set to YES, additional index files
959 # To create a documentation set, doxygen will generate a Makefile in the
969 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
976 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
979 # will append .docset to the name.
993 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
995 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1000 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1001 # be used to specify the file name of the resulting .chm file. You
1003 # written to the html output directory.
1007 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1008 # be used to specify the location (absolute path including file name) of
1009 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1014 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1020 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1021 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1026 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1032 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1033 # to the contents of the HTML help documentation and to the tree view.
1037 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1039 # that can be used as input for Qt's qhelpgenerator to generate a
1045 # be used to specify the file name of the resulting .qch file.
1046 # The path specified is relative to the HTML output folder.
1050 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1056 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1062 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1069 # custom filter to add. For more information please see
1083 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1084 # be used to specify the location of Qt's qhelpgenerator.
1085 # If non-empty doxygen will try to run qhelpgenerator on the generated
1090 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1092 # plugin. To install this plugin and make it available under the help contents
1094 # files needs to be copied into the plugins directory of eclipse. The name of
1096 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1107 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1110 # navigation tree you can set this option to NO if you already set
1111 # GENERATE_TREEVIEW to YES.
1115 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1116 # structure should be generated to display hierarchical information.
1117 # If the tag value is set to YES, a side panel will be generated
1119 # is generated for HTML Help). For this to work a browser that supports
1123 # could consider to set DISABLE_INDEX to NO when enabling this option.
1127 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1140 # used to set the initial width (in pixels) of the frame in which the tree
1145 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1146 # links to external symbols imported via tag files in a separate window.
1150 # Use this tag to change the font size of Latex formulas included
1153 # to manually remove any form_*.png images from the HTML output directory
1154 # to force them to be regenerated.
1158 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1161 # Note that when changing this option you need to delete any form_*.png files
1166 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1169 # have LaTeX installed or if you want to formulas look prettier in the HTML
1170 # output. When enabled you also need to install MathJax separately and
1171 # configure the path to it using the MATHJAX_RELPATH option.
1175 # When MathJax is enabled you need to specify the location relative to the
1179 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1181 # MathJax, but it is strongly recommended to install a local copy of MathJax
1186 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1204 # file to put on the web server. The advantage of the server
1205 # based approach is that it scales better to large projects and allows
1206 # full text search. The disadvantages are that it is more difficult to setup
1212 # configuration options related to the LaTeX output
1215 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1220 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1226 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1230 # Makefile that is written to the output directory.
1234 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1240 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1241 # LaTeX documents. This may be useful for small projects and may help to
1246 # The PAPER_TYPE tag can be used to set the paper type that is used
1252 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1257 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1264 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1271 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1272 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1278 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1279 # plain latex in the generated Makefile. Set this option to YES to get a
1284 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1285 # command to the generated LaTeX files. This will instruct LaTeX to keep
1291 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1297 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1304 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1311 # configuration options related to the RTF output
1314 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1320 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1326 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1327 # RTF documents. This may be useful for small projects and may help to
1332 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1341 # Load style sheet definitions from file. Syntax is similar to doxygen's
1342 # config file, i.e. a series of assignments. You only have to provide
1343 # replacements, missing definitions are set to their default value.
1348 # Syntax is similar to doxygen's config file.
1353 # configuration options related to the man page output
1356 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1361 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1367 # The MAN_EXTENSION tag determines the extension that is added to
1372 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1376 # would be unable to find the correct page. The default is NO.
1381 # configuration options related to the XML output
1384 # If the GENERATE_XML tag is set to YES Doxygen will
1390 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1396 # The XML_SCHEMA tag can be used to specify an XML schema,
1397 # which can be used by a validating XML parser to check the
1402 # The XML_DTD tag can be used to specify an XML DTD,
1403 # which can be used by a validating XML parser to check the
1408 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1410 # and cross-referencing information) to the XML output. Note that
1419 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1428 # configuration options related to the Perl module output
1431 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1439 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1440 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1441 # to generate PDF and DVI output from the Perl module output.
1445 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1447 # if you want to understand what is going on.  On the other hand, if this
1448 # tag is set to NO the size of the Perl module output will be much smaller
1461 # Configuration options related to the preprocessor
1464 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1470 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1471 # names in the source code. If set to NO (the default) only conditional
1473 # way by setting EXPAND_ONLY_PREDEF to YES.
1477 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1478 # then the macro expansion is limited to the macros specified with the
1483 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1484 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1488 # The INCLUDE_PATH tag can be used to specify one or more directories that
1494 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1495 # patterns (like *.h and *.hpp) to filter out the header-files in the
1501 # The PREDEFINED tag can be used to specify one or more macro names that
1502 # are defined before the preprocessor is started (similar to the -D option of
1505 # omitted =1 is assumed. To prevent a macro definition from being
1520 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1521 # this tag can be used to specify a list of macro names that should be expanded.
1523 # Use the PREDEFINED tag if you want to use a different macro definition that
1528 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1529 # doxygen's preprocessor will remove all references to function-like macros
1536 # Configuration::additions related to external references
1539 # The TAGFILES option can be used to specify one or more tagfiles.
1548 # does not have to be run to correct the links.
1552 # is run, you must also specify the path to the tagfile here.
1561 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1562 # in the class index. If set to NO only the inherited external classes
1567 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1568 # in the modules index. If set to NO, only the current project's groups will
1579 # Configuration options related to the dot tool
1582 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1584 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1585 # this option also works with HAVE_DOT disabled, but it is recommended to
1592 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1593 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1594 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1599 # If set to YES, the inheritance and collaboration graphs will hide
1605 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1608 # have no effect if this option is set to NO (the default)
1613 # allowed to run in parallel. When set to 0 (the default) doxygen will
1615 # explicitly to a value larger than 0 to get control over the balance
1622 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1624 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1629 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1634 # By default doxygen will tell dot to use the Helvetica font.
1635 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1640 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1642 # indirect inheritance relations. Setting this tag to YES will force the
1643 # CLASS_DIAGRAMS tag to NO.
1647 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1654 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1659 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1660 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1665 # If set to YES, the inheritance and collaboration graphs will show the
1671 # tags are set to YES then doxygen will generate a graph for each documented
1678 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1684 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1687 # the time of a run. So in most cases it will be better to enable call graphs
1692 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1695 # the time of a run. So in most cases it will be better to enable caller
1700 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1705 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1712 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1714 # If left blank png will be used. If you choose svg you need to set
1715 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1720 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1724 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1729 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1734 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1740 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1746 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1756 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1760 # option to 1 or 2 may greatly reduce the computation time needed for large
1766 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1768 # seem to support this out of the box. Warning: Depending on the platform used,
1769 # enabling this option may lead to badly anti-aliased labels on the edges of
1770 # a graph (i.e. they become hard to read).
1774 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1781 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1787 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1788 # remove the intermediate dot files that are used to generate