Commit 6aba1882a1a4784acfc73f2615d9e69644371d16
1 parent
549d24ef
Added doxygen file
Showing
2 changed files
with
2988 additions
and
1 deletions
.gitignore
Doxyfile
0 → 100644
| 1 | +# Doxyfile 1.14.0 | ||
| 2 | + | ||
| 3 | +# This file describes the settings to be used by the documentation system | ||
| 4 | +# Doxygen (www.doxygen.org) for a project. | ||
| 5 | +# | ||
| 6 | +# All text after a double hash (##) is considered a comment and is placed in | ||
| 7 | +# front of the TAG it is preceding. | ||
| 8 | +# | ||
| 9 | +# All text after a single hash (#) is considered a comment and will be ignored. | ||
| 10 | +# The format is: | ||
| 11 | +# TAG = value [value, ...] | ||
| 12 | +# For lists, items can also be appended using: | ||
| 13 | +# TAG += value [value, ...] | ||
| 14 | +# 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] | ||
| 25 | + | ||
| 26 | +#--------------------------------------------------------------------------- | ||
| 27 | +# Project related configuration options | ||
| 28 | +#--------------------------------------------------------------------------- | ||
| 29 | + | ||
| 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. | ||
| 35 | +# The default value is: UTF-8. | ||
| 36 | + | ||
| 37 | +DOXYFILE_ENCODING = UTF-8 | ||
| 38 | + | ||
| 39 | +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | ||
| 40 | +# double-quotes, unless you are using Doxywizard) that should identify the | ||
| 41 | +# project for which the documentation is generated. This name is used in the | ||
| 42 | +# title of most generated pages and in a few other places. | ||
| 43 | +# The default value is: My Project. | ||
| 44 | + | ||
| 45 | +PROJECT_NAME = libQPDF | ||
| 46 | + | ||
| 47 | +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This | ||
| 48 | +# could be handy for archiving the generated documentation or if some version | ||
| 49 | +# control system is used. | ||
| 50 | + | ||
| 51 | +PROJECT_NUMBER = | ||
| 52 | + | ||
| 53 | +# Using the PROJECT_BRIEF tag one can provide an optional one line description | ||
| 54 | +# for a project that appears at the top of each page and should give viewers a | ||
| 55 | +# quick idea about the purpose of the project. Keep the description short. | ||
| 56 | + | ||
| 57 | +PROJECT_BRIEF = | ||
| 58 | + | ||
| 59 | +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included | ||
| 60 | +# in the documentation. The maximum height of the logo should not exceed 55 | ||
| 61 | +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | ||
| 62 | +# the logo to the output directory. | ||
| 63 | + | ||
| 64 | +PROJECT_LOGO = | ||
| 65 | + | ||
| 66 | +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs | ||
| 67 | +# when the HTML document is shown. Doxygen will copy the logo to the output | ||
| 68 | +# directory. | ||
| 69 | + | ||
| 70 | +PROJECT_ICON = | ||
| 71 | + | ||
| 72 | +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path | ||
| 73 | +# into which the generated documentation will be written. If a relative path is | ||
| 74 | +# entered, it will be relative to the location where Doxygen was started. If | ||
| 75 | +# left blank the current directory will be used. | ||
| 76 | + | ||
| 77 | +OUTPUT_DIRECTORY = /home/pgroen/projects/qpdf/docs | ||
| 78 | + | ||
| 79 | +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 | ||
| 80 | +# sub-directories (in 2 levels) under the output directory of each output format | ||
| 81 | +# and will distribute the generated files over these directories. Enabling this | ||
| 82 | +# option can be useful when feeding Doxygen a huge amount of source files, where | ||
| 83 | +# putting all generated files in the same directory would otherwise cause | ||
| 84 | +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to | ||
| 85 | +# control the number of sub-directories. | ||
| 86 | +# The default value is: NO. | ||
| 87 | + | ||
| 88 | +CREATE_SUBDIRS = NO | ||
| 89 | + | ||
| 90 | +# Controls the number of sub-directories that will be created when | ||
| 91 | +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every | ||
| 92 | +# level increment doubles the number of directories, resulting in 4096 | ||
| 93 | +# directories at level 8 which is the default and also the maximum value. The | ||
| 94 | +# sub-directories are organized in 2 levels, the first level always has a fixed | ||
| 95 | +# number of 16 directories. | ||
| 96 | +# Minimum value: 0, maximum value: 8, default value: 8. | ||
| 97 | +# This tag requires that the tag CREATE_SUBDIRS is set to YES. | ||
| 98 | + | ||
| 99 | +CREATE_SUBDIRS_LEVEL = 8 | ||
| 100 | + | ||
| 101 | +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII | ||
| 102 | +# characters to appear in the names of generated files. If set to NO, non-ASCII | ||
| 103 | +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode | ||
| 104 | +# U+3044. | ||
| 105 | +# The default value is: NO. | ||
| 106 | + | ||
| 107 | +ALLOW_UNICODE_NAMES = NO | ||
| 108 | + | ||
| 109 | +# The OUTPUT_LANGUAGE tag is used to specify the language in which all | ||
| 110 | +# documentation generated by Doxygen is written. Doxygen will use this | ||
| 111 | +# information to generate all constant output in the proper language. | ||
| 112 | +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, | ||
| 113 | +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English | ||
| 114 | +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, | ||
| 115 | +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with | ||
| 116 | +# English messages), Korean, Korean-en (Korean with English messages), Latvian, | ||
| 117 | +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, | ||
| 118 | +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, | ||
| 119 | +# Swedish, Turkish, Ukrainian and Vietnamese. | ||
| 120 | +# The default value is: English. | ||
| 121 | + | ||
| 122 | +OUTPUT_LANGUAGE = English | ||
| 123 | + | ||
| 124 | +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member | ||
| 125 | +# descriptions after the members that are listed in the file and class | ||
| 126 | +# documentation (similar to Javadoc). Set to NO to disable this. | ||
| 127 | +# The default value is: YES. | ||
| 128 | + | ||
| 129 | +BRIEF_MEMBER_DESC = YES | ||
| 130 | + | ||
| 131 | +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief | ||
| 132 | +# description of a member or function before the detailed description | ||
| 133 | +# | ||
| 134 | +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | ||
| 135 | +# brief descriptions will be completely suppressed. | ||
| 136 | +# The default value is: YES. | ||
| 137 | + | ||
| 138 | +REPEAT_BRIEF = YES | ||
| 139 | + | ||
| 140 | +# This tag implements a quasi-intelligent brief description abbreviator that is | ||
| 141 | +# used to form the text in various listings. Each string in this list, if found | ||
| 142 | +# as the leading text of the brief description, will be stripped from the text | ||
| 143 | +# and the result, after processing the whole list, is used as the annotated | ||
| 144 | +# text. Otherwise, the brief description is used as-is. If left blank, the | ||
| 145 | +# following values are used ($name is automatically replaced with the name of | ||
| 146 | +# the entity):The $name class, The $name widget, The $name file, is, provides, | ||
| 147 | +# specifies, contains, represents, a, an and the. | ||
| 148 | + | ||
| 149 | +ABBREVIATE_BRIEF = "The $name class" \ | ||
| 150 | + "The $name widget" \ | ||
| 151 | + "The $name file" \ | ||
| 152 | + is \ | ||
| 153 | + provides \ | ||
| 154 | + specifies \ | ||
| 155 | + contains \ | ||
| 156 | + represents \ | ||
| 157 | + a \ | ||
| 158 | + an \ | ||
| 159 | + the | ||
| 160 | + | ||
| 161 | +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | ||
| 162 | +# Doxygen will generate a detailed section even if there is only a brief | ||
| 163 | +# description. | ||
| 164 | +# The default value is: NO. | ||
| 165 | + | ||
| 166 | +ALWAYS_DETAILED_SEC = NO | ||
| 167 | + | ||
| 168 | +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all | ||
| 169 | +# inherited members of a class in the documentation of that class as if those | ||
| 170 | +# members were ordinary class members. Constructors, destructors and assignment | ||
| 171 | +# operators of the base classes will not be shown. | ||
| 172 | +# The default value is: NO. | ||
| 173 | + | ||
| 174 | +INLINE_INHERITED_MEMB = NO | ||
| 175 | + | ||
| 176 | +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path | ||
| 177 | +# before files name in the file list and in the header files. If set to NO the | ||
| 178 | +# shortest path that makes the file name unique will be used | ||
| 179 | +# The default value is: YES. | ||
| 180 | + | ||
| 181 | +FULL_PATH_NAMES = YES | ||
| 182 | + | ||
| 183 | +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. | ||
| 184 | +# Stripping is only done if one of the specified strings matches the left-hand | ||
| 185 | +# part of the path. The tag can be used to show relative paths in the file list. | ||
| 186 | +# If left blank the directory from which Doxygen is run is used as the path to | ||
| 187 | +# strip. | ||
| 188 | +# | ||
| 189 | +# Note that you can specify absolute paths here, but also relative paths, which | ||
| 190 | +# will be relative from the directory where Doxygen is started. | ||
| 191 | +# This tag requires that the tag FULL_PATH_NAMES is set to YES. | ||
| 192 | + | ||
| 193 | +STRIP_FROM_PATH = | ||
| 194 | + | ||
| 195 | +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the | ||
| 196 | +# path mentioned in the documentation of a class, which tells the reader which | ||
| 197 | +# header file to include in order to use a class. If left blank only the name of | ||
| 198 | +# the header file containing the class definition is used. Otherwise one should | ||
| 199 | +# specify the list of include paths that are normally passed to the compiler | ||
| 200 | +# using the -I flag. | ||
| 201 | + | ||
| 202 | +STRIP_FROM_INC_PATH = | ||
| 203 | + | ||
| 204 | +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but | ||
| 205 | +# less readable) file names. This can be useful if your file system doesn't | ||
| 206 | +# support long names like on DOS, Mac, or CD-ROM. | ||
| 207 | +# The default value is: NO. | ||
| 208 | + | ||
| 209 | +SHORT_NAMES = NO | ||
| 210 | + | ||
| 211 | +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the | ||
| 212 | +# first line (until the first dot, question mark or exclamation mark) of a | ||
| 213 | +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- | ||
| 214 | +# style will behave just like regular Qt-style comments (thus requiring an | ||
| 215 | +# explicit @brief command for a brief description.) | ||
| 216 | +# The default value is: NO. | ||
| 217 | + | ||
| 218 | +JAVADOC_AUTOBRIEF = NO | ||
| 219 | + | ||
| 220 | +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line | ||
| 221 | +# such as | ||
| 222 | +# /*************** | ||
| 223 | +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the | ||
| 224 | +# Javadoc-style will behave just like regular comments and it will not be | ||
| 225 | +# interpreted by Doxygen. | ||
| 226 | +# The default value is: NO. | ||
| 227 | + | ||
| 228 | +JAVADOC_BANNER = NO | ||
| 229 | + | ||
| 230 | +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first | ||
| 231 | +# line (until the first dot, question mark or exclamation mark) of a Qt-style | ||
| 232 | +# comment as the brief description. If set to NO, the Qt-style will behave just | ||
| 233 | +# like regular Qt-style comments (thus requiring an explicit \brief command for | ||
| 234 | +# a brief description.) | ||
| 235 | +# The default value is: NO. | ||
| 236 | + | ||
| 237 | +QT_AUTOBRIEF = NO | ||
| 238 | + | ||
| 239 | +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a | ||
| 240 | +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as | ||
| 241 | +# a brief description. This used to be the default behavior. The new default is | ||
| 242 | +# to treat a multi-line C++ comment block as a detailed description. Set this | ||
| 243 | +# tag to YES if you prefer the old behavior instead. | ||
| 244 | +# | ||
| 245 | +# Note that setting this tag to YES also means that rational rose comments are | ||
| 246 | +# not recognized any more. | ||
| 247 | +# The default value is: NO. | ||
| 248 | + | ||
| 249 | +MULTILINE_CPP_IS_BRIEF = NO | ||
| 250 | + | ||
| 251 | +# By default Python docstrings are displayed as preformatted text and Doxygen's | ||
| 252 | +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the | ||
| 253 | +# Doxygen's special commands can be used and the contents of the docstring | ||
| 254 | +# documentation blocks is shown as Doxygen documentation. | ||
| 255 | +# The default value is: YES. | ||
| 256 | + | ||
| 257 | +PYTHON_DOCSTRING = YES | ||
| 258 | + | ||
| 259 | +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | ||
| 260 | +# documentation from any documented member that it re-implements. | ||
| 261 | +# The default value is: YES. | ||
| 262 | + | ||
| 263 | +INHERIT_DOCS = YES | ||
| 264 | + | ||
| 265 | +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new | ||
| 266 | +# page for each member. If set to NO, the documentation of a member will be part | ||
| 267 | +# of the file/class/namespace that contains it. | ||
| 268 | +# The default value is: NO. | ||
| 269 | + | ||
| 270 | +SEPARATE_MEMBER_PAGES = NO | ||
| 271 | + | ||
| 272 | +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen | ||
| 273 | +# uses this value to replace tabs by spaces in code fragments. | ||
| 274 | +# Minimum value: 1, maximum value: 16, default value: 4. | ||
| 275 | + | ||
| 276 | +TAB_SIZE = 4 | ||
| 277 | + | ||
| 278 | +# This tag can be used to specify a number of aliases that act as commands in | ||
| 279 | +# the documentation. An alias has the form: | ||
| 280 | +# name=value | ||
| 281 | +# For example adding | ||
| 282 | +# "sideeffect=@par Side Effects:^^" | ||
| 283 | +# will allow you to put the command \sideeffect (or @sideeffect) in the | ||
| 284 | +# documentation, which will result in a user-defined paragraph with heading | ||
| 285 | +# "Side Effects:". Note that you cannot put \n's in the value part of an alias | ||
| 286 | +# to insert newlines (in the resulting output). You can put ^^ in the value part | ||
| 287 | +# of an alias to insert a newline as if a physical newline was in the original | ||
| 288 | +# file. When you need a literal { or } or , in the value part of an alias you | ||
| 289 | +# have to escape them by means of a backslash (\), this can lead to conflicts | ||
| 290 | +# with the commands \{ and \} for these it is advised to use the version @{ and | ||
| 291 | +# @} or use a double escape (\\{ and \\}) | ||
| 292 | + | ||
| 293 | +ALIASES = | ||
| 294 | + | ||
| 295 | +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | ||
| 296 | +# only. Doxygen will then generate output that is more tailored for C. For | ||
| 297 | +# instance, some of the names that are used will be different. The list of all | ||
| 298 | +# members will be omitted, etc. | ||
| 299 | +# The default value is: NO. | ||
| 300 | + | ||
| 301 | +OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 302 | + | ||
| 303 | +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or | ||
| 304 | +# Python sources only. Doxygen will then generate output that is more tailored | ||
| 305 | +# for that language. For instance, namespaces will be presented as packages, | ||
| 306 | +# qualified scopes will look different, etc. | ||
| 307 | +# The default value is: NO. | ||
| 308 | + | ||
| 309 | +OPTIMIZE_OUTPUT_JAVA = NO | ||
| 310 | + | ||
| 311 | +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | ||
| 312 | +# sources. Doxygen will then generate output that is tailored for Fortran. | ||
| 313 | +# The default value is: NO. | ||
| 314 | + | ||
| 315 | +OPTIMIZE_FOR_FORTRAN = NO | ||
| 316 | + | ||
| 317 | +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | ||
| 318 | +# sources. Doxygen will then generate output that is tailored for VHDL. | ||
| 319 | +# The default value is: NO. | ||
| 320 | + | ||
| 321 | +OPTIMIZE_OUTPUT_VHDL = NO | ||
| 322 | + | ||
| 323 | +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice | ||
| 324 | +# sources only. Doxygen will then generate output that is more tailored for that | ||
| 325 | +# language. For instance, namespaces will be presented as modules, types will be | ||
| 326 | +# separated into more groups, etc. | ||
| 327 | +# The default value is: NO. | ||
| 328 | + | ||
| 329 | +OPTIMIZE_OUTPUT_SLICE = NO | ||
| 330 | + | ||
| 331 | +# Doxygen selects the parser to use depending on the extension of the files it | ||
| 332 | +# parses. With this tag you can assign which parser to use for a given | ||
| 333 | +# extension. Doxygen has a built-in mapping, but you can override or extend it | ||
| 334 | +# using this tag. The format is ext=language, where ext is a file extension, and | ||
| 335 | +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, | ||
| 336 | +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, | ||
| 337 | +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: | ||
| 338 | +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser | ||
| 339 | +# tries to guess whether the code is fixed or free formatted code, this is the | ||
| 340 | +# default for Fortran type files). For instance to make Doxygen treat .inc files | ||
| 341 | +# as Fortran files (default is PHP), and .f files as C (default is Fortran), | ||
| 342 | +# use: inc=Fortran f=C. | ||
| 343 | +# | ||
| 344 | +# Note: For files without extension you can use no_extension as a placeholder. | ||
| 345 | +# | ||
| 346 | +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise | ||
| 347 | +# the files are not read by Doxygen. When specifying no_extension you should add | ||
| 348 | +# * to the FILE_PATTERNS. | ||
| 349 | +# | ||
| 350 | +# Note see also the list of default file extension mappings. | ||
| 351 | + | ||
| 352 | +EXTENSION_MAPPING = | ||
| 353 | + | ||
| 354 | +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments | ||
| 355 | +# according to the Markdown format, which allows for more readable | ||
| 356 | +# documentation. See https://daringfireball.net/projects/markdown/ for details. | ||
| 357 | +# The output of markdown processing is further processed by Doxygen, so you can | ||
| 358 | +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in | ||
| 359 | +# case of backward compatibilities issues. | ||
| 360 | +# The default value is: YES. | ||
| 361 | + | ||
| 362 | +MARKDOWN_SUPPORT = YES | ||
| 363 | + | ||
| 364 | +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up | ||
| 365 | +# to that level are automatically included in the table of contents, even if | ||
| 366 | +# they do not have an id attribute. | ||
| 367 | +# Note: This feature currently applies only to Markdown headings. | ||
| 368 | +# Minimum value: 0, maximum value: 99, default value: 6. | ||
| 369 | +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | ||
| 370 | + | ||
| 371 | +TOC_INCLUDE_HEADINGS = 6 | ||
| 372 | + | ||
| 373 | +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to | ||
| 374 | +# generate identifiers for the Markdown headings. Note: Every identifier is | ||
| 375 | +# unique. | ||
| 376 | +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a | ||
| 377 | +# sequence number starting at 0 and GITHUB use the lower case version of title | ||
| 378 | +# with any whitespace replaced by '-' and punctuation characters removed. | ||
| 379 | +# The default value is: DOXYGEN. | ||
| 380 | +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | ||
| 381 | + | ||
| 382 | +MARKDOWN_ID_STYLE = DOXYGEN | ||
| 383 | + | ||
| 384 | +# When enabled Doxygen tries to link words that correspond to documented | ||
| 385 | +# classes, or namespaces to their corresponding documentation. Such a link can | ||
| 386 | +# be prevented in individual cases by putting a % sign in front of the word or | ||
| 387 | +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the | ||
| 388 | +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. | ||
| 389 | +# The default value is: YES. | ||
| 390 | + | ||
| 391 | +AUTOLINK_SUPPORT = YES | ||
| 392 | + | ||
| 393 | +# This tag specifies a list of words that, when matching the start of a word in | ||
| 394 | +# the documentation, will suppress auto links generation, if it is enabled via | ||
| 395 | +# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \# | ||
| 396 | +# or the \link or commands. | ||
| 397 | +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. | ||
| 398 | + | ||
| 399 | +AUTOLINK_IGNORE_WORDS = | ||
| 400 | + | ||
| 401 | +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | ||
| 402 | +# to include (a tag file for) the STL sources as input, then you should set this | ||
| 403 | +# tag to YES in order to let Doxygen match functions declarations and | ||
| 404 | +# definitions whose arguments contain STL classes (e.g. func(std::string); | ||
| 405 | +# versus func(std::string) {}). This also makes the inheritance and | ||
| 406 | +# collaboration diagrams that involve STL classes more complete and accurate. | ||
| 407 | +# The default value is: NO. | ||
| 408 | + | ||
| 409 | +BUILTIN_STL_SUPPORT = NO | ||
| 410 | + | ||
| 411 | +# If you use Microsoft's C++/CLI language, you should set this option to YES to | ||
| 412 | +# enable parsing support. | ||
| 413 | +# The default value is: NO. | ||
| 414 | + | ||
| 415 | +CPP_CLI_SUPPORT = NO | ||
| 416 | + | ||
| 417 | +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: | ||
| 418 | +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse | ||
| 419 | +# them like normal C++ but will assume all classes use public instead of private | ||
| 420 | +# inheritance when no explicit protection keyword is present. | ||
| 421 | +# The default value is: NO. | ||
| 422 | + | ||
| 423 | +SIP_SUPPORT = NO | ||
| 424 | + | ||
| 425 | +# For Microsoft's IDL there are propget and propput attributes to indicate | ||
| 426 | +# getter and setter methods for a property. Setting this option to YES will make | ||
| 427 | +# Doxygen to replace the get and set methods by a property in the documentation. | ||
| 428 | +# This will only work if the methods are indeed getting or setting a simple | ||
| 429 | +# type. If this is not the case, or you want to show the methods anyway, you | ||
| 430 | +# should set this option to NO. | ||
| 431 | +# The default value is: YES. | ||
| 432 | + | ||
| 433 | +IDL_PROPERTY_SUPPORT = YES | ||
| 434 | + | ||
| 435 | +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | ||
| 436 | +# tag is set to YES then Doxygen will reuse the documentation of the first | ||
| 437 | +# member in the group (if any) for the other members of the group. By default | ||
| 438 | +# all members of a group must be documented explicitly. | ||
| 439 | +# The default value is: NO. | ||
| 440 | + | ||
| 441 | +DISTRIBUTE_GROUP_DOC = NO | ||
| 442 | + | ||
| 443 | +# If one adds a struct or class to a group and this option is enabled, then also | ||
| 444 | +# any nested class or struct is added to the same group. By default this option | ||
| 445 | +# is disabled and one has to add nested compounds explicitly via \ingroup. | ||
| 446 | +# The default value is: NO. | ||
| 447 | + | ||
| 448 | +GROUP_NESTED_COMPOUNDS = NO | ||
| 449 | + | ||
| 450 | +# Set the SUBGROUPING tag to YES to allow class member groups of the same type | ||
| 451 | +# (for instance a group of public functions) to be put as a subgroup of that | ||
| 452 | +# type (e.g. under the Public Functions section). Set it to NO to prevent | ||
| 453 | +# subgrouping. Alternatively, this can be done per class using the | ||
| 454 | +# \nosubgrouping command. | ||
| 455 | +# The default value is: YES. | ||
| 456 | + | ||
| 457 | +SUBGROUPING = YES | ||
| 458 | + | ||
| 459 | +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions | ||
| 460 | +# are shown inside the group in which they are included (e.g. using \ingroup) | ||
| 461 | +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX | ||
| 462 | +# and RTF). | ||
| 463 | +# | ||
| 464 | +# Note that this feature does not work in combination with | ||
| 465 | +# SEPARATE_MEMBER_PAGES. | ||
| 466 | +# The default value is: NO. | ||
| 467 | + | ||
| 468 | +INLINE_GROUPED_CLASSES = NO | ||
| 469 | + | ||
| 470 | +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions | ||
| 471 | +# with only public data fields or simple typedef fields will be shown inline in | ||
| 472 | +# the documentation of the scope in which they are defined (i.e. file, | ||
| 473 | +# namespace, or group documentation), provided this scope is documented. If set | ||
| 474 | +# to NO, structs, classes, and unions are shown on a separate page (for HTML and | ||
| 475 | +# Man pages) or section (for LaTeX and RTF). | ||
| 476 | +# The default value is: NO. | ||
| 477 | + | ||
| 478 | +INLINE_SIMPLE_STRUCTS = NO | ||
| 479 | + | ||
| 480 | +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or | ||
| 481 | +# enum is documented as struct, union, or enum with the name of the typedef. So | ||
| 482 | +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
| 483 | +# with name TypeT. When disabled the typedef will appear as a member of a file, | ||
| 484 | +# namespace, or class. And the struct will be named TypeS. This can typically be | ||
| 485 | +# useful for C code in case the coding convention dictates that all compound | ||
| 486 | +# types are typedef'ed and only the typedef is referenced, never the tag name. | ||
| 487 | +# The default value is: NO. | ||
| 488 | + | ||
| 489 | +TYPEDEF_HIDES_STRUCT = NO | ||
| 490 | + | ||
| 491 | +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This | ||
| 492 | +# cache is used to resolve symbols given their name and scope. Since this can be | ||
| 493 | +# an expensive process and often the same symbol appears multiple times in the | ||
| 494 | +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small | ||
| 495 | +# Doxygen will become slower. If the cache is too large, memory is wasted. The | ||
| 496 | +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range | ||
| 497 | +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 | ||
| 498 | +# symbols. At the end of a run Doxygen will report the cache usage and suggest | ||
| 499 | +# the optimal cache size from a speed point of view. | ||
| 500 | +# Minimum value: 0, maximum value: 9, default value: 0. | ||
| 501 | + | ||
| 502 | +LOOKUP_CACHE_SIZE = 0 | ||
| 503 | + | ||
| 504 | +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use | ||
| 505 | +# during processing. When set to 0 Doxygen will based this on the number of | ||
| 506 | +# cores available in the system. You can set it explicitly to a value larger | ||
| 507 | +# than 0 to get more control over the balance between CPU load and processing | ||
| 508 | +# speed. At this moment only the input processing can be done using multiple | ||
| 509 | +# threads. Since this is still an experimental feature the default is set to 1, | ||
| 510 | +# which effectively disables parallel processing. Please report any issues you | ||
| 511 | +# encounter. Generating dot graphs in parallel is controlled by the | ||
| 512 | +# DOT_NUM_THREADS setting. | ||
| 513 | +# Minimum value: 0, maximum value: 32, default value: 1. | ||
| 514 | + | ||
| 515 | +NUM_PROC_THREADS = 1 | ||
| 516 | + | ||
| 517 | +# If the TIMESTAMP tag is set different from NO then each generated page will | ||
| 518 | +# contain the date or date and time when the page was generated. Setting this to | ||
| 519 | +# NO can help when comparing the output of multiple runs. | ||
| 520 | +# Possible values are: YES, NO, DATETIME and DATE. | ||
| 521 | +# The default value is: NO. | ||
| 522 | + | ||
| 523 | +TIMESTAMP = NO | ||
| 524 | + | ||
| 525 | +#--------------------------------------------------------------------------- | ||
| 526 | +# Build related configuration options | ||
| 527 | +#--------------------------------------------------------------------------- | ||
| 528 | + | ||
| 529 | +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in | ||
| 530 | +# documentation are documented, even if no documentation was available. Private | ||
| 531 | +# class members and static file members will be hidden unless the | ||
| 532 | +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. | ||
| 533 | +# Note: This will also disable the warnings about undocumented members that are | ||
| 534 | +# normally produced when WARNINGS is set to YES. | ||
| 535 | +# The default value is: NO. | ||
| 536 | + | ||
| 537 | +EXTRACT_ALL = YES | ||
| 538 | + | ||
| 539 | +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will | ||
| 540 | +# be included in the documentation. | ||
| 541 | +# The default value is: NO. | ||
| 542 | + | ||
| 543 | +EXTRACT_PRIVATE = NO | ||
| 544 | + | ||
| 545 | +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual | ||
| 546 | +# methods of a class will be included in the documentation. | ||
| 547 | +# The default value is: NO. | ||
| 548 | + | ||
| 549 | +EXTRACT_PRIV_VIRTUAL = NO | ||
| 550 | + | ||
| 551 | +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal | ||
| 552 | +# scope will be included in the documentation. | ||
| 553 | +# The default value is: NO. | ||
| 554 | + | ||
| 555 | +EXTRACT_PACKAGE = NO | ||
| 556 | + | ||
| 557 | +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be | ||
| 558 | +# included in the documentation. | ||
| 559 | +# The default value is: NO. | ||
| 560 | + | ||
| 561 | +EXTRACT_STATIC = NO | ||
| 562 | + | ||
| 563 | +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined | ||
| 564 | +# locally in source files will be included in the documentation. If set to NO, | ||
| 565 | +# only classes defined in header files are included. Does not have any effect | ||
| 566 | +# for Java sources. | ||
| 567 | +# The default value is: YES. | ||
| 568 | + | ||
| 569 | +EXTRACT_LOCAL_CLASSES = YES | ||
| 570 | + | ||
| 571 | +# This flag is only useful for Objective-C code. If set to YES, local methods, | ||
| 572 | +# which are defined in the implementation section but not in the interface are | ||
| 573 | +# included in the documentation. If set to NO, only methods in the interface are | ||
| 574 | +# included. | ||
| 575 | +# The default value is: NO. | ||
| 576 | + | ||
| 577 | +EXTRACT_LOCAL_METHODS = NO | ||
| 578 | + | ||
| 579 | +# If this flag is set to YES, the members of anonymous namespaces will be | ||
| 580 | +# extracted and appear in the documentation as a namespace called | ||
| 581 | +# 'anonymous_namespace{file}', where file will be replaced with the base name of | ||
| 582 | +# the file that contains the anonymous namespace. By default anonymous namespace | ||
| 583 | +# are hidden. | ||
| 584 | +# The default value is: NO. | ||
| 585 | + | ||
| 586 | +EXTRACT_ANON_NSPACES = NO | ||
| 587 | + | ||
| 588 | +# If this flag is set to YES, the name of an unnamed parameter in a declaration | ||
| 589 | +# will be determined by the corresponding definition. By default unnamed | ||
| 590 | +# parameters remain unnamed in the output. | ||
| 591 | +# The default value is: YES. | ||
| 592 | + | ||
| 593 | +RESOLVE_UNNAMED_PARAMS = YES | ||
| 594 | + | ||
| 595 | +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | ||
| 596 | +# undocumented members inside documented classes or files. If set to NO these | ||
| 597 | +# members will be included in the various overviews, but no documentation | ||
| 598 | +# section is generated. This option has no effect if EXTRACT_ALL is enabled. | ||
| 599 | +# The default value is: NO. | ||
| 600 | + | ||
| 601 | +HIDE_UNDOC_MEMBERS = NO | ||
| 602 | + | ||
| 603 | +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | ||
| 604 | +# undocumented classes that are normally visible in the class hierarchy. If set | ||
| 605 | +# to NO, these classes will be included in the various overviews. This option | ||
| 606 | +# will also hide undocumented C++ concepts if enabled. This option has no effect | ||
| 607 | +# if EXTRACT_ALL is enabled. | ||
| 608 | +# The default value is: NO. | ||
| 609 | + | ||
| 610 | +HIDE_UNDOC_CLASSES = NO | ||
| 611 | + | ||
| 612 | +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all | ||
| 613 | +# undocumented namespaces that are normally visible in the namespace hierarchy. | ||
| 614 | +# If set to NO, these namespaces will be included in the various overviews. This | ||
| 615 | +# option has no effect if EXTRACT_ALL is enabled. | ||
| 616 | +# The default value is: YES. | ||
| 617 | + | ||
| 618 | +HIDE_UNDOC_NAMESPACES = YES | ||
| 619 | + | ||
| 620 | +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend | ||
| 621 | +# declarations. If set to NO, these declarations will be included in the | ||
| 622 | +# documentation. | ||
| 623 | +# The default value is: NO. | ||
| 624 | + | ||
| 625 | +HIDE_FRIEND_COMPOUNDS = NO | ||
| 626 | + | ||
| 627 | +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | ||
| 628 | +# documentation blocks found inside the body of a function. If set to NO, these | ||
| 629 | +# blocks will be appended to the function's detailed documentation block. | ||
| 630 | +# The default value is: NO. | ||
| 631 | + | ||
| 632 | +HIDE_IN_BODY_DOCS = NO | ||
| 633 | + | ||
| 634 | +# The INTERNAL_DOCS tag determines if documentation that is typed after a | ||
| 635 | +# \internal command is included. If the tag is set to NO then the documentation | ||
| 636 | +# will be excluded. Set it to YES to include the internal documentation. | ||
| 637 | +# The default value is: NO. | ||
| 638 | + | ||
| 639 | +INTERNAL_DOCS = NO | ||
| 640 | + | ||
| 641 | +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be | ||
| 642 | +# able to match the capabilities of the underlying filesystem. In case the | ||
| 643 | +# filesystem is case sensitive (i.e. it supports files in the same directory | ||
| 644 | +# whose names only differ in casing), the option must be set to YES to properly | ||
| 645 | +# deal with such files in case they appear in the input. For filesystems that | ||
| 646 | +# are not case sensitive the option should be set to NO to properly deal with | ||
| 647 | +# output files written for symbols that only differ in casing, such as for two | ||
| 648 | +# classes, one named CLASS and the other named Class, and to also support | ||
| 649 | +# references to files without having to specify the exact matching casing. On | ||
| 650 | +# Windows (including Cygwin) and macOS, users should typically set this option | ||
| 651 | +# to NO, whereas on Linux or other Unix flavors it should typically be set to | ||
| 652 | +# YES. | ||
| 653 | +# Possible values are: SYSTEM, NO and YES. | ||
| 654 | +# The default value is: SYSTEM. | ||
| 655 | + | ||
| 656 | +CASE_SENSE_NAMES = SYSTEM | ||
| 657 | + | ||
| 658 | +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with | ||
| 659 | +# their full class and namespace scopes in the documentation. If set to YES, the | ||
| 660 | +# scope will be hidden. | ||
| 661 | +# The default value is: NO. | ||
| 662 | + | ||
| 663 | +HIDE_SCOPE_NAMES = NO | ||
| 664 | + | ||
| 665 | +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will | ||
| 666 | +# append additional text to a page's title, such as Class Reference. If set to | ||
| 667 | +# YES the compound reference will be hidden. | ||
| 668 | +# The default value is: NO. | ||
| 669 | + | ||
| 670 | +HIDE_COMPOUND_REFERENCE= NO | ||
| 671 | + | ||
| 672 | +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class | ||
| 673 | +# will show which file needs to be included to use the class. | ||
| 674 | +# The default value is: YES. | ||
| 675 | + | ||
| 676 | +SHOW_HEADERFILE = YES | ||
| 677 | + | ||
| 678 | +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of | ||
| 679 | +# the files that are included by a file in the documentation of that file. | ||
| 680 | +# The default value is: YES. | ||
| 681 | + | ||
| 682 | +SHOW_INCLUDE_FILES = YES | ||
| 683 | + | ||
| 684 | +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each | ||
| 685 | +# grouped member an include statement to the documentation, telling the reader | ||
| 686 | +# which file to include in order to use the member. | ||
| 687 | +# The default value is: NO. | ||
| 688 | + | ||
| 689 | +SHOW_GROUPED_MEMB_INC = NO | ||
| 690 | + | ||
| 691 | +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include | ||
| 692 | +# files with double quotes in the documentation rather than with sharp brackets. | ||
| 693 | +# The default value is: NO. | ||
| 694 | + | ||
| 695 | +FORCE_LOCAL_INCLUDES = NO | ||
| 696 | + | ||
| 697 | +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the | ||
| 698 | +# documentation for inline members. | ||
| 699 | +# The default value is: YES. | ||
| 700 | + | ||
| 701 | +INLINE_INFO = YES | ||
| 702 | + | ||
| 703 | +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the | ||
| 704 | +# (detailed) documentation of file and class members alphabetically by member | ||
| 705 | +# name. If set to NO, the members will appear in declaration order. | ||
| 706 | +# The default value is: YES. | ||
| 707 | + | ||
| 708 | +SORT_MEMBER_DOCS = YES | ||
| 709 | + | ||
| 710 | +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief | ||
| 711 | +# descriptions of file, namespace and class members alphabetically by member | ||
| 712 | +# name. If set to NO, the members will appear in declaration order. Note that | ||
| 713 | +# this will also influence the order of the classes in the class list. | ||
| 714 | +# The default value is: NO. | ||
| 715 | + | ||
| 716 | +SORT_BRIEF_DOCS = NO | ||
| 717 | + | ||
| 718 | +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the | ||
| 719 | +# (brief and detailed) documentation of class members so that constructors and | ||
| 720 | +# destructors are listed first. If set to NO the constructors will appear in the | ||
| 721 | +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. | ||
| 722 | +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief | ||
| 723 | +# member documentation. | ||
| 724 | +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting | ||
| 725 | +# detailed member documentation. | ||
| 726 | +# The default value is: NO. | ||
| 727 | + | ||
| 728 | +SORT_MEMBERS_CTORS_1ST = NO | ||
| 729 | + | ||
| 730 | +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy | ||
| 731 | +# of group names into alphabetical order. If set to NO the group names will | ||
| 732 | +# appear in their defined order. | ||
| 733 | +# The default value is: NO. | ||
| 734 | + | ||
| 735 | +SORT_GROUP_NAMES = NO | ||
| 736 | + | ||
| 737 | +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by | ||
| 738 | +# fully-qualified names, including namespaces. If set to NO, the class list will | ||
| 739 | +# be sorted only by class name, not including the namespace part. | ||
| 740 | +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | ||
| 741 | +# Note: This option applies only to the class list, not to the alphabetical | ||
| 742 | +# list. | ||
| 743 | +# The default value is: NO. | ||
| 744 | + | ||
| 745 | +SORT_BY_SCOPE_NAME = NO | ||
| 746 | + | ||
| 747 | +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper | ||
| 748 | +# type resolution of all parameters of a function it will reject a match between | ||
| 749 | +# the prototype and the implementation of a member function even if there is | ||
| 750 | +# only one candidate or it is obvious which candidate to choose by doing a | ||
| 751 | +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still | ||
| 752 | +# accept a match between prototype and implementation in such cases. | ||
| 753 | +# The default value is: NO. | ||
| 754 | + | ||
| 755 | +STRICT_PROTO_MATCHING = NO | ||
| 756 | + | ||
| 757 | +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo | ||
| 758 | +# list. This list is created by putting \todo commands in the documentation. | ||
| 759 | +# The default value is: YES. | ||
| 760 | + | ||
| 761 | +GENERATE_TODOLIST = YES | ||
| 762 | + | ||
| 763 | +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test | ||
| 764 | +# list. This list is created by putting \test commands in the documentation. | ||
| 765 | +# The default value is: YES. | ||
| 766 | + | ||
| 767 | +GENERATE_TESTLIST = YES | ||
| 768 | + | ||
| 769 | +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug | ||
| 770 | +# list. This list is created by putting \bug commands in the documentation. | ||
| 771 | +# The default value is: YES. | ||
| 772 | + | ||
| 773 | +GENERATE_BUGLIST = YES | ||
| 774 | + | ||
| 775 | +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) | ||
| 776 | +# the deprecated list. This list is created by putting \deprecated commands in | ||
| 777 | +# the documentation. | ||
| 778 | +# The default value is: YES. | ||
| 779 | + | ||
| 780 | +GENERATE_DEPRECATEDLIST= YES | ||
| 781 | + | ||
| 782 | +# The ENABLED_SECTIONS tag can be used to enable conditional documentation | ||
| 783 | +# sections, marked by \if <section_label> ... \endif and \cond <section_label> | ||
| 784 | +# ... \endcond blocks. | ||
| 785 | + | ||
| 786 | +ENABLED_SECTIONS = | ||
| 787 | + | ||
| 788 | +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the | ||
| 789 | +# initial value of a variable or macro / define can have for it to appear in the | ||
| 790 | +# documentation. If the initializer consists of more lines than specified here | ||
| 791 | +# it will be hidden. Use a value of 0 to hide initializers completely. The | ||
| 792 | +# appearance of the value of individual variables and macros / defines can be | ||
| 793 | +# controlled using \showinitializer or \hideinitializer command in the | ||
| 794 | +# documentation regardless of this setting. | ||
| 795 | +# Minimum value: 0, maximum value: 10000, default value: 30. | ||
| 796 | + | ||
| 797 | +MAX_INITIALIZER_LINES = 30 | ||
| 798 | + | ||
| 799 | +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at | ||
| 800 | +# the bottom of the documentation of classes and structs. If set to YES, the | ||
| 801 | +# list will mention the files that were used to generate the documentation. | ||
| 802 | +# The default value is: YES. | ||
| 803 | + | ||
| 804 | +SHOW_USED_FILES = YES | ||
| 805 | + | ||
| 806 | +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This | ||
| 807 | +# will remove the Files entry from the Quick Index and from the Folder Tree View | ||
| 808 | +# (if specified). | ||
| 809 | +# The default value is: YES. | ||
| 810 | + | ||
| 811 | +SHOW_FILES = YES | ||
| 812 | + | ||
| 813 | +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces | ||
| 814 | +# page. This will remove the Namespaces entry from the Quick Index and from the | ||
| 815 | +# Folder Tree View (if specified). | ||
| 816 | +# The default value is: YES. | ||
| 817 | + | ||
| 818 | +SHOW_NAMESPACES = YES | ||
| 819 | + | ||
| 820 | +# The FILE_VERSION_FILTER tag can be used to specify a program or script that | ||
| 821 | +# Doxygen should invoke to get the current version for each file (typically from | ||
| 822 | +# the version control system). Doxygen will invoke the program by executing (via | ||
| 823 | +# popen()) the command command input-file, where command is the value of the | ||
| 824 | +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided | ||
| 825 | +# by Doxygen. Whatever the program writes to standard output is used as the file | ||
| 826 | +# version. For an example see the documentation. | ||
| 827 | + | ||
| 828 | +FILE_VERSION_FILTER = | ||
| 829 | + | ||
| 830 | +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | ||
| 831 | +# by Doxygen. The layout file controls the global structure of the generated | ||
| 832 | +# output files in an output format independent way. To create the layout file | ||
| 833 | +# that represents Doxygen's defaults, run Doxygen with the -l option. You can | ||
| 834 | +# optionally specify a file name after the option, if omitted DoxygenLayout.xml | ||
| 835 | +# will be used as the name of the layout file. See also section "Changing the | ||
| 836 | +# layout of pages" for information. | ||
| 837 | +# | ||
| 838 | +# Note that if you run Doxygen from a directory containing a file called | ||
| 839 | +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE | ||
| 840 | +# tag is left empty. | ||
| 841 | + | ||
| 842 | +LAYOUT_FILE = | ||
| 843 | + | ||
| 844 | +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing | ||
| 845 | +# the reference definitions. This must be a list of .bib files. The .bib | ||
| 846 | +# extension is automatically appended if omitted. This requires the bibtex tool | ||
| 847 | +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. | ||
| 848 | +# For LaTeX the style of the bibliography can be controlled using | ||
| 849 | +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the | ||
| 850 | +# search path. See also \cite for info how to create references. | ||
| 851 | + | ||
| 852 | +CITE_BIB_FILES = | ||
| 853 | + | ||
| 854 | +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH | ||
| 855 | +# environment variable) so that external tools such as latex and gs can be | ||
| 856 | +# found. | ||
| 857 | +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the | ||
| 858 | +# path already specified by the PATH variable, and are added in the order | ||
| 859 | +# specified. | ||
| 860 | +# Note: This option is particularly useful for macOS version 14 (Sonoma) and | ||
| 861 | +# higher, when running Doxygen from Doxywizard, because in this case any user- | ||
| 862 | +# defined changes to the PATH are ignored. A typical example on macOS is to set | ||
| 863 | +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin | ||
| 864 | +# together with the standard path, the full search path used by doxygen when | ||
| 865 | +# launching external tools will then become | ||
| 866 | +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin | ||
| 867 | + | ||
| 868 | +EXTERNAL_TOOL_PATH = | ||
| 869 | + | ||
| 870 | +#--------------------------------------------------------------------------- | ||
| 871 | +# Configuration options related to warning and progress messages | ||
| 872 | +#--------------------------------------------------------------------------- | ||
| 873 | + | ||
| 874 | +# The QUIET tag can be used to turn on/off the messages that are generated to | ||
| 875 | +# standard output by Doxygen. If QUIET is set to YES this implies that the | ||
| 876 | +# messages are off. | ||
| 877 | +# The default value is: NO. | ||
| 878 | + | ||
| 879 | +QUIET = NO | ||
| 880 | + | ||
| 881 | +# The WARNINGS tag can be used to turn on/off the warning messages that are | ||
| 882 | +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES | ||
| 883 | +# this implies that the warnings are on. | ||
| 884 | +# | ||
| 885 | +# Tip: Turn warnings on while writing the documentation. | ||
| 886 | +# The default value is: YES. | ||
| 887 | + | ||
| 888 | +WARNINGS = YES | ||
| 889 | + | ||
| 890 | +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate | ||
| 891 | +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag | ||
| 892 | +# will automatically be disabled. | ||
| 893 | +# The default value is: YES. | ||
| 894 | + | ||
| 895 | +WARN_IF_UNDOCUMENTED = YES | ||
| 896 | + | ||
| 897 | +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for | ||
| 898 | +# potential errors in the documentation, such as documenting some parameters in | ||
| 899 | +# a documented function twice, or documenting parameters that don't exist or | ||
| 900 | +# using markup commands wrongly. | ||
| 901 | +# The default value is: YES. | ||
| 902 | + | ||
| 903 | +WARN_IF_DOC_ERROR = YES | ||
| 904 | + | ||
| 905 | +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete | ||
| 906 | +# function parameter documentation. If set to NO, Doxygen will accept that some | ||
| 907 | +# parameters have no documentation without warning. | ||
| 908 | +# The default value is: YES. | ||
| 909 | + | ||
| 910 | +WARN_IF_INCOMPLETE_DOC = YES | ||
| 911 | + | ||
| 912 | +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | ||
| 913 | +# are documented, but have no documentation for their parameters or return | ||
| 914 | +# value. If set to NO, Doxygen will only warn about wrong parameter | ||
| 915 | +# documentation, but not about the absence of documentation. If EXTRACT_ALL is | ||
| 916 | +# set to YES then this flag will automatically be disabled. See also | ||
| 917 | +# WARN_IF_INCOMPLETE_DOC | ||
| 918 | +# The default value is: NO. | ||
| 919 | + | ||
| 920 | +WARN_NO_PARAMDOC = NO | ||
| 921 | + | ||
| 922 | +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about | ||
| 923 | +# undocumented enumeration values. If set to NO, Doxygen will accept | ||
| 924 | +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag | ||
| 925 | +# will automatically be disabled. | ||
| 926 | +# The default value is: NO. | ||
| 927 | + | ||
| 928 | +WARN_IF_UNDOC_ENUM_VAL = NO | ||
| 929 | + | ||
| 930 | +# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found | ||
| 931 | +# while parsing the user defined layout file, such as missing or wrong elements. | ||
| 932 | +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file | ||
| 933 | +# will be suppressed. | ||
| 934 | +# The default value is: YES. | ||
| 935 | + | ||
| 936 | +WARN_LAYOUT_FILE = YES | ||
| 937 | + | ||
| 938 | +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when | ||
| 939 | +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS | ||
| 940 | +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but | ||
| 941 | +# at the end of the Doxygen process Doxygen will return with a non-zero status. | ||
| 942 | +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves | ||
| 943 | +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not | ||
| 944 | +# write the warning messages in between other messages but write them at the end | ||
| 945 | +# of a run, in case a WARN_LOGFILE is defined the warning messages will be | ||
| 946 | +# besides being in the defined file also be shown at the end of a run, unless | ||
| 947 | +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case | ||
| 948 | +# the behavior will remain as with the setting FAIL_ON_WARNINGS. | ||
| 949 | +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. | ||
| 950 | +# The default value is: NO. | ||
| 951 | + | ||
| 952 | +WARN_AS_ERROR = NO | ||
| 953 | + | ||
| 954 | +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen | ||
| 955 | +# can produce. The string should contain the $file, $line, and $text tags, which | ||
| 956 | +# will be replaced by the file and line number from which the warning originated | ||
| 957 | +# and the warning text. Optionally the format may contain $version, which will | ||
| 958 | +# be replaced by the version of the file (if it could be obtained via | ||
| 959 | +# FILE_VERSION_FILTER) | ||
| 960 | +# See also: WARN_LINE_FORMAT | ||
| 961 | +# The default value is: $file:$line: $text. | ||
| 962 | + | ||
| 963 | +WARN_FORMAT = "$file:$line: $text" | ||
| 964 | + | ||
| 965 | +# In the $text part of the WARN_FORMAT command it is possible that a reference | ||
| 966 | +# to a more specific place is given. To make it easier to jump to this place | ||
| 967 | +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. | ||
| 968 | +# Example: | ||
| 969 | +# WARN_LINE_FORMAT = "'vi $file +$line'" | ||
| 970 | +# See also: WARN_FORMAT | ||
| 971 | +# The default value is: at line $line of file $file. | ||
| 972 | + | ||
| 973 | +WARN_LINE_FORMAT = "at line $line of file $file" | ||
| 974 | + | ||
| 975 | +# The WARN_LOGFILE tag can be used to specify a file to which warning and error | ||
| 976 | +# messages should be written. If left blank the output is written to standard | ||
| 977 | +# error (stderr). In case the file specified cannot be opened for writing the | ||
| 978 | +# warning and error messages are written to standard error. When as file - is | ||
| 979 | +# specified the warning and error messages are written to standard output | ||
| 980 | +# (stdout). | ||
| 981 | + | ||
| 982 | +WARN_LOGFILE = | ||
| 983 | + | ||
| 984 | +#--------------------------------------------------------------------------- | ||
| 985 | +# Configuration options related to the input files | ||
| 986 | +#--------------------------------------------------------------------------- | ||
| 987 | + | ||
| 988 | +# The INPUT tag is used to specify the files and/or directories that contain | ||
| 989 | +# documented source files. You may enter file names like myfile.cpp or | ||
| 990 | +# directories like /usr/src/myproject. Separate the files or directories with | ||
| 991 | +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | ||
| 992 | +# Note: If this tag is empty the current directory is searched. | ||
| 993 | + | ||
| 994 | +INPUT = /home/pgroen/projects/qpdf/include/qpdf | ||
| 995 | + | ||
| 996 | +# This tag can be used to specify the character encoding of the source files | ||
| 997 | +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses | ||
| 998 | +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv | ||
| 999 | +# documentation (see: | ||
| 1000 | +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. | ||
| 1001 | +# See also: INPUT_FILE_ENCODING | ||
| 1002 | +# The default value is: UTF-8. | ||
| 1003 | + | ||
| 1004 | +INPUT_ENCODING = UTF-8 | ||
| 1005 | + | ||
| 1006 | +# This tag can be used to specify the character encoding of the source files | ||
| 1007 | +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify | ||
| 1008 | +# character encoding on a per file pattern basis. Doxygen will compare the file | ||
| 1009 | +# name with each pattern and apply the encoding instead of the default | ||
| 1010 | +# INPUT_ENCODING if there is a match. The character encodings are a list of the | ||
| 1011 | +# form: pattern=encoding (like *.php=ISO-8859-1). | ||
| 1012 | +# See also: INPUT_ENCODING for further information on supported encodings. | ||
| 1013 | + | ||
| 1014 | +INPUT_FILE_ENCODING = | ||
| 1015 | + | ||
| 1016 | +# If the value of the INPUT tag contains directories, you can use the | ||
| 1017 | +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | ||
| 1018 | +# *.h) to filter out the source-files in the directories. | ||
| 1019 | +# | ||
| 1020 | +# Note that for custom extensions or not directly supported extensions you also | ||
| 1021 | +# need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
| 1022 | +# read by Doxygen. | ||
| 1023 | +# | ||
| 1024 | +# Note the list of default checked file patterns might differ from the list of | ||
| 1025 | +# default file extension mappings. | ||
| 1026 | +# | ||
| 1027 | +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, | ||
| 1028 | +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, | ||
| 1029 | +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, | ||
| 1030 | +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be | ||
| 1031 | +# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | ||
| 1032 | +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. | ||
| 1033 | + | ||
| 1034 | +FILE_PATTERNS = *.c \ | ||
| 1035 | + *.cc \ | ||
| 1036 | + *.cxx \ | ||
| 1037 | + *.cxxm \ | ||
| 1038 | + *.cpp \ | ||
| 1039 | + *.cppm \ | ||
| 1040 | + *.ccm \ | ||
| 1041 | + *.c++ \ | ||
| 1042 | + *.c++m \ | ||
| 1043 | + *.java \ | ||
| 1044 | + *.ii \ | ||
| 1045 | + *.ixx \ | ||
| 1046 | + *.ipp \ | ||
| 1047 | + *.i++ \ | ||
| 1048 | + *.inl \ | ||
| 1049 | + *.idl \ | ||
| 1050 | + *.ddl \ | ||
| 1051 | + *.odl \ | ||
| 1052 | + *.h \ | ||
| 1053 | + *.hh \ | ||
| 1054 | + *.hxx \ | ||
| 1055 | + *.hpp \ | ||
| 1056 | + *.h++ \ | ||
| 1057 | + *.ixx \ | ||
| 1058 | + *.l \ | ||
| 1059 | + *.cs \ | ||
| 1060 | + *.d \ | ||
| 1061 | + *.php \ | ||
| 1062 | + *.php4 \ | ||
| 1063 | + *.php5 \ | ||
| 1064 | + *.phtml \ | ||
| 1065 | + *.inc \ | ||
| 1066 | + *.m \ | ||
| 1067 | + *.markdown \ | ||
| 1068 | + *.md \ | ||
| 1069 | + *.mm \ | ||
| 1070 | + *.dox \ | ||
| 1071 | + *.py \ | ||
| 1072 | + *.pyw \ | ||
| 1073 | + *.f90 \ | ||
| 1074 | + *.f95 \ | ||
| 1075 | + *.f03 \ | ||
| 1076 | + *.f08 \ | ||
| 1077 | + *.f18 \ | ||
| 1078 | + *.f \ | ||
| 1079 | + *.for \ | ||
| 1080 | + *.vhd \ | ||
| 1081 | + *.vhdl \ | ||
| 1082 | + *.ucf \ | ||
| 1083 | + *.qsf \ | ||
| 1084 | + *.ice | ||
| 1085 | + | ||
| 1086 | +# The RECURSIVE tag can be used to specify whether or not subdirectories should | ||
| 1087 | +# be searched for input files as well. | ||
| 1088 | +# The default value is: NO. | ||
| 1089 | + | ||
| 1090 | +RECURSIVE = YES | ||
| 1091 | + | ||
| 1092 | +# The EXCLUDE tag can be used to specify files and/or directories that should be | ||
| 1093 | +# excluded from the INPUT source files. This way you can easily exclude a | ||
| 1094 | +# subdirectory from a directory tree whose root is specified with the INPUT tag. | ||
| 1095 | +# | ||
| 1096 | +# Note that relative paths are relative to the directory from which Doxygen is | ||
| 1097 | +# run. | ||
| 1098 | + | ||
| 1099 | +EXCLUDE = | ||
| 1100 | + | ||
| 1101 | +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or | ||
| 1102 | +# directories that are symbolic links (a Unix file system feature) are excluded | ||
| 1103 | +# from the input. | ||
| 1104 | +# The default value is: NO. | ||
| 1105 | + | ||
| 1106 | +EXCLUDE_SYMLINKS = NO | ||
| 1107 | + | ||
| 1108 | +# If the value of the INPUT tag contains directories, you can use the | ||
| 1109 | +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | ||
| 1110 | +# certain files from those directories. | ||
| 1111 | +# | ||
| 1112 | +# Note that the wildcards are matched against the file with absolute path, so to | ||
| 1113 | +# exclude all test directories for example use the pattern */test/* | ||
| 1114 | + | ||
| 1115 | +EXCLUDE_PATTERNS = | ||
| 1116 | + | ||
| 1117 | +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | ||
| 1118 | +# (namespaces, classes, functions, etc.) that should be excluded from the | ||
| 1119 | +# output. The symbol name can be a fully qualified name, a word, or if the | ||
| 1120 | +# wildcard * is used, a substring. Examples: ANamespace, AClass, | ||
| 1121 | +# ANamespace::AClass, ANamespace::*Test | ||
| 1122 | + | ||
| 1123 | +EXCLUDE_SYMBOLS = | ||
| 1124 | + | ||
| 1125 | +# The EXAMPLE_PATH tag can be used to specify one or more files or directories | ||
| 1126 | +# that contain example code fragments that are included (see the \include | ||
| 1127 | +# command). | ||
| 1128 | + | ||
| 1129 | +EXAMPLE_PATH = | ||
| 1130 | + | ||
| 1131 | +# If the value of the EXAMPLE_PATH tag contains directories, you can use the | ||
| 1132 | +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and | ||
| 1133 | +# *.h) to filter out the source-files in the directories. If left blank all | ||
| 1134 | +# files are included. | ||
| 1135 | + | ||
| 1136 | +EXAMPLE_PATTERNS = * | ||
| 1137 | + | ||
| 1138 | +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | ||
| 1139 | +# searched for input files to be used with the \include or \dontinclude commands | ||
| 1140 | +# irrespective of the value of the RECURSIVE tag. | ||
| 1141 | +# The default value is: NO. | ||
| 1142 | + | ||
| 1143 | +EXAMPLE_RECURSIVE = NO | ||
| 1144 | + | ||
| 1145 | +# The IMAGE_PATH tag can be used to specify one or more files or directories | ||
| 1146 | +# that contain images that are to be included in the documentation (see the | ||
| 1147 | +# \image command). | ||
| 1148 | + | ||
| 1149 | +IMAGE_PATH = | ||
| 1150 | + | ||
| 1151 | +# The INPUT_FILTER tag can be used to specify a program that Doxygen should | ||
| 1152 | +# invoke to filter for each input file. Doxygen will invoke the filter program | ||
| 1153 | +# by executing (via popen()) the command: | ||
| 1154 | +# | ||
| 1155 | +# <filter> <input-file> | ||
| 1156 | +# | ||
| 1157 | +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the | ||
| 1158 | +# name of an input file. Doxygen will then use the output that the filter | ||
| 1159 | +# program writes to standard output. If FILTER_PATTERNS is specified, this tag | ||
| 1160 | +# will be ignored. | ||
| 1161 | +# | ||
| 1162 | +# Note that the filter must not add or remove lines; it is applied before the | ||
| 1163 | +# code is scanned, but not when the output code is generated. If lines are added | ||
| 1164 | +# or removed, the anchors will not be placed correctly. | ||
| 1165 | +# | ||
| 1166 | +# Note that Doxygen will use the data processed and written to standard output | ||
| 1167 | +# for further processing, therefore nothing else, like debug statements or used | ||
| 1168 | +# commands (so in case of a Windows batch file always use @echo OFF), should be | ||
| 1169 | +# written to standard output. | ||
| 1170 | +# | ||
| 1171 | +# Note that for custom extensions or not directly supported extensions you also | ||
| 1172 | +# need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
| 1173 | +# properly processed by Doxygen. | ||
| 1174 | + | ||
| 1175 | +INPUT_FILTER = | ||
| 1176 | + | ||
| 1177 | +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | ||
| 1178 | +# basis. Doxygen will compare the file name with each pattern and apply the | ||
| 1179 | +# filter if there is a match. The filters are a list of the form: pattern=filter | ||
| 1180 | +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how | ||
| 1181 | +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the | ||
| 1182 | +# patterns match the file name, INPUT_FILTER is applied. | ||
| 1183 | +# | ||
| 1184 | +# Note that for custom extensions or not directly supported extensions you also | ||
| 1185 | +# need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
| 1186 | +# properly processed by Doxygen. | ||
| 1187 | + | ||
| 1188 | +FILTER_PATTERNS = | ||
| 1189 | + | ||
| 1190 | +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | ||
| 1191 | +# INPUT_FILTER) will also be used to filter the input files that are used for | ||
| 1192 | +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). | ||
| 1193 | +# The default value is: NO. | ||
| 1194 | + | ||
| 1195 | +FILTER_SOURCE_FILES = NO | ||
| 1196 | + | ||
| 1197 | +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | ||
| 1198 | +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and | ||
| 1199 | +# it is also possible to disable source filtering for a specific pattern using | ||
| 1200 | +# *.ext= (so without naming a filter). | ||
| 1201 | +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. | ||
| 1202 | + | ||
| 1203 | +FILTER_SOURCE_PATTERNS = | ||
| 1204 | + | ||
| 1205 | +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that | ||
| 1206 | +# is part of the input, its contents will be placed on the main page | ||
| 1207 | +# (index.html). This can be useful if you have a project on for instance GitHub | ||
| 1208 | +# and want to reuse the introduction page also for the Doxygen output. | ||
| 1209 | + | ||
| 1210 | +USE_MDFILE_AS_MAINPAGE = | ||
| 1211 | + | ||
| 1212 | +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- | ||
| 1213 | +# directories of the project's root, is used as the documentation for that sub- | ||
| 1214 | +# directory, except when the README.md starts with a \dir, \page or \mainpage | ||
| 1215 | +# command. If set to NO, the README.md file needs to start with an explicit \dir | ||
| 1216 | +# command in order to be used as directory documentation. | ||
| 1217 | +# The default value is: YES. | ||
| 1218 | + | ||
| 1219 | +IMPLICIT_DIR_DOCS = YES | ||
| 1220 | + | ||
| 1221 | +# The Fortran standard specifies that for fixed formatted Fortran code all | ||
| 1222 | +# characters from position 72 are to be considered as comment. A common | ||
| 1223 | +# extension is to allow longer lines before the automatic comment starts. The | ||
| 1224 | +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can | ||
| 1225 | +# be processed before the automatic comment starts. | ||
| 1226 | +# Minimum value: 7, maximum value: 10000, default value: 72. | ||
| 1227 | + | ||
| 1228 | +FORTRAN_COMMENT_AFTER = 72 | ||
| 1229 | + | ||
| 1230 | +#--------------------------------------------------------------------------- | ||
| 1231 | +# Configuration options related to source browsing | ||
| 1232 | +#--------------------------------------------------------------------------- | ||
| 1233 | + | ||
| 1234 | +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be | ||
| 1235 | +# generated. Documented entities will be cross-referenced with these sources. | ||
| 1236 | +# | ||
| 1237 | +# Note: To get rid of all source code in the generated output, make sure that | ||
| 1238 | +# also VERBATIM_HEADERS is set to NO. | ||
| 1239 | +# The default value is: NO. | ||
| 1240 | + | ||
| 1241 | +SOURCE_BROWSER = NO | ||
| 1242 | + | ||
| 1243 | +# Setting the INLINE_SOURCES tag to YES will include the body of functions, | ||
| 1244 | +# multi-line macros, enums or list initialized variables directly into the | ||
| 1245 | +# documentation. | ||
| 1246 | +# The default value is: NO. | ||
| 1247 | + | ||
| 1248 | +INLINE_SOURCES = NO | ||
| 1249 | + | ||
| 1250 | +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any | ||
| 1251 | +# special comment blocks from generated source code fragments. Normal C, C++ and | ||
| 1252 | +# Fortran comments will always remain visible. | ||
| 1253 | +# The default value is: YES. | ||
| 1254 | + | ||
| 1255 | +STRIP_CODE_COMMENTS = YES | ||
| 1256 | + | ||
| 1257 | +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented | ||
| 1258 | +# entity all documented functions referencing it will be listed. | ||
| 1259 | +# The default value is: NO. | ||
| 1260 | + | ||
| 1261 | +REFERENCED_BY_RELATION = NO | ||
| 1262 | + | ||
| 1263 | +# If the REFERENCES_RELATION tag is set to YES then for each documented function | ||
| 1264 | +# all documented entities called/used by that function will be listed. | ||
| 1265 | +# The default value is: NO. | ||
| 1266 | + | ||
| 1267 | +REFERENCES_RELATION = NO | ||
| 1268 | + | ||
| 1269 | +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set | ||
| 1270 | +# to YES then the hyperlinks from functions in REFERENCES_RELATION and | ||
| 1271 | +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will | ||
| 1272 | +# link to the documentation. | ||
| 1273 | +# The default value is: YES. | ||
| 1274 | + | ||
| 1275 | +REFERENCES_LINK_SOURCE = YES | ||
| 1276 | + | ||
| 1277 | +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the | ||
| 1278 | +# source code will show a tooltip with additional information such as prototype, | ||
| 1279 | +# brief description and links to the definition and documentation. Since this | ||
| 1280 | +# will make the HTML file larger and loading of large files a bit slower, you | ||
| 1281 | +# can opt to disable this feature. | ||
| 1282 | +# The default value is: YES. | ||
| 1283 | +# This tag requires that the tag SOURCE_BROWSER is set to YES. | ||
| 1284 | + | ||
| 1285 | +SOURCE_TOOLTIPS = YES | ||
| 1286 | + | ||
| 1287 | +# If the USE_HTAGS tag is set to YES then the references to source code will | ||
| 1288 | +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in | ||
| 1289 | +# source browser. The htags tool is part of GNU's global source tagging system | ||
| 1290 | +# (see https://www.gnu.org/software/global/global.html). You will need version | ||
| 1291 | +# 4.8.6 or higher. | ||
| 1292 | +# | ||
| 1293 | +# To use it do the following: | ||
| 1294 | +# - Install the latest version of global | ||
| 1295 | +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file | ||
| 1296 | +# - Make sure the INPUT points to the root of the source tree | ||
| 1297 | +# - Run doxygen as normal | ||
| 1298 | +# | ||
| 1299 | +# Doxygen will invoke htags (and that will in turn invoke gtags), so these | ||
| 1300 | +# tools must be available from the command line (i.e. in the search path). | ||
| 1301 | +# | ||
| 1302 | +# The result: instead of the source browser generated by Doxygen, the links to | ||
| 1303 | +# source code will now point to the output of htags. | ||
| 1304 | +# The default value is: NO. | ||
| 1305 | +# This tag requires that the tag SOURCE_BROWSER is set to YES. | ||
| 1306 | + | ||
| 1307 | +USE_HTAGS = NO | ||
| 1308 | + | ||
| 1309 | +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a | ||
| 1310 | +# verbatim copy of the header file for each class for which an include is | ||
| 1311 | +# specified. Set to NO to disable this. | ||
| 1312 | +# See also: Section \class. | ||
| 1313 | +# The default value is: YES. | ||
| 1314 | + | ||
| 1315 | +VERBATIM_HEADERS = YES | ||
| 1316 | + | ||
| 1317 | +# If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the | ||
| 1318 | +# clang parser (see: | ||
| 1319 | +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced | ||
| 1320 | +# performance. This can be particularly helpful with template rich C++ code for | ||
| 1321 | +# which Doxygen's built-in parser lacks the necessary type information. | ||
| 1322 | +# Note: The availability of this option depends on whether or not Doxygen was | ||
| 1323 | +# generated with the -Duse_libclang=ON option for CMake. | ||
| 1324 | +# The default value is: NO. | ||
| 1325 | + | ||
| 1326 | +CLANG_ASSISTED_PARSING = NO | ||
| 1327 | + | ||
| 1328 | +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS | ||
| 1329 | +# tag is set to YES then Doxygen will add the directory of each input to the | ||
| 1330 | +# include path. | ||
| 1331 | +# The default value is: YES. | ||
| 1332 | +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||
| 1333 | + | ||
| 1334 | +CLANG_ADD_INC_PATHS = YES | ||
| 1335 | + | ||
| 1336 | +# If clang assisted parsing is enabled you can provide the compiler with command | ||
| 1337 | +# line options that you would normally use when invoking the compiler. Note that | ||
| 1338 | +# the include paths will already be set by Doxygen for the files and directories | ||
| 1339 | +# specified with INPUT and INCLUDE_PATH. | ||
| 1340 | +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||
| 1341 | + | ||
| 1342 | +CLANG_OPTIONS = | ||
| 1343 | + | ||
| 1344 | +# If clang assisted parsing is enabled you can provide the clang parser with the | ||
| 1345 | +# path to the directory containing a file called compile_commands.json. This | ||
| 1346 | +# file is the compilation database (see: | ||
| 1347 | +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the | ||
| 1348 | +# options used when the source files were built. This is equivalent to | ||
| 1349 | +# specifying the -p option to a clang tool, such as clang-check. These options | ||
| 1350 | +# will then be passed to the parser. Any options specified with CLANG_OPTIONS | ||
| 1351 | +# will be added as well. | ||
| 1352 | +# Note: The availability of this option depends on whether or not Doxygen was | ||
| 1353 | +# generated with the -Duse_libclang=ON option for CMake. | ||
| 1354 | + | ||
| 1355 | +CLANG_DATABASE_PATH = | ||
| 1356 | + | ||
| 1357 | +#--------------------------------------------------------------------------- | ||
| 1358 | +# Configuration options related to the alphabetical class index | ||
| 1359 | +#--------------------------------------------------------------------------- | ||
| 1360 | + | ||
| 1361 | +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all | ||
| 1362 | +# compounds will be generated. Enable this if the project contains a lot of | ||
| 1363 | +# classes, structs, unions or interfaces. | ||
| 1364 | +# The default value is: YES. | ||
| 1365 | + | ||
| 1366 | +ALPHABETICAL_INDEX = YES | ||
| 1367 | + | ||
| 1368 | +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) | ||
| 1369 | +# that should be ignored while generating the index headers. The IGNORE_PREFIX | ||
| 1370 | +# tag works for classes, function and member names. The entity will be placed in | ||
| 1371 | +# the alphabetical list under the first letter of the entity name that remains | ||
| 1372 | +# after removing the prefix. | ||
| 1373 | +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||
| 1374 | + | ||
| 1375 | +IGNORE_PREFIX = | ||
| 1376 | + | ||
| 1377 | +#--------------------------------------------------------------------------- | ||
| 1378 | +# Configuration options related to the HTML output | ||
| 1379 | +#--------------------------------------------------------------------------- | ||
| 1380 | + | ||
| 1381 | +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output | ||
| 1382 | +# The default value is: YES. | ||
| 1383 | + | ||
| 1384 | +GENERATE_HTML = YES | ||
| 1385 | + | ||
| 1386 | +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a | ||
| 1387 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
| 1388 | +# it. | ||
| 1389 | +# The default directory is: html. | ||
| 1390 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1391 | + | ||
| 1392 | +HTML_OUTPUT = html | ||
| 1393 | + | ||
| 1394 | +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each | ||
| 1395 | +# generated HTML page (for example: .htm, .php, .asp). | ||
| 1396 | +# The default value is: .html. | ||
| 1397 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1398 | + | ||
| 1399 | +HTML_FILE_EXTENSION = .html | ||
| 1400 | + | ||
| 1401 | +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for | ||
| 1402 | +# each generated HTML page. If the tag is left blank Doxygen will generate a | ||
| 1403 | +# standard header. | ||
| 1404 | +# | ||
| 1405 | +# To get valid HTML the header file that includes any scripts and style sheets | ||
| 1406 | +# that Doxygen needs, which is dependent on the configuration options used (e.g. | ||
| 1407 | +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a | ||
| 1408 | +# default header using | ||
| 1409 | +# doxygen -w html new_header.html new_footer.html new_stylesheet.css | ||
| 1410 | +# YourConfigFile | ||
| 1411 | +# and then modify the file new_header.html. See also section "Doxygen usage" | ||
| 1412 | +# for information on how to generate the default header that Doxygen normally | ||
| 1413 | +# uses. | ||
| 1414 | +# Note: The header is subject to change so you typically have to regenerate the | ||
| 1415 | +# default header when upgrading to a newer version of Doxygen. For a description | ||
| 1416 | +# of the possible markers and block names see the documentation. | ||
| 1417 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1418 | + | ||
| 1419 | +HTML_HEADER = | ||
| 1420 | + | ||
| 1421 | +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each | ||
| 1422 | +# generated HTML page. If the tag is left blank Doxygen will generate a standard | ||
| 1423 | +# footer. See HTML_HEADER for more information on how to generate a default | ||
| 1424 | +# footer and what special commands can be used inside the footer. See also | ||
| 1425 | +# section "Doxygen usage" for information on how to generate the default footer | ||
| 1426 | +# that Doxygen normally uses. | ||
| 1427 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1428 | + | ||
| 1429 | +HTML_FOOTER = | ||
| 1430 | + | ||
| 1431 | +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style | ||
| 1432 | +# sheet that is used by each HTML page. It can be used to fine-tune the look of | ||
| 1433 | +# the HTML output. If left blank Doxygen will generate a default style sheet. | ||
| 1434 | +# See also section "Doxygen usage" for information on how to generate the style | ||
| 1435 | +# sheet that Doxygen normally uses. | ||
| 1436 | +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as | ||
| 1437 | +# it is more robust and this tag (HTML_STYLESHEET) will in the future become | ||
| 1438 | +# obsolete. | ||
| 1439 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1440 | + | ||
| 1441 | +HTML_STYLESHEET = | ||
| 1442 | + | ||
| 1443 | +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined | ||
| 1444 | +# cascading style sheets that are included after the standard style sheets | ||
| 1445 | +# created by Doxygen. Using this option one can overrule certain style aspects. | ||
| 1446 | +# This is preferred over using HTML_STYLESHEET since it does not replace the | ||
| 1447 | +# standard style sheet and is therefore more robust against future updates. | ||
| 1448 | +# Doxygen will copy the style sheet files to the output directory. | ||
| 1449 | +# Note: The order of the extra style sheet files is of importance (e.g. the last | ||
| 1450 | +# style sheet in the list overrules the setting of the previous ones in the | ||
| 1451 | +# list). | ||
| 1452 | +# Note: Since the styling of scrollbars can currently not be overruled in | ||
| 1453 | +# Webkit/Chromium, the styling will be left out of the default doxygen.css if | ||
| 1454 | +# one or more extra stylesheets have been specified. So if scrollbar | ||
| 1455 | +# customization is desired it has to be added explicitly. For an example see the | ||
| 1456 | +# documentation. | ||
| 1457 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1458 | + | ||
| 1459 | +HTML_EXTRA_STYLESHEET = | ||
| 1460 | + | ||
| 1461 | +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | ||
| 1462 | +# other source files which should be copied to the HTML output directory. Note | ||
| 1463 | +# that these files will be copied to the base HTML output directory. Use the | ||
| 1464 | +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | ||
| 1465 | +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the | ||
| 1466 | +# files will be copied as-is; there are no commands or markers available. | ||
| 1467 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1468 | + | ||
| 1469 | +HTML_EXTRA_FILES = | ||
| 1470 | + | ||
| 1471 | +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output | ||
| 1472 | +# should be rendered with a dark or light theme. | ||
| 1473 | +# Possible values are: LIGHT always generates light mode output, DARK always | ||
| 1474 | +# generates dark mode output, AUTO_LIGHT automatically sets the mode according | ||
| 1475 | +# to the user preference, uses light mode if no preference is set (the default), | ||
| 1476 | +# AUTO_DARK automatically sets the mode according to the user preference, uses | ||
| 1477 | +# dark mode if no preference is set and TOGGLE allows a user to switch between | ||
| 1478 | +# light and dark mode via a button. | ||
| 1479 | +# The default value is: AUTO_LIGHT. | ||
| 1480 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1481 | + | ||
| 1482 | +HTML_COLORSTYLE = AUTO_LIGHT | ||
| 1483 | + | ||
| 1484 | +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen | ||
| 1485 | +# will adjust the colors in the style sheet and background images according to | ||
| 1486 | +# this color. Hue is specified as an angle on a color-wheel, see | ||
| 1487 | +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value | ||
| 1488 | +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | ||
| 1489 | +# purple, and 360 is red again. | ||
| 1490 | +# Minimum value: 0, maximum value: 359, default value: 220. | ||
| 1491 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1492 | + | ||
| 1493 | +HTML_COLORSTYLE_HUE = 220 | ||
| 1494 | + | ||
| 1495 | +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors | ||
| 1496 | +# in the HTML output. For a value of 0 the output will use gray-scales only. A | ||
| 1497 | +# value of 255 will produce the most vivid colors. | ||
| 1498 | +# Minimum value: 0, maximum value: 255, default value: 100. | ||
| 1499 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1500 | + | ||
| 1501 | +HTML_COLORSTYLE_SAT = 100 | ||
| 1502 | + | ||
| 1503 | +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the | ||
| 1504 | +# luminance component of the colors in the HTML output. Values below 100 | ||
| 1505 | +# gradually make the output lighter, whereas values above 100 make the output | ||
| 1506 | +# darker. The value divided by 100 is the actual gamma applied, so 80 represents | ||
| 1507 | +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not | ||
| 1508 | +# change the gamma. | ||
| 1509 | +# Minimum value: 40, maximum value: 240, default value: 80. | ||
| 1510 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1511 | + | ||
| 1512 | +HTML_COLORSTYLE_GAMMA = 80 | ||
| 1513 | + | ||
| 1514 | +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML | ||
| 1515 | +# documentation will contain a main index with vertical navigation menus that | ||
| 1516 | +# are dynamically created via JavaScript. If disabled, the navigation index will | ||
| 1517 | +# consists of multiple levels of tabs that are statically embedded in every HTML | ||
| 1518 | +# page. Disable this option to support browsers that do not have JavaScript, | ||
| 1519 | +# like the Qt help browser. | ||
| 1520 | +# The default value is: YES. | ||
| 1521 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1522 | + | ||
| 1523 | +HTML_DYNAMIC_MENUS = YES | ||
| 1524 | + | ||
| 1525 | +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
| 1526 | +# documentation will contain sections that can be hidden and shown after the | ||
| 1527 | +# page has loaded. | ||
| 1528 | +# The default value is: NO. | ||
| 1529 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1530 | + | ||
| 1531 | +HTML_DYNAMIC_SECTIONS = NO | ||
| 1532 | + | ||
| 1533 | +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be | ||
| 1534 | +# dynamically folded and expanded in the generated HTML source code. | ||
| 1535 | +# The default value is: YES. | ||
| 1536 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1537 | + | ||
| 1538 | +HTML_CODE_FOLDING = YES | ||
| 1539 | + | ||
| 1540 | +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in | ||
| 1541 | +# the top right corner of code and text fragments that allows the user to copy | ||
| 1542 | +# its content to the clipboard. Note this only works if supported by the browser | ||
| 1543 | +# and the web page is served via a secure context (see: | ||
| 1544 | +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: | ||
| 1545 | +# protocol. | ||
| 1546 | +# The default value is: YES. | ||
| 1547 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1548 | + | ||
| 1549 | +HTML_COPY_CLIPBOARD = YES | ||
| 1550 | + | ||
| 1551 | +# Doxygen stores a couple of settings persistently in the browser (via e.g. | ||
| 1552 | +# cookies). By default these settings apply to all HTML pages generated by | ||
| 1553 | +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store | ||
| 1554 | +# the settings under a project specific key, such that the user preferences will | ||
| 1555 | +# be stored separately. | ||
| 1556 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1557 | + | ||
| 1558 | +HTML_PROJECT_COOKIE = | ||
| 1559 | + | ||
| 1560 | +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries | ||
| 1561 | +# shown in the various tree structured indices initially; the user can expand | ||
| 1562 | +# and collapse entries dynamically later on. Doxygen will expand the tree to | ||
| 1563 | +# such a level that at most the specified number of entries are visible (unless | ||
| 1564 | +# a fully collapsed tree already exceeds this amount). So setting the number of | ||
| 1565 | +# entries 1 will produce a full collapsed tree by default. 0 is a special value | ||
| 1566 | +# representing an infinite number of entries and will result in a full expanded | ||
| 1567 | +# tree by default. | ||
| 1568 | +# Minimum value: 0, maximum value: 9999, default value: 100. | ||
| 1569 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1570 | + | ||
| 1571 | +HTML_INDEX_NUM_ENTRIES = 100 | ||
| 1572 | + | ||
| 1573 | +# If the GENERATE_DOCSET tag is set to YES, additional index files will be | ||
| 1574 | +# generated that can be used as input for Apple's Xcode 3 integrated development | ||
| 1575 | +# environment (see: | ||
| 1576 | +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To | ||
| 1577 | +# create a documentation set, Doxygen will generate a Makefile in the HTML | ||
| 1578 | +# output directory. Running make will produce the docset in that directory and | ||
| 1579 | +# running make install will install the docset in | ||
| 1580 | +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | ||
| 1581 | +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy | ||
| 1582 | +# genXcode/_index.html for more information. | ||
| 1583 | +# The default value is: NO. | ||
| 1584 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1585 | + | ||
| 1586 | +GENERATE_DOCSET = NO | ||
| 1587 | + | ||
| 1588 | +# This tag determines the name of the docset feed. A documentation feed provides | ||
| 1589 | +# an umbrella under which multiple documentation sets from a single provider | ||
| 1590 | +# (such as a company or product suite) can be grouped. | ||
| 1591 | +# The default value is: Doxygen generated docs. | ||
| 1592 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
| 1593 | + | ||
| 1594 | +DOCSET_FEEDNAME = "Doxygen generated docs" | ||
| 1595 | + | ||
| 1596 | +# This tag determines the URL of the docset feed. A documentation feed provides | ||
| 1597 | +# an umbrella under which multiple documentation sets from a single provider | ||
| 1598 | +# (such as a company or product suite) can be grouped. | ||
| 1599 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
| 1600 | + | ||
| 1601 | +DOCSET_FEEDURL = | ||
| 1602 | + | ||
| 1603 | +# This tag specifies a string that should uniquely identify the documentation | ||
| 1604 | +# set bundle. This should be a reverse domain-name style string, e.g. | ||
| 1605 | +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. | ||
| 1606 | +# The default value is: org.doxygen.Project. | ||
| 1607 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
| 1608 | + | ||
| 1609 | +DOCSET_BUNDLE_ID = org.doxygen.Project | ||
| 1610 | + | ||
| 1611 | +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify | ||
| 1612 | +# the documentation publisher. This should be a reverse domain-name style | ||
| 1613 | +# string, e.g. com.mycompany.MyDocSet.documentation. | ||
| 1614 | +# The default value is: org.doxygen.Publisher. | ||
| 1615 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
| 1616 | + | ||
| 1617 | +DOCSET_PUBLISHER_ID = org.doxygen.Publisher | ||
| 1618 | + | ||
| 1619 | +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. | ||
| 1620 | +# The default value is: Publisher. | ||
| 1621 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
| 1622 | + | ||
| 1623 | +DOCSET_PUBLISHER_NAME = Publisher | ||
| 1624 | + | ||
| 1625 | +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three | ||
| 1626 | +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The | ||
| 1627 | +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | ||
| 1628 | +# on Windows. In the beginning of 2021 Microsoft took the original page, with | ||
| 1629 | +# a.o. the download links, offline (the HTML help workshop was already many | ||
| 1630 | +# years in maintenance mode). You can download the HTML help workshop from the | ||
| 1631 | +# web archives at Installation executable (see: | ||
| 1632 | +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo | ||
| 1633 | +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). | ||
| 1634 | +# | ||
| 1635 | +# The HTML Help Workshop contains a compiler that can convert all HTML output | ||
| 1636 | +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML | ||
| 1637 | +# files are now used as the Windows 98 help format, and will replace the old | ||
| 1638 | +# Windows help format (.hlp) on all Windows platforms in the future. Compressed | ||
| 1639 | +# HTML files also contain an index, a table of contents, and you can search for | ||
| 1640 | +# words in the documentation. The HTML workshop also contains a viewer for | ||
| 1641 | +# compressed HTML files. | ||
| 1642 | +# The default value is: NO. | ||
| 1643 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1644 | + | ||
| 1645 | +GENERATE_HTMLHELP = NO | ||
| 1646 | + | ||
| 1647 | +# The CHM_FILE tag can be used to specify the file name of the resulting .chm | ||
| 1648 | +# file. You can add a path in front of the file if the result should not be | ||
| 1649 | +# written to the html output directory. | ||
| 1650 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
| 1651 | + | ||
| 1652 | +CHM_FILE = | ||
| 1653 | + | ||
| 1654 | +# The HHC_LOCATION tag can be used to specify the location (absolute path | ||
| 1655 | +# including file name) of the HTML help compiler (hhc.exe). If non-empty, | ||
| 1656 | +# Doxygen will try to run the HTML help compiler on the generated index.hhp. | ||
| 1657 | +# The file has to be specified with full path. | ||
| 1658 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
| 1659 | + | ||
| 1660 | +HHC_LOCATION = | ||
| 1661 | + | ||
| 1662 | +# The GENERATE_CHI flag controls if a separate .chi index file is generated | ||
| 1663 | +# (YES) or that it should be included in the main .chm file (NO). | ||
| 1664 | +# The default value is: NO. | ||
| 1665 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
| 1666 | + | ||
| 1667 | +GENERATE_CHI = NO | ||
| 1668 | + | ||
| 1669 | +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) | ||
| 1670 | +# and project file content. | ||
| 1671 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
| 1672 | + | ||
| 1673 | +CHM_INDEX_ENCODING = | ||
| 1674 | + | ||
| 1675 | +# The BINARY_TOC flag controls whether a binary table of contents is generated | ||
| 1676 | +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it | ||
| 1677 | +# enables the Previous and Next buttons. | ||
| 1678 | +# The default value is: NO. | ||
| 1679 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
| 1680 | + | ||
| 1681 | +BINARY_TOC = NO | ||
| 1682 | + | ||
| 1683 | +# The TOC_EXPAND flag can be set to YES to add extra items for group members to | ||
| 1684 | +# the table of contents of the HTML help documentation and to the tree view. | ||
| 1685 | +# The default value is: NO. | ||
| 1686 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
| 1687 | + | ||
| 1688 | +TOC_EXPAND = NO | ||
| 1689 | + | ||
| 1690 | +# The SITEMAP_URL tag is used to specify the full URL of the place where the | ||
| 1691 | +# generated documentation will be placed on the server by the user during the | ||
| 1692 | +# deployment of the documentation. The generated sitemap is called sitemap.xml | ||
| 1693 | +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL | ||
| 1694 | +# is specified no sitemap is generated. For information about the sitemap | ||
| 1695 | +# protocol see https://www.sitemaps.org | ||
| 1696 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1697 | + | ||
| 1698 | +SITEMAP_URL = | ||
| 1699 | + | ||
| 1700 | +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | ||
| 1701 | +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that | ||
| 1702 | +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help | ||
| 1703 | +# (.qch) of the generated HTML documentation. | ||
| 1704 | +# The default value is: NO. | ||
| 1705 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1706 | + | ||
| 1707 | +GENERATE_QHP = NO | ||
| 1708 | + | ||
| 1709 | +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify | ||
| 1710 | +# the file name of the resulting .qch file. The path specified is relative to | ||
| 1711 | +# the HTML output folder. | ||
| 1712 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1713 | + | ||
| 1714 | +QCH_FILE = | ||
| 1715 | + | ||
| 1716 | +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | ||
| 1717 | +# Project output. For more information please see Qt Help Project / Namespace | ||
| 1718 | +# (see: | ||
| 1719 | +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | ||
| 1720 | +# The default value is: org.doxygen.Project. | ||
| 1721 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1722 | + | ||
| 1723 | +QHP_NAMESPACE = org.doxygen.Project | ||
| 1724 | + | ||
| 1725 | +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | ||
| 1726 | +# Help Project output. For more information please see Qt Help Project / Virtual | ||
| 1727 | +# Folders (see: | ||
| 1728 | +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). | ||
| 1729 | +# The default value is: doc. | ||
| 1730 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1731 | + | ||
| 1732 | +QHP_VIRTUAL_FOLDER = doc | ||
| 1733 | + | ||
| 1734 | +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | ||
| 1735 | +# filter to add. For more information please see Qt Help Project / Custom | ||
| 1736 | +# Filters (see: | ||
| 1737 | +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). | ||
| 1738 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1739 | + | ||
| 1740 | +QHP_CUST_FILTER_NAME = | ||
| 1741 | + | ||
| 1742 | +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the | ||
| 1743 | +# custom filter to add. For more information please see Qt Help Project / Custom | ||
| 1744 | +# Filters (see: | ||
| 1745 | +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). | ||
| 1746 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1747 | + | ||
| 1748 | +QHP_CUST_FILTER_ATTRS = | ||
| 1749 | + | ||
| 1750 | +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | ||
| 1751 | +# project's filter section matches. Qt Help Project / Filter Attributes (see: | ||
| 1752 | +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). | ||
| 1753 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1754 | + | ||
| 1755 | +QHP_SECT_FILTER_ATTRS = | ||
| 1756 | + | ||
| 1757 | +# The QHG_LOCATION tag can be used to specify the location (absolute path | ||
| 1758 | +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to | ||
| 1759 | +# run qhelpgenerator on the generated .qhp file. | ||
| 1760 | +# This tag requires that the tag GENERATE_QHP is set to YES. | ||
| 1761 | + | ||
| 1762 | +QHG_LOCATION = | ||
| 1763 | + | ||
| 1764 | +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be | ||
| 1765 | +# generated, together with the HTML files, they form an Eclipse help plugin. To | ||
| 1766 | +# install this plugin and make it available under the help contents menu in | ||
| 1767 | +# Eclipse, the contents of the directory containing the HTML and XML files needs | ||
| 1768 | +# to be copied into the plugins directory of eclipse. The name of the directory | ||
| 1769 | +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. | ||
| 1770 | +# After copying Eclipse needs to be restarted before the help appears. | ||
| 1771 | +# The default value is: NO. | ||
| 1772 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1773 | + | ||
| 1774 | +GENERATE_ECLIPSEHELP = NO | ||
| 1775 | + | ||
| 1776 | +# A unique identifier for the Eclipse help plugin. When installing the plugin | ||
| 1777 | +# the directory name containing the HTML and XML files should also have this | ||
| 1778 | +# name. Each documentation set should have its own identifier. | ||
| 1779 | +# The default value is: org.doxygen.Project. | ||
| 1780 | +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. | ||
| 1781 | + | ||
| 1782 | +ECLIPSE_DOC_ID = org.doxygen.Project | ||
| 1783 | + | ||
| 1784 | +# If you want full control over the layout of the generated HTML pages it might | ||
| 1785 | +# be necessary to disable the index and replace it with your own. The | ||
| 1786 | +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top | ||
| 1787 | +# of each HTML page. A value of NO enables the index and the value YES disables | ||
| 1788 | +# it. Since the tabs in the index contain the same information as the navigation | ||
| 1789 | +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. | ||
| 1790 | +# The default value is: NO. | ||
| 1791 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1792 | + | ||
| 1793 | +DISABLE_INDEX = NO | ||
| 1794 | + | ||
| 1795 | +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | ||
| 1796 | +# structure should be generated to display hierarchical information. If the tag | ||
| 1797 | +# value is set to YES, a side panel will be generated containing a tree-like | ||
| 1798 | +# index structure (just like the one that is generated for HTML Help). For this | ||
| 1799 | +# to work a browser that supports JavaScript, DHTML, CSS and frames is required | ||
| 1800 | +# (i.e. any modern browser). Windows users are probably better off using the | ||
| 1801 | +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can | ||
| 1802 | +# further fine tune the look of the index (see "Fine-tuning the output"). As an | ||
| 1803 | +# example, the default style sheet generated by Doxygen has an example that | ||
| 1804 | +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. | ||
| 1805 | +# Since the tree basically has more details information than the tab index, you | ||
| 1806 | +# could consider setting DISABLE_INDEX to YES when enabling this option. | ||
| 1807 | +# The default value is: YES. | ||
| 1808 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1809 | + | ||
| 1810 | +GENERATE_TREEVIEW = NO | ||
| 1811 | + | ||
| 1812 | +# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines | ||
| 1813 | +# if an additional navigation panel is shown at the right hand side of the | ||
| 1814 | +# screen, displaying an outline of the contents of the main page, similar to | ||
| 1815 | +# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to | ||
| 1816 | +# NO, this option has no effect. | ||
| 1817 | +# The default value is: YES. | ||
| 1818 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1819 | + | ||
| 1820 | +PAGE_OUTLINE_PANEL = YES | ||
| 1821 | + | ||
| 1822 | +# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if | ||
| 1823 | +# the side bar is limited to only the treeview area (value NO) or if it should | ||
| 1824 | +# extend to the full height of the window (value YES). Setting this to YES gives | ||
| 1825 | +# a layout similar to e.g. https://docs.readthedocs.io with more room for | ||
| 1826 | +# contents, but less room for the project logo, title, and description. If | ||
| 1827 | +# GENERATE_TREEVIEW is set to NO, this option has no effect. | ||
| 1828 | +# The default value is: NO. | ||
| 1829 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1830 | + | ||
| 1831 | +FULL_SIDEBAR = NO | ||
| 1832 | + | ||
| 1833 | +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that | ||
| 1834 | +# Doxygen will group on one line in the generated HTML documentation. | ||
| 1835 | +# | ||
| 1836 | +# Note that a value of 0 will completely suppress the enum values from appearing | ||
| 1837 | +# in the overview section. | ||
| 1838 | +# Minimum value: 0, maximum value: 20, default value: 4. | ||
| 1839 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1840 | + | ||
| 1841 | +ENUM_VALUES_PER_LINE = 4 | ||
| 1842 | + | ||
| 1843 | +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified | ||
| 1844 | +# enumeration values besides the enumeration mnemonics. | ||
| 1845 | +# The default value is: NO. | ||
| 1846 | + | ||
| 1847 | +SHOW_ENUM_VALUES = NO | ||
| 1848 | + | ||
| 1849 | +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used | ||
| 1850 | +# to set the initial width (in pixels) of the frame in which the tree is shown. | ||
| 1851 | +# Minimum value: 0, maximum value: 1500, default value: 250. | ||
| 1852 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1853 | + | ||
| 1854 | +TREEVIEW_WIDTH = 250 | ||
| 1855 | + | ||
| 1856 | +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to | ||
| 1857 | +# external symbols imported via tag files in a separate window. | ||
| 1858 | +# The default value is: NO. | ||
| 1859 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1860 | + | ||
| 1861 | +EXT_LINKS_IN_WINDOW = NO | ||
| 1862 | + | ||
| 1863 | +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email | ||
| 1864 | +# addresses. | ||
| 1865 | +# The default value is: YES. | ||
| 1866 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1867 | + | ||
| 1868 | +OBFUSCATE_EMAILS = YES | ||
| 1869 | + | ||
| 1870 | +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg | ||
| 1871 | +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see | ||
| 1872 | +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for | ||
| 1873 | +# the HTML output. These images will generally look nicer at scaled resolutions. | ||
| 1874 | +# Possible values are: png (the default) and svg (looks nicer but requires the | ||
| 1875 | +# pdf2svg or inkscape tool). | ||
| 1876 | +# The default value is: png. | ||
| 1877 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1878 | + | ||
| 1879 | +HTML_FORMULA_FORMAT = png | ||
| 1880 | + | ||
| 1881 | +# Use this tag to change the font size of LaTeX formulas included as images in | ||
| 1882 | +# the HTML documentation. When you change the font size after a successful | ||
| 1883 | +# Doxygen run you need to manually remove any form_*.png images from the HTML | ||
| 1884 | +# output directory to force them to be regenerated. | ||
| 1885 | +# Minimum value: 8, maximum value: 50, default value: 10. | ||
| 1886 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1887 | + | ||
| 1888 | +FORMULA_FONTSIZE = 10 | ||
| 1889 | + | ||
| 1890 | +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands | ||
| 1891 | +# to create new LaTeX commands to be used in formulas as building blocks. See | ||
| 1892 | +# the section "Including formulas" for details. | ||
| 1893 | + | ||
| 1894 | +FORMULA_MACROFILE = | ||
| 1895 | + | ||
| 1896 | +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | ||
| 1897 | +# https://www.mathjax.org) which uses client side JavaScript for the rendering | ||
| 1898 | +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX | ||
| 1899 | +# installed or if you want to formulas look prettier in the HTML output. When | ||
| 1900 | +# enabled you may also need to install MathJax separately and configure the path | ||
| 1901 | +# to it using the MATHJAX_RELPATH option. | ||
| 1902 | +# The default value is: NO. | ||
| 1903 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1904 | + | ||
| 1905 | +USE_MATHJAX = NO | ||
| 1906 | + | ||
| 1907 | +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. | ||
| 1908 | +# Note that the different versions of MathJax have different requirements with | ||
| 1909 | +# regards to the different settings, so it is possible that also other MathJax | ||
| 1910 | +# settings have to be changed when switching between the different MathJax | ||
| 1911 | +# versions. | ||
| 1912 | +# Possible values are: MathJax_2 and MathJax_3. | ||
| 1913 | +# The default value is: MathJax_2. | ||
| 1914 | +# This tag requires that the tag USE_MATHJAX is set to YES. | ||
| 1915 | + | ||
| 1916 | +MATHJAX_VERSION = MathJax_2 | ||
| 1917 | + | ||
| 1918 | +# When MathJax is enabled you can set the default output format to be used for | ||
| 1919 | +# the MathJax output. For more details about the output format see MathJax | ||
| 1920 | +# version 2 (see: | ||
| 1921 | +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 | ||
| 1922 | +# (see: | ||
| 1923 | +# http://docs.mathjax.org/en/latest/web/components/output.html). | ||
| 1924 | +# Possible values are: HTML-CSS (which is slower, but has the best | ||
| 1925 | +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 | ||
| 1926 | +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported | ||
| 1927 | +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This | ||
| 1928 | +# is the name for Mathjax version 3, for MathJax version 2 this will be | ||
| 1929 | +# translated into HTML-CSS) and SVG. | ||
| 1930 | +# The default value is: HTML-CSS. | ||
| 1931 | +# This tag requires that the tag USE_MATHJAX is set to YES. | ||
| 1932 | + | ||
| 1933 | +MATHJAX_FORMAT = HTML-CSS | ||
| 1934 | + | ||
| 1935 | +# When MathJax is enabled you need to specify the location relative to the HTML | ||
| 1936 | +# output directory using the MATHJAX_RELPATH option. The destination directory | ||
| 1937 | +# should contain the MathJax.js script. For instance, if the mathjax directory | ||
| 1938 | +# is located at the same level as the HTML output directory, then | ||
| 1939 | +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | ||
| 1940 | +# Content Delivery Network so you can quickly see the result without installing | ||
| 1941 | +# MathJax. However, it is strongly recommended to install a local copy of | ||
| 1942 | +# MathJax from https://www.mathjax.org before deployment. The default value is: | ||
| 1943 | +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 | ||
| 1944 | +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 | ||
| 1945 | +# This tag requires that the tag USE_MATHJAX is set to YES. | ||
| 1946 | + | ||
| 1947 | +MATHJAX_RELPATH = | ||
| 1948 | + | ||
| 1949 | +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | ||
| 1950 | +# extension names that should be enabled during MathJax rendering. For example | ||
| 1951 | +# for MathJax version 2 (see | ||
| 1952 | +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): | ||
| 1953 | +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | ||
| 1954 | +# For example for MathJax version 3 (see | ||
| 1955 | +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): | ||
| 1956 | +# MATHJAX_EXTENSIONS = ams | ||
| 1957 | +# This tag requires that the tag USE_MATHJAX is set to YES. | ||
| 1958 | + | ||
| 1959 | +MATHJAX_EXTENSIONS = | ||
| 1960 | + | ||
| 1961 | +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces | ||
| 1962 | +# of code that will be used on startup of the MathJax code. See the MathJax site | ||
| 1963 | +# (see: | ||
| 1964 | +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an | ||
| 1965 | +# example see the documentation. | ||
| 1966 | +# This tag requires that the tag USE_MATHJAX is set to YES. | ||
| 1967 | + | ||
| 1968 | +MATHJAX_CODEFILE = | ||
| 1969 | + | ||
| 1970 | +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for | ||
| 1971 | +# the HTML output. The underlying search engine uses JavaScript and DHTML and | ||
| 1972 | +# should work on any modern browser. Note that when using HTML help | ||
| 1973 | +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) | ||
| 1974 | +# there is already a search function so this one should typically be disabled. | ||
| 1975 | +# For large projects the JavaScript based search engine can be slow, then | ||
| 1976 | +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to | ||
| 1977 | +# search using the keyboard; to jump to the search box use <access key> + S | ||
| 1978 | +# (what the <access key> is depends on the OS and browser, but it is typically | ||
| 1979 | +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down | ||
| 1980 | +# key> to jump into the search results window, the results can be navigated | ||
| 1981 | +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel | ||
| 1982 | +# the search. The filter options can be selected when the cursor is inside the | ||
| 1983 | +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> | ||
| 1984 | +# to select a filter and <Enter> or <escape> to activate or cancel the filter | ||
| 1985 | +# option. | ||
| 1986 | +# The default value is: YES. | ||
| 1987 | +# This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1988 | + | ||
| 1989 | +SEARCHENGINE = YES | ||
| 1990 | + | ||
| 1991 | +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be | ||
| 1992 | +# implemented using a web server instead of a web client using JavaScript. There | ||
| 1993 | +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH | ||
| 1994 | +# setting. When disabled, Doxygen will generate a PHP script for searching and | ||
| 1995 | +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | ||
| 1996 | +# and searching needs to be provided by external tools. See the section | ||
| 1997 | +# "External Indexing and Searching" for details. | ||
| 1998 | +# The default value is: NO. | ||
| 1999 | +# This tag requires that the tag SEARCHENGINE is set to YES. | ||
| 2000 | + | ||
| 2001 | +SERVER_BASED_SEARCH = NO | ||
| 2002 | + | ||
| 2003 | +# When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP | ||
| 2004 | +# script for searching. Instead the search results are written to an XML file | ||
| 2005 | +# which needs to be processed by an external indexer. Doxygen will invoke an | ||
| 2006 | +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the | ||
| 2007 | +# search results. | ||
| 2008 | +# | ||
| 2009 | +# Doxygen ships with an example indexer (doxyindexer) and search engine | ||
| 2010 | +# (doxysearch.cgi) which are based on the open source search engine library | ||
| 2011 | +# Xapian (see: | ||
| 2012 | +# https://xapian.org/). | ||
| 2013 | +# | ||
| 2014 | +# See the section "External Indexing and Searching" for details. | ||
| 2015 | +# The default value is: NO. | ||
| 2016 | +# This tag requires that the tag SEARCHENGINE is set to YES. | ||
| 2017 | + | ||
| 2018 | +EXTERNAL_SEARCH = NO | ||
| 2019 | + | ||
| 2020 | +# The SEARCHENGINE_URL should point to a search engine hosted by a web server | ||
| 2021 | +# which will return the search results when EXTERNAL_SEARCH is enabled. | ||
| 2022 | +# | ||
| 2023 | +# Doxygen ships with an example indexer (doxyindexer) and search engine | ||
| 2024 | +# (doxysearch.cgi) which are based on the open source search engine library | ||
| 2025 | +# Xapian (see: | ||
| 2026 | +# https://xapian.org/). See the section "External Indexing and Searching" for | ||
| 2027 | +# details. | ||
| 2028 | +# This tag requires that the tag SEARCHENGINE is set to YES. | ||
| 2029 | + | ||
| 2030 | +SEARCHENGINE_URL = | ||
| 2031 | + | ||
| 2032 | +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed | ||
| 2033 | +# search data is written to a file for indexing by an external tool. With the | ||
| 2034 | +# SEARCHDATA_FILE tag the name of this file can be specified. | ||
| 2035 | +# The default file is: searchdata.xml. | ||
| 2036 | +# This tag requires that the tag SEARCHENGINE is set to YES. | ||
| 2037 | + | ||
| 2038 | +SEARCHDATA_FILE = searchdata.xml | ||
| 2039 | + | ||
| 2040 | +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the | ||
| 2041 | +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is | ||
| 2042 | +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple | ||
| 2043 | +# projects and redirect the results back to the right project. | ||
| 2044 | +# This tag requires that the tag SEARCHENGINE is set to YES. | ||
| 2045 | + | ||
| 2046 | +EXTERNAL_SEARCH_ID = | ||
| 2047 | + | ||
| 2048 | +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen | ||
| 2049 | +# projects other than the one defined by this configuration file, but that are | ||
| 2050 | +# all added to the same external search index. Each project needs to have a | ||
| 2051 | +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of | ||
| 2052 | +# to a relative location where the documentation can be found. The format is: | ||
| 2053 | +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... | ||
| 2054 | +# This tag requires that the tag SEARCHENGINE is set to YES. | ||
| 2055 | + | ||
| 2056 | +EXTRA_SEARCH_MAPPINGS = | ||
| 2057 | + | ||
| 2058 | +#--------------------------------------------------------------------------- | ||
| 2059 | +# Configuration options related to the LaTeX output | ||
| 2060 | +#--------------------------------------------------------------------------- | ||
| 2061 | + | ||
| 2062 | +# If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output. | ||
| 2063 | +# The default value is: YES. | ||
| 2064 | + | ||
| 2065 | +GENERATE_LATEX = NO | ||
| 2066 | + | ||
| 2067 | +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a | ||
| 2068 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
| 2069 | +# it. | ||
| 2070 | +# The default directory is: latex. | ||
| 2071 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2072 | + | ||
| 2073 | +LATEX_OUTPUT = latex | ||
| 2074 | + | ||
| 2075 | +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | ||
| 2076 | +# invoked. | ||
| 2077 | +# | ||
| 2078 | +# Note that when not enabling USE_PDFLATEX the default is latex when enabling | ||
| 2079 | +# USE_PDFLATEX the default is pdflatex and when in the later case latex is | ||
| 2080 | +# chosen this is overwritten by pdflatex. For specific output languages the | ||
| 2081 | +# default can have been set differently, this depends on the implementation of | ||
| 2082 | +# the output language. | ||
| 2083 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2084 | + | ||
| 2085 | +LATEX_CMD_NAME = | ||
| 2086 | + | ||
| 2087 | +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate | ||
| 2088 | +# index for LaTeX. | ||
| 2089 | +# Note: This tag is used in the Makefile / make.bat. | ||
| 2090 | +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file | ||
| 2091 | +# (.tex). | ||
| 2092 | +# The default file is: makeindex. | ||
| 2093 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2094 | + | ||
| 2095 | +MAKEINDEX_CMD_NAME = makeindex | ||
| 2096 | + | ||
| 2097 | +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to | ||
| 2098 | +# generate index for LaTeX. In case there is no backslash (\) as first character | ||
| 2099 | +# it will be automatically added in the LaTeX code. | ||
| 2100 | +# Note: This tag is used in the generated output file (.tex). | ||
| 2101 | +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. | ||
| 2102 | +# The default value is: makeindex. | ||
| 2103 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2104 | + | ||
| 2105 | +LATEX_MAKEINDEX_CMD = makeindex | ||
| 2106 | + | ||
| 2107 | +# If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX | ||
| 2108 | +# documents. This may be useful for small projects and may help to save some | ||
| 2109 | +# trees in general. | ||
| 2110 | +# The default value is: NO. | ||
| 2111 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2112 | + | ||
| 2113 | +COMPACT_LATEX = NO | ||
| 2114 | + | ||
| 2115 | +# The PAPER_TYPE tag can be used to set the paper type that is used by the | ||
| 2116 | +# printer. | ||
| 2117 | +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x | ||
| 2118 | +# 14 inches) and executive (7.25 x 10.5 inches). | ||
| 2119 | +# The default value is: a4. | ||
| 2120 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2121 | + | ||
| 2122 | +PAPER_TYPE = a4 | ||
| 2123 | + | ||
| 2124 | +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names | ||
| 2125 | +# that should be included in the LaTeX output. The package can be specified just | ||
| 2126 | +# by its name or with the correct syntax as to be used with the LaTeX | ||
| 2127 | +# \usepackage command. To get the times font for instance you can specify : | ||
| 2128 | +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} | ||
| 2129 | +# To use the option intlimits with the amsmath package you can specify: | ||
| 2130 | +# EXTRA_PACKAGES=[intlimits]{amsmath} | ||
| 2131 | +# If left blank no extra packages will be included. | ||
| 2132 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2133 | + | ||
| 2134 | +EXTRA_PACKAGES = | ||
| 2135 | + | ||
| 2136 | +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for | ||
| 2137 | +# the generated LaTeX document. The header should contain everything until the | ||
| 2138 | +# first chapter. If it is left blank Doxygen will generate a standard header. It | ||
| 2139 | +# is highly recommended to start with a default header using | ||
| 2140 | +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty | ||
| 2141 | +# and then modify the file new_header.tex. See also section "Doxygen usage" for | ||
| 2142 | +# information on how to generate the default header that Doxygen normally uses. | ||
| 2143 | +# | ||
| 2144 | +# Note: Only use a user-defined header if you know what you are doing! | ||
| 2145 | +# Note: The header is subject to change so you typically have to regenerate the | ||
| 2146 | +# default header when upgrading to a newer version of Doxygen. The following | ||
| 2147 | +# commands have a special meaning inside the header (and footer): For a | ||
| 2148 | +# description of the possible markers and block names see the documentation. | ||
| 2149 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2150 | + | ||
| 2151 | +LATEX_HEADER = | ||
| 2152 | + | ||
| 2153 | +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for | ||
| 2154 | +# the generated LaTeX document. The footer should contain everything after the | ||
| 2155 | +# last chapter. If it is left blank Doxygen will generate a standard footer. See | ||
| 2156 | +# LATEX_HEADER for more information on how to generate a default footer and what | ||
| 2157 | +# special commands can be used inside the footer. See also section "Doxygen | ||
| 2158 | +# usage" for information on how to generate the default footer that Doxygen | ||
| 2159 | +# normally uses. Note: Only use a user-defined footer if you know what you are | ||
| 2160 | +# doing! | ||
| 2161 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2162 | + | ||
| 2163 | +LATEX_FOOTER = | ||
| 2164 | + | ||
| 2165 | +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined | ||
| 2166 | +# LaTeX style sheets that are included after the standard style sheets created | ||
| 2167 | +# by Doxygen. Using this option one can overrule certain style aspects. Doxygen | ||
| 2168 | +# will copy the style sheet files to the output directory. | ||
| 2169 | +# Note: The order of the extra style sheet files is of importance (e.g. the last | ||
| 2170 | +# style sheet in the list overrules the setting of the previous ones in the | ||
| 2171 | +# list). | ||
| 2172 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2173 | + | ||
| 2174 | +LATEX_EXTRA_STYLESHEET = | ||
| 2175 | + | ||
| 2176 | +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or | ||
| 2177 | +# other source files which should be copied to the LATEX_OUTPUT output | ||
| 2178 | +# directory. Note that the files will be copied as-is; there are no commands or | ||
| 2179 | +# markers available. | ||
| 2180 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2181 | + | ||
| 2182 | +LATEX_EXTRA_FILES = | ||
| 2183 | + | ||
| 2184 | +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is | ||
| 2185 | +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will | ||
| 2186 | +# contain links (just like the HTML output) instead of page references. This | ||
| 2187 | +# makes the output suitable for online browsing using a PDF viewer. | ||
| 2188 | +# The default value is: YES. | ||
| 2189 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2190 | + | ||
| 2191 | +PDF_HYPERLINKS = YES | ||
| 2192 | + | ||
| 2193 | +# If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as | ||
| 2194 | +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX | ||
| 2195 | +# files. Set this option to YES, to get a higher quality PDF documentation. | ||
| 2196 | +# | ||
| 2197 | +# See also section LATEX_CMD_NAME for selecting the engine. | ||
| 2198 | +# The default value is: YES. | ||
| 2199 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2200 | + | ||
| 2201 | +USE_PDFLATEX = YES | ||
| 2202 | + | ||
| 2203 | +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. | ||
| 2204 | +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch | ||
| 2205 | +# mode nothing is printed on the terminal, errors are scrolled as if <return> is | ||
| 2206 | +# hit at every error; missing files that TeX tries to input or request from | ||
| 2207 | +# keyboard input (\read on a not open input stream) cause the job to abort, | ||
| 2208 | +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, | ||
| 2209 | +# but there is no possibility of user interaction just like in batch mode, | ||
| 2210 | +# SCROLL In scroll mode, TeX will stop only for missing files to input or if | ||
| 2211 | +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at | ||
| 2212 | +# each error, asking for user intervention. | ||
| 2213 | +# The default value is: NO. | ||
| 2214 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2215 | + | ||
| 2216 | +LATEX_BATCHMODE = NO | ||
| 2217 | + | ||
| 2218 | +# If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the | ||
| 2219 | +# index chapters (such as File Index, Compound Index, etc.) in the output. | ||
| 2220 | +# The default value is: NO. | ||
| 2221 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2222 | + | ||
| 2223 | +LATEX_HIDE_INDICES = NO | ||
| 2224 | + | ||
| 2225 | +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the | ||
| 2226 | +# bibliography, e.g. plainnat, or ieeetr. See | ||
| 2227 | +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. | ||
| 2228 | +# The default value is: plainnat. | ||
| 2229 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2230 | + | ||
| 2231 | +LATEX_BIB_STYLE = plain | ||
| 2232 | + | ||
| 2233 | +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) | ||
| 2234 | +# path from which the emoji images will be read. If a relative path is entered, | ||
| 2235 | +# it will be relative to the LATEX_OUTPUT directory. If left blank the | ||
| 2236 | +# LATEX_OUTPUT directory will be used. | ||
| 2237 | +# This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 2238 | + | ||
| 2239 | +LATEX_EMOJI_DIRECTORY = | ||
| 2240 | + | ||
| 2241 | +#--------------------------------------------------------------------------- | ||
| 2242 | +# Configuration options related to the RTF output | ||
| 2243 | +#--------------------------------------------------------------------------- | ||
| 2244 | + | ||
| 2245 | +# If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The | ||
| 2246 | +# RTF output is optimized for Word 97 and may not look too pretty with other RTF | ||
| 2247 | +# readers/editors. | ||
| 2248 | +# The default value is: NO. | ||
| 2249 | + | ||
| 2250 | +GENERATE_RTF = NO | ||
| 2251 | + | ||
| 2252 | +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a | ||
| 2253 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
| 2254 | +# it. | ||
| 2255 | +# The default directory is: rtf. | ||
| 2256 | +# This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2257 | + | ||
| 2258 | +RTF_OUTPUT = rtf | ||
| 2259 | + | ||
| 2260 | +# If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF | ||
| 2261 | +# documents. This may be useful for small projects and may help to save some | ||
| 2262 | +# trees in general. | ||
| 2263 | +# The default value is: NO. | ||
| 2264 | +# This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2265 | + | ||
| 2266 | +COMPACT_RTF = NO | ||
| 2267 | + | ||
| 2268 | +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will | ||
| 2269 | +# contain hyperlink fields. The RTF file will contain links (just like the HTML | ||
| 2270 | +# output) instead of page references. This makes the output suitable for online | ||
| 2271 | +# browsing using Word or some other Word compatible readers that support those | ||
| 2272 | +# fields. | ||
| 2273 | +# | ||
| 2274 | +# Note: WordPad (write) and others do not support links. | ||
| 2275 | +# The default value is: NO. | ||
| 2276 | +# This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2277 | + | ||
| 2278 | +RTF_HYPERLINKS = NO | ||
| 2279 | + | ||
| 2280 | +# Load stylesheet definitions from file. Syntax is similar to Doxygen's | ||
| 2281 | +# configuration file, i.e. a series of assignments. You only have to provide | ||
| 2282 | +# replacements, missing definitions are set to their default value. | ||
| 2283 | +# | ||
| 2284 | +# See also section "Doxygen usage" for information on how to generate the | ||
| 2285 | +# default style sheet that Doxygen normally uses. | ||
| 2286 | +# This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2287 | + | ||
| 2288 | +RTF_STYLESHEET_FILE = | ||
| 2289 | + | ||
| 2290 | +# Set optional variables used in the generation of an RTF document. Syntax is | ||
| 2291 | +# similar to Doxygen's configuration file. A template extensions file can be | ||
| 2292 | +# generated using doxygen -e rtf extensionFile. | ||
| 2293 | +# This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2294 | + | ||
| 2295 | +RTF_EXTENSIONS_FILE = | ||
| 2296 | + | ||
| 2297 | +# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or | ||
| 2298 | +# other source files which should be copied to the RTF_OUTPUT output directory. | ||
| 2299 | +# Note that the files will be copied as-is; there are no commands or markers | ||
| 2300 | +# available. | ||
| 2301 | +# This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 2302 | + | ||
| 2303 | +RTF_EXTRA_FILES = | ||
| 2304 | + | ||
| 2305 | +#--------------------------------------------------------------------------- | ||
| 2306 | +# Configuration options related to the man page output | ||
| 2307 | +#--------------------------------------------------------------------------- | ||
| 2308 | + | ||
| 2309 | +# If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for | ||
| 2310 | +# classes and files. | ||
| 2311 | +# The default value is: NO. | ||
| 2312 | + | ||
| 2313 | +GENERATE_MAN = NO | ||
| 2314 | + | ||
| 2315 | +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a | ||
| 2316 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
| 2317 | +# it. A directory man3 will be created inside the directory specified by | ||
| 2318 | +# MAN_OUTPUT. | ||
| 2319 | +# The default directory is: man. | ||
| 2320 | +# This tag requires that the tag GENERATE_MAN is set to YES. | ||
| 2321 | + | ||
| 2322 | +MAN_OUTPUT = man | ||
| 2323 | + | ||
| 2324 | +# The MAN_EXTENSION tag determines the extension that is added to the generated | ||
| 2325 | +# man pages. In case the manual section does not start with a number, the number | ||
| 2326 | +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is | ||
| 2327 | +# optional. | ||
| 2328 | +# The default value is: .3. | ||
| 2329 | +# This tag requires that the tag GENERATE_MAN is set to YES. | ||
| 2330 | + | ||
| 2331 | +MAN_EXTENSION = .3 | ||
| 2332 | + | ||
| 2333 | +# The MAN_SUBDIR tag determines the name of the directory created within | ||
| 2334 | +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by | ||
| 2335 | +# MAN_EXTENSION with the initial . removed. | ||
| 2336 | +# This tag requires that the tag GENERATE_MAN is set to YES. | ||
| 2337 | + | ||
| 2338 | +MAN_SUBDIR = | ||
| 2339 | + | ||
| 2340 | +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it | ||
| 2341 | +# will generate one additional man file for each entity documented in the real | ||
| 2342 | +# man page(s). These additional files only source the real man page, but without | ||
| 2343 | +# them the man command would be unable to find the correct page. | ||
| 2344 | +# The default value is: NO. | ||
| 2345 | +# This tag requires that the tag GENERATE_MAN is set to YES. | ||
| 2346 | + | ||
| 2347 | +MAN_LINKS = NO | ||
| 2348 | + | ||
| 2349 | +#--------------------------------------------------------------------------- | ||
| 2350 | +# Configuration options related to the XML output | ||
| 2351 | +#--------------------------------------------------------------------------- | ||
| 2352 | + | ||
| 2353 | +# If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that | ||
| 2354 | +# captures the structure of the code including all documentation. | ||
| 2355 | +# The default value is: NO. | ||
| 2356 | + | ||
| 2357 | +GENERATE_XML = NO | ||
| 2358 | + | ||
| 2359 | +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a | ||
| 2360 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
| 2361 | +# it. | ||
| 2362 | +# The default directory is: xml. | ||
| 2363 | +# This tag requires that the tag GENERATE_XML is set to YES. | ||
| 2364 | + | ||
| 2365 | +XML_OUTPUT = xml | ||
| 2366 | + | ||
| 2367 | +# If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program | ||
| 2368 | +# listings (including syntax highlighting and cross-referencing information) to | ||
| 2369 | +# the XML output. Note that enabling this will significantly increase the size | ||
| 2370 | +# of the XML output. | ||
| 2371 | +# The default value is: YES. | ||
| 2372 | +# This tag requires that the tag GENERATE_XML is set to YES. | ||
| 2373 | + | ||
| 2374 | +XML_PROGRAMLISTING = YES | ||
| 2375 | + | ||
| 2376 | +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include | ||
| 2377 | +# namespace members in file scope as well, matching the HTML output. | ||
| 2378 | +# The default value is: NO. | ||
| 2379 | +# This tag requires that the tag GENERATE_XML is set to YES. | ||
| 2380 | + | ||
| 2381 | +XML_NS_MEMB_FILE_SCOPE = NO | ||
| 2382 | + | ||
| 2383 | +#--------------------------------------------------------------------------- | ||
| 2384 | +# Configuration options related to the DOCBOOK output | ||
| 2385 | +#--------------------------------------------------------------------------- | ||
| 2386 | + | ||
| 2387 | +# If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files | ||
| 2388 | +# that can be used to generate PDF. | ||
| 2389 | +# The default value is: NO. | ||
| 2390 | + | ||
| 2391 | +GENERATE_DOCBOOK = NO | ||
| 2392 | + | ||
| 2393 | +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. | ||
| 2394 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in | ||
| 2395 | +# front of it. | ||
| 2396 | +# The default directory is: docbook. | ||
| 2397 | +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. | ||
| 2398 | + | ||
| 2399 | +DOCBOOK_OUTPUT = docbook | ||
| 2400 | + | ||
| 2401 | +#--------------------------------------------------------------------------- | ||
| 2402 | +# Configuration options for the AutoGen Definitions output | ||
| 2403 | +#--------------------------------------------------------------------------- | ||
| 2404 | + | ||
| 2405 | +# If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an | ||
| 2406 | +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures | ||
| 2407 | +# the structure of the code including all documentation. Note that this feature | ||
| 2408 | +# is still experimental and incomplete at the moment. | ||
| 2409 | +# The default value is: NO. | ||
| 2410 | + | ||
| 2411 | +GENERATE_AUTOGEN_DEF = NO | ||
| 2412 | + | ||
| 2413 | +#--------------------------------------------------------------------------- | ||
| 2414 | +# Configuration options related to Sqlite3 output | ||
| 2415 | +#--------------------------------------------------------------------------- | ||
| 2416 | + | ||
| 2417 | +# If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3 | ||
| 2418 | +# database with symbols found by Doxygen stored in tables. | ||
| 2419 | +# The default value is: NO. | ||
| 2420 | + | ||
| 2421 | +GENERATE_SQLITE3 = NO | ||
| 2422 | + | ||
| 2423 | +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be | ||
| 2424 | +# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put | ||
| 2425 | +# in front of it. | ||
| 2426 | +# The default directory is: sqlite3. | ||
| 2427 | +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. | ||
| 2428 | + | ||
| 2429 | +SQLITE3_OUTPUT = sqlite3 | ||
| 2430 | + | ||
| 2431 | +# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db | ||
| 2432 | +# database file will be recreated with each Doxygen run. If set to NO, Doxygen | ||
| 2433 | +# will warn if a database file is already found and not modify it. | ||
| 2434 | +# The default value is: YES. | ||
| 2435 | +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. | ||
| 2436 | + | ||
| 2437 | +SQLITE3_RECREATE_DB = YES | ||
| 2438 | + | ||
| 2439 | +#--------------------------------------------------------------------------- | ||
| 2440 | +# Configuration options related to the Perl module output | ||
| 2441 | +#--------------------------------------------------------------------------- | ||
| 2442 | + | ||
| 2443 | +# If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module | ||
| 2444 | +# file that captures the structure of the code including all documentation. | ||
| 2445 | +# | ||
| 2446 | +# Note that this feature is still experimental and incomplete at the moment. | ||
| 2447 | +# The default value is: NO. | ||
| 2448 | + | ||
| 2449 | +GENERATE_PERLMOD = NO | ||
| 2450 | + | ||
| 2451 | +# If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary | ||
| 2452 | +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI | ||
| 2453 | +# output from the Perl module output. | ||
| 2454 | +# The default value is: NO. | ||
| 2455 | +# This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||
| 2456 | + | ||
| 2457 | +PERLMOD_LATEX = NO | ||
| 2458 | + | ||
| 2459 | +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely | ||
| 2460 | +# formatted so it can be parsed by a human reader. This is useful if you want to | ||
| 2461 | +# understand what is going on. On the other hand, if this tag is set to NO, the | ||
| 2462 | +# size of the Perl module output will be much smaller and Perl will parse it | ||
| 2463 | +# just the same. | ||
| 2464 | +# The default value is: YES. | ||
| 2465 | +# This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||
| 2466 | + | ||
| 2467 | +PERLMOD_PRETTY = YES | ||
| 2468 | + | ||
| 2469 | +# The names of the make variables in the generated doxyrules.make file are | ||
| 2470 | +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful | ||
| 2471 | +# so different doxyrules.make files included by the same Makefile don't | ||
| 2472 | +# overwrite each other's variables. | ||
| 2473 | +# This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||
| 2474 | + | ||
| 2475 | +PERLMOD_MAKEVAR_PREFIX = | ||
| 2476 | + | ||
| 2477 | +#--------------------------------------------------------------------------- | ||
| 2478 | +# Configuration options related to the preprocessor | ||
| 2479 | +#--------------------------------------------------------------------------- | ||
| 2480 | + | ||
| 2481 | +# If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all | ||
| 2482 | +# C-preprocessor directives found in the sources and include files. | ||
| 2483 | +# The default value is: YES. | ||
| 2484 | + | ||
| 2485 | +ENABLE_PREPROCESSING = YES | ||
| 2486 | + | ||
| 2487 | +# If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names | ||
| 2488 | +# in the source code. If set to NO, only conditional compilation will be | ||
| 2489 | +# performed. Macro expansion can be done in a controlled way by setting | ||
| 2490 | +# EXPAND_ONLY_PREDEF to YES. | ||
| 2491 | +# The default value is: NO. | ||
| 2492 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2493 | + | ||
| 2494 | +MACRO_EXPANSION = NO | ||
| 2495 | + | ||
| 2496 | +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then | ||
| 2497 | +# the macro expansion is limited to the macros specified with the PREDEFINED and | ||
| 2498 | +# EXPAND_AS_DEFINED tags. | ||
| 2499 | +# The default value is: NO. | ||
| 2500 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2501 | + | ||
| 2502 | +EXPAND_ONLY_PREDEF = NO | ||
| 2503 | + | ||
| 2504 | +# If the SEARCH_INCLUDES tag is set to YES, the include files in the | ||
| 2505 | +# INCLUDE_PATH will be searched if a #include is found. | ||
| 2506 | +# The default value is: YES. | ||
| 2507 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2508 | + | ||
| 2509 | +SEARCH_INCLUDES = YES | ||
| 2510 | + | ||
| 2511 | +# The INCLUDE_PATH tag can be used to specify one or more directories that | ||
| 2512 | +# contain include files that are not input files but should be processed by the | ||
| 2513 | +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of | ||
| 2514 | +# RECURSIVE has no effect here. | ||
| 2515 | +# This tag requires that the tag SEARCH_INCLUDES is set to YES. | ||
| 2516 | + | ||
| 2517 | +INCLUDE_PATH = | ||
| 2518 | + | ||
| 2519 | +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | ||
| 2520 | +# patterns (like *.h and *.hpp) to filter out the header-files in the | ||
| 2521 | +# directories. If left blank, the patterns specified with FILE_PATTERNS will be | ||
| 2522 | +# used. | ||
| 2523 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2524 | + | ||
| 2525 | +INCLUDE_FILE_PATTERNS = | ||
| 2526 | + | ||
| 2527 | +# The PREDEFINED tag can be used to specify one or more macro names that are | ||
| 2528 | +# defined before the preprocessor is started (similar to the -D option of e.g. | ||
| 2529 | +# gcc). The argument of the tag is a list of macros of the form: name or | ||
| 2530 | +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" | ||
| 2531 | +# is assumed. To prevent a macro definition from being undefined via #undef or | ||
| 2532 | +# recursively expanded use the := operator instead of the = operator. | ||
| 2533 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2534 | + | ||
| 2535 | +PREDEFINED = | ||
| 2536 | + | ||
| 2537 | +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this | ||
| 2538 | +# tag can be used to specify a list of macro names that should be expanded. The | ||
| 2539 | +# macro definition that is found in the sources will be used. Use the PREDEFINED | ||
| 2540 | +# tag if you want to use a different macro definition that overrules the | ||
| 2541 | +# definition found in the source code. | ||
| 2542 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2543 | + | ||
| 2544 | +EXPAND_AS_DEFINED = | ||
| 2545 | + | ||
| 2546 | +# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will | ||
| 2547 | +# remove all references to function-like macros that are alone on a line, have | ||
| 2548 | +# an all uppercase name, and do not end with a semicolon. Such function macros | ||
| 2549 | +# are typically used for boiler-plate code, and will confuse the parser if not | ||
| 2550 | +# removed. | ||
| 2551 | +# The default value is: YES. | ||
| 2552 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
| 2553 | + | ||
| 2554 | +SKIP_FUNCTION_MACROS = YES | ||
| 2555 | + | ||
| 2556 | +#--------------------------------------------------------------------------- | ||
| 2557 | +# Configuration options related to external references | ||
| 2558 | +#--------------------------------------------------------------------------- | ||
| 2559 | + | ||
| 2560 | +# The TAGFILES tag can be used to specify one or more tag files. For each tag | ||
| 2561 | +# file the location of the external documentation should be added. The format of | ||
| 2562 | +# a tag file without this location is as follows: | ||
| 2563 | +# TAGFILES = file1 file2 ... | ||
| 2564 | +# Adding location for the tag files is done as follows: | ||
| 2565 | +# TAGFILES = file1=loc1 "file2 = loc2" ... | ||
| 2566 | +# where loc1 and loc2 can be relative or absolute paths or URLs. See the | ||
| 2567 | +# section "Linking to external documentation" for more information about the use | ||
| 2568 | +# of tag files. | ||
| 2569 | +# Note: Each tag file must have a unique name (where the name does NOT include | ||
| 2570 | +# the path). If a tag file is not located in the directory in which Doxygen is | ||
| 2571 | +# run, you must also specify the path to the tagfile here. | ||
| 2572 | + | ||
| 2573 | +TAGFILES = | ||
| 2574 | + | ||
| 2575 | +# When a file name is specified after GENERATE_TAGFILE, Doxygen will create a | ||
| 2576 | +# tag file that is based on the input files it reads. See section "Linking to | ||
| 2577 | +# external documentation" for more information about the usage of tag files. | ||
| 2578 | + | ||
| 2579 | +GENERATE_TAGFILE = | ||
| 2580 | + | ||
| 2581 | +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces | ||
| 2582 | +# will be listed in the class and namespace index. If set to NO, only the | ||
| 2583 | +# inherited external classes will be listed. | ||
| 2584 | +# The default value is: NO. | ||
| 2585 | + | ||
| 2586 | +ALLEXTERNALS = NO | ||
| 2587 | + | ||
| 2588 | +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed | ||
| 2589 | +# in the topic index. If set to NO, only the current project's groups will be | ||
| 2590 | +# listed. | ||
| 2591 | +# The default value is: YES. | ||
| 2592 | + | ||
| 2593 | +EXTERNAL_GROUPS = YES | ||
| 2594 | + | ||
| 2595 | +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in | ||
| 2596 | +# the related pages index. If set to NO, only the current project's pages will | ||
| 2597 | +# be listed. | ||
| 2598 | +# The default value is: YES. | ||
| 2599 | + | ||
| 2600 | +EXTERNAL_PAGES = YES | ||
| 2601 | + | ||
| 2602 | +#--------------------------------------------------------------------------- | ||
| 2603 | +# Configuration options related to diagram generator tools | ||
| 2604 | +#--------------------------------------------------------------------------- | ||
| 2605 | + | ||
| 2606 | +# If set to YES the inheritance and collaboration graphs will hide inheritance | ||
| 2607 | +# and usage relations if the target is undocumented or is not a class. | ||
| 2608 | +# The default value is: YES. | ||
| 2609 | + | ||
| 2610 | +HIDE_UNDOC_RELATIONS = YES | ||
| 2611 | + | ||
| 2612 | +# If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is | ||
| 2613 | +# available from the path. This tool is part of Graphviz (see: | ||
| 2614 | +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent | ||
| 2615 | +# Bell Labs. The other options in this section have no effect if this option is | ||
| 2616 | +# set to NO | ||
| 2617 | +# The default value is: NO. | ||
| 2618 | + | ||
| 2619 | +HAVE_DOT = YES | ||
| 2620 | + | ||
| 2621 | +# The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed | ||
| 2622 | +# to run in parallel. When set to 0 Doxygen will base this on the number of | ||
| 2623 | +# processors available in the system. You can set it explicitly to a value | ||
| 2624 | +# larger than 0 to get control over the balance between CPU load and processing | ||
| 2625 | +# speed. | ||
| 2626 | +# Minimum value: 0, maximum value: 32, default value: 0. | ||
| 2627 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2628 | + | ||
| 2629 | +DOT_NUM_THREADS = 0 | ||
| 2630 | + | ||
| 2631 | +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of | ||
| 2632 | +# subgraphs. When you want a differently looking font in the dot files that | ||
| 2633 | +# Doxygen generates you can specify fontname, fontcolor and fontsize attributes. | ||
| 2634 | +# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, | ||
| 2635 | +# Edge and Graph Attributes specification</a> You need to make sure dot is able | ||
| 2636 | +# to find the font, which can be done by putting it in a standard location or by | ||
| 2637 | +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | ||
| 2638 | +# directory containing the font. Default graphviz fontsize is 14. | ||
| 2639 | +# The default value is: fontname=Helvetica,fontsize=10. | ||
| 2640 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2641 | + | ||
| 2642 | +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" | ||
| 2643 | + | ||
| 2644 | +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can | ||
| 2645 | +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a | ||
| 2646 | +# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about | ||
| 2647 | +# arrows shapes.</a> | ||
| 2648 | +# The default value is: labelfontname=Helvetica,labelfontsize=10. | ||
| 2649 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2650 | + | ||
| 2651 | +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" | ||
| 2652 | + | ||
| 2653 | +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes | ||
| 2654 | +# around nodes set 'shape=plain' or 'shape=plaintext' <a | ||
| 2655 | +# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> | ||
| 2656 | +# The default value is: shape=box,height=0.2,width=0.4. | ||
| 2657 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2658 | + | ||
| 2659 | +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" | ||
| 2660 | + | ||
| 2661 | +# You can set the path where dot can find font specified with fontname in | ||
| 2662 | +# DOT_COMMON_ATTR and others dot attributes. | ||
| 2663 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2664 | + | ||
| 2665 | +DOT_FONTPATH = | ||
| 2666 | + | ||
| 2667 | +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will | ||
| 2668 | +# generate a graph for each documented class showing the direct and indirect | ||
| 2669 | +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and | ||
| 2670 | +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case | ||
| 2671 | +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the | ||
| 2672 | +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. | ||
| 2673 | +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance | ||
| 2674 | +# relations will be shown as texts / links. Explicit enabling an inheritance | ||
| 2675 | +# graph or choosing a different representation for an inheritance graph of a | ||
| 2676 | +# specific class, can be accomplished by means of the command \inheritancegraph. | ||
| 2677 | +# Disabling an inheritance graph can be accomplished by means of the command | ||
| 2678 | +# \hideinheritancegraph. | ||
| 2679 | +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. | ||
| 2680 | +# The default value is: YES. | ||
| 2681 | + | ||
| 2682 | +CLASS_GRAPH = YES | ||
| 2683 | + | ||
| 2684 | +# If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a | ||
| 2685 | +# graph for each documented class showing the direct and indirect implementation | ||
| 2686 | +# dependencies (inheritance, containment, and class references variables) of the | ||
| 2687 | +# class with other documented classes. Explicit enabling a collaboration graph, | ||
| 2688 | +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the | ||
| 2689 | +# command \collaborationgraph. Disabling a collaboration graph can be | ||
| 2690 | +# accomplished by means of the command \hidecollaborationgraph. | ||
| 2691 | +# The default value is: YES. | ||
| 2692 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2693 | + | ||
| 2694 | +COLLABORATION_GRAPH = YES | ||
| 2695 | + | ||
| 2696 | +# If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for | ||
| 2697 | +# groups, showing the direct groups dependencies. Explicit enabling a group | ||
| 2698 | +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means | ||
| 2699 | +# of the command \groupgraph. Disabling a directory graph can be accomplished by | ||
| 2700 | +# means of the command \hidegroupgraph. See also the chapter Grouping in the | ||
| 2701 | +# manual. | ||
| 2702 | +# The default value is: YES. | ||
| 2703 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2704 | + | ||
| 2705 | +GROUP_GRAPHS = YES | ||
| 2706 | + | ||
| 2707 | +# If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and | ||
| 2708 | +# collaboration diagrams in a style similar to the OMG's Unified Modeling | ||
| 2709 | +# Language. | ||
| 2710 | +# The default value is: NO. | ||
| 2711 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2712 | + | ||
| 2713 | +UML_LOOK = NO | ||
| 2714 | + | ||
| 2715 | +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the | ||
| 2716 | +# class node. If there are many fields or methods and many nodes the graph may | ||
| 2717 | +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the | ||
| 2718 | +# number of items for each type to make the size more manageable. Set this to 0 | ||
| 2719 | +# for no limit. Note that the threshold may be exceeded by 50% before the limit | ||
| 2720 | +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, | ||
| 2721 | +# but if the number exceeds 15, the total amount of fields shown is limited to | ||
| 2722 | +# 10. | ||
| 2723 | +# Minimum value: 0, maximum value: 100, default value: 10. | ||
| 2724 | +# This tag requires that the tag UML_LOOK is set to YES. | ||
| 2725 | + | ||
| 2726 | +UML_LIMIT_NUM_FIELDS = 10 | ||
| 2727 | + | ||
| 2728 | +# If the UML_LOOK tag is enabled, field labels are shown along the edge between | ||
| 2729 | +# two class nodes. If there are many fields and many nodes the graph may become | ||
| 2730 | +# too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to | ||
| 2731 | +# make the size more manageable. Set this to 0 for no limit. | ||
| 2732 | +# Minimum value: 0, maximum value: 100, default value: 10. | ||
| 2733 | +# This tag requires that the tag UML_LOOK is set to YES. | ||
| 2734 | + | ||
| 2735 | +UML_MAX_EDGE_LABELS = 10 | ||
| 2736 | + | ||
| 2737 | +# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and | ||
| 2738 | +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS | ||
| 2739 | +# tag is set to YES, Doxygen will add type and arguments for attributes and | ||
| 2740 | +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen | ||
| 2741 | +# will not generate fields with class member information in the UML graphs. The | ||
| 2742 | +# class diagrams will look similar to the default class diagrams but using UML | ||
| 2743 | +# notation for the relationships. | ||
| 2744 | +# Possible values are: NO, YES and NONE. | ||
| 2745 | +# The default value is: NO. | ||
| 2746 | +# This tag requires that the tag UML_LOOK is set to YES. | ||
| 2747 | + | ||
| 2748 | +DOT_UML_DETAILS = NO | ||
| 2749 | + | ||
| 2750 | +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters | ||
| 2751 | +# to display on a single line. If the actual line length exceeds this threshold | ||
| 2752 | +# significantly it will be wrapped across multiple lines. Some heuristics are | ||
| 2753 | +# applied to avoid ugly line breaks. | ||
| 2754 | +# Minimum value: 0, maximum value: 1000, default value: 17. | ||
| 2755 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2756 | + | ||
| 2757 | +DOT_WRAP_THRESHOLD = 17 | ||
| 2758 | + | ||
| 2759 | +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | ||
| 2760 | +# collaboration graphs will show the relations between templates and their | ||
| 2761 | +# instances. | ||
| 2762 | +# The default value is: NO. | ||
| 2763 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2764 | + | ||
| 2765 | +TEMPLATE_RELATIONS = NO | ||
| 2766 | + | ||
| 2767 | +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to | ||
| 2768 | +# YES then Doxygen will generate a graph for each documented file showing the | ||
| 2769 | +# direct and indirect include dependencies of the file with other documented | ||
| 2770 | +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, | ||
| 2771 | +# can be accomplished by means of the command \includegraph. Disabling an | ||
| 2772 | +# include graph can be accomplished by means of the command \hideincludegraph. | ||
| 2773 | +# The default value is: YES. | ||
| 2774 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2775 | + | ||
| 2776 | +INCLUDE_GRAPH = YES | ||
| 2777 | + | ||
| 2778 | +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are | ||
| 2779 | +# set to YES then Doxygen will generate a graph for each documented file showing | ||
| 2780 | +# the direct and indirect include dependencies of the file with other documented | ||
| 2781 | +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set | ||
| 2782 | +# to NO, can be accomplished by means of the command \includedbygraph. Disabling | ||
| 2783 | +# an included by graph can be accomplished by means of the command | ||
| 2784 | +# \hideincludedbygraph. | ||
| 2785 | +# The default value is: YES. | ||
| 2786 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2787 | + | ||
| 2788 | +INCLUDED_BY_GRAPH = YES | ||
| 2789 | + | ||
| 2790 | +# If the CALL_GRAPH tag is set to YES then Doxygen will generate a call | ||
| 2791 | +# dependency graph for every global function or class method. | ||
| 2792 | +# | ||
| 2793 | +# Note that enabling this option will significantly increase the time of a run. | ||
| 2794 | +# So in most cases it will be better to enable call graphs for selected | ||
| 2795 | +# functions only using the \callgraph command. Disabling a call graph can be | ||
| 2796 | +# accomplished by means of the command \hidecallgraph. | ||
| 2797 | +# The default value is: NO. | ||
| 2798 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2799 | + | ||
| 2800 | +CALL_GRAPH = YES | ||
| 2801 | + | ||
| 2802 | +# If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller | ||
| 2803 | +# dependency graph for every global function or class method. | ||
| 2804 | +# | ||
| 2805 | +# Note that enabling this option will significantly increase the time of a run. | ||
| 2806 | +# So in most cases it will be better to enable caller graphs for selected | ||
| 2807 | +# functions only using the \callergraph command. Disabling a caller graph can be | ||
| 2808 | +# accomplished by means of the command \hidecallergraph. | ||
| 2809 | +# The default value is: NO. | ||
| 2810 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2811 | + | ||
| 2812 | +CALLER_GRAPH = YES | ||
| 2813 | + | ||
| 2814 | +# If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical | ||
| 2815 | +# hierarchy of all classes instead of a textual one. | ||
| 2816 | +# The default value is: YES. | ||
| 2817 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2818 | + | ||
| 2819 | +GRAPHICAL_HIERARCHY = YES | ||
| 2820 | + | ||
| 2821 | +# If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the | ||
| 2822 | +# dependencies a directory has on other directories in a graphical way. The | ||
| 2823 | +# dependency relations are determined by the #include relations between the | ||
| 2824 | +# files in the directories. Explicit enabling a directory graph, when | ||
| 2825 | +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command | ||
| 2826 | +# \directorygraph. Disabling a directory graph can be accomplished by means of | ||
| 2827 | +# the command \hidedirectorygraph. | ||
| 2828 | +# The default value is: YES. | ||
| 2829 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2830 | + | ||
| 2831 | +DIRECTORY_GRAPH = YES | ||
| 2832 | + | ||
| 2833 | +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels | ||
| 2834 | +# of child directories generated in directory dependency graphs by dot. | ||
| 2835 | +# Minimum value: 1, maximum value: 25, default value: 1. | ||
| 2836 | +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. | ||
| 2837 | + | ||
| 2838 | +DIR_GRAPH_MAX_DEPTH = 1 | ||
| 2839 | + | ||
| 2840 | +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | ||
| 2841 | +# generated by dot. For an explanation of the image formats see the section | ||
| 2842 | +# output formats in the documentation of the dot tool (Graphviz (see: | ||
| 2843 | +# https://www.graphviz.org/)). | ||
| 2844 | +# | ||
| 2845 | +# Note the formats svg:cairo and svg:cairo:cairo cannot be used in combination | ||
| 2846 | +# with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to NO). | ||
| 2847 | +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, | ||
| 2848 | +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus, | ||
| 2849 | +# png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core, | ||
| 2850 | +# gif:cairo, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus, | ||
| 2851 | +# gif:gd, gif:gd:gd, jpg:cairo, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd, | ||
| 2852 | +# jpg:gd:gd, jpg:gdiplus and jpg:gdiplus:gdiplus. | ||
| 2853 | +# The default value is: png. | ||
| 2854 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2855 | + | ||
| 2856 | +DOT_IMAGE_FORMAT = png | ||
| 2857 | + | ||
| 2858 | +# If DOT_IMAGE_FORMAT is set to svg or svg:svg or svg:svg:core, then this option | ||
| 2859 | +# can be set to YES to enable generation of interactive SVG images that allow | ||
| 2860 | +# zooming and panning. | ||
| 2861 | +# | ||
| 2862 | +# Note that this requires a modern browser other than Internet Explorer. Tested | ||
| 2863 | +# and working are Firefox, Chrome, Safari, and Opera. | ||
| 2864 | +# | ||
| 2865 | +# Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set | ||
| 2866 | +# to svg:cairo or svg:cairo:cairo. | ||
| 2867 | +# The default value is: NO. | ||
| 2868 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2869 | + | ||
| 2870 | +INTERACTIVE_SVG = NO | ||
| 2871 | + | ||
| 2872 | +# The DOT_PATH tag can be used to specify the path where the dot tool can be | ||
| 2873 | +# found. If left blank, it is assumed the dot tool can be found in the path. | ||
| 2874 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2875 | + | ||
| 2876 | +DOT_PATH = | ||
| 2877 | + | ||
| 2878 | +# The DOTFILE_DIRS tag can be used to specify one or more directories that | ||
| 2879 | +# contain dot files that are included in the documentation (see the \dotfile | ||
| 2880 | +# command). | ||
| 2881 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2882 | + | ||
| 2883 | +DOTFILE_DIRS = | ||
| 2884 | + | ||
| 2885 | +# You can include diagrams made with dia in Doxygen documentation. Doxygen will | ||
| 2886 | +# then run dia to produce the diagram and insert it in the documentation. The | ||
| 2887 | +# DIA_PATH tag allows you to specify the directory where the dia binary resides. | ||
| 2888 | +# If left empty dia is assumed to be found in the default search path. | ||
| 2889 | + | ||
| 2890 | +DIA_PATH = | ||
| 2891 | + | ||
| 2892 | +# The DIAFILE_DIRS tag can be used to specify one or more directories that | ||
| 2893 | +# contain dia files that are included in the documentation (see the \diafile | ||
| 2894 | +# command). | ||
| 2895 | + | ||
| 2896 | +DIAFILE_DIRS = | ||
| 2897 | + | ||
| 2898 | +# When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the | ||
| 2899 | +# path where java can find the plantuml.jar file or to the filename of jar file | ||
| 2900 | +# to be used. If left blank, it is assumed PlantUML is not used or called during | ||
| 2901 | +# a preprocessing step. Doxygen will generate a warning when it encounters a | ||
| 2902 | +# \startuml command in this case and will not generate output for the diagram. | ||
| 2903 | + | ||
| 2904 | +PLANTUML_JAR_PATH = | ||
| 2905 | + | ||
| 2906 | +# When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a | ||
| 2907 | +# configuration file for PlantUML. | ||
| 2908 | + | ||
| 2909 | +PLANTUML_CFG_FILE = | ||
| 2910 | + | ||
| 2911 | +# When using PlantUML, the specified paths are searched for files specified by | ||
| 2912 | +# the !include statement in a PlantUML block. | ||
| 2913 | + | ||
| 2914 | +PLANTUML_INCLUDE_PATH = | ||
| 2915 | + | ||
| 2916 | +# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that | ||
| 2917 | +# contain PlantUml files that are included in the documentation (see the | ||
| 2918 | +# \plantumlfile command). | ||
| 2919 | + | ||
| 2920 | +PLANTUMLFILE_DIRS = | ||
| 2921 | + | ||
| 2922 | +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes | ||
| 2923 | +# that will be shown in the graph. If the number of nodes in a graph becomes | ||
| 2924 | +# larger than this value, Doxygen will truncate the graph, which is visualized | ||
| 2925 | +# by representing a node as a red box. Note that if the number of direct | ||
| 2926 | +# children of the root node in a graph is already larger than | ||
| 2927 | +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that | ||
| 2928 | +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||
| 2929 | +# Minimum value: 0, maximum value: 10000, default value: 50. | ||
| 2930 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2931 | + | ||
| 2932 | +DOT_GRAPH_MAX_NODES = 50 | ||
| 2933 | + | ||
| 2934 | +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs | ||
| 2935 | +# generated by dot. A depth value of 3 means that only nodes reachable from the | ||
| 2936 | +# root by following a path via at most 3 edges will be shown. Nodes that lay | ||
| 2937 | +# further from the root node will be omitted. Note that setting this option to 1 | ||
| 2938 | +# or 2 may greatly reduce the computation time needed for large code bases. Also | ||
| 2939 | +# note that the size of a graph can be further restricted by | ||
| 2940 | +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | ||
| 2941 | +# Minimum value: 0, maximum value: 1000, default value: 0. | ||
| 2942 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2943 | + | ||
| 2944 | +MAX_DOT_GRAPH_DEPTH = 0 | ||
| 2945 | + | ||
| 2946 | +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | ||
| 2947 | +# files in one run (i.e. multiple -o and -T options on the command line). This | ||
| 2948 | +# makes dot run faster, but since only newer versions of dot (>1.8.10) support | ||
| 2949 | +# this, this feature is disabled by default. | ||
| 2950 | +# The default value is: NO. | ||
| 2951 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2952 | + | ||
| 2953 | +DOT_MULTI_TARGETS = NO | ||
| 2954 | + | ||
| 2955 | +# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page | ||
| 2956 | +# explaining the meaning of the various boxes and arrows in the dot generated | ||
| 2957 | +# graphs. | ||
| 2958 | +# Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal | ||
| 2959 | +# graphical representation for inheritance and collaboration diagrams is used. | ||
| 2960 | +# The default value is: YES. | ||
| 2961 | +# This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2962 | + | ||
| 2963 | +GENERATE_LEGEND = YES | ||
| 2964 | + | ||
| 2965 | +# If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate | ||
| 2966 | +# files that are used to generate the various graphs. | ||
| 2967 | +# | ||
| 2968 | +# Note: This setting is not only used for dot files but also for msc temporary | ||
| 2969 | +# files. | ||
| 2970 | +# The default value is: YES. | ||
| 2971 | + | ||
| 2972 | +DOT_CLEANUP = YES | ||
| 2973 | + | ||
| 2974 | +# You can define message sequence charts within Doxygen comments using the \msc | ||
| 2975 | +# command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will | ||
| 2976 | +# use a built-in version of mscgen tool to produce the charts. Alternatively, | ||
| 2977 | +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, | ||
| 2978 | +# specifying prog as the value, Doxygen will call the tool as prog -T | ||
| 2979 | +# <outfile_format> -o <outputfile> <inputfile>. The external tool should support | ||
| 2980 | +# output file formats "png", "eps", "svg", and "ismap". | ||
| 2981 | + | ||
| 2982 | +MSCGEN_TOOL = | ||
| 2983 | + | ||
| 2984 | +# The MSCFILE_DIRS tag can be used to specify one or more directories that | ||
| 2985 | +# contain msc files that are included in the documentation (see the \mscfile | ||
| 2986 | +# command). | ||
| 2987 | + | ||
| 2988 | +MSCFILE_DIRS = |