Doxyfile - OpenGrok cross reference for /libCEED/Doxyfile

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
40 # double-quotes, unless you are using Doxywizard) that should identify the
62 # the logo to the output directory.
69 # left blank the current directory will be used.
74 # sub-directories (in 2 levels) under the output directory of each output format
77 # putting all generated files in the same directory would otherwise causes
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
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
180 # If left blank the directory from which doxygen is run is used as the path to
184 # will be relative from the directory where doxygen is started.
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
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
253 # documentation from any documented member that it re-implements.
277 # documentation, which will result in a user-defined paragraph with heading
326 # extension. Doxygen has a built-in mapping, but you can override or extend it
329 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
348 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
358 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
468 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
491 #---------------------------------------------------------------------------
493 #---------------------------------------------------------------------------
537 # This flag is only useful for Objective-C code. If set to YES, local methods,
600 # filesystem is case sensitive (i.e. it supports files in the same directory
695 # fully-qualified names, including namespaces. If set to NO, the class list will
780 # popen()) the command command input-file, where command is the value of the
781 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
790 # that represents doxygen's defaults, run doxygen with the -l option. You can
795 # Note that if you run doxygen from a directory containing a file called
811 #---------------------------------------------------------------------------
813 #---------------------------------------------------------------------------
866 # at the end of the doxygen process doxygen will return with a non-zero status.
896 # warning and error messages are written to standard error. When as file - is
902 #---------------------------------------------------------------------------
904 #---------------------------------------------------------------------------
910 # Note: If this tag is empty the current directory is searched.
918 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
923 # The default value is: UTF-8.
925 INPUT_ENCODING         = UTF-8
932 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
939 # *.h) to filter out the source-files in the directories.
1004 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1006 # Note that relative paths are relative to the directory from which doxygen is
1011                          include/ceed/jit-source \
1012                          tests/junit-xml \
1014                          include/ceed-fortran-name.h \
1053 # *.h) to filter out the source-files in the directories. If left blank all
1075 # <filter> <input-file>
1077 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1141 #---------------------------------------------------------------------------
1143 #---------------------------------------------------------------------------
1146 # generated. Documented entities will be cross-referenced with these sources.
1198 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1204 # - Install the latest version of global
1205 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1206 # - Make sure the INPUT points to the root of the source tree
1207 # - Run doxygen as normal
1227 #---------------------------------------------------------------------------
1229 #---------------------------------------------------------------------------
1246 #---------------------------------------------------------------------------
1248 #---------------------------------------------------------------------------
1258 # The default directory is: html.
1270 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1278 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1290 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1300 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1301 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1312 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1317 # Doxygen will copy the style sheet files to the output directory.
1326 # other source files which should be copied to the HTML output directory. Note
1327 # that these files will be copied to the base HTML output directory. Use the
1330 # files will be copied as-is; there are no commands or markers available.
1354 # this color. Hue is specified as an angle on a color-wheel, see
1364 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1419 # output directory. Running make will produce the docset in that directory and
1445 # set bundle. This should be a reverse domain-name style string, e.g.
1453 # the documentation publisher. This should be a reverse domain-name style
1474 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1490 # written to the html output directory.
1496 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1550 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1559 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1568 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1576 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1583 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1589 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1598 # Eclipse, the contents of the directory containing the HTML and XML files needs
1599 # to be copied into the plugins directory of eclipse. The name of the directory
1600 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1608 # the directory name containing the HTML and XML files should also have this
1626 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1628 # value is set to YES, a side panel will be generated containing a tree-like
1633 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1700 # output directory to force them to be regenerated.
1714 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1737 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1740 # Possible values are: HTML-CSS (which is slower, but has the best
1745 # translated into HTML-CSS) and SVG.
1746 # The default value is: HTML-CSS.
1749 MATHJAX_FORMAT         = HTML-CSS
1752 # output directory using the MATHJAX_RELPATH option. The destination directory
1753 # should contain the MathJax.js script. For instance, if the mathjax directory
1754 # is located at the same level as the HTML output directory, then
1759 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1760 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1768 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1781 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1875 #---------------------------------------------------------------------------
1877 #---------------------------------------------------------------------------
1887 # The default directory is: latex.
1953 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1957 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1961 # Note: Only use a user-defined header if you know what you are doing!
1970 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1976 # normally uses. Note: Only use a user-defined footer if you know what you are
1982 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1985 # will copy the style sheet files to the output directory.
1995 # directory. Note that the files will be copied as-is; there are no commands or
2045 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2046 # LATEX_OUTPUT directory will be used.
2051 #---------------------------------------------------------------------------
2053 #---------------------------------------------------------------------------
2065 # The default directory is: rtf.
2102 # generated using doxygen -e rtf extensionFile.
2107 #---------------------------------------------------------------------------
2109 #---------------------------------------------------------------------------
2119 # it. A directory man3 will be created inside the directory specified by
2121 # The default directory is: man.
2135 # The MAN_SUBDIR tag determines the name of the directory created within
2151 #---------------------------------------------------------------------------
2153 #---------------------------------------------------------------------------
2164 # The default directory is: xml.
2170 # listings (including syntax highlighting and cross-referencing information) to
2185 #---------------------------------------------------------------------------
2187 #---------------------------------------------------------------------------
2198 # The default directory is: docbook.
2203 #---------------------------------------------------------------------------
2205 #---------------------------------------------------------------------------
2215 #---------------------------------------------------------------------------
2217 #---------------------------------------------------------------------------
2253 #---------------------------------------------------------------------------
2255 #---------------------------------------------------------------------------
2258 # C-preprocessor directives found in the sources and include files.
2296 # patterns (like *.h and *.hpp) to filter out the header-files in the
2304 # defined before the preprocessor is started (similar to the -D option of e.g.
2324 # remove all references to function-like macros that are alone on a line, have
2326 # are typically used for boiler-plate code, and will confuse the parser if not
2333 #---------------------------------------------------------------------------
2335 #---------------------------------------------------------------------------
2347 # the path). If a tag file is not located in the directory in which doxygen is
2379 #---------------------------------------------------------------------------
2381 #---------------------------------------------------------------------------
2385 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2422 # directory containing the font. Default graphviz fontsize is 14.
2454 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2580 # dependencies a directory has on other directories in a graphical way. The
2589 # of child directories generated in directory dependency graphs by dot.
2690 # files in one run (i.e. multiple -o and -T options on the command line). This