Doxyfile - OpenGrok cross reference for /honee/Doxyfile

3 # This file describes the settings to be used by the documentation system
20 # doxygen -x [configFile]
24 # doxygen -x_noenv [configFile]
26 #---------------------------------------------------------------------------
28 #---------------------------------------------------------------------------
31 # file that follow. The default is UTF-8 which is also the encoding used for all
35 # The default value is: UTF-8.
37 DOXYFILE_ENCODING      = UTF-8
39 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40 # double-quotes, unless you are using Doxywizard) that should identify the
57 PROJECT_BRIEF          = "HONEE - High-Order Navier-stokes Equation Evaluator"
74 # sub-directories (in 2 levels) under the output directory of each output format
79 # control the number of sub-directories.
84 # Controls the number of sub-directories that will be created when
88 # sub-directories are organized in 2 levels, the first level always has a fixed
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
96 # characters to appear in the names of generated files. If set to NO, non-ASCII
104 # documentation generated by doxygen is written. Doxygen will use this
107 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
109 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
110 # English messages), Korean, Korean-en (Korean with English messages), Latvian,
112 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
134 # This tag implements a quasi-intelligent brief description abbreviator that is
138 # text. Otherwise, the brief description is used as-is. If left blank, the
177 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
178 # Stripping is only done if one of the specified strings matches the left-hand
189 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
194 # using the -I flag.
200 # support long names like on DOS, Mac, or CD-ROM.
206 # first line (until the first dot) of a Javadoc-style comment as the brief
207 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
217 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
218 # Javadoc-style will behave just like regular comments and it will not be
219 # interpreted by doxygen.
225 # line (until the first dot) of a Qt-style comment as the brief description. If
226 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
233 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
235 # to treat a multi-line C++ comment block as a detailed description. Set this
244 # By default Python docstrings are displayed as preformatted text and doxygen's
245 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
253 # documentation from any documented member that it re-implements.
266 # uses this value to replace tabs by spaces in code fragments.
277 # documentation, which will result in a user-defined paragraph with heading
282 # have to escape them by means of a backslash (\), this can lead to conflicts
326 # extension. Doxygen has a built-in mapping, but you can override or extend it
328 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
329 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
340 # the files are not read by doxygen. When specifying no_extension you should add
347 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
350 # The output of markdown processing is further processed by doxygen, so you can
357 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
369 # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
371 # with any whitespace replaced by '-' and punctuation characters removed.
379 # be prevented in individual cases by putting a % sign in front of the word or
380 # globally by setting AUTOLINK_SUPPORT to NO.
411 # doxygen to replace the get and set methods by a property in the documentation.
421 # member in the group (if any) for the other members of the group. By default
428 # any nested class or struct is added to the same group. By default this option
478 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
480 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
495 # encounter. Generating dot graphs in parallel is controlled by the
509 #---------------------------------------------------------------------------
511 #---------------------------------------------------------------------------
555 # This flag is only useful for Objective-C code. If set to YES, local methods,
566 # the file that contains the anonymous namespace. By default anonymous namespace
573 # will be determined by the corresponding definition. By default unnamed
655 # the files that are included by a file in the documentation of that file.
680 # (detailed) documentation of file and class members alphabetically by member
687 # descriptions of file, namespace and class members alphabetically by member
697 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
713 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
714 # fully-qualified names, including namespaces. If set to NO, the class list will
715 # be sorted only by class name, not including the namespace part.
726 # only one candidate or it is obvious which candidate to choose by doing a
727 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
734 # list. This list is created by putting \todo commands in the documentation.
740 # list. This list is created by putting \test commands in the documentation.
746 # list. This list is created by putting \bug commands in the documentation.
752 # the deprecated list. This list is created by putting \deprecated commands in
759 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
764 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
766 # documentation. If the initializer consists of more lines than specified here
798 # the version control system). Doxygen will invoke the program by executing (via
799 # popen()) the command command input-file, where command is the value of the
800 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
801 # by doxygen. Whatever the program writes to standard output is used as the file
807 # by doxygen. The layout file controls the global structure of the generated
809 # that represents doxygen's defaults, run doxygen with the -l option. You can
830 #---------------------------------------------------------------------------
832 #---------------------------------------------------------------------------
835 # standard output by doxygen. If QUIET is set to YES this implies that the
842 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
893 # at the end of the doxygen process doxygen will return with a non-zero status.
899 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
908 # will be replaced by the file and line number from which the warning originated
910 # be replaced by the version of the file (if it could be obtained via
930 # warning and error messages are written to standard error. When as file - is
936 #---------------------------------------------------------------------------
938 #---------------------------------------------------------------------------
950 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
955 # The default value is: UTF-8.
957 INPUT_ENCODING         = UTF-8
961 # character encoding on a per file pattern basis. Doxygen will compare the file
962 # name with each pattern and apply the encoding instead of the default
964 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
971 # *.h) to filter out the source-files in the directories.
975 # read by doxygen.
1034 # The EXCLUDE tag can be used to specify files and/or directories that should be
1035 # excluded from the INPUT source files. This way you can easily exclude a
1041 EXCLUDE                = tests/junit-xml
1051 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1055 # exclude all test directories for example use the pattern */test/*
1074 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1075 # *.h) to filter out the source-files in the directories. If left blank all
1095 # by executing (via popen()) the command:
1097 # <filter> <input-file>
1099 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1104 # Note that the filter must not add or remove lines; it is applied before the
1105 # code is scanned, but not when the output code is generated. If lines are added
1115 # properly processed by doxygen.
1119 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1120 # basis. Doxygen will compare the file name with each pattern and apply the
1121 # filter if there is a match. The filters are a list of the form: pattern=filter
1128 # properly processed by doxygen.
1140 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1141 # it is also possible to disable source filtering for a specific pattern using
1156 # extension is to allow longer lines before the automatic comment starts. The
1157 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1163 #---------------------------------------------------------------------------
1165 #---------------------------------------------------------------------------
1168 # generated. Documented entities will be cross-referenced with these sources.
1196 # all documented entities called/used by that function will be listed.
1220 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1226 # - Install the latest version of global
1227 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1228 # - Make sure the INPUT points to the root of the source tree
1229 # - Run doxygen as normal
1234 # The result: instead of the source browser generated by doxygen, the links to
1249 #---------------------------------------------------------------------------
1251 #---------------------------------------------------------------------------
1269 #---------------------------------------------------------------------------
1271 #---------------------------------------------------------------------------
1293 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1301 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1313 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1323 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1324 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1335 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1337 # created by doxygen. Using this option one can overrule certain style aspects.
1358 # files will be copied as-is; there are no commands or markers available.
1378 # this color. Hue is specified as an angle on a color-wheel, see
1388 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1398 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1437 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1439 # tree by default.
1476 # set bundle. This should be a reverse domain-name style string, e.g.
1484 # the documentation publisher. This should be a reverse domain-name style
1499 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1505 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1508 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1527 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1563 # generated documentation will be placed on the server by the user during the
1565 # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1591 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1600 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1609 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1617 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1624 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1630 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1667 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1669 # value is set to YES, a side panel will be generated containing a tree-like
1674 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1675 # example, the default style sheet generated by doxygen has an example that
1755 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1778 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1781 # Possible values are: HTML-CSS (which is slower, but has the best
1786 # translated into HTML-CSS) and SVG.
1787 # The default value is: HTML-CSS.
1790 MATHJAX_FORMAT         = HTML-CSS
1800 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1801 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1809 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1822 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1841 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1853 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1854 # and searching needs to be provided by external tools. See the section
1863 # which needs to be processed by an external indexer. Doxygen will invoke an
1864 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1878 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1891 # search data is written to a file for indexing by an external tool. With the
1907 # projects other than the one defined by this configuration file, but that are
1916 #---------------------------------------------------------------------------
1918 #---------------------------------------------------------------------------
1938 # chosen this is overwritten by pdflatex. For specific output languages the
1973 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1984 # by its name or with the correct syntax as to be used with the LaTeX
1994 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1998 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2002 # Note: Only use a user-defined header if you know what you are doing!
2011 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2017 # normally uses. Note: Only use a user-defined footer if you know what you are
2023 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2025 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
2036 # directory. Note that the files will be copied as-is; there are no commands or
2099 #---------------------------------------------------------------------------
2101 #---------------------------------------------------------------------------
2150 # generated using doxygen -e rtf extensionFile.
2155 #---------------------------------------------------------------------------
2157 #---------------------------------------------------------------------------
2167 # it. A directory man3 will be created inside the directory specified by
2184 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2199 #---------------------------------------------------------------------------
2201 #---------------------------------------------------------------------------
2218 # listings (including syntax highlighting and cross-referencing information) to
2233 #---------------------------------------------------------------------------
2235 #---------------------------------------------------------------------------
2251 #---------------------------------------------------------------------------
2253 #---------------------------------------------------------------------------
2263 #---------------------------------------------------------------------------
2265 #---------------------------------------------------------------------------
2284 # formatted so it can be parsed by a human reader. This is useful if you want to
2295 # so different doxyrules.make files included by the same Makefile don't
2301 #---------------------------------------------------------------------------
2303 #---------------------------------------------------------------------------
2306 # C-preprocessor directives found in the sources and include files.
2313 # performed. Macro expansion can be done in a controlled way by setting
2336 # contain include files that are not input files but should be processed by the
2344 # patterns (like *.h and *.hpp) to filter out the header-files in the
2352 # defined before the preprocessor is started (similar to the -D option of e.g.
2374 # remove all references to function-like macros that are alone on a line, have
2376 # are typically used for boiler-plate code, and will confuse the parser if not
2383 #---------------------------------------------------------------------------
2385 #---------------------------------------------------------------------------
2429 #---------------------------------------------------------------------------
2431 #---------------------------------------------------------------------------
2463 # to find the font, which can be done by putting it in a standard location or by
2464 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2499 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2511 # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2513 # accomplished by means of the command \hidecollaborationgraph.
2521 # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2522 # of the command \groupgraph. Disabling a directory graph can be accomplished by
2542 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2566 # significantly it will wrapped across multiple lines. Some heuristics are apply
2585 # can be accomplished by means of the command \includegraph. Disabling an
2586 # include graph can be accomplished by means of the command \hideincludegraph.
2595 # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2596 # to NO, can be accomplished by means of the command \includedbygraph. Disabling
2597 # an included by graph can be accomplished by means of the command
2610 # accomplished by means of the command \hidecallgraph.
2622 # accomplished by means of the command \hidecallergraph.
2637 # dependency relations are determined by the #include relations between the
2639 # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2640 # \directorygraph. Disabling a directory graph can be accomplished by means of
2648 # of child directories generated in directory dependency graphs by dot.
2655 # generated by dot. For an explanation of the image formats see the section
2720 # When using plantuml, the specified paths are searched for files specified by
2728 # by representing a node as a red box. Note that doxygen if the number of direct
2731 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2738 # generated by dot. A depth value of 3 means that only nodes reachable from the
2739 # root by following a path via at most 3 edges will be shown. Nodes that lay
2742 # note that the size of a graph can be further restricted by
2750 # files in one run (i.e. multiple -o and -T options on the command line). This
2752 # this, this feature is disabled by default.
2779 # use a built-in version of mscgen tool to produce the charts. Alternatively,
2781 # specifying prog as the value, doxygen will call the tool as prog -T
2782 # <outfile_format> -o <outputfile> <inputfile>. The external tool should support