Doxyfile - OpenGrok cross reference for /libCEED/Doxyfile

3 # This file describes the settings to be used by the documentation system
18 # Use doxygen to compare the used configuration file with the template
19 # configuration file:
20 # doxygen -x [configFile]
21 # Use doxygen to compare the used configuration file with the template
22 # configuration file without replacing the environment variables or CMake type
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.
74 # sub-directories (in 2 levels) under the output directory of each output format
78 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
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
105 # information to generate all constant output in the proper language.
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,
119 # descriptions after the members that are listed in the file and class
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
140 # the entity):The $name class, The $name widget, The $name file, is, provides,
145                          "The $name file" \
171 # before files name in the file list and in the header files. If set to NO the
172 # shortest path that makes the file name unique will be used
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
179 # part of the path. The tag can be used to show relative paths in the file list.
189 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
191 # header file to include in order to use a class. If left blank only the name of
192 # the header file containing the class definition is used. Otherwise one should
194 # using the -I flag.
199 # less readable) file names. This can be useful is your file systems doesn't
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.
260 # of the file/class/namespace that contains it.
277 # documentation, which will result in a user-defined paragraph with heading
279 # to insert newlines (in the resulting output). You can put ^^ in the value part
281 # file. When you need a literal { or } or , in the value part of an alias you
289 # only. Doxygen will then generate output that is more tailored for C. For
297 # Python sources only. Doxygen will then generate output that is more tailored
305 # sources. Doxygen will then generate output that is tailored for Fortran.
311 # sources. Doxygen will then generate output that is tailored for VHDL.
317 # sources only. Doxygen will then generate output that is more tailored for that
326 # extension. Doxygen has a built-in mapping, but you can override or extend it
327 # using this tag. The format is ext=language, where ext is a file extension, and
329 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
343 # Note see also the list of default file extension mappings.
348 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
351 # The output of markdown processing is further processed by doxygen, so you can
358 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
376 # to include (a tag file for) the STL sources as input, then you should set this
446 # the documentation of the scope in which they are defined (i.e. file,
457 # with name TypeT. When disabled the typedef will appear as a member of a file,
468 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
491 #---------------------------------------------------------------------------
493 #---------------------------------------------------------------------------
497 # class members and static file members will be hidden unless the
523 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
537 # This flag is only useful for Objective-C code. If set to YES, local methods,
547 # 'anonymous_namespace{file}', where file will be replaced with the base name of
548 # the file that contains the anonymous namespace. By default anonymous namespace
556 # parameters remain unnamed in the output.
604 # output files written for symbols that only differ in casing, such as for two
630 # will show which file needs to be included to use the class.
636 # the files that are included by a file in the documentation of that file.
643 # which file to include in order to use the member.
661 # (detailed) documentation of file and class members alphabetically by member
668 # descriptions of file, namespace and class members alphabetically by member
695 # fully-qualified names, including namespaces. If set to NO, the class list will
778 # doxygen should invoke to get the current version for each file (typically from
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
782 # by doxygen. Whatever the program writes to standard output is used as the file
787 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
788 # by doxygen. The layout file controls the global structure of the generated
789 # output files in an output format independent way. To create the layout file
790 # that represents doxygen's defaults, run doxygen with the -l option. You can
791 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
792 # will be used as the name of the layout file. See also section "Changing the
795 # Note that if you run doxygen from a directory containing a file called
811 #---------------------------------------------------------------------------
813 #---------------------------------------------------------------------------
816 # standard output by doxygen. If QUIET is set to YES this implies that the
866 # at the end of the doxygen process doxygen will return with a non-zero status.
873 # can produce. The string should contain the $file, $line, and $text tags, which
874 # will be replaced by the file and line number from which the warning originated
876 # be replaced by the version of the file (if it could be obtained via
879 # The default value is: $file:$line: $text.
881 WARN_FORMAT            = "$file:$line: $text"
887 # WARN_LINE_FORMAT = "'vi $file +$line'"
889 # The default value is: at line $line of file $file.
891 WARN_LINE_FORMAT       = "at line $line of file $file"
893 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
894 # messages should be written. If left blank the output is written to standard
895 # error (stderr). In case the file specified cannot be opened for writing the
896 # warning and error messages are written to standard error. When as file - is
897 # specified the warning and error messages are written to standard output
902 #---------------------------------------------------------------------------
904 #---------------------------------------------------------------------------
907 # documented source files. You may enter file names like myfile.cpp or
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
929 # character encoding on a per file pattern basis. Doxygen will compare the file
932 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
939 # *.h) to filter out the source-files in the directories.
945 # Note the list of default checked file patterns might differ from the list of
946 # default file extension mappings.
1011                          include/ceed/jit-source \
1012                          tests/junit-xml \
1013                          tests/output \
1014                          include/ceed-fortran-name.h \
1018 # directories that are symbolic links (a Unix file system feature) are excluded
1028 # Note that the wildcards are matched against the file with absolute path, so to
1035 # output. The symbol name can be a fully qualified name, a word, or if the
1039 # Note that the wildcards are matched against the file with absolute path, so to
1053 # *.h) to filter out the source-files in the directories. If left blank all
1072 # invoke to filter for each input file. Doxygen will invoke the filter program
1075 # <filter> <input-file>
1077 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1078 # name of an input file. Doxygen will then use the output that the filter
1079 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1083 # code is scanned, but not when the output code is generated. If lines are added
1086 # Note that doxygen will use the data processed and written to standard output
1088 # commands (so in case of a Windows batch file always use @echo OFF), should be
1089 # written to standard output.
1097 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1098 # basis. Doxygen will compare the file name with each pattern and apply the
1102 # patterns match the file name, INPUT_FILTER is applied.
1117 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1125 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1128 # and want to reuse the introduction page also for the doxygen output.
1141 #---------------------------------------------------------------------------
1143 #---------------------------------------------------------------------------
1146 # generated. Documented entities will be cross-referenced with these sources.
1148 # Note: To get rid of all source code in the generated output, make sure that
1190 # will make the HTML file larger and loading of large files a bit slower, you
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
1213 # source code will now point to the output of htags.
1220 # verbatim copy of the header file for each class for which an include is
1227 #---------------------------------------------------------------------------
1229 #---------------------------------------------------------------------------
1246 #---------------------------------------------------------------------------
1247 # Configuration options related to the HTML output
1248 #---------------------------------------------------------------------------
1250 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1263 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1270 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1274 # To get valid HTML the header file that includes any scripts and style sheets
1278 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1280 # and then modify the file new_header.html. See also section "Doxygen usage"
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
1302 # the HTML output. If left blank doxygen will generate a default style sheet.
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
1329 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1330 # files will be copied as-is; there are no commands or markers available.
1335 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1337 # enables light output unless the user preference is dark output. Other options
1341 # Possible values are: LIGHT Always generate light output., DARK Always generate
1342 # dark output., AUTO_LIGHT Automatically set the mode according to the user
1352 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
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
1372 # luminance component of the colors in the HTML output. Values below 100
1373 # gradually make the output lighter, whereas values above 100 make the output
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
1468 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1474 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1476 # The HTML Help Workshop contains a compiler that can convert all HTML output
1477 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1488 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1489 # file. You can add a path in front of the file if the result should not be
1490 # written to the html output directory.
1496 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1498 # The file has to be specified with full path.
1503 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1504 # (YES) or that it should be included in the main .chm file (NO).
1511 # and project file content.
1517 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1532 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1541 # the file name of the resulting .qch file. The path specified is relative to
1542 # the HTML output folder.
1548 # Project output. For more information please see Qt Help Project / Namespace
1550 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1557 # Help Project output. For more information please see Qt Help Project / Virtual
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
1590 # run qhelpgenerator on the generated .qhp file.
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
1689 # the HTML output. These images will generally look nicer at scaled resolutions.
1700 # output directory to force them to be regenerated.
1714 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1715 # installed or if you want to formulas look prettier in the HTML output. When
1734 # When MathJax is enabled you can set the default output format to be used for
1735 # the MathJax output. For more details about the output format see MathJax
1737 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1739 # http://docs.mathjax.org/en/latest/web/components/output.html).
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
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):
1778 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1781 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1788 # the HTML output. The underlying search engine uses javascript and DHTML and
1812 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1821 # script for searching. Instead the search results are written to an XML file
1850 # search data is written to a file for indexing by an external tool. With the
1851 # SEARCHDATA_FILE tag the name of this file can be specified.
1852 # The default file is: searchdata.xml.
1866 # projects other than the one defined by this configuration file, but that are
1875 #---------------------------------------------------------------------------
1876 # Configuration options related to the LaTeX output
1877 #---------------------------------------------------------------------------
1879 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1897 # chosen this is overwritten by pdflatex. For specific output languages the
1899 # the output language.
1907 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1909 # The default file is: makeindex.
1917 # Note: This tag is used in the generated output file (.tex).
1942 # that should be included in the LaTeX output. The package can be specified just
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
1958 # and then modify the file new_header.tex. See also section "Doxygen usage" for
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.
1994 # other source files which should be copied to the LATEX_OUTPUT output
1995 # directory. Note that the files will be copied as-is; there are no commands or
2002 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2003 # contain links (just like the HTML output) instead of page references. This
2004 # makes the output suitable for online browsing using a PDF viewer.
2011 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2029 # index chapters (such as File Index, Compound Index, etc.) in the output.
2051 #---------------------------------------------------------------------------
2052 # Configuration options related to the RTF output
2053 #---------------------------------------------------------------------------
2055 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2056 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2079 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2080 # output) instead of page references. This makes the output suitable for online
2090 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2091 # configuration file, i.e. a series of assignments. You only have to provide
2101 # similar to doxygen's configuration file. A template extensions file can be
2102 # generated using doxygen -e rtf extensionFile.
2107 #---------------------------------------------------------------------------
2108 # Configuration options related to the man page output
2109 #---------------------------------------------------------------------------
2142 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2143 # will generate one additional man file for each entity documented in the real
2151 #---------------------------------------------------------------------------
2152 # Configuration options related to the XML output
2153 #---------------------------------------------------------------------------
2155 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2170 # listings (including syntax highlighting and cross-referencing information) to
2171 # the XML output. Note that enabling this will significantly increase the size
2172 # of the XML output.
2179 # namespace members in file scope as well, matching the HTML output.
2185 #---------------------------------------------------------------------------
2186 # Configuration options related to the DOCBOOK output
2187 #---------------------------------------------------------------------------
2203 #---------------------------------------------------------------------------
2204 # Configuration options for the AutoGen Definitions output
2205 #---------------------------------------------------------------------------
2208 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2215 #---------------------------------------------------------------------------
2216 # Configuration options related to the Perl module output
2217 #---------------------------------------------------------------------------
2220 # file that captures the structure of the code including all documentation.
2229 # output from the Perl module output.
2235 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2238 # size of the Perl module output will be much smaller and Perl will parse it
2245 # The names of the make variables in the generated doxyrules.make file are
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 #---------------------------------------------------------------------------
2338 # file the location of the external documentation should be added. The format of
2339 # a tag file without this location is as follows:
2346 # Note: Each tag file must have a unique name (where the name does NOT include
2347 # the path). If a tag file is not located in the directory in which doxygen is
2352 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2353 # tag file that is based on the input files it reads. See section "Linking to
2379 #---------------------------------------------------------------------------
2381 #---------------------------------------------------------------------------
2454 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2531 # YES then doxygen will generate a graph for each documented file showing the
2532 # direct and indirect include dependencies of the file with other documented
2540 # set to YES then doxygen will generate a graph for each documented file showing
2541 # the direct and indirect include dependencies of the file with other documented
2597 # output formats in the documentation of the dot tool (Graphviz (see:
2648 # path where java can find the plantuml.jar file or to the filename of jar file
2651 # \startuml command in this case and will not generate output for the diagram.
2656 # configuration file for plantuml.
2689 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2690 # files in one run (i.e. multiple -o and -T options on the command line). This