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