2022-09-01 16:47:59 +00:00
|
|
|
# Doxyfile 1.9.5
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
|
|
# doxygen (www.doxygen.org) for a project.
|
|
|
|
#
|
|
|
|
# All text after a double hash (##) is considered a comment and is placed in
|
|
|
|
# front of the TAG it is preceding.
|
|
|
|
#
|
|
|
|
# All text after a single hash (#) is considered a comment and will be ignored.
|
|
|
|
# The format is:
|
|
|
|
# TAG = value [value, ...]
|
|
|
|
# For lists, items can also be appended using:
|
|
|
|
# TAG += value [value, ...]
|
|
|
|
# Values that contain spaces should be placed between quotes (\" \").
|
2022-09-01 16:47:59 +00:00
|
|
|
#
|
|
|
|
# Note:
|
|
|
|
#
|
|
|
|
# Use doxygen to compare the used configuration file with the template
|
|
|
|
# configuration file:
|
|
|
|
# doxygen -x [configFile]
|
|
|
|
# Use doxygen to compare the used configuration file with the template
|
|
|
|
# configuration file without replacing the environment variables or CMake type
|
|
|
|
# replacement variables:
|
|
|
|
# doxygen -x_noenv [configFile]
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
# Project related configuration options
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# This tag specifies the encoding used for all characters in the configuration
|
|
|
|
# file that follow. The default is UTF-8 which is also the encoding used for all
|
|
|
|
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
|
|
|
|
# iconv built into libc) for the transcoding. See
|
2020-03-02 20:47:43 +00:00
|
|
|
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
|
|
|
|
# The default value is: UTF-8.
|
|
|
|
|
|
|
|
DOXYFILE_ENCODING = UTF-8
|
|
|
|
|
|
|
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
|
|
|
# double-quotes, unless you are using Doxywizard) that should identify the
|
|
|
|
# project for which the documentation is generated. This name is used in the
|
|
|
|
# title of most generated pages and in a few other places.
|
|
|
|
# The default value is: My Project.
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
PROJECT_NAME = Tint
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
|
|
|
# could be handy for archiving the generated documentation or if some version
|
|
|
|
# control system is used.
|
|
|
|
|
|
|
|
PROJECT_NUMBER =
|
|
|
|
|
|
|
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
|
|
|
# for a project that appears at the top of each page and should give viewer a
|
|
|
|
# quick idea about the purpose of the project. Keep the description short.
|
|
|
|
|
|
|
|
PROJECT_BRIEF = Tint
|
|
|
|
|
|
|
|
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
|
|
|
|
# in the documentation. The maximum height of the logo should not exceed 55
|
|
|
|
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
|
|
|
# the logo to the output directory.
|
|
|
|
|
|
|
|
PROJECT_LOGO =
|
|
|
|
|
|
|
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
|
|
|
# into which the generated documentation will be written. If a relative path is
|
|
|
|
# entered, it will be relative to the location where doxygen was started. If
|
|
|
|
# left blank the current directory will be used.
|
|
|
|
|
2021-05-12 08:15:41 +00:00
|
|
|
OUTPUT_DIRECTORY = $(DOXYGEN_OUTPUT_DIRECTORY)
|
2020-03-02 20:47:43 +00:00
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
|
|
|
|
# sub-directories (in 2 levels) under the output directory of each output format
|
|
|
|
# and will distribute the generated files over these directories. Enabling this
|
2020-03-02 20:47:43 +00:00
|
|
|
# option can be useful when feeding doxygen a huge amount of source files, where
|
|
|
|
# putting all generated files in the same directory would otherwise causes
|
2022-09-01 16:47:59 +00:00
|
|
|
# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
|
|
|
|
# control the number of sub-directories.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
CREATE_SUBDIRS = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# Controls the number of sub-directories that will be created when
|
|
|
|
# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
|
|
|
|
# level increment doubles the number of directories, resulting in 4096
|
|
|
|
# directories at level 8 which is the default and also the maximum value. The
|
|
|
|
# sub-directories are organized in 2 levels, the first level always has a fixed
|
|
|
|
# numer of 16 directories.
|
|
|
|
# Minimum value: 0, maximum value: 8, default value: 8.
|
|
|
|
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
|
|
|
|
|
|
|
|
CREATE_SUBDIRS_LEVEL = 8
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
|
|
|
|
# characters to appear in the names of generated files. If set to NO, non-ASCII
|
|
|
|
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
|
|
|
|
# U+3044.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
ALLOW_UNICODE_NAMES = NO
|
|
|
|
|
|
|
|
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
|
|
|
# documentation generated by doxygen is written. Doxygen will use this
|
|
|
|
# information to generate all constant output in the proper language.
|
2022-09-01 16:47:59 +00:00
|
|
|
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
|
|
|
|
# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
|
|
|
|
# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
|
|
|
|
# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
|
|
|
|
# English messages), Korean, Korean-en (Korean with English messages), Latvian,
|
|
|
|
# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
|
|
|
|
# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
|
|
|
|
# Swedish, Turkish, Ukrainian and Vietnamese.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: English.
|
|
|
|
|
|
|
|
OUTPUT_LANGUAGE = English
|
|
|
|
|
|
|
|
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
|
|
|
|
# descriptions after the members that are listed in the file and class
|
|
|
|
# documentation (similar to Javadoc). Set to NO to disable this.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
BRIEF_MEMBER_DESC = YES
|
|
|
|
|
|
|
|
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
|
|
|
|
# description of a member or function before the detailed description
|
|
|
|
#
|
|
|
|
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
|
|
|
# brief descriptions will be completely suppressed.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
REPEAT_BRIEF = YES
|
|
|
|
|
|
|
|
# This tag implements a quasi-intelligent brief description abbreviator that is
|
|
|
|
# used to form the text in various listings. Each string in this list, if found
|
|
|
|
# as the leading text of the brief description, will be stripped from the text
|
|
|
|
# and the result, after processing the whole list, is used as the annotated
|
|
|
|
# text. Otherwise, the brief description is used as-is. If left blank, the
|
|
|
|
# following values are used ($name is automatically replaced with the name of
|
|
|
|
# the entity):The $name class, The $name widget, The $name file, is, provides,
|
|
|
|
# specifies, contains, represents, a, an and the.
|
|
|
|
|
|
|
|
ABBREVIATE_BRIEF = "The $name class" \
|
|
|
|
"The $name widget" \
|
|
|
|
"The $name file" \
|
|
|
|
is \
|
|
|
|
provides \
|
|
|
|
specifies \
|
|
|
|
contains \
|
|
|
|
represents \
|
|
|
|
a \
|
|
|
|
an \
|
|
|
|
the
|
|
|
|
|
|
|
|
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
|
|
|
# doxygen will generate a detailed section even if there is only a brief
|
|
|
|
# description.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
ALWAYS_DETAILED_SEC = NO
|
|
|
|
|
|
|
|
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
|
|
|
# inherited members of a class in the documentation of that class as if those
|
|
|
|
# members were ordinary class members. Constructors, destructors and assignment
|
|
|
|
# operators of the base classes will not be shown.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
INLINE_INHERITED_MEMB = NO
|
|
|
|
|
|
|
|
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
|
|
|
|
# before files name in the file list and in the header files. If set to NO the
|
|
|
|
# shortest path that makes the file name unique will be used
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
FULL_PATH_NAMES = YES
|
|
|
|
|
|
|
|
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
|
|
|
|
# Stripping is only done if one of the specified strings matches the left-hand
|
|
|
|
# part of the path. The tag can be used to show relative paths in the file list.
|
|
|
|
# If left blank the directory from which doxygen is run is used as the path to
|
|
|
|
# strip.
|
|
|
|
#
|
|
|
|
# Note that you can specify absolute paths here, but also relative paths, which
|
|
|
|
# will be relative from the directory where doxygen is started.
|
|
|
|
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
|
|
|
|
|
|
|
STRIP_FROM_PATH =
|
|
|
|
|
|
|
|
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
|
|
|
|
# path mentioned in the documentation of a class, which tells the reader which
|
|
|
|
# header file to include in order to use a class. If left blank only the name of
|
|
|
|
# the header file containing the class definition is used. Otherwise one should
|
|
|
|
# specify the list of include paths that are normally passed to the compiler
|
|
|
|
# using the -I flag.
|
|
|
|
|
|
|
|
STRIP_FROM_INC_PATH =
|
|
|
|
|
|
|
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
|
|
|
|
# less readable) file names. This can be useful is your file systems doesn't
|
|
|
|
# support long names like on DOS, Mac, or CD-ROM.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SHORT_NAMES = NO
|
|
|
|
|
|
|
|
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
|
|
|
|
# first line (until the first dot) of a Javadoc-style comment as the brief
|
|
|
|
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
|
|
|
|
# style comments (thus requiring an explicit @brief command for a brief
|
|
|
|
# description.)
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
JAVADOC_AUTOBRIEF = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
|
|
|
|
# such as
|
|
|
|
# /***************
|
|
|
|
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
|
|
|
|
# Javadoc-style will behave just like regular comments and it will not be
|
|
|
|
# interpreted by doxygen.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
JAVADOC_BANNER = NO
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
|
|
|
# line (until the first dot) of a Qt-style comment as the brief description. If
|
|
|
|
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
|
|
|
|
# requiring an explicit \brief command for a brief description.)
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
QT_AUTOBRIEF = NO
|
|
|
|
|
|
|
|
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
|
|
|
|
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
|
|
|
|
# a brief description. This used to be the default behavior. The new default is
|
|
|
|
# to treat a multi-line C++ comment block as a detailed description. Set this
|
|
|
|
# tag to YES if you prefer the old behavior instead.
|
|
|
|
#
|
|
|
|
# Note that setting this tag to YES also means that rational rose comments are
|
|
|
|
# not recognized any more.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# By default Python docstrings are displayed as preformatted text and doxygen's
|
|
|
|
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
|
|
|
|
# doxygen's special commands can be used and the contents of the docstring
|
|
|
|
# documentation blocks is shown as doxygen documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
PYTHON_DOCSTRING = YES
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
|
|
|
|
# documentation from any documented member that it re-implements.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
INHERIT_DOCS = YES
|
|
|
|
|
|
|
|
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
|
|
|
|
# page for each member. If set to NO, the documentation of a member will be part
|
|
|
|
# of the file/class/namespace that contains it.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
|
|
|
|
|
|
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
|
|
|
|
# uses this value to replace tabs by spaces in code fragments.
|
|
|
|
# Minimum value: 1, maximum value: 16, default value: 4.
|
|
|
|
|
|
|
|
TAB_SIZE = 2
|
|
|
|
|
|
|
|
# This tag can be used to specify a number of aliases that act as commands in
|
|
|
|
# the documentation. An alias has the form:
|
|
|
|
# name=value
|
|
|
|
# For example adding
|
2022-09-01 16:47:59 +00:00
|
|
|
# "sideeffect=@par Side Effects:^^"
|
2020-03-02 20:47:43 +00:00
|
|
|
# will allow you to put the command \sideeffect (or @sideeffect) in the
|
|
|
|
# documentation, which will result in a user-defined paragraph with heading
|
2022-09-01 16:47:59 +00:00
|
|
|
# "Side Effects:". Note that you cannot put \n's in the value part of an alias
|
|
|
|
# to insert newlines (in the resulting output). You can put ^^ in the value part
|
|
|
|
# of an alias to insert a newline as if a physical newline was in the original
|
|
|
|
# file. When you need a literal { or } or , in the value part of an alias you
|
|
|
|
# have to escape them by means of a backslash (\), this can lead to conflicts
|
|
|
|
# with the commands \{ and \} for these it is advised to use the version @{ and
|
|
|
|
# @} or use a double escape (\\{ and \\})
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
ALIASES =
|
|
|
|
|
|
|
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
|
|
|
# only. Doxygen will then generate output that is more tailored for C. For
|
|
|
|
# instance, some of the names that are used will be different. The list of all
|
|
|
|
# members will be omitted, etc.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
|
|
|
|
|
|
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
|
|
|
|
# Python sources only. Doxygen will then generate output that is more tailored
|
|
|
|
# for that language. For instance, namespaces will be presented as packages,
|
|
|
|
# qualified scopes will look different, etc.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
|
|
|
|
|
|
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
|
|
|
# sources. Doxygen will then generate output that is tailored for Fortran.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
OPTIMIZE_FOR_FORTRAN = NO
|
|
|
|
|
|
|
|
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
|
|
|
# sources. Doxygen will then generate output that is tailored for VHDL.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
OPTIMIZE_OUTPUT_VHDL = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
|
|
|
|
# sources only. Doxygen will then generate output that is more tailored for that
|
|
|
|
# language. For instance, namespaces will be presented as modules, types will be
|
|
|
|
# separated into more groups, etc.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
OPTIMIZE_OUTPUT_SLICE = NO
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# Doxygen selects the parser to use depending on the extension of the files it
|
|
|
|
# parses. With this tag you can assign which parser to use for a given
|
|
|
|
# extension. Doxygen has a built-in mapping, but you can override or extend it
|
|
|
|
# using this tag. The format is ext=language, where ext is a file extension, and
|
2022-09-01 16:47:59 +00:00
|
|
|
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
|
|
|
|
# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
|
|
|
|
# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
|
|
|
|
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
|
|
|
|
# tries to guess whether the code is fixed or free formatted code, this is the
|
|
|
|
# default for Fortran type files). For instance to make doxygen treat .inc files
|
|
|
|
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
|
|
|
|
# use: inc=Fortran f=C.
|
2020-03-02 20:47:43 +00:00
|
|
|
#
|
|
|
|
# Note: For files without extension you can use no_extension as a placeholder.
|
|
|
|
#
|
|
|
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
2022-09-01 16:47:59 +00:00
|
|
|
# the files are not read by doxygen. When specifying no_extension you should add
|
|
|
|
# * to the FILE_PATTERNS.
|
|
|
|
#
|
|
|
|
# Note see also the list of default file extension mappings.
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
EXTENSION_MAPPING =
|
|
|
|
|
|
|
|
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
|
|
|
|
# according to the Markdown format, which allows for more readable
|
2022-09-01 16:47:59 +00:00
|
|
|
# documentation. See https://daringfireball.net/projects/markdown/ for details.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The output of markdown processing is further processed by doxygen, so you can
|
|
|
|
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
|
|
|
|
# case of backward compatibilities issues.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
MARKDOWN_SUPPORT = YES
|
|
|
|
|
|
|
|
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
|
|
|
|
# to that level are automatically included in the table of contents, even if
|
|
|
|
# they do not have an id attribute.
|
|
|
|
# Note: This feature currently applies only to Markdown headings.
|
2022-09-01 16:47:59 +00:00
|
|
|
# Minimum value: 0, maximum value: 99, default value: 5.
|
2020-03-02 20:47:43 +00:00
|
|
|
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
|
|
|
|
|
|
|
|
TOC_INCLUDE_HEADINGS = 0
|
|
|
|
|
|
|
|
# When enabled doxygen tries to link words that correspond to documented
|
|
|
|
# classes, or namespaces to their corresponding documentation. Such a link can
|
|
|
|
# be prevented in individual cases by putting a % sign in front of the word or
|
|
|
|
# globally by setting AUTOLINK_SUPPORT to NO.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
AUTOLINK_SUPPORT = YES
|
|
|
|
|
|
|
|
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
|
|
|
# to include (a tag file for) the STL sources as input, then you should set this
|
|
|
|
# tag to YES in order to let doxygen match functions declarations and
|
|
|
|
# definitions whose arguments contain STL classes (e.g. func(std::string);
|
|
|
|
# versus func(std::string) {}). This also make the inheritance and collaboration
|
|
|
|
# diagrams that involve STL classes more complete and accurate.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
BUILTIN_STL_SUPPORT = NO
|
|
|
|
|
|
|
|
# If you use Microsoft's C++/CLI language, you should set this option to YES to
|
|
|
|
# enable parsing support.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
CPP_CLI_SUPPORT = NO
|
|
|
|
|
|
|
|
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
|
|
|
|
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
|
|
|
|
# will parse them like normal C++ but will assume all classes use public instead
|
|
|
|
# of private inheritance when no explicit protection keyword is present.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SIP_SUPPORT = NO
|
|
|
|
|
|
|
|
# For Microsoft's IDL there are propget and propput attributes to indicate
|
|
|
|
# getter and setter methods for a property. Setting this option to YES will make
|
|
|
|
# doxygen to replace the get and set methods by a property in the documentation.
|
|
|
|
# This will only work if the methods are indeed getting or setting a simple
|
|
|
|
# type. If this is not the case, or you want to show the methods anyway, you
|
|
|
|
# should set this option to NO.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
IDL_PROPERTY_SUPPORT = YES
|
|
|
|
|
|
|
|
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
|
|
|
# tag is set to YES then doxygen will reuse the documentation of the first
|
|
|
|
# member in the group (if any) for the other members of the group. By default
|
|
|
|
# all members of a group must be documented explicitly.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
|
|
|
|
|
|
# If one adds a struct or class to a group and this option is enabled, then also
|
|
|
|
# any nested class or struct is added to the same group. By default this option
|
|
|
|
# is disabled and one has to add nested compounds explicitly via \ingroup.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
GROUP_NESTED_COMPOUNDS = NO
|
|
|
|
|
|
|
|
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
|
|
|
|
# (for instance a group of public functions) to be put as a subgroup of that
|
|
|
|
# type (e.g. under the Public Functions section). Set it to NO to prevent
|
|
|
|
# subgrouping. Alternatively, this can be done per class using the
|
|
|
|
# \nosubgrouping command.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SUBGROUPING = YES
|
|
|
|
|
|
|
|
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
|
|
|
|
# are shown inside the group in which they are included (e.g. using \ingroup)
|
|
|
|
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
|
|
|
|
# and RTF).
|
|
|
|
#
|
|
|
|
# Note that this feature does not work in combination with
|
|
|
|
# SEPARATE_MEMBER_PAGES.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
INLINE_GROUPED_CLASSES = NO
|
|
|
|
|
|
|
|
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
|
|
|
|
# with only public data fields or simple typedef fields will be shown inline in
|
|
|
|
# the documentation of the scope in which they are defined (i.e. file,
|
|
|
|
# namespace, or group documentation), provided this scope is documented. If set
|
|
|
|
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
|
|
|
|
# Man pages) or section (for LaTeX and RTF).
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
INLINE_SIMPLE_STRUCTS = NO
|
|
|
|
|
|
|
|
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
|
|
|
|
# enum is documented as struct, union, or enum with the name of the typedef. So
|
|
|
|
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
|
|
|
# with name TypeT. When disabled the typedef will appear as a member of a file,
|
|
|
|
# namespace, or class. And the struct will be named TypeS. This can typically be
|
|
|
|
# useful for C code in case the coding convention dictates that all compound
|
|
|
|
# types are typedef'ed and only the typedef is referenced, never the tag name.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
TYPEDEF_HIDES_STRUCT = NO
|
|
|
|
|
|
|
|
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
|
|
|
|
# cache is used to resolve symbols given their name and scope. Since this can be
|
|
|
|
# an expensive process and often the same symbol appears multiple times in the
|
|
|
|
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
|
|
|
|
# doxygen will become slower. If the cache is too large, memory is wasted. The
|
|
|
|
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
|
|
|
|
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
|
|
|
|
# symbols. At the end of a run doxygen will report the cache usage and suggest
|
|
|
|
# the optimal cache size from a speed point of view.
|
|
|
|
# Minimum value: 0, maximum value: 9, default value: 0.
|
|
|
|
|
|
|
|
LOOKUP_CACHE_SIZE = 0
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
|
|
|
|
# during processing. When set to 0 doxygen will based this on the number of
|
|
|
|
# cores available in the system. You can set it explicitly to a value larger
|
|
|
|
# than 0 to get more control over the balance between CPU load and processing
|
|
|
|
# speed. At this moment only the input processing can be done using multiple
|
|
|
|
# threads. Since this is still an experimental feature the default is set to 1,
|
|
|
|
# which effectively disables parallel processing. Please report any issues you
|
|
|
|
# encounter. Generating dot graphs in parallel is controlled by the
|
|
|
|
# DOT_NUM_THREADS setting.
|
|
|
|
# Minimum value: 0, maximum value: 32, default value: 1.
|
|
|
|
|
|
|
|
NUM_PROC_THREADS = 1
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
# Build related configuration options
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
|
|
|
|
# documentation are documented, even if no documentation was available. Private
|
|
|
|
# class members and static file members will be hidden unless the
|
|
|
|
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
|
|
|
|
# Note: This will also disable the warnings about undocumented members that are
|
|
|
|
# normally produced when WARNINGS is set to YES.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_ALL = NO
|
|
|
|
|
|
|
|
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
|
|
|
|
# be included in the documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_PRIVATE = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
|
|
|
|
# methods of a class will be included in the documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_PRIV_VIRTUAL = NO
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
|
|
|
|
# scope will be included in the documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_PACKAGE = yes
|
|
|
|
|
|
|
|
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
|
|
|
|
# included in the documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_STATIC = yes
|
|
|
|
|
|
|
|
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
|
|
|
|
# locally in source files will be included in the documentation. If set to NO,
|
|
|
|
# only classes defined in header files are included. Does not have any effect
|
|
|
|
# for Java sources.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
|
|
|
|
|
|
# This flag is only useful for Objective-C code. If set to YES, local methods,
|
|
|
|
# which are defined in the implementation section but not in the interface are
|
|
|
|
# included in the documentation. If set to NO, only methods in the interface are
|
|
|
|
# included.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
|
|
|
|
|
|
# If this flag is set to YES, the members of anonymous namespaces will be
|
|
|
|
# extracted and appear in the documentation as a namespace called
|
|
|
|
# 'anonymous_namespace{file}', where file will be replaced with the base name of
|
|
|
|
# the file that contains the anonymous namespace. By default anonymous namespace
|
|
|
|
# are hidden.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXTRACT_ANON_NSPACES = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# If this flag is set to YES, the name of an unnamed parameter in a declaration
|
|
|
|
# will be determined by the corresponding definition. By default unnamed
|
|
|
|
# parameters remain unnamed in the output.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
RESOLVE_UNNAMED_PARAMS = YES
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
|
|
|
|
# undocumented members inside documented classes or files. If set to NO these
|
|
|
|
# members will be included in the various overviews, but no documentation
|
|
|
|
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
|
|
|
|
|
|
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
|
|
|
|
# undocumented classes that are normally visible in the class hierarchy. If set
|
|
|
|
# to NO, these classes will be included in the various overviews. This option
|
|
|
|
# has no effect if EXTRACT_ALL is enabled.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
HIDE_UNDOC_CLASSES = NO
|
|
|
|
|
|
|
|
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
|
2022-09-01 16:47:59 +00:00
|
|
|
# declarations. If set to NO, these declarations will be included in the
|
|
|
|
# documentation.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
|
|
|
|
|
|
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
|
|
|
|
# documentation blocks found inside the body of a function. If set to NO, these
|
|
|
|
# blocks will be appended to the function's detailed documentation block.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
HIDE_IN_BODY_DOCS = NO
|
|
|
|
|
|
|
|
# The INTERNAL_DOCS tag determines if documentation that is typed after a
|
|
|
|
# \internal command is included. If the tag is set to NO then the documentation
|
|
|
|
# will be excluded. Set it to YES to include the internal documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
INTERNAL_DOCS = NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
|
|
|
|
# able to match the capabilities of the underlying filesystem. In case the
|
|
|
|
# filesystem is case sensitive (i.e. it supports files in the same directory
|
|
|
|
# whose names only differ in casing), the option must be set to YES to properly
|
|
|
|
# deal with such files in case they appear in the input. For filesystems that
|
|
|
|
# are not case sensitive the option should be set to NO to properly deal with
|
|
|
|
# output files written for symbols that only differ in casing, such as for two
|
|
|
|
# classes, one named CLASS and the other named Class, and to also support
|
|
|
|
# references to files without having to specify the exact matching casing. On
|
|
|
|
# Windows (including Cygwin) and MacOS, users should typically set this option
|
|
|
|
# to NO, whereas on Linux or other Unix flavors it should typically be set to
|
|
|
|
# YES.
|
|
|
|
# Possible values are: SYSTEM, NO and YES.
|
|
|
|
# The default value is: SYSTEM.
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
CASE_SENSE_NAMES = NO
|
|
|
|
|
|
|
|
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
|
|
|
|
# their full class and namespace scopes in the documentation. If set to YES, the
|
|
|
|
# scope will be hidden.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
HIDE_SCOPE_NAMES = NO
|
|
|
|
|
|
|
|
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
|
|
|
|
# append additional text to a page's title, such as Class Reference. If set to
|
|
|
|
# YES the compound reference will be hidden.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
HIDE_COMPOUND_REFERENCE= NO
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
|
|
|
|
# will show which file needs to be included to use the class.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SHOW_HEADERFILE = YES
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
|
|
|
|
# the files that are included by a file in the documentation of that file.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SHOW_INCLUDE_FILES = YES
|
|
|
|
|
|
|
|
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
|
|
|
|
# grouped member an include statement to the documentation, telling the reader
|
|
|
|
# which file to include in order to use the member.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SHOW_GROUPED_MEMB_INC = NO
|
|
|
|
|
|
|
|
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
|
|
|
|
# files with double quotes in the documentation rather than with sharp brackets.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
FORCE_LOCAL_INCLUDES = NO
|
|
|
|
|
|
|
|
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
|
|
|
|
# documentation for inline members.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
INLINE_INFO = YES
|
|
|
|
|
|
|
|
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
|
|
|
|
# (detailed) documentation of file and class members alphabetically by member
|
|
|
|
# name. If set to NO, the members will appear in declaration order.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SORT_MEMBER_DOCS = YES
|
|
|
|
|
|
|
|
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
|
|
|
|
# descriptions of file, namespace and class members alphabetically by member
|
|
|
|
# name. If set to NO, the members will appear in declaration order. Note that
|
|
|
|
# this will also influence the order of the classes in the class list.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SORT_BRIEF_DOCS = YES
|
|
|
|
|
|
|
|
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
|
|
|
|
# (brief and detailed) documentation of class members so that constructors and
|
|
|
|
# destructors are listed first. If set to NO the constructors will appear in the
|
|
|
|
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
|
|
|
|
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
|
|
|
|
# member documentation.
|
|
|
|
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
|
|
|
|
# detailed member documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SORT_MEMBERS_CTORS_1ST = YES
|
|
|
|
|
|
|
|
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
|
|
|
|
# of group names into alphabetical order. If set to NO the group names will
|
|
|
|
# appear in their defined order.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SORT_GROUP_NAMES = YES
|
|
|
|
|
|
|
|
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
|
|
|
|
# fully-qualified names, including namespaces. If set to NO, the class list will
|
|
|
|
# be sorted only by class name, not including the namespace part.
|
|
|
|
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
|
|
|
# Note: This option applies only to the class list, not to the alphabetical
|
|
|
|
# list.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SORT_BY_SCOPE_NAME = YES
|
|
|
|
|
|
|
|
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
|
|
|
|
# type resolution of all parameters of a function it will reject a match between
|
|
|
|
# the prototype and the implementation of a member function even if there is
|
|
|
|
# only one candidate or it is obvious which candidate to choose by doing a
|
|
|
|
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
|
|
|
|
# accept a match between prototype and implementation in such cases.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
STRICT_PROTO_MATCHING = NO
|
|
|
|
|
|
|
|
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
|
|
|
|
# list. This list is created by putting \todo commands in the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
GENERATE_TODOLIST = YES
|
|
|
|
|
|
|
|
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
|
|
|
|
# list. This list is created by putting \test commands in the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
GENERATE_TESTLIST = YES
|
|
|
|
|
|
|
|
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
|
|
|
|
# list. This list is created by putting \bug commands in the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
GENERATE_BUGLIST = YES
|
|
|
|
|
|
|
|
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
|
|
|
|
# the deprecated list. This list is created by putting \deprecated commands in
|
|
|
|
# the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
GENERATE_DEPRECATEDLIST= YES
|
|
|
|
|
|
|
|
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
|
|
|
|
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
|
|
|
|
# ... \endcond blocks.
|
|
|
|
|
|
|
|
ENABLED_SECTIONS =
|
|
|
|
|
|
|
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
|
|
|
|
# initial value of a variable or macro / define can have for it to appear in the
|
|
|
|
# documentation. If the initializer consists of more lines than specified here
|
|
|
|
# it will be hidden. Use a value of 0 to hide initializers completely. The
|
|
|
|
# appearance of the value of individual variables and macros / defines can be
|
|
|
|
# controlled using \showinitializer or \hideinitializer command in the
|
|
|
|
# documentation regardless of this setting.
|
|
|
|
# Minimum value: 0, maximum value: 10000, default value: 30.
|
|
|
|
|
|
|
|
MAX_INITIALIZER_LINES = 30
|
|
|
|
|
|
|
|
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
|
|
|
|
# the bottom of the documentation of classes and structs. If set to YES, the
|
|
|
|
# list will mention the files that were used to generate the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SHOW_USED_FILES = YES
|
|
|
|
|
|
|
|
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
|
|
|
|
# will remove the Files entry from the Quick Index and from the Folder Tree View
|
|
|
|
# (if specified).
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SHOW_FILES = YES
|
|
|
|
|
|
|
|
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
|
|
|
|
# page. This will remove the Namespaces entry from the Quick Index and from the
|
|
|
|
# Folder Tree View (if specified).
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
SHOW_NAMESPACES = YES
|
|
|
|
|
|
|
|
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
|
|
|
# doxygen should invoke to get the current version for each file (typically from
|
|
|
|
# the version control system). Doxygen will invoke the program by executing (via
|
|
|
|
# popen()) the command command input-file, where command is the value of the
|
|
|
|
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
|
|
|
|
# by doxygen. Whatever the program writes to standard output is used as the file
|
|
|
|
# version. For an example see the documentation.
|
|
|
|
|
|
|
|
FILE_VERSION_FILTER =
|
|
|
|
|
|
|
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
|
|
|
# by doxygen. The layout file controls the global structure of the generated
|
|
|
|
# output files in an output format independent way. To create the layout file
|
|
|
|
# that represents doxygen's defaults, run doxygen with the -l option. You can
|
|
|
|
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
|
2022-09-01 16:47:59 +00:00
|
|
|
# will be used as the name of the layout file. See also section "Changing the
|
|
|
|
# layout of pages" for information.
|
2020-03-02 20:47:43 +00:00
|
|
|
#
|
|
|
|
# Note that if you run doxygen from a directory containing a file called
|
|
|
|
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
|
|
|
# tag is left empty.
|
|
|
|
|
|
|
|
LAYOUT_FILE =
|
|
|
|
|
|
|
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
|
|
|
|
# the reference definitions. This must be a list of .bib files. The .bib
|
|
|
|
# extension is automatically appended if omitted. This requires the bibtex tool
|
|
|
|
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
|
|
|
|
# For LaTeX the style of the bibliography can be controlled using
|
|
|
|
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
|
|
|
|
# search path. See also \cite for info how to create references.
|
|
|
|
|
|
|
|
CITE_BIB_FILES =
|
|
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
# Configuration options related to warning and progress messages
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
# The QUIET tag can be used to turn on/off the messages that are generated to
|
|
|
|
# standard output by doxygen. If QUIET is set to YES this implies that the
|
|
|
|
# messages are off.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
QUIET = YES
|
|
|
|
|
|
|
|
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
|
|
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
|
|
|
|
# this implies that the warnings are on.
|
|
|
|
#
|
|
|
|
# Tip: Turn warnings on while writing the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
WARNINGS = YES
|
|
|
|
|
|
|
|
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
|
|
|
|
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
|
|
|
|
# will automatically be disabled.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
|
|
|
|
|
|
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
|
2022-09-01 16:47:59 +00:00
|
|
|
# potential errors in the documentation, such as documenting some parameters in
|
|
|
|
# a documented function twice, or documenting parameters that don't exist or
|
|
|
|
# using markup commands wrongly.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
WARN_IF_DOC_ERROR = YES
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
|
|
|
|
# function parameter documentation. If set to NO, doxygen will accept that some
|
|
|
|
# parameters have no documentation without warning.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
WARN_IF_INCOMPLETE_DOC = YES
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
|
|
|
|
# are documented, but have no documentation for their parameters or return
|
2022-09-01 16:47:59 +00:00
|
|
|
# value. If set to NO, doxygen will only warn about wrong parameter
|
|
|
|
# documentation, but not about the absence of documentation. If EXTRACT_ALL is
|
|
|
|
# set to YES then this flag will automatically be disabled. See also
|
|
|
|
# WARN_IF_INCOMPLETE_DOC
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
WARN_NO_PARAMDOC = YES
|
|
|
|
|
|
|
|
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
|
2022-09-01 16:47:59 +00:00
|
|
|
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
|
|
|
|
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
|
|
|
|
# at the end of the doxygen process doxygen will return with a non-zero status.
|
|
|
|
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: NO.
|
|
|
|
|
2021-06-25 14:00:36 +00:00
|
|
|
WARN_AS_ERROR = $(DOXYGEN_WARN_AS_ERROR)
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
|
|
|
|
# can produce. The string should contain the $file, $line, and $text tags, which
|
|
|
|
# will be replaced by the file and line number from which the warning originated
|
|
|
|
# and the warning text. Optionally the format may contain $version, which will
|
|
|
|
# be replaced by the version of the file (if it could be obtained via
|
|
|
|
# FILE_VERSION_FILTER)
|
2022-09-01 16:47:59 +00:00
|
|
|
# See also: WARN_LINE_FORMAT
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: $file:$line: $text.
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
WARN_FORMAT = $(DOXYGEN_WARN_FORMAT)
|
|
|
|
|
|
|
|
# In the $text part of the WARN_FORMAT command it is possible that a reference
|
|
|
|
# to a more specific place is given. To make it easier to jump to this place
|
|
|
|
# (outside of doxygen) the user can define a custom "cut" / "paste" string.
|
|
|
|
# Example:
|
|
|
|
# WARN_LINE_FORMAT = "'vi $file +$line'"
|
|
|
|
# See also: WARN_FORMAT
|
|
|
|
# The default value is: at line $line of file $file.
|
|
|
|
|
|
|
|
WARN_LINE_FORMAT = "at line $line of file $file"
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
|
|
|
|
# messages should be written. If left blank the output is written to standard
|
2022-09-01 16:47:59 +00:00
|
|
|
# error (stderr). In case the file specified cannot be opened for writing the
|
|
|
|
# warning and error messages are written to standard error. When as file - is
|
|
|
|
# specified the warning and error messages are written to standard output
|
|
|
|
# (stdout).
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
WARN_LOGFILE =
|
|
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
# Configuration options related to the input files
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
# The INPUT tag is used to specify the files and/or directories that contain
|
|
|
|
# documented source files. You may enter file names like myfile.cpp or
|
|
|
|
# directories like /usr/src/myproject. Separate the files or directories with
|
|
|
|
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
|
|
|
# Note: If this tag is empty the current directory is searched.
|
|
|
|
|
2021-05-04 17:20:31 +00:00
|
|
|
INPUT = CODE_OF_CONDUCT.md \
|
2022-04-11 22:27:34 +00:00
|
|
|
src/tint \
|
|
|
|
tools/src
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
# This tag can be used to specify the character encoding of the source files
|
|
|
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
|
|
|
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
2022-09-01 16:47:59 +00:00
|
|
|
# documentation (see:
|
|
|
|
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
|
|
|
|
# See also: INPUT_FILE_ENCODING
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: UTF-8.
|
|
|
|
|
|
|
|
INPUT_ENCODING = UTF-8
|
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# This tag can be used to specify the character encoding of the source files
|
|
|
|
# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
|
|
|
|
# character encoding on a per file pattern basis. Doxygen will compare the file
|
|
|
|
# name with each pattern and apply the encoding instead of the default
|
|
|
|
# INPUT_ENCODING) if there is a match. The character encodings are a list of the
|
|
|
|
# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
|
|
|
|
# "INPUT_ENCODING" for further information on supported encodings.
|
|
|
|
|
|
|
|
INPUT_FILE_ENCODING =
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
# If the value of the INPUT tag contains directories, you can use the
|
|
|
|
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
|
|
|
# *.h) to filter out the source-files in the directories.
|
|
|
|
#
|
|
|
|
# Note that for custom extensions or not directly supported extensions you also
|
|
|
|
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
|
|
|
# read by doxygen.
|
|
|
|
#
|
2022-09-01 16:47:59 +00:00
|
|
|
# Note the list of default checked file patterns might differ from the list of
|
|
|
|
# default file extension mappings.
|
|
|
|
#
|
2020-03-02 20:47:43 +00:00
|
|
|
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
|
|
|
|
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
|
2022-09-01 16:47:59 +00:00
|
|
|
# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
|
|
|
|
# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
|
|
|
|
# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
|
|
|
|
# *.vhdl, *.ucf, *.qsf and *.ice.
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
FILE_PATTERNS = *.c \
|
|
|
|
*.cc \
|
|
|
|
*.cxx \
|
|
|
|
*.cpp \
|
|
|
|
*.c++ \
|
|
|
|
*.java \
|
|
|
|
*.ii \
|
|
|
|
*.ixx \
|
|
|
|
*.ipp \
|
|
|
|
*.i++ \
|
|
|
|
*.inl \
|
|
|
|
*.idl \
|
|
|
|
*.ddl \
|
|
|
|
*.odl \
|
|
|
|
*.h \
|
|
|
|
*.hh \
|
|
|
|
*.hxx \
|
|
|
|
*.hpp \
|
|
|
|
*.h++ \
|
|
|
|
*.cs \
|
|
|
|
*.d \
|
|
|
|
*.php \
|
|
|
|
*.php4 \
|
|
|
|
*.php5 \
|
|
|
|
*.phtml \
|
|
|
|
*.inc \
|
|
|
|
*.m \
|
|
|
|
*.markdown \
|
|
|
|
*.md \
|
|
|
|
*.mm \
|
|
|
|
*.dox \
|
|
|
|
*.py \
|
|
|
|
*.pyw \
|
|
|
|
*.f90 \
|
|
|
|
*.f95 \
|
|
|
|
*.f03 \
|
|
|
|
*.f08 \
|
|
|
|
*.f \
|
|
|
|
*.for \
|
|
|
|
*.tcl \
|
|
|
|
*.vhd \
|
|
|
|
*.vhdl \
|
|
|
|
*.ucf \
|
|
|
|
*.qsf
|
|
|
|
|
|
|
|
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
|
|
|
# be searched for input files as well.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
RECURSIVE = YES
|
|
|
|
|
|
|
|
# The EXCLUDE tag can be used to specify files and/or directories that should be
|
|
|
|
# excluded from the INPUT source files. This way you can easily exclude a
|
|
|
|
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
|
|
|
#
|
|
|
|
# Note that relative paths are relative to the directory from which doxygen is
|
|
|
|
# run.
|
|
|
|
|
2022-10-27 20:17:45 +00:00
|
|
|
EXCLUDE = src/tint/tint_gdb.py \
|
|
|
|
src/tint/tint_lldb.py
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
|
|
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
|
|
|
# from the input.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXCLUDE_SYMLINKS = NO
|
|
|
|
|
|
|
|
# If the value of the INPUT tag contains directories, you can use the
|
|
|
|
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
|
|
|
# certain files from those directories.
|
|
|
|
#
|
|
|
|
# Note that the wildcards are matched against the file with absolute path, so to
|
|
|
|
# exclude all test directories for example use the pattern */test/*
|
|
|
|
|
|
|
|
EXCLUDE_PATTERNS = *_test.cc
|
|
|
|
|
|
|
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
|
|
|
# (namespaces, classes, functions, etc.) that should be excluded from the
|
|
|
|
# output. The symbol name can be a fully qualified name, a word, or if the
|
|
|
|
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
2022-09-01 16:47:59 +00:00
|
|
|
# ANamespace::AClass, ANamespace::*Test
|
2020-03-02 20:47:43 +00:00
|
|
|
#
|
|
|
|
# Note that the wildcards are matched against the file with absolute path, so to
|
|
|
|
# exclude all test directories use the pattern */test/*
|
|
|
|
|
|
|
|
EXCLUDE_SYMBOLS =
|
|
|
|
|
|
|
|
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
|
|
|
|
# that contain example code fragments that are included (see the \include
|
|
|
|
# command).
|
|
|
|
|
|
|
|
EXAMPLE_PATH =
|
|
|
|
|
|
|
|
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
|
|
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
|
|
|
|
# *.h) to filter out the source-files in the directories. If left blank all
|
|
|
|
# files are included.
|
|
|
|
|
|
|
|
EXAMPLE_PATTERNS = *
|
|
|
|
|
|
|
|
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
|
|
|
# searched for input files to be used with the \include or \dontinclude commands
|
|
|
|
# irrespective of the value of the RECURSIVE tag.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
EXAMPLE_RECURSIVE = NO
|
|
|
|
|
|
|
|
# The IMAGE_PATH tag can be used to specify one or more files or directories
|
|
|
|
# that contain images that are to be included in the documentation (see the
|
|
|
|
# \image command).
|
|
|
|
|
|
|
|
IMAGE_PATH =
|
|
|
|
|
|
|
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
|
|
|
# invoke to filter for each input file. Doxygen will invoke the filter program
|
|
|
|
# by executing (via popen()) the command:
|
|
|
|
#
|
|
|
|
# <filter> <input-file>
|
|
|
|
#
|
|
|
|
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
|
|
|
|
# name of an input file. Doxygen will then use the output that the filter
|
|
|
|
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
|
|
|
|
# will be ignored.
|
|
|
|
#
|
|
|
|
# Note that the filter must not add or remove lines; it is applied before the
|
|
|
|
# code is scanned, but not when the output code is generated. If lines are added
|
|
|
|
# or removed, the anchors will not be placed correctly.
|
|
|
|
#
|
2022-09-01 16:47:59 +00:00
|
|
|
# Note that doxygen will use the data processed and written to standard output
|
|
|
|
# for further processing, therefore nothing else, like debug statements or used
|
|
|
|
# commands (so in case of a Windows batch file always use @echo OFF), should be
|
|
|
|
# written to standard output.
|
|
|
|
#
|
2020-03-02 20:47:43 +00:00
|
|
|
# Note that for custom extensions or not directly supported extensions you also
|
|
|
|
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
|
|
|
# properly processed by doxygen.
|
|
|
|
|
|
|
|
INPUT_FILTER =
|
|
|
|
|
|
|
|
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
|
|
|
# basis. Doxygen will compare the file name with each pattern and apply the
|
|
|
|
# filter if there is a match. The filters are a list of the form: pattern=filter
|
|
|
|
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
|
|
|
|
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
|
|
|
|
# patterns match the file name, INPUT_FILTER is applied.
|
|
|
|
#
|
|
|
|
# Note that for custom extensions or not directly supported extensions you also
|
|
|
|
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
|
|
|
# properly processed by doxygen.
|
|
|
|
|
|
|
|
FILTER_PATTERNS =
|
|
|
|
|
|
|
|
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
|
|
|
# INPUT_FILTER) will also be used to filter the input files that are used for
|
|
|
|
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
FILTER_SOURCE_FILES = NO
|
|
|
|
|
|
|
|
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
|
|
|
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
|
|
|
|
# it is also possible to disable source filtering for a specific pattern using
|
|
|
|
# *.ext= (so without naming a filter).
|
|
|
|
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
|
|
|
|
|
|
|
|
FILTER_SOURCE_PATTERNS =
|
|
|
|
|
|
|
|
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
|
|
|
|
# is part of the input, its contents will be placed on the main page
|
|
|
|
# (index.html). This can be useful if you have a project on for instance GitHub
|
|
|
|
# and want to reuse the introduction page also for the doxygen output.
|
|
|
|
|
2020-07-24 00:11:53 +00:00
|
|
|
USE_MDFILE_AS_MAINPAGE = ./README.md
|
2020-03-02 20:47:43 +00:00
|
|
|
|
2022-09-01 16:47:59 +00:00
|
|
|
# The Fortran standard specifies that for fixed formatted Fortran code all
|
|
|
|
# characters from position 72 are to be considered as comment. A common
|
|
|
|
# extension is to allow longer lines before the automatic comment starts. The
|
|
|
|
# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
|
|
|
|
# be processed before the automatic comment starts.
|
|
|
|
# Minimum value: 7, maximum value: 10000, default value: 72.
|
|
|
|
|
|
|
|
FORTRAN_COMMENT_AFTER = 72
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
# Configuration options related to source browsing
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
|
|
|
|
# generated. Documented entities will be cross-referenced with these sources.
|
|
|
|
#
|
|
|
|
# Note: To get rid of all source code in the generated output, make sure that
|
|
|
|
# also VERBATIM_HEADERS is set to NO.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
SOURCE_BROWSER = NO
|
|
|
|
|
|
|
|
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
|
|
|
|
# classes and enums directly into the documentation.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
INLINE_SOURCES = NO
|
|
|
|
|
|
|
|
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
|
|
|
|
# special comment blocks from generated source code fragments. Normal C, C++ and
|
|
|
|
# Fortran comments will always remain visible.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
STRIP_CODE_COMMENTS = YES
|
|
|
|
|
|
|
|
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
|
2022-09-01 16:47:59 +00:00
|
|
|
# entity all documented functions referencing it will be listed.
|
2020-03-02 20:47:43 +00:00
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
REFERENCED_BY_RELATION = NO
|
|
|
|
|
|
|
|
# If the REFERENCES_RELATION tag is set to YES then for each documented function
|
|
|
|
# all documented entities called/used by that function will be listed.
|
|
|
|
# The default value is: NO.
|
|
|
|
|
|
|
|
REFERENCES_RELATION = NO
|
|
|
|
|
|
|
|
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
|
|
|
|
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
|
|
|
|
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
|
|
|
|
# link to the documentation.
|
|
|
|
# The default value is: YES.
|
|
|
|
|
|
|
|
REFERENCES_LINK_SOURCE = YES
|
|
|
|
|
|
|
|
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
|
|
|
|
# source code will show a tooltip with additional information such as prototype,
|
|
|
|
# brief description and links to the definition and documentation. Since this
|
|
|
|
# will make the HTML file larger and loading of large files a bit slower, you
|
|
|
|
# can opt to disable this feature.
|
|
|
|
# The default value is: YES.
|
|
|
|
# This tag requires that the tag SOURCE_BROWSER is set to YES.
|
|
|
|
|
|
|
|
SOURCE_TOOLTIPS = YES
|
|
|
|
|
|
|
|
# If the USE_HTAGS tag is set to YES then the references to source code will
|
|
|
|
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
|
|
|
|
# source browser. The htags tool is part of GNU's global source tagging system
|
|
|
|
# (see https://www.gnu.org/software/global/global.html). You will need version
|
|
|
|
# 4.8.6 or higher.
|
|
|
|
#
|
|
|
|
# To use it do the following:
|
|
|
|
# - Install the latest version of global
|
2022-09-01 16:47:59 +00:00
|
|
|
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
|
2020-03-02 20:47:43 +00:00
|
|
|
# - Make sure the INPUT points to the root of the source tree
|
|
|
|
# - Run doxygen as normal
|
|