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