|
|
@@ -1,4 +1,4 @@
|
|
|
-# Doxyfile 1.9.7
|
|
|
+# Doxyfile 1.10.0
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
|
# doxygen (www.doxygen.org) for a project.
|
|
|
@@ -63,6 +63,12 @@ PROJECT_BRIEF =
|
|
|
|
|
|
PROJECT_LOGO =
|
|
|
|
|
|
+# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
|
|
|
+# when the HTML document is shown. Doxygen will copy the logo to the output
|
|
|
+# directory.
|
|
|
+
|
|
|
+PROJECT_ICON =
|
|
|
+
|
|
|
# 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
|
|
|
@@ -356,13 +362,13 @@ TOC_INCLUDE_HEADINGS = 5
|
|
|
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
|
|
|
# generate identifiers for the Markdown headings. Note: Every identifier is
|
|
|
# unique.
|
|
|
-# Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a
|
|
|
-# sequence number starting at 0. and GITHUB Use the lower case version of title
|
|
|
-# with any whitespace replaced by '-' and punctations characters removed..
|
|
|
+# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
|
|
|
+# sequence number starting at 0 and GITHUB use the lower case version of title
|
|
|
+# with any whitespace replaced by '-' and punctuation characters removed.
|
|
|
# The default value is: DOXYGEN.
|
|
|
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
|
|
|
|
|
|
-MARKDOWN_ID_STYLE = DOXYGEN
|
|
|
+MARKDOWN_ID_STYLE = GITHUB
|
|
|
|
|
|
# When enabled doxygen tries to link words that correspond to documented
|
|
|
# classes, or namespaces to their corresponding documentation. Such a link can
|
|
|
@@ -968,12 +974,12 @@ INPUT_FILE_ENCODING =
|
|
|
# Note the list of default checked file patterns might differ from the list of
|
|
|
# default file extension mappings.
|
|
|
#
|
|
|
-# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
|
|
|
-# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
|
|
|
-# *.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.
|
|
|
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
|
|
|
+# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
|
|
|
+# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.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.
|
|
|
|
|
|
FILE_PATTERNS = *.h \
|
|
|
*.hpp \
|
|
|
@@ -1129,7 +1135,8 @@ FORTRAN_COMMENT_AFTER = 72
|
|
|
SOURCE_BROWSER = YES
|
|
|
|
|
|
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
|
|
|
-# classes and enums directly into the documentation.
|
|
|
+# multi-line macros, enums or list initialized variables directly into the
|
|
|
+# documentation.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
INLINE_SOURCES = NO
|
|
|
@@ -1417,6 +1424,33 @@ HTML_DYNAMIC_MENUS = YES
|
|
|
|
|
|
HTML_DYNAMIC_SECTIONS = NO
|
|
|
|
|
|
+# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
|
|
|
+# dynamically folded and expanded in the generated HTML source code.
|
|
|
+# The default value is: YES.
|
|
|
+# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
+
|
|
|
+HTML_CODE_FOLDING = YES
|
|
|
+
|
|
|
+# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in
|
|
|
+# the top right corner of code and text fragments that allows the user to copy
|
|
|
+# its content to the clipboard. Note this only works if supported by the browser
|
|
|
+# and the web page is served via a secure context (see:
|
|
|
+# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
|
|
|
+# protocol.
|
|
|
+# The default value is: YES.
|
|
|
+# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
+
|
|
|
+HTML_COPY_CLIPBOARD = YES
|
|
|
+
|
|
|
+# Doxygen stores a couple of settings persistently in the browser (via e.g.
|
|
|
+# cookies). By default these settings apply to all HTML pages generated by
|
|
|
+# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
|
|
|
+# the settings under a project specific key, such that the user preferences will
|
|
|
+# be stored separately.
|
|
|
+# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
+
|
|
|
+HTML_PROJECT_COOKIE =
|
|
|
+
|
|
|
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
|
|
|
# shown in the various tree structured indices initially; the user can expand
|
|
|
# and collapse entries dynamically later on. Doxygen will expand the tree to
|
|
|
@@ -2045,7 +2079,7 @@ PDF_HYPERLINKS = YES
|
|
|
|
|
|
USE_PDFLATEX = YES
|
|
|
|
|
|
-# The LATEX_BATCHMODE tag ignals the behavior of LaTeX in case of an error.
|
|
|
+# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
|
|
|
# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
|
|
|
# mode nothing is printed on the terminal, errors are scrolled as if <return> is
|
|
|
# hit at every error; missing files that TeX tries to input or request from
|
|
|
@@ -2247,6 +2281,32 @@ DOCBOOK_OUTPUT = docbook
|
|
|
|
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
|
|
|
|
+#---------------------------------------------------------------------------
|
|
|
+# Configuration options related to Sqlite3 output
|
|
|
+#---------------------------------------------------------------------------
|
|
|
+
|
|
|
+# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
|
|
|
+# database with symbols found by doxygen stored in tables.
|
|
|
+# The default value is: NO.
|
|
|
+
|
|
|
+GENERATE_SQLITE3 = NO
|
|
|
+
|
|
|
+# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
|
|
|
+# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
|
|
|
+# in front of it.
|
|
|
+# The default directory is: sqlite3.
|
|
|
+# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
|
|
|
+
|
|
|
+SQLITE3_OUTPUT = sqlite3
|
|
|
+
|
|
|
+# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
|
|
|
+# database file will be recreated with each doxygen run. If set to NO, doxygen
|
|
|
+# will warn if a database file is already found and not modify it.
|
|
|
+# The default value is: YES.
|
|
|
+# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
|
|
|
+
|
|
|
+SQLITE3_RECREATE_DB = YES
|
|
|
+
|
|
|
#---------------------------------------------------------------------------
|
|
|
# Configuration options related to the Perl module output
|
|
|
#---------------------------------------------------------------------------
|
|
|
@@ -2389,15 +2449,15 @@ TAGFILES =
|
|
|
|
|
|
GENERATE_TAGFILE =
|
|
|
|
|
|
-# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
|
|
|
-# the class index. If set to NO, only the inherited external classes will be
|
|
|
-# listed.
|
|
|
+# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
|
|
|
+# will be listed in the class and namespace index. If set to NO, only the
|
|
|
+# inherited external classes will be listed.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
ALLEXTERNALS = NO
|
|
|
|
|
|
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
|
|
|
-# in the modules index. If set to NO, only the current project's groups will be
|
|
|
+# in the topic index. If set to NO, only the current project's groups will be
|
|
|
# listed.
|
|
|
# The default value is: YES.
|
|
|
|
|
|
@@ -2482,7 +2542,11 @@ DOT_FONTPATH =
|
|
|
# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
|
|
|
# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
|
|
|
# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
|
|
|
-# relations will be shown as texts / links.
|
|
|
+# relations will be shown as texts / links. Explicit enabling an inheritance
|
|
|
+# graph or choosing a different representation for an inheritance graph of a
|
|
|
+# specific class, can be accomplished by means of the command \inheritancegraph.
|
|
|
+# Disabling an inheritance graph can be accomplished by means of the command
|
|
|
+# \hideinheritancegraph.
|
|
|
# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
|
|
|
# The default value is: YES.
|
|
|
|
|
|
@@ -2491,15 +2555,21 @@ CLASS_GRAPH = YES
|
|
|
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
|
|
|
# graph for each documented class showing the direct and indirect implementation
|
|
|
# dependencies (inheritance, containment, and class references variables) of the
|
|
|
-# class with other documented classes.
|
|
|
+# class with other documented classes. Explicit enabling a collaboration graph,
|
|
|
+# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
|
|
|
+# command \collaborationgraph. Disabling a collaboration graph can be
|
|
|
+# accomplished by means of the command \hidecollaborationgraph.
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
|
|
COLLABORATION_GRAPH = YES
|
|
|
|
|
|
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
|
|
|
-# groups, showing the direct groups dependencies. See also the chapter Grouping
|
|
|
-# in the manual.
|
|
|
+# groups, showing the direct groups dependencies. Explicit enabling a group
|
|
|
+# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
|
|
|
+# of the command \groupgraph. Disabling a directory graph can be accomplished by
|
|
|
+# means of the command \hidegroupgraph. See also the chapter Grouping in the
|
|
|
+# manual.
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
|
|
@@ -2541,8 +2611,8 @@ DOT_UML_DETAILS = NO
|
|
|
|
|
|
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
|
|
|
# to display on a single line. If the actual line length exceeds this threshold
|
|
|
-# significantly it will wrapped across multiple lines. Some heuristics are apply
|
|
|
-# to avoid ugly line breaks.
|
|
|
+# significantly it will be wrapped across multiple lines. Some heuristics are
|
|
|
+# applied to avoid ugly line breaks.
|
|
|
# Minimum value: 0, maximum value: 1000, default value: 17.
|
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
|
|
@@ -2559,7 +2629,9 @@ TEMPLATE_RELATIONS = NO
|
|
|
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
|
|
|
# YES then doxygen will generate a graph for each documented file showing the
|
|
|
# direct and indirect include dependencies of the file with other documented
|
|
|
-# files.
|
|
|
+# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
|
|
|
+# can be accomplished by means of the command \includegraph. Disabling an
|
|
|
+# include graph can be accomplished by means of the command \hideincludegraph.
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
|
|
@@ -2568,7 +2640,10 @@ INCLUDE_GRAPH = YES
|
|
|
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
|
|
|
# set to YES then doxygen will generate a graph for each documented file showing
|
|
|
# the direct and indirect include dependencies of the file with other documented
|
|
|
-# files.
|
|
|
+# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
|
|
|
+# to NO, can be accomplished by means of the command \includedbygraph. Disabling
|
|
|
+# an included by graph can be accomplished by means of the command
|
|
|
+# \hideincludedbygraph.
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
|
|
@@ -2608,7 +2683,10 @@ GRAPHICAL_HIERARCHY = YES
|
|
|
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
|
|
|
# dependencies a directory has on other directories in a graphical way. The
|
|
|
# dependency relations are determined by the #include relations between the
|
|
|
-# files in the directories.
|
|
|
+# files in the directories. Explicit enabling a directory graph, when
|
|
|
+# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
|
|
|
+# \directorygraph. Disabling a directory graph can be accomplished by means of
|
|
|
+# the command \hidedirectorygraph.
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|