VirtualBox

Changeset 99759 in vbox


Ignore:
Timestamp:
May 11, 2023 9:47:33 PM (18 months ago)
Author:
vboxsync
Message:

IPRT/Doxyfile: updated and re-enabled markdown. bugref:10442

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/Runtime/Doxyfile

    r99758 r99759  
    1 # Doxyfile 1.8.11
     1# Doxyfile 1.9.6
    22
    33# This file describes the settings to be used by the documentation system
     
    1313# TAG += value [value, ...]
    1414# Values that contain spaces should be placed between quotes (\" \").
     15#
     16# Note:
     17#
     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
     23# replacement variables:
     24# doxygen -x_noenv [configFile]
    1525
    1626#---------------------------------------------------------------------------
     
    1828#---------------------------------------------------------------------------
    1929
    20 # This tag specifies the encoding used for all characters in the config file
    21 # that follow. The default is UTF-8 which is also the encoding used for all text
    22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
    23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
    24 # for the list of possible encodings.
     30# This tag specifies the encoding used for all characters in the configuration
     31# file that follow. The default is UTF-8 which is also the encoding used for all
     32# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     33# iconv built into libc) for the transcoding. See
     34# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
    2535# The default value is: UTF-8.
    2636
     
    6171OUTPUT_DIRECTORY       =
    6272
    63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
    64 # directories (in 2 levels) under the output directory of each output format and
    65 # will distribute the generated files over these directories. Enabling this
     73# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
     74# sub-directories (in 2 levels) under the output directory of each output format
     75# and will distribute the generated files over these directories. Enabling this
    6676# option can be useful when feeding doxygen a huge amount of source files, where
    6777# putting all generated files in the same directory would otherwise causes
    68 # performance problems for the file system.
     78# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
     79# control the number of sub-directories.
    6980# The default value is: NO.
    7081
    7182CREATE_SUBDIRS         = NO
     83
     84# Controls the number of sub-directories that will be created when
     85# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
     86# level increment doubles the number of directories, resulting in 4096
     87# directories at level 8 which is the default and also the maximum value. The
     88# sub-directories are organized in 2 levels, the first level always has a fixed
     89# number of 16 directories.
     90# Minimum value: 0, maximum value: 8, default value: 8.
     91# This tag requires that the tag CREATE_SUBDIRS is set to YES.
     92
     93CREATE_SUBDIRS_LEVEL   = 8
    7294
    7395# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
     
    82104# documentation generated by doxygen is written. Doxygen will use this
    83105# information to generate all constant output in the proper language.
    84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
    85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
    86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
    87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
    88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
    89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
    90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
    91 # Ukrainian and Vietnamese.
     106# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
     107# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
     108# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
     109# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
     110# English messages), Korean, Korean-en (Korean with English messages), Latvian,
     111# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
     112# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
     113# Swedish, Turkish, Ukrainian and Vietnamese.
    92114# The default value is: English.
    93115
     
    180202JAVADOC_AUTOBRIEF      = YES
    181203
     204# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
     205# such as
     206# /***************
     207# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
     208# Javadoc-style will behave just like regular comments and it will not be
     209# interpreted by doxygen.
     210# The default value is: NO.
     211
     212JAVADOC_BANNER         = NO
     213
    182214# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
    183215# line (until the first dot) of a Qt-style comment as the brief description. If
     
    200232MULTILINE_CPP_IS_BRIEF = NO
    201233
     234# By default Python docstrings are displayed as preformatted text and doxygen's
     235# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
     236# doxygen's special commands can be used and the contents of the docstring
     237# documentation blocks is shown as doxygen documentation.
     238# The default value is: YES.
     239
     240PYTHON_DOCSTRING       = YES
     241
    202242# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
    203243# documentation from any documented member that it re-implements.
     
    223263# name=value
    224264# For example adding
    225 # "sideeffect=@par Side Effects:\n"
     265# "sideeffect=@par Side Effects:^^"
    226266# will allow you to put the command \sideeffect (or @sideeffect) in the
    227267# documentation, which will result in a user-defined paragraph with heading
    228 # "Side Effects:". You can put \n's in the value part of an alias to insert
    229 # newlines.
     268# "Side Effects:". Note that you cannot put \n's in the value part of an alias
     269# to insert newlines (in the resulting output). You can put ^^ in the value part
     270# of an alias to insert a newline as if a physical newline was in the original
     271# file. When you need a literal { or } or , in the value part of an alias you
     272# have to escape them by means of a backslash (\), this can lead to conflicts
     273# with the commands \{ and \} for these it is advised to use the version @{ and
     274# @} or use a double escape (\\{ and \\})
    230275
    231276ALIASES                = "note=@remark" \
     
    250295ALIASES += "ecma167{3}=\ecma{167,Part\1/\2,\3}"
    251296
    252 # This tag can be used to specify a number of word-keyword mappings (TCL only).
    253 # A mapping has the form "name=value". For example adding "class=itcl::class"
    254 # will allow you to use the command class in the itcl::class meaning.
    255 
    256 TCL_SUBST              =
    257 
    258297# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    259298# only. Doxygen will then generate output that is more tailored for C. For
     
    284323OPTIMIZE_OUTPUT_VHDL   = NO
    285324
     325# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
     326# sources only. Doxygen will then generate output that is more tailored for that
     327# language. For instance, namespaces will be presented as modules, types will be
     328# separated into more groups, etc.
     329# The default value is: NO.
     330
     331OPTIMIZE_OUTPUT_SLICE  = NO
     332
    286333# Doxygen selects the parser to use depending on the extension of the files it
    287334# parses. With this tag you can assign which parser to use for a given
    288335# extension. Doxygen has a built-in mapping, but you can override or extend it
    289336# using this tag. The format is ext=language, where ext is a file extension, and
    290 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
    291 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
    292 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
    293 # Fortran. In the later case the parser tries to guess whether the code is fixed
    294 # or free formatted code, this is the default for Fortran type files), VHDL. For
    295 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
    296 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
     337# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
     338# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
     339# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
     340# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
     341# tries to guess whether the code is fixed or free formatted code, this is the
     342# default for Fortran type files). For instance to make doxygen treat .inc files
     343# as Fortran files (default is PHP), and .f files as C (default is Fortran),
     344# use: inc=Fortran f=C.
    297345#
    298346# Note: For files without extension you can use no_extension as a placeholder.
    299347#
    300348# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
    301 # the files are not read by doxygen.
     349# the files are not read by doxygen. When specifying no_extension you should add
     350# * to the FILE_PATTERNS.
     351#
     352# Note see also the list of default file extension mappings.
    302353
    303354EXTENSION_MAPPING      =
     
    305356# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
    306357# according to the Markdown format, which allows for more readable
    307 # documentation. See http://daringfireball.net/projects/markdown/ for details.
     358# documentation. See https://daringfireball.net/projects/markdown/ for details.
    308359# The output of markdown processing is further processed by doxygen, so you can
    309360# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
     
    312363
    313364MARKDOWN_SUPPORT       = YES
     365
     366# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
     367# to that level are automatically included in the table of contents, even if
     368# they do not have an id attribute.
     369# Note: This feature currently applies only to Markdown headings.
     370# Minimum value: 0, maximum value: 99, default value: 5.
     371# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
     372
     373TOC_INCLUDE_HEADINGS   = 5
    314374
    315375# When enabled doxygen tries to link words that correspond to documented
     
    338398
    339399# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
    340 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
     400# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
    341401# will parse them like normal C++ but will assume all classes use public instead
    342402# of private inheritance when no explicit protection keyword is present.
     
    424484LOOKUP_CACHE_SIZE      = 0
    425485
     486# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
     487# during processing. When set to 0 doxygen will based this on the number of
     488# cores available in the system. You can set it explicitly to a value larger
     489# than 0 to get more control over the balance between CPU load and processing
     490# speed. At this moment only the input processing can be done using multiple
     491# threads. Since this is still an experimental feature the default is set to 1,
     492# which effectively disables parallel processing. Please report any issues you
     493# encounter. Generating dot graphs in parallel is controlled by the
     494# DOT_NUM_THREADS setting.
     495# Minimum value: 0, maximum value: 32, default value: 1.
     496
     497NUM_PROC_THREADS       = 0
     498
    426499#---------------------------------------------------------------------------
    427500# Build related configuration options
     
    444517EXTRACT_PRIVATE        = YES
    445518
     519# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
     520# methods of a class will be included in the documentation.
     521# The default value is: NO.
     522
     523EXTRACT_PRIV_VIRTUAL   = NO
     524
    446525# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
    447526# scope will be included in the documentation.
     
    481560EXTRACT_ANON_NSPACES   = NO
    482561
     562# If this flag is set to YES, the name of an unnamed parameter in a declaration
     563# will be determined by the corresponding definition. By default unnamed
     564# parameters remain unnamed in the output.
     565# The default value is: YES.
     566
     567RESOLVE_UNNAMED_PARAMS = YES
     568
    483569# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
    484570# undocumented members inside documented classes or files. If set to NO these
     
    492578# undocumented classes that are normally visible in the class hierarchy. If set
    493579# to NO, these classes will be included in the various overviews. This option
    494 # has no effect if EXTRACT_ALL is enabled.
     580# will also hide undocumented C++ concepts if enabled. This option has no effect
     581# if EXTRACT_ALL is enabled.
    495582# The default value is: NO.
    496583
     
    498585
    499586# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
    500 # (class|struct|union) declarations. If set to NO, these declarations will be
    501 # included in the documentation.
     587# declarations. If set to NO, these declarations will be included in the
     588# documentation.
    502589# The default value is: NO.
    503590
     
    518605INTERNAL_DOCS          = YES
    519606
    520 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
    521 # names in lower-case letters. If set to YES, upper-case letters are also
    522 # allowed. This is useful if you have classes or files whose names only differ
    523 # in case and if your file system supports case sensitive file names. Windows
    524 # and Mac users are advised to set this option to NO.
    525 # The default value is: system dependent.
     607# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
     608# able to match the capabilities of the underlying filesystem. In case the
     609# filesystem is case sensitive (i.e. it supports files in the same directory
     610# whose names only differ in casing), the option must be set to YES to properly
     611# deal with such files in case they appear in the input. For filesystems that
     612# are not case sensitive the option should be set to NO to properly deal with
     613# output files written for symbols that only differ in casing, such as for two
     614# classes, one named CLASS and the other named Class, and to also support
     615# references to files without having to specify the exact matching casing. On
     616# Windows (including Cygwin) and MacOS, users should typically set this option
     617# to NO, whereas on Linux or other Unix flavors it should typically be set to
     618# YES.
     619# Possible values are: SYSTEM, NO and YES.
     620# The default value is: SYSTEM.
    526621
    527622CASE_SENSE_NAMES       = NO
     
    540635
    541636HIDE_COMPOUND_REFERENCE= NO
     637
     638# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
     639# will show which file needs to be included to use the class.
     640# The default value is: YES.
     641
     642SHOW_HEADERFILE        = YES
    542643
    543644# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
     
    698799# that represents doxygen's defaults, run doxygen with the -l option. You can
    699800# optionally specify a file name after the option, if omitted DoxygenLayout.xml
    700 # will be used as the name of the layout file.
     801# will be used as the name of the layout file. See also section "Changing the
     802# layout of pages" for information.
    701803#
    702804# Note that if you run doxygen from a directory containing a file called
     
    709811# the reference definitions. This must be a list of .bib files. The .bib
    710812# extension is automatically appended if omitted. This requires the bibtex tool
    711 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
     813# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
    712814# For LaTeX the style of the bibliography can be controlled using
    713815# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
     
    744846
    745847# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
    746 # potential errors in the documentation, such as not documenting some parameters
    747 # in a documented function, or documenting parameters that don't exist or using
    748 # markup commands wrongly.
     848# potential errors in the documentation, such as documenting some parameters in
     849# a documented function twice, or documenting parameters that don't exist or
     850# using markup commands wrongly.
    749851# The default value is: YES.
    750852
    751853WARN_IF_DOC_ERROR      = YES
     854
     855# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
     856# function parameter documentation. If set to NO, doxygen will accept that some
     857# parameters have no documentation without warning.
     858# The default value is: YES.
     859
     860WARN_IF_INCOMPLETE_DOC = YES
    752861
    753862# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
    754863# are documented, but have no documentation for their parameters or return
    755 # value. If set to NO, doxygen will only warn about wrong or incomplete
    756 # parameter documentation, but not about the absence of documentation.
     864# value. If set to NO, doxygen will only warn about wrong parameter
     865# documentation, but not about the absence of documentation. If EXTRACT_ALL is
     866# set to YES then this flag will automatically be disabled. See also
     867# WARN_IF_INCOMPLETE_DOC
    757868# The default value is: NO.
    758869
    759870WARN_NO_PARAMDOC       = NO
    760871
     872# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
     873# undocumented enumeration values. If set to NO, doxygen will accept
     874# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
     875# will automatically be disabled.
     876# The default value is: NO.
     877
     878WARN_IF_UNDOC_ENUM_VAL = NO
     879
    761880# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
    762 # a warning is encountered.
     881# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
     882# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
     883# at the end of the doxygen process doxygen will return with a non-zero status.
     884# Possible values are: NO, YES and FAIL_ON_WARNINGS.
    763885# The default value is: NO.
    764886
     
    771893# be replaced by the version of the file (if it could be obtained via
    772894# FILE_VERSION_FILTER)
     895# See also: WARN_LINE_FORMAT
    773896# The default value is: $file:$line: $text.
    774897
    775898WARN_FORMAT            = "$file:$line: $text"
     899
     900# In the $text part of the WARN_FORMAT command it is possible that a reference
     901# to a more specific place is given. To make it easier to jump to this place
     902# (outside of doxygen) the user can define a custom "cut" / "paste" string.
     903# Example:
     904# WARN_LINE_FORMAT = "'vi $file +$line'"
     905# See also: WARN_FORMAT
     906# The default value is: at line $line of file $file.
     907
     908WARN_LINE_FORMAT       = "at line $line of file $file"
    776909
    777910# The WARN_LOGFILE tag can be used to specify a file to which warning and error
    778911# messages should be written. If left blank the output is written to standard
    779 # error (stderr).
     912# error (stderr). In case the file specified cannot be opened for writing the
     913# warning and error messages are written to standard error. When as file - is
     914# specified the warning and error messages are written to standard output
     915# (stdout).
    780916
    781917WARN_LOGFILE           =
     
    796932# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
    797933# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
    798 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
    799 # possible encodings.
     934# documentation (see:
     935# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
     936# See also: INPUT_FILE_ENCODING
    800937# The default value is: UTF-8.
    801938
    802939INPUT_ENCODING         = UTF-8
     940
     941# This tag can be used to specify the character encoding of the source files
     942# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
     943# character encoding on a per file pattern basis. Doxygen will compare the file
     944# name with each pattern and apply the encoding instead of the default
     945# INPUT_ENCODING) if there is a match. The character encodings are a list of the
     946# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
     947# "INPUT_ENCODING" for further information on supported encodings.
     948
     949INPUT_FILE_ENCODING    =
    803950
    804951# If the value of the INPUT tag contains directories, you can use the
     
    810957# read by doxygen.
    811958#
     959# Note the list of default checked file patterns might differ from the list of
     960# default file extension mappings.
     961#
    812962# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
    813963# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
    814 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
    815 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
    816 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
     964# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
     965# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
     966# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
     967# *.vhdl, *.ucf, *.qsf and *.ice.
    817968
    818969FILE_PATTERNS          =
     
    8531004# output. The symbol name can be a fully qualified name, a word, or if the
    8541005# wildcard * is used, a substring. Examples: ANamespace, AClass,
    855 # AClass::ANamespace, ANamespace::*Test
     1006# ANamespace::AClass, ANamespace::*Test
    8561007#
    8571008# Note that the wildcards are matched against the file with absolute path, so to
     
    9001051# code is scanned, but not when the output code is generated. If lines are added
    9011052# or removed, the anchors will not be placed correctly.
     1053#
     1054# Note that doxygen will use the data processed and written to standard output
     1055# for further processing, therefore nothing else, like debug statements or used
     1056# commands (so in case of a Windows batch file always use @echo OFF), should be
     1057# written to standard output.
    9021058#
    9031059# Note that for custom extensions or not directly supported extensions you also
     
    9421098USE_MDFILE_AS_MAINPAGE =
    9431099
     1100# The Fortran standard specifies that for fixed formatted Fortran code all
     1101# characters from position 72 are to be considered as comment. A common
     1102# extension is to allow longer lines before the automatic comment starts. The
     1103# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
     1104# be processed before the automatic comment starts.
     1105# Minimum value: 7, maximum value: 10000, default value: 72.
     1106
     1107FORTRAN_COMMENT_AFTER  = 72
     1108
    9441109#---------------------------------------------------------------------------
    9451110# Configuration options related to source browsing
     
    9691134
    9701135# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
    971 # function all documented functions referencing it will be listed.
     1136# entity all documented functions referencing it will be listed.
    9721137# The default value is: NO.
    9731138
     
    10011166# point to the HTML generated by the htags(1) tool instead of doxygen built-in
    10021167# source browser. The htags tool is part of GNU's global source tagging system
    1003 # (see http://www.gnu.org/software/global/global.html). You will need version
     1168# (see https://www.gnu.org/software/global/global.html). You will need version
    10041169# 4.8.6 or higher.
    10051170#
    10061171# To use it do the following:
    10071172# - Install the latest version of global
    1008 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
     1173# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
    10091174# - Make sure the INPUT points to the root of the source tree
    10101175# - Run doxygen as normal
     
    10281193VERBATIM_HEADERS       = YES
    10291194
    1030 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
    1031 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
    1032 # cost of reduced performance. This can be particularly helpful with template
    1033 # rich C++ code for which doxygen's built-in parser lacks the necessary type
    1034 # information.
    1035 # Note: The availability of this option depends on whether or not doxygen was
    1036 # generated with the -Duse-libclang=ON option for CMake.
    1037 # The default value is: NO.
    1038 
    1039 CLANG_ASSISTED_PARSING = NO
    1040 
    1041 # If clang assisted parsing is enabled you can provide the compiler with command
    1042 # line options that you would normally use when invoking the compiler. Note that
    1043 # the include paths will already be set by doxygen for the files and directories
    1044 # specified with INPUT and INCLUDE_PATH.
    1045 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
    1046 
    1047 CLANG_OPTIONS          =
    1048 
    10491195#---------------------------------------------------------------------------
    10501196# Configuration options related to the alphabetical class index
     
    10581204ALPHABETICAL_INDEX     = NO
    10591205
    1060 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
    1061 # which the alphabetical index list will be split.
    1062 # Minimum value: 1, maximum value: 20, default value: 5.
    1063 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    1064 
    1065 COLS_IN_ALPHA_INDEX    = 5
    1066 
    1067 # In case all classes in a project start with a common prefix, all classes will
    1068 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
    1069 # can be used to specify a prefix (or a list of prefixes) that should be ignored
    1070 # while generating the index headers.
     1206# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
     1207# that should be ignored while generating the index headers. The IGNORE_PREFIX
     1208# tag works for classes, function and member names. The entity will be placed in
     1209# the alphabetical list under the first letter of the entity name that remains
     1210# after removing the prefix.
    10711211# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    10721212
     
    11471287# Note: The order of the extra style sheet files is of importance (e.g. the last
    11481288# style sheet in the list overrules the setting of the previous ones in the
    1149 # list). For an example see the documentation.
     1289# list).
     1290# Note: Since the styling of scrollbars can currently not be overruled in
     1291# Webkit/Chromium, the styling will be left out of the default doxygen.css if
     1292# one or more extra stylesheets have been specified. So if scrollbar
     1293# customization is desired it has to be added explicitly. For an example see the
     1294# documentation.
    11501295# This tag requires that the tag GENERATE_HTML is set to YES.
    11511296
     
    11621307HTML_EXTRA_FILES       =
    11631308
     1309# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
     1310# should be rendered with a dark or light theme.
     1311# Possible values are: LIGHT always generate light mode output, DARK always
     1312# generate dark mode output, AUTO_LIGHT automatically set the mode according to
     1313# the user preference, use light mode if no preference is set (the default),
     1314# AUTO_DARK automatically set the mode according to the user preference, use
     1315# dark mode if no preference is set and TOGGLE allow to user to switch between
     1316# light and dark mode via a button.
     1317# The default value is: AUTO_LIGHT.
     1318# This tag requires that the tag GENERATE_HTML is set to YES.
     1319
     1320HTML_COLORSTYLE        = AUTO_LIGHT
     1321
    11641322# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
    11651323# will adjust the colors in the style sheet and background images according to
    1166 # this color. Hue is specified as an angle on a colorwheel, see
    1167 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
     1324# this color. Hue is specified as an angle on a color-wheel, see
     1325# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
    11681326# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
    11691327# purple, and 360 is red again.
     
    11741332
    11751333# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
    1176 # in the HTML output. For a value of 0 the output will use grayscales only. A
     1334# in the HTML output. For a value of 0 the output will use gray-scales only. A
    11771335# value of 255 will produce the most vivid colors.
    11781336# Minimum value: 0, maximum value: 255, default value: 100.
     
    12001358
    12011359HTML_TIMESTAMP         = NO
     1360
     1361# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
     1362# documentation will contain a main index with vertical navigation menus that
     1363# are dynamically created via JavaScript. If disabled, the navigation index will
     1364# consists of multiple levels of tabs that are statically embedded in every HTML
     1365# page. Disable this option to support browsers that do not have JavaScript,
     1366# like the Qt help browser.
     1367# The default value is: YES.
     1368# This tag requires that the tag GENERATE_HTML is set to YES.
     1369
     1370HTML_DYNAMIC_MENUS     = YES
    12021371
    12031372# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     
    12241393# If the GENERATE_DOCSET tag is set to YES, additional index files will be
    12251394# generated that can be used as input for Apple's Xcode 3 integrated development
    1226 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
    1227 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
    1228 # Makefile in the HTML output directory. Running make will produce the docset in
    1229 # that directory and running make install will install the docset in
     1395# environment (see:
     1396# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
     1397# create a documentation set, doxygen will generate a Makefile in the HTML
     1398# output directory. Running make will produce the docset in that directory and
     1399# running make install will install the docset in
    12301400# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
    1231 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
    1232 # for more information.
     1401# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
     1402# genXcode/_index.html for more information.
    12331403# The default value is: NO.
    12341404# This tag requires that the tag GENERATE_HTML is set to YES.
     
    12441414DOCSET_FEEDNAME        = "Doxygen generated docs"
    12451415
     1416# This tag determines the URL of the docset feed. A documentation feed provides
     1417# an umbrella under which multiple documentation sets from a single provider
     1418# (such as a company or product suite) can be grouped.
     1419# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1420
     1421DOCSET_FEEDURL         =
     1422
    12461423# This tag specifies a string that should uniquely identify the documentation
    12471424# set bundle. This should be a reverse domain-name style string, e.g.
     
    12691446# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
    12701447# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
    1271 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
    1272 # Windows.
     1448# on Windows. In the beginning of 2021 Microsoft took the original page, with
     1449# a.o. the download links, offline the HTML help workshop was already many years
     1450# in maintenance mode). You can download the HTML help workshop from the web
     1451# archives at Installation executable (see:
     1452# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
     1453# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
    12731454#
    12741455# The HTML Help Workshop contains a compiler that can convert all HTML output
     
    13001481
    13011482# The GENERATE_CHI flag controls if a separate .chi index file is generated
    1302 # (YES) or that it should be included in the master .chm file (NO).
     1483# (YES) or that it should be included in the main .chm file (NO).
    13031484# The default value is: NO.
    13041485# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     
    13451526# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
    13461527# Project output. For more information please see Qt Help Project / Namespace
    1347 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
     1528# (see:
     1529# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
    13481530# The default value is: org.doxygen.Project.
    13491531# This tag requires that the tag GENERATE_QHP is set to YES.
     
    13531535# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
    13541536# Help Project output. For more information please see Qt Help Project / Virtual
    1355 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
    1356 # folders).
     1537# Folders (see:
     1538# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
    13571539# The default value is: doc.
    13581540# This tag requires that the tag GENERATE_QHP is set to YES.
     
    13621544# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
    13631545# filter to add. For more information please see Qt Help Project / Custom
    1364 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
    1365 # filters).
     1546# Filters (see:
     1547# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
    13661548# This tag requires that the tag GENERATE_QHP is set to YES.
    13671549
     
    13701552# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
    13711553# custom filter to add. For more information please see Qt Help Project / Custom
    1372 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
    1373 # filters).
     1554# Filters (see:
     1555# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
    13741556# This tag requires that the tag GENERATE_QHP is set to YES.
    13751557
     
    13781560# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
    13791561# project's filter section matches. Qt Help Project / Filter Attributes (see:
    1380 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
     1562# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
    13811563# This tag requires that the tag GENERATE_QHP is set to YES.
    13821564
    13831565QHP_SECT_FILTER_ATTRS  =
    13841566
    1385 # The QHG_LOCATION tag can be used to specify the location of Qt's
    1386 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
    1387 # generated .qhp file.
     1567# The QHG_LOCATION tag can be used to specify the location (absolute path
     1568# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
     1569# run qhelpgenerator on the generated .qhp file.
    13881570# This tag requires that the tag GENERATE_QHP is set to YES.
    13891571
     
    14281610# (i.e. any modern browser). Windows users are probably better off using the
    14291611# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
    1430 # further fine-tune the look of the index. As an example, the default style
    1431 # sheet generated by doxygen has an example that shows how to put an image at
    1432 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
    1433 # the same information as the tab index, you could consider setting
    1434 # DISABLE_INDEX to YES when enabling this option.
     1612# further fine tune the look of the index (see "Fine-tuning the output"). As an
     1613# example, the default style sheet generated by doxygen has an example that
     1614# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
     1615# Since the tree basically has the same information as the tab index, you could
     1616# consider setting DISABLE_INDEX to YES when enabling this option.
    14351617# The default value is: NO.
    14361618# This tag requires that the tag GENERATE_HTML is set to YES.
    14371619
    14381620GENERATE_TREEVIEW      = YES
     1621
     1622# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
     1623# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
     1624# area (value NO) or if it should extend to the full height of the window (value
     1625# YES). Setting this to YES gives a layout similar to
     1626# https://docs.readthedocs.io with more room for contents, but less room for the
     1627# project logo, title, and description. If either GENERATE_TREEVIEW or
     1628# DISABLE_INDEX is set to NO, this option has no effect.
     1629# The default value is: NO.
     1630# This tag requires that the tag GENERATE_HTML is set to YES.
     1631
     1632FULL_SIDEBAR           = NO
    14391633
    14401634# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
     
    14611655
    14621656EXT_LINKS_IN_WINDOW    = NO
     1657
     1658# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
     1659# addresses.
     1660# The default value is: YES.
     1661# This tag requires that the tag GENERATE_HTML is set to YES.
     1662
     1663OBFUSCATE_EMAILS       = YES
     1664
     1665# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
     1666# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
     1667# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
     1668# the HTML output. These images will generally look nicer at scaled resolutions.
     1669# Possible values are: png (the default) and svg (looks nicer but requires the
     1670# pdf2svg or inkscape tool).
     1671# The default value is: png.
     1672# This tag requires that the tag GENERATE_HTML is set to YES.
     1673
     1674HTML_FORMULA_FORMAT    = png
    14631675
    14641676# Use this tag to change the font size of LaTeX formulas included as images in
     
    14711683FORMULA_FONTSIZE       = 10
    14721684
    1473 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
    1474 # generated for formulas are transparent PNGs. Transparent PNGs are not
    1475 # supported properly for IE 6.0, but are supported on all modern browsers.
    1476 #
    1477 # Note that when changing this option you need to delete any form_*.png files in
    1478 # the HTML output directory before the changes have effect.
    1479 # The default value is: YES.
    1480 # This tag requires that the tag GENERATE_HTML is set to YES.
    1481 
    1482 FORMULA_TRANSPARENT    = YES
     1685# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
     1686# to create new LaTeX commands to be used in formulas as building blocks. See
     1687# the section "Including formulas" for details.
     1688
     1689FORMULA_MACROFILE      =
    14831690
    14841691# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
    1485 # http://www.mathjax.org) which uses client side Javascript for the rendering
     1692# https://www.mathjax.org) which uses client side JavaScript for the rendering
    14861693# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
    14871694# installed or if you want to formulas look prettier in the HTML output. When
     
    14931700USE_MATHJAX            = NO
    14941701
     1702# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
     1703# Note that the different versions of MathJax have different requirements with
     1704# regards to the different settings, so it is possible that also other MathJax
     1705# settings have to be changed when switching between the different MathJax
     1706# versions.
     1707# Possible values are: MathJax_2 and MathJax_3.
     1708# The default value is: MathJax_2.
     1709# This tag requires that the tag USE_MATHJAX is set to YES.
     1710
     1711MATHJAX_VERSION        = MathJax_2
     1712
    14951713# When MathJax is enabled you can set the default output format to be used for
    1496 # the MathJax output. See the MathJax site (see:
    1497 # http://docs.mathjax.org/en/latest/output.html) for more details.
     1714# the MathJax output. For more details about the output format see MathJax
     1715# version 2 (see:
     1716# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
     1717# (see:
     1718# http://docs.mathjax.org/en/latest/web/components/output.html).
    14981719# Possible values are: HTML-CSS (which is slower, but has the best
    1499 # compatibility), NativeMML (i.e. MathML) and SVG.
     1720# compatibility. This is the name for Mathjax version 2, for MathJax version 3
     1721# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
     1722# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
     1723# is the name for Mathjax version 3, for MathJax version 2 this will be
     1724# translated into HTML-CSS) and SVG.
    15001725# The default value is: HTML-CSS.
    15011726# This tag requires that the tag USE_MATHJAX is set to YES.
     
    15101735# Content Delivery Network so you can quickly see the result without installing
    15111736# MathJax. However, it is strongly recommended to install a local copy of
    1512 # MathJax from http://www.mathjax.org before deployment.
    1513 # The default value is: http://cdn.mathjax.org/mathjax/latest.
     1737# MathJax from https://www.mathjax.org before deployment. The default value is:
     1738# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
     1739# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
    15141740# This tag requires that the tag USE_MATHJAX is set to YES.
    15151741
     
    15181744# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
    15191745# extension names that should be enabled during MathJax rendering. For example
     1746# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html
     1747# #tex-and-latex-extensions):
    15201748# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
     1749# For example for MathJax version 3 (see
     1750# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
     1751# MATHJAX_EXTENSIONS = ams
    15211752# This tag requires that the tag USE_MATHJAX is set to YES.
    15221753
     
    15251756# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
    15261757# of code that will be used on startup of the MathJax code. See the MathJax site
    1527 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
     1758# (see:
     1759# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
    15281760# example see the documentation.
    15291761# This tag requires that the tag USE_MATHJAX is set to YES.
     
    15531785
    15541786# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    1555 # implemented using a web server instead of a web client using Javascript. There
     1787# implemented using a web server instead of a web client using JavaScript. There
    15561788# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
    15571789# setting. When disabled, doxygen will generate a PHP script for searching and
     
    15721804# Doxygen ships with an example indexer (doxyindexer) and search engine
    15731805# (doxysearch.cgi) which are based on the open source search engine library
    1574 # Xapian (see: http://xapian.org/).
     1806# Xapian (see:
     1807# https://xapian.org/).
    15751808#
    15761809# See the section "External Indexing and Searching" for details.
     
    15851818# Doxygen ships with an example indexer (doxyindexer) and search engine
    15861819# (doxysearch.cgi) which are based on the open source search engine library
    1587 # Xapian (see: http://xapian.org/). See the section "External Indexing and
    1588 # Searching" for details.
     1820# Xapian (see:
     1821# https://xapian.org/). See the section "External Indexing and Searching" for
     1822# details.
    15891823# This tag requires that the tag SEARCHENGINE is set to YES.
    15901824
     
    16371871# invoked.
    16381872#
    1639 # Note that when enabling USE_PDFLATEX this option is only used for generating
    1640 # bitmaps for formulas in the HTML output, but not in the Makefile that is
    1641 # written to the output directory.
    1642 # The default file is: latex.
     1873# Note that when not enabling USE_PDFLATEX the default is latex when enabling
     1874# USE_PDFLATEX the default is pdflatex and when in the later case latex is
     1875# chosen this is overwritten by pdflatex. For specific output languages the
     1876# default can have been set differently, this depends on the implementation of
     1877# the output language.
    16431878# This tag requires that the tag GENERATE_LATEX is set to YES.
    16441879
     
    16471882# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
    16481883# index for LaTeX.
     1884# Note: This tag is used in the Makefile / make.bat.
     1885# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
     1886# (.tex).
    16491887# The default file is: makeindex.
    16501888# This tag requires that the tag GENERATE_LATEX is set to YES.
    16511889
    16521890MAKEINDEX_CMD_NAME     = makeindex
     1891
     1892# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
     1893# generate index for LaTeX. In case there is no backslash (\) as first character
     1894# it will be automatically added in the LaTeX code.
     1895# Note: This tag is used in the generated output file (.tex).
     1896# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
     1897# The default value is: makeindex.
     1898# This tag requires that the tag GENERATE_LATEX is set to YES.
     1899
     1900LATEX_MAKEINDEX_CMD    = makeindex
    16531901
    16541902# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
     
    16811929EXTRA_PACKAGES         =
    16821930
    1683 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
    1684 # generated LaTeX document. The header should contain everything until the first
    1685 # chapter. If it is left blank doxygen will generate a standard header. See
    1686 # section "Doxygen usage" for information on how to let doxygen write the
    1687 # default header to a separate file.
    1688 #
    1689 # Note: Only use a user-defined header if you know what you are doing! The
    1690 # following commands have a special meaning inside the header: $title,
    1691 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
    1692 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
    1693 # string, for the replacement values of the other commands the user is referred
    1694 # to HTML_HEADER.
     1931# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
     1932# the generated LaTeX document. The header should contain everything until the
     1933# first chapter. If it is left blank doxygen will generate a standard header. It
     1934# is highly recommended to start with a default header using
     1935# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
     1936# and then modify the file new_header.tex. See also section "Doxygen usage" for
     1937# information on how to generate the default header that doxygen normally uses.
     1938#
     1939# Note: Only use a user-defined header if you know what you are doing!
     1940# Note: The header is subject to change so you typically have to regenerate the
     1941# default header when upgrading to a newer version of doxygen. The following
     1942# commands have a special meaning inside the header (and footer): For a
     1943# description of the possible markers and block names see the documentation.
    16951944# This tag requires that the tag GENERATE_LATEX is set to YES.
    16961945
    16971946LATEX_HEADER           =
    16981947
    1699 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
    1700 # generated LaTeX document. The footer should contain everything after the last
    1701 # chapter. If it is left blank doxygen will generate a standard footer. See
     1948# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
     1949# the generated LaTeX document. The footer should contain everything after the
     1950# last chapter. If it is left blank doxygen will generate a standard footer. See
    17021951# LATEX_HEADER for more information on how to generate a default footer and what
    1703 # special commands can be used inside the footer.
    1704 #
    1705 # Note: Only use a user-defined footer if you know what you are doing!
     1952# special commands can be used inside the footer. See also section "Doxygen
     1953# usage" for information on how to generate the default footer that doxygen
     1954# normally uses. Note: Only use a user-defined footer if you know what you are
     1955# doing!
    17061956# This tag requires that the tag GENERATE_LATEX is set to YES.
    17071957
     
    17361986PDF_HYPERLINKS         = NO
    17371987
    1738 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
    1739 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
    1740 # higher quality PDF documentation.
     1988# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
     1989# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
     1990# files. Set this option to YES, to get a higher quality PDF documentation.
     1991#
     1992# See also section LATEX_CMD_NAME for selecting the engine.
    17411993# The default value is: YES.
    17421994# This tag requires that the tag GENERATE_LATEX is set to YES.
     
    17461998# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
    17471999# command to the generated LaTeX files. This will instruct LaTeX to keep running
    1748 # if errors occur, instead of asking the user for help. This option is also used
    1749 # when generating formulas in HTML.
     2000# if errors occur, instead of asking the user for help.
    17502001# The default value is: NO.
    17512002# This tag requires that the tag GENERATE_LATEX is set to YES.
     
    17602011LATEX_HIDE_INDICES     = NO
    17612012
    1762 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
    1763 # code with syntax highlighting in the LaTeX output.
    1764 #
    1765 # Note that which sources are shown also depends on other settings such as
    1766 # SOURCE_BROWSER.
    1767 # The default value is: NO.
    1768 # This tag requires that the tag GENERATE_LATEX is set to YES.
    1769 
    1770 LATEX_SOURCE_CODE      = NO
    1771 
    17722013# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
    17732014# bibliography, e.g. plainnat, or ieeetr. See
    1774 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
     2015# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
    17752016# The default value is: plain.
    17762017# This tag requires that the tag GENERATE_LATEX is set to YES.
     
    17852026
    17862027LATEX_TIMESTAMP        = NO
     2028
     2029# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
     2030# path from which the emoji images will be read. If a relative path is entered,
     2031# it will be relative to the LATEX_OUTPUT directory. If left blank the
     2032# LATEX_OUTPUT directory will be used.
     2033# This tag requires that the tag GENERATE_LATEX is set to YES.
     2034
     2035LATEX_EMOJI_DIRECTORY  =
    17872036
    17882037#---------------------------------------------------------------------------
     
    18252074RTF_HYPERLINKS         = NO
    18262075
    1827 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
    1828 # file, i.e. a series of assignments. You only have to provide replacements,
    1829 # missing definitions are set to their default value.
     2076# Load stylesheet definitions from file. Syntax is similar to doxygen's
     2077# configuration file, i.e. a series of assignments. You only have to provide
     2078# replacements, missing definitions are set to their default value.
    18302079#
    18312080# See also section "Doxygen usage" for information on how to generate the
     
    18362085
    18372086# Set optional variables used in the generation of an RTF document. Syntax is
    1838 # similar to doxygen's config file. A template extensions file can be generated
    1839 # using doxygen -e rtf extensionFile.
     2087# similar to doxygen's configuration file. A template extensions file can be
     2088# generated using doxygen -e rtf extensionFile.
    18402089# This tag requires that the tag GENERATE_RTF is set to YES.
    18412090
    18422091RTF_EXTENSIONS_FILE    =
    1843 
    1844 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
    1845 # with syntax highlighting in the RTF output.
    1846 #
    1847 # Note that which sources are shown also depends on other settings such as
    1848 # SOURCE_BROWSER.
    1849 # The default value is: NO.
    1850 # This tag requires that the tag GENERATE_RTF is set to YES.
    1851 
    1852 RTF_SOURCE_CODE        = NO
    18532092
    18542093#---------------------------------------------------------------------------
     
    19232162XML_PROGRAMLISTING     = YES
    19242163
     2164# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
     2165# namespace members in file scope as well, matching the HTML output.
     2166# The default value is: NO.
     2167# This tag requires that the tag GENERATE_XML is set to YES.
     2168
     2169XML_NS_MEMB_FILE_SCOPE = NO
     2170
    19252171#---------------------------------------------------------------------------
    19262172# Configuration options related to the DOCBOOK output
     
    19412187DOCBOOK_OUTPUT         = docbook
    19422188
    1943 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
    1944 # program listings (including syntax highlighting and cross-referencing
    1945 # information) to the DOCBOOK output. Note that enabling this will significantly
    1946 # increase the size of the DOCBOOK output.
    1947 # The default value is: NO.
    1948 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
    1949 
    1950 DOCBOOK_PROGRAMLISTING = NO
    1951 
    19522189#---------------------------------------------------------------------------
    19532190# Configuration options for the AutoGen Definitions output
     
    19552192
    19562193# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
    1957 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
    1958 # structure of the code including all documentation. Note that this feature is
    1959 # still experimental and incomplete at the moment.
     2194# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
     2195# the structure of the code including all documentation. Note that this feature
     2196# is still experimental and incomplete at the moment.
    19602197# The default value is: NO.
    19612198
     
    20362273# The INCLUDE_PATH tag can be used to specify one or more directories that
    20372274# contain include files that are not input files but should be processed by the
    2038 # preprocessor.
     2275# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
     2276# RECURSIVE has no effect here.
    20392277# This tag requires that the tag SEARCH_INCLUDES is set to YES.
    20402278
     
    21522390        "CTX_MID_Z(first,last)=firstr##RZ##last" \
    21532391
     2392
    21542393# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
    21552394# tag can be used to specify a list of macro names that should be expanded. The
     
    22352474EXTERNAL_PAGES         = YES
    22362475
    2237 # The PERL_PATH should be the absolute path and name of the perl script
    2238 # interpreter (i.e. the result of 'which perl').
    2239 # The default file (with absolute path) is: /usr/bin/perl.
    2240 
    2241 PERL_PATH              = /usr/bin/perl
    2242 
    22432476#---------------------------------------------------------------------------
    22442477# Configuration options related to the dot tool
    22452478#---------------------------------------------------------------------------
    2246 
    2247 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
    2248 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
    2249 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
    2250 # disabled, but it is recommended to install and use dot, since it yields more
    2251 # powerful graphs.
    2252 # The default value is: YES.
    2253 
    2254 CLASS_DIAGRAMS         = YES
    2255 
    2256 # You can define message sequence charts within doxygen comments using the \msc
    2257 # command. Doxygen will then run the mscgen tool (see:
    2258 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
    2259 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
    2260 # the mscgen tool resides. If left empty the tool is assumed to be found in the
    2261 # default search path.
    2262 
    2263 MSCGEN_PATH            =
    22642479
    22652480# You can include diagrams made with dia in doxygen documentation. Doxygen will
     
    22812496# Bell Labs. The other options in this section have no effect if this option is
    22822497# set to NO
    2283 # The default value is: YES.
     2498# The default value is: NO.
    22842499
    22852500HAVE_DOT               = NO
     
    22952510DOT_NUM_THREADS        = 0
    22962511
    2297 # When you want a differently looking font in the dot files that doxygen
    2298 # generates you can specify the font name using DOT_FONTNAME. You need to make
    2299 # sure dot is able to find the font, which can be done by putting it in a
    2300 # standard location or by setting the DOTFONTPATH environment variable or by
    2301 # setting DOT_FONTPATH to the directory containing the font.
    2302 # The default value is: Helvetica.
     2512# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
     2513# subgraphs. When you want a differently looking font in the dot files that
     2514# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
     2515# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
     2516# Edge and Graph Attributes specification</a> You need to make sure dot is able
     2517# to find the font, which can be done by putting it in a standard location or by
     2518# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
     2519# directory containing the font. Default graphviz fontsize is 14.
     2520# The default value is: fontname=Helvetica,fontsize=10.
    23032521# This tag requires that the tag HAVE_DOT is set to YES.
    23042522
    2305 DOT_FONTNAME           = Helvetica
    2306 
    2307 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
    2308 # dot graphs.
    2309 # Minimum value: 4, maximum value: 24, default value: 10.
     2523DOT_COMMON_ATTR        = "fontname=Helvetica,fontsize=10"
     2524
     2525# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
     2526# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
     2527# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
     2528# arrows shapes.</a>
     2529# The default value is: labelfontname=Helvetica,labelfontsize=10.
    23102530# This tag requires that the tag HAVE_DOT is set to YES.
    23112531
    2312 DOT_FONTSIZE           = 10
    2313 
    2314 # By default doxygen will tell dot to use the default font as specified with
    2315 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
    2316 # the path where dot can find it using this tag.
     2532DOT_EDGE_ATTR          = "labelfontname=Helvetica,labelfontsize=10"
     2533
     2534# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
     2535# around nodes set 'shape=plain' or 'shape=plaintext' <a
     2536# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
     2537# The default value is: shape=box,height=0.2,width=0.4.
    23172538# This tag requires that the tag HAVE_DOT is set to YES.
    23182539
     2540DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
     2541
     2542# You can set the path where dot can find font specified with fontname in
     2543# DOT_COMMON_ATTR and others dot attributes.
     2544# This tag requires that the tag HAVE_DOT is set to YES.
     2545
    23192546DOT_FONTPATH           =
    23202547
    2321 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
    2322 # each documented class showing the direct and indirect inheritance relations.
    2323 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
    2324 # The default value is: YES.
    2325 # This tag requires that the tag HAVE_DOT is set to YES.
     2548# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
     2549# graph for each documented class showing the direct and indirect inheritance
     2550# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
     2551# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
     2552# to TEXT the direct and indirect inheritance relations will be shown as texts /
     2553# links.
     2554# Possible values are: NO, YES, TEXT and GRAPH.
     2555# The default value is: YES.
    23262556
    23272557CLASS_GRAPH            = YES
     
    23372567
    23382568# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
    2339 # groups, showing the direct groups dependencies.
     2569# groups, showing the direct groups dependencies. See also the chapter Grouping
     2570# in the manual.
    23402571# The default value is: YES.
    23412572# This tag requires that the tag HAVE_DOT is set to YES.
     
    23602591# 10.
    23612592# Minimum value: 0, maximum value: 100, default value: 10.
     2593# This tag requires that the tag UML_LOOK is set to YES.
     2594
     2595UML_LIMIT_NUM_FIELDS   = 10
     2596
     2597# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
     2598# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
     2599# tag is set to YES, doxygen will add type and arguments for attributes and
     2600# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
     2601# will not generate fields with class member information in the UML graphs. The
     2602# class diagrams will look similar to the default class diagrams but using UML
     2603# notation for the relationships.
     2604# Possible values are: NO, YES and NONE.
     2605# The default value is: NO.
     2606# This tag requires that the tag UML_LOOK is set to YES.
     2607
     2608DOT_UML_DETAILS        = NO
     2609
     2610# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
     2611# to display on a single line. If the actual line length exceeds this threshold
     2612# significantly it will wrapped across multiple lines. Some heuristics are apply
     2613# to avoid ugly line breaks.
     2614# Minimum value: 0, maximum value: 1000, default value: 17.
    23622615# This tag requires that the tag HAVE_DOT is set to YES.
    23632616
    2364 UML_LIMIT_NUM_FIELDS   = 10
     2617DOT_WRAP_THRESHOLD     = 17
    23652618
    23662619# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
     
    24292682
    24302683DIRECTORY_GRAPH        = YES
     2684
     2685# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
     2686# of child directories generated in directory dependency graphs by dot.
     2687# Minimum value: 1, maximum value: 25, default value: 1.
     2688# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
     2689
     2690DIR_GRAPH_MAX_DEPTH    = 1
    24312691
    24322692# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     
    24372697# to make the SVG files visible in IE 9+ (other browsers do not have this
    24382698# requirement).
    2439 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
    2440 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
    2441 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
     2699# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
    24422700# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
    24432701# png:gdiplus:gdiplus.
     
    24852743
    24862744# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
    2487 # path where java can find the plantuml.jar file. If left blank, it is assumed
    2488 # PlantUML is not used or called during a preprocessing step. Doxygen will
    2489 # generate a warning when it encounters a \startuml command in this case and
    2490 # will not generate output for the diagram.
     2745# path where java can find the plantuml.jar file or to the filename of jar file
     2746# to be used. If left blank, it is assumed PlantUML is not used or called during
     2747# a preprocessing step. Doxygen will generate a warning when it encounters a
     2748# \startuml command in this case and will not generate output for the diagram.
    24912749
    24922750PLANTUML_JAR_PATH      =
     2751
     2752# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
     2753# configuration file for plantuml.
     2754
     2755PLANTUML_CFG_FILE      =
    24932756
    24942757# When using plantuml, the specified paths are searched for files specified by
     
    25212784MAX_DOT_GRAPH_DEPTH    = 0
    25222785
    2523 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    2524 # background. This is disabled by default, because dot on Windows does not seem
    2525 # to support this out of the box.
    2526 #
    2527 # Warning: Depending on the platform used, enabling this option may lead to
    2528 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
    2529 # read).
    2530 # The default value is: NO.
    2531 # This tag requires that the tag HAVE_DOT is set to YES.
    2532 
    2533 DOT_TRANSPARENT        = YES
    2534 
    25352786# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
    25362787# files in one run (i.e. multiple -o and -T options on the command line). This
     
    25452796# explaining the meaning of the various boxes and arrows in the dot generated
    25462797# graphs.
     2798# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
     2799# graphical representation for inheritance and collaboration diagrams is used.
    25472800# The default value is: YES.
    25482801# This tag requires that the tag HAVE_DOT is set to YES.
     
    25502803GENERATE_LEGEND        = YES
    25512804
    2552 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
     2805# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
    25532806# files that are used to generate the various graphs.
    2554 # The default value is: YES.
    2555 # This tag requires that the tag HAVE_DOT is set to YES.
     2807#
     2808# Note: This setting is not only used for dot files but also for msc temporary
     2809# files.
     2810# The default value is: YES.
    25562811
    25572812DOT_CLEANUP            = YES
    2558 
    2559 MARKDOWN_SUPPORT       = NO
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette