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 = @srcdir@/doc/ @srcdir@/libsupc++/ include/ 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 789# N.B. update STRIP_FROM_PATH to sanitize paths outside the build tree. 790INPUT = @srcdir@/doc/doxygen/doxygroups.cc \ 791 @srcdir@/libsupc++/compare \ 792 @srcdir@/libsupc++/cxxabi.h \ 793 @srcdir@/libsupc++/exception \ 794 @srcdir@/libsupc++/initializer_list \ 795 @srcdir@/libsupc++/new \ 796 @srcdir@/libsupc++/typeinfo \ 797 include/algorithm \ 798 include/any \ 799 include/array \ 800 include/atomic \ 801 include/bit \ 802 include/bitset \ 803 include/charconv \ 804 include/chrono \ 805 include/codecvt \ 806 include/complex \ 807 include/concepts \ 808 include/condition_variable \ 809 include/deque \ 810 include/filesystem \ 811 include/forward_list \ 812 include/fstream \ 813 include/functional \ 814 include/future \ 815 include/iomanip \ 816 include/ios \ 817 include/iosfwd \ 818 include/iostream \ 819 include/istream \ 820 include/iterator \ 821 include/limits \ 822 include/list \ 823 include/locale \ 824 include/map \ 825 include/memory \ 826 include/memory_resource \ 827 include/mutex \ 828 include/numeric \ 829 include/numbers \ 830 include/optional \ 831 include/ostream \ 832 include/queue \ 833 include/random \ 834 include/ranges \ 835 include/ratio \ 836 include/regex \ 837 include/scoped_allocator \ 838 include/set \ 839 include/shared_mutex \ 840 include/span \ 841 include/sstream \ 842 include/stack \ 843 include/stdexcept \ 844 include/stop_token \ 845 include/streambuf \ 846 include/string \ 847 include/string_view \ 848 include/system_error \ 849 include/thread \ 850 include/tuple \ 851 include/typeindex \ 852 include/type_traits \ 853 include/unordered_map \ 854 include/unordered_set \ 855 include/utility \ 856 include/valarray \ 857 include/variant \ 858 include/vector \ 859 include/cassert \ 860 include/ccomplex \ 861 include/cctype \ 862 include/cerrno \ 863 include/cfenv \ 864 include/cfloat \ 865 include/cinttypes \ 866 include/ciso646 \ 867 include/climits \ 868 include/clocale \ 869 include/cmath \ 870 include/csetjmp \ 871 include/csignal \ 872 include/cstdalign \ 873 include/cstdarg \ 874 include/cstdbool \ 875 include/cstddef \ 876 include/cstdint \ 877 include/cstdio \ 878 include/cstdlib \ 879 include/cstring \ 880 include/ctgmath \ 881 include/ctime \ 882 include/cwchar \ 883 include/cuchar \ 884 include/cwctype \ 885 include/ \ 886 include/bits \ 887 include/@host_alias@/bits \ 888 include/backward \ 889 include/backward/hash_map \ 890 include/backward/hash_set \ 891 include/backward/strstream \ 892 include/debug \ 893 include/debug/array \ 894 include/debug/bitset \ 895 include/debug/deque \ 896 include/debug/forward_list \ 897 include/debug/list \ 898 include/debug/map \ 899 include/debug/set \ 900 include/debug/string \ 901 include/debug/unordered_map \ 902 include/debug/unordered_set \ 903 include/debug/vector \ 904 include/ext/algorithm \ 905 include/ext/cmath \ 906 include/ext/functional \ 907 include/ext/iterator \ 908 include/ext/memory \ 909 include/ext/numeric \ 910 include/ext/rb_tree \ 911 include/ext/rope \ 912 include/ext/slist \ 913 include/parallel \ 914 include/parallel/algorithm \ 915 include/parallel/numeric \ 916 include/tr1/ccomplex \ 917 include/tr1/cctype \ 918 include/tr1/cfenv \ 919 include/tr1/cfloat \ 920 include/tr1/cinttypes \ 921 include/tr1/climits \ 922 include/tr1/cmath \ 923 include/tr1/complex \ 924 include/tr1/cstdarg \ 925 include/tr1/cstdbool \ 926 include/tr1/cstdint \ 927 include/tr1/cstdio \ 928 include/tr1/cstdlib \ 929 include/tr1/ctgmath \ 930 include/tr1/ctime \ 931 include/tr1/cwchar \ 932 include/tr1/cwctype \ 933 include/tr2/ \ 934 include/tr2/bool_set \ 935 include/tr2/dynamic_bitset \ 936 include/tr2/ratio \ 937 include/tr2/type_traits \ 938 include/decimal/decimal \ 939 include/experimental/bits \ 940 include/experimental/algorithm \ 941 include/experimental/any \ 942 include/experimental/array \ 943 include/experimental/chrono \ 944 include/experimental/deque \ 945 include/experimental/filesystem \ 946 include/experimental/forward_list \ 947 include/experimental/functional \ 948 include/experimental/iterator \ 949 include/experimental/list \ 950 include/experimental/map \ 951 include/experimental/memory \ 952 include/experimental/memory_resource \ 953 include/experimental/numeric \ 954 include/experimental/optional \ 955 include/experimental/propagate_const \ 956 include/experimental/random \ 957 include/experimental/ratio \ 958 include/experimental/regex \ 959 include/experimental/set \ 960 include/experimental/string \ 961 include/experimental/string_view \ 962 include/experimental/system_error \ 963 include/experimental/tuple \ 964 include/experimental/type_traits \ 965 include/experimental/unordered_map \ 966 include/experimental/unordered_set \ 967 include/experimental/utility \ 968 include/experimental/vector \ 969 include/ext \ 970 include/ext/pb_ds \ 971 include/ext/pb_ds/detail \ 972 include/ext/pb_ds/detail/binary_heap_ \ 973 include/ext/pb_ds/detail/binomial_heap_ \ 974 include/ext/pb_ds/detail/binomial_heap_base_ \ 975 include/ext/pb_ds/detail/bin_search_tree_ \ 976 include/ext/pb_ds/detail/branch_policy \ 977 include/ext/pb_ds/detail/cc_hash_table_map_ \ 978 include/ext/pb_ds/detail/eq_fn \ 979 include/ext/pb_ds/detail/gp_hash_table_map_ \ 980 include/ext/pb_ds/detail/hash_fn \ 981 include/ext/pb_ds/detail/left_child_next_sibling_heap_ \ 982 include/ext/pb_ds/detail/list_update_map_ \ 983 include/ext/pb_ds/detail/list_update_policy \ 984 include/ext/pb_ds/detail/ov_tree_map_ \ 985 include/ext/pb_ds/detail/pairing_heap_ \ 986 include/ext/pb_ds/detail/pat_trie_ \ 987 include/ext/pb_ds/detail/rb_tree_map_ \ 988 include/ext/pb_ds/detail/rc_binomial_heap_ \ 989 include/ext/pb_ds/detail/resize_policy \ 990 include/ext/pb_ds/detail/splay_tree_ \ 991 include/ext/pb_ds/detail/thin_heap_ \ 992 include/ext/pb_ds/detail/tree_policy \ 993 include/ext/pb_ds/detail/trie_policy \ 994 include/ext/pb_ds/detail/unordered_iterator 995 996# This tag can be used to specify the character encoding of the source files 997# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 998# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 999# documentation (see: https://www.gnu.org/software/libiconv/) for the list of 1000# possible encodings. 1001# The default value is: UTF-8. 1002 1003INPUT_ENCODING = UTF-8 1004 1005# If the value of the INPUT tag contains directories, you can use the 1006# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 1007# *.h) to filter out the source-files in the directories. 1008# 1009# Note that for custom extensions or not directly supported extensions you also 1010# need to set EXTENSION_MAPPING for the extension otherwise the files are not 1011# read by doxygen. 1012# 1013# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 1014# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 1015# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 1016# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 1017# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 1018 1019FILE_PATTERNS = *.h \ 1020 *.hpp \ 1021 *.tcc 1022 1023# The RECURSIVE tag can be used to specify whether or not subdirectories should 1024# be searched for input files as well. 1025# The default value is: NO. 1026 1027RECURSIVE = NO 1028 1029# The EXCLUDE tag can be used to specify files and/or directories that should be 1030# excluded from the INPUT source files. This way you can easily exclude a 1031# subdirectory from a directory tree whose root is specified with the INPUT tag. 1032# 1033# Note that relative paths are relative to the directory from which doxygen is 1034# run. 1035 1036EXCLUDE = Makefile 1037 1038# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 1039# directories that are symbolic links (a Unix file system feature) are excluded 1040# from the input. 1041# The default value is: NO. 1042 1043EXCLUDE_SYMLINKS = NO 1044 1045# If the value of the INPUT tag contains directories, you can use the 1046# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 1047# certain files from those directories. 1048# 1049# Note that the wildcards are matched against the file with absolute path, so to 1050# exclude all test directories for example use the pattern */test/* 1051 1052EXCLUDE_PATTERNS = stamp-* \ 1053 doxygroups.cc \ 1054 *.gch \ 1055 */.svn/* 1056 1057# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 1058# (namespaces, classes, functions, etc.) that should be excluded from the 1059# output. The symbol name can be a fully qualified name, a word, or if the 1060# wildcard * is used, a substring. Examples: ANamespace, AClass, 1061# AClass::ANamespace, ANamespace::*Test 1062# 1063# Note that the wildcards are matched against the file with absolute path, so to 1064# exclude all test directories use the pattern */test/* 1065 1066EXCLUDE_SYMBOLS = 1067 1068# The EXAMPLE_PATH tag can be used to specify one or more files or directories 1069# that contain example code fragments that are included (see the \include 1070# command). 1071 1072EXAMPLE_PATH = 1073 1074# If the value of the EXAMPLE_PATH tag contains directories, you can use the 1075# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 1076# *.h) to filter out the source-files in the directories. If left blank all 1077# files are included. 1078 1079EXAMPLE_PATTERNS = 1080 1081# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1082# searched for input files to be used with the \include or \dontinclude commands 1083# irrespective of the value of the RECURSIVE tag. 1084# The default value is: NO. 1085 1086EXAMPLE_RECURSIVE = NO 1087 1088# The IMAGE_PATH tag can be used to specify one or more files or directories 1089# that contain images that are to be included in the documentation (see the 1090# \image command). 1091 1092IMAGE_PATH = 1093 1094# The INPUT_FILTER tag can be used to specify a program that doxygen should 1095# invoke to filter for each input file. Doxygen will invoke the filter program 1096# by executing (via popen()) the command: 1097# 1098# <filter> <input-file> 1099# 1100# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 1101# name of an input file. Doxygen will then use the output that the filter 1102# program writes to standard output. If FILTER_PATTERNS is specified, this tag 1103# will be ignored. 1104# 1105# Note that the filter must not add or remove lines; it is applied before the 1106# code is scanned, but not when the output code is generated. If lines are added 1107# or removed, the anchors will not be placed correctly. 1108# 1109# Note that for custom extensions or not directly supported extensions you also 1110# need to set EXTENSION_MAPPING for the extension otherwise the files are not 1111# properly processed by doxygen. 1112 1113INPUT_FILTER = 1114 1115# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1116# basis. Doxygen will compare the file name with each pattern and apply the 1117# filter if there is a match. The filters are a list of the form: pattern=filter 1118# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1119# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1120# patterns match the file name, INPUT_FILTER is applied. 1121# 1122# Note that for custom extensions or not directly supported extensions you also 1123# need to set EXTENSION_MAPPING for the extension otherwise the files are not 1124# properly processed by doxygen. 1125 1126FILTER_PATTERNS = 1127 1128# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1129# INPUT_FILTER) will also be used to filter the input files that are used for 1130# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1131# The default value is: NO. 1132 1133FILTER_SOURCE_FILES = NO 1134 1135# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1136# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1137# it is also possible to disable source filtering for a specific pattern using 1138# *.ext= (so without naming a filter). 1139# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1140 1141FILTER_SOURCE_PATTERNS = 1142 1143# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1144# is part of the input, its contents will be placed on the main page 1145# (index.html). This can be useful if you have a project on for instance GitHub 1146# and want to reuse the introduction page also for the doxygen output. 1147 1148USE_MDFILE_AS_MAINPAGE = 1149 1150#--------------------------------------------------------------------------- 1151# Configuration options related to source browsing 1152#--------------------------------------------------------------------------- 1153 1154# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1155# generated. Documented entities will be cross-referenced with these sources. 1156# 1157# Note: To get rid of all source code in the generated output, make sure that 1158# also VERBATIM_HEADERS is set to NO. 1159# The default value is: NO. 1160 1161SOURCE_BROWSER = @do_html@ 1162 1163# Setting the INLINE_SOURCES tag to YES will include the body of functions, 1164# classes and enums directly into the documentation. 1165# The default value is: NO. 1166 1167INLINE_SOURCES = NO 1168 1169# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1170# special comment blocks from generated source code fragments. Normal C, C++ and 1171# Fortran comments will always remain visible. 1172# The default value is: YES. 1173 1174STRIP_CODE_COMMENTS = NO 1175 1176# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1177# function all documented functions referencing it will be listed. 1178# The default value is: NO. 1179 1180REFERENCED_BY_RELATION = YES 1181 1182# If the REFERENCES_RELATION tag is set to YES then for each documented function 1183# all documented entities called/used by that function will be listed. 1184# The default value is: NO. 1185 1186REFERENCES_RELATION = YES 1187 1188# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1189# to YES then the hyperlinks from functions in REFERENCES_RELATION and 1190# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1191# link to the documentation. 1192# The default value is: YES. 1193 1194REFERENCES_LINK_SOURCE = YES 1195 1196# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1197# source code will show a tooltip with additional information such as prototype, 1198# brief description and links to the definition and documentation. Since this 1199# will make the HTML file larger and loading of large files a bit slower, you 1200# can opt to disable this feature. 1201# The default value is: YES. 1202# This tag requires that the tag SOURCE_BROWSER is set to YES. 1203 1204SOURCE_TOOLTIPS = YES 1205 1206# If the USE_HTAGS tag is set to YES then the references to source code will 1207# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1208# source browser. The htags tool is part of GNU's global source tagging system 1209# (see https://www.gnu.org/software/global/global.html). You will need version 1210# 4.8.6 or higher. 1211# 1212# To use it do the following: 1213# - Install the latest version of global 1214# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1215# - Make sure the INPUT points to the root of the source tree 1216# - Run doxygen as normal 1217# 1218# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1219# tools must be available from the command line (i.e. in the search path). 1220# 1221# The result: instead of the source browser generated by doxygen, the links to 1222# source code will now point to the output of htags. 1223# The default value is: NO. 1224# This tag requires that the tag SOURCE_BROWSER is set to YES. 1225 1226USE_HTAGS = NO 1227 1228# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1229# verbatim copy of the header file for each class for which an include is 1230# specified. Set to NO to disable this. 1231# See also: Section \class. 1232# The default value is: YES. 1233 1234VERBATIM_HEADERS = NO 1235 1236#--------------------------------------------------------------------------- 1237# Configuration options related to the alphabetical class index 1238#--------------------------------------------------------------------------- 1239 1240# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1241# compounds will be generated. Enable this if the project contains a lot of 1242# classes, structs, unions or interfaces. 1243# The default value is: YES. 1244 1245ALPHABETICAL_INDEX = YES 1246 1247# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1248# which the alphabetical index list will be split. 1249# Minimum value: 1, maximum value: 20, default value: 5. 1250# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1251 1252COLS_IN_ALPHA_INDEX = 2 1253 1254# In case all classes in a project start with a common prefix, all classes will 1255# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1256# can be used to specify a prefix (or a list of prefixes) that should be ignored 1257# while generating the index headers. 1258# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1259 1260IGNORE_PREFIX = 1261 1262#--------------------------------------------------------------------------- 1263# Configuration options related to the HTML output 1264#--------------------------------------------------------------------------- 1265 1266# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1267# The default value is: YES. 1268 1269GENERATE_HTML = @do_html@ 1270 1271# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1272# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1273# it. 1274# The default directory is: html. 1275# This tag requires that the tag GENERATE_HTML is set to YES. 1276 1277HTML_OUTPUT = html 1278 1279# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1280# generated HTML page (for example: .htm, .php, .asp). 1281# The default value is: .html. 1282# This tag requires that the tag GENERATE_HTML is set to YES. 1283 1284HTML_FILE_EXTENSION = .html 1285 1286# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1287# each generated HTML page. If the tag is left blank doxygen will generate a 1288# standard header. 1289# 1290# To get valid HTML the header file that includes any scripts and style sheets 1291# that doxygen needs, which is dependent on the configuration options used (e.g. 1292# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1293# default header using 1294# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1295# YourConfigFile 1296# and then modify the file new_header.html. See also section "Doxygen usage" 1297# for information on how to generate the default header that doxygen normally 1298# uses. 1299# Note: The header is subject to change so you typically have to regenerate the 1300# default header when upgrading to a newer version of doxygen. For a description 1301# of the possible markers and block names see the documentation. 1302# This tag requires that the tag GENERATE_HTML is set to YES. 1303 1304HTML_HEADER = 1305 1306# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1307# generated HTML page. If the tag is left blank doxygen will generate a standard 1308# footer. See HTML_HEADER for more information on how to generate a default 1309# footer and what special commands can be used inside the footer. See also 1310# section "Doxygen usage" for information on how to generate the default footer 1311# that doxygen normally uses. 1312# This tag requires that the tag GENERATE_HTML is set to YES. 1313 1314HTML_FOOTER = 1315 1316# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1317# sheet that is used by each HTML page. It can be used to fine-tune the look of 1318# the HTML output. If left blank doxygen will generate a default style sheet. 1319# See also section "Doxygen usage" for information on how to generate the style 1320# sheet that doxygen normally uses. 1321# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1322# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1323# obsolete. 1324# This tag requires that the tag GENERATE_HTML is set to YES. 1325 1326HTML_STYLESHEET = 1327 1328# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1329# cascading style sheets that are included after the standard style sheets 1330# created by doxygen. Using this option one can overrule certain style aspects. 1331# This is preferred over using HTML_STYLESHEET since it does not replace the 1332# standard style sheet and is therefore more robust against future updates. 1333# Doxygen will copy the style sheet files to the output directory. 1334# Note: The order of the extra style sheet files is of importance (e.g. the last 1335# style sheet in the list overrules the setting of the previous ones in the 1336# list). For an example see the documentation. 1337# This tag requires that the tag GENERATE_HTML is set to YES. 1338 1339HTML_EXTRA_STYLESHEET = 1340 1341# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1342# other source files which should be copied to the HTML output directory. Note 1343# that these files will be copied to the base HTML output directory. Use the 1344# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1345# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1346# files will be copied as-is; there are no commands or markers available. 1347# This tag requires that the tag GENERATE_HTML is set to YES. 1348 1349HTML_EXTRA_FILES = 1350 1351# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1352# will adjust the colors in the style sheet and background images according to 1353# this color. Hue is specified as an angle on a colorwheel, see 1354# https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1355# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1356# purple, and 360 is red again. 1357# Minimum value: 0, maximum value: 359, default value: 220. 1358# This tag requires that the tag GENERATE_HTML is set to YES. 1359 1360HTML_COLORSTYLE_HUE = 220 1361 1362# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1363# in the HTML output. For a value of 0 the output will use grayscales only. A 1364# value of 255 will produce the most vivid colors. 1365# Minimum value: 0, maximum value: 255, default value: 100. 1366# This tag requires that the tag GENERATE_HTML is set to YES. 1367 1368HTML_COLORSTYLE_SAT = 100 1369 1370# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1371# luminance component of the colors in the HTML output. Values below 100 1372# gradually make the output lighter, whereas values above 100 make the output 1373# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1374# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1375# change the gamma. 1376# Minimum value: 40, maximum value: 240, default value: 80. 1377# This tag requires that the tag GENERATE_HTML is set to YES. 1378 1379HTML_COLORSTYLE_GAMMA = 80 1380 1381# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1382# page will contain the date and time when the page was generated. Setting this 1383# to YES can help to show when doxygen was last run and thus if the 1384# documentation is up to date. 1385# The default value is: NO. 1386# This tag requires that the tag GENERATE_HTML is set to YES. 1387 1388HTML_TIMESTAMP = NO 1389 1390# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1391# documentation will contain a main index with vertical navigation menus that 1392# are dynamically created via Javascript. If disabled, the navigation index will 1393# consists of multiple levels of tabs that are statically embedded in every HTML 1394# page. Disable this option to support browsers that do not have Javascript, 1395# like the Qt help browser. 1396# The default value is: YES. 1397# This tag requires that the tag GENERATE_HTML is set to YES. 1398 1399HTML_DYNAMIC_MENUS = YES 1400 1401# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1402# documentation will contain sections that can be hidden and shown after the 1403# page has loaded. 1404# The default value is: NO. 1405# This tag requires that the tag GENERATE_HTML is set to YES. 1406 1407HTML_DYNAMIC_SECTIONS = NO 1408 1409# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1410# shown in the various tree structured indices initially; the user can expand 1411# and collapse entries dynamically later on. Doxygen will expand the tree to 1412# such a level that at most the specified number of entries are visible (unless 1413# a fully collapsed tree already exceeds this amount). So setting the number of 1414# entries 1 will produce a full collapsed tree by default. 0 is a special value 1415# representing an infinite number of entries and will result in a full expanded 1416# tree by default. 1417# Minimum value: 0, maximum value: 9999, default value: 100. 1418# This tag requires that the tag GENERATE_HTML is set to YES. 1419 1420HTML_INDEX_NUM_ENTRIES = 0 1421 1422# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1423# generated that can be used as input for Apple's Xcode 3 integrated development 1424# environment (see: https://developer.apple.com/tools/xcode/), introduced with 1425# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1426# Makefile in the HTML output directory. Running make will produce the docset in 1427# that directory and running make install will install the docset in 1428# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1429# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1430# for more information. 1431# The default value is: NO. 1432# This tag requires that the tag GENERATE_HTML is set to YES. 1433 1434GENERATE_DOCSET = NO 1435 1436# This tag determines the name of the docset feed. A documentation feed provides 1437# an umbrella under which multiple documentation sets from a single provider 1438# (such as a company or product suite) can be grouped. 1439# The default value is: Doxygen generated docs. 1440# This tag requires that the tag GENERATE_DOCSET is set to YES. 1441 1442DOCSET_FEEDNAME = "Doxygen generated docs" 1443 1444# This tag specifies a string that should uniquely identify the documentation 1445# set bundle. This should be a reverse domain-name style string, e.g. 1446# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1447# The default value is: org.doxygen.Project. 1448# This tag requires that the tag GENERATE_DOCSET is set to YES. 1449 1450DOCSET_BUNDLE_ID = org.gnu.libstdc++ 1451 1452# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1453# the documentation publisher. This should be a reverse domain-name style 1454# string, e.g. com.mycompany.MyDocSet.documentation. 1455# The default value is: org.doxygen.Publisher. 1456# This tag requires that the tag GENERATE_DOCSET is set to YES. 1457 1458DOCSET_PUBLISHER_ID = org.fsf 1459 1460# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1461# The default value is: Publisher. 1462# This tag requires that the tag GENERATE_DOCSET is set to YES. 1463 1464DOCSET_PUBLISHER_NAME = libstdc++ 1465 1466# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1467# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1468# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1469# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1470# Windows. 1471# 1472# The HTML Help Workshop contains a compiler that can convert all HTML output 1473# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1474# files are now used as the Windows 98 help format, and will replace the old 1475# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1476# HTML files also contain an index, a table of contents, and you can search for 1477# words in the documentation. The HTML workshop also contains a viewer for 1478# compressed HTML files. 1479# The default value is: NO. 1480# This tag requires that the tag GENERATE_HTML is set to YES. 1481 1482GENERATE_HTMLHELP = NO 1483 1484# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1485# file. You can add a path in front of the file if the result should not be 1486# written to the html output directory. 1487# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1488 1489CHM_FILE = 1490 1491# The HHC_LOCATION tag can be used to specify the location (absolute path 1492# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1493# doxygen will try to run the HTML help compiler on the generated index.hhp. 1494# The file has to be specified with full path. 1495# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1496 1497HHC_LOCATION = 1498 1499# The GENERATE_CHI flag controls if a separate .chi index file is generated 1500# (YES) or that it should be included in the master .chm file (NO). 1501# The default value is: NO. 1502# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1503 1504GENERATE_CHI = NO 1505 1506# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1507# and project file content. 1508# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1509 1510CHM_INDEX_ENCODING = 1511 1512# The BINARY_TOC flag controls whether a binary table of contents is generated 1513# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1514# enables the Previous and Next buttons. 1515# The default value is: NO. 1516# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1517 1518BINARY_TOC = NO 1519 1520# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1521# the table of contents of the HTML help documentation and to the tree view. 1522# The default value is: NO. 1523# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1524 1525TOC_EXPAND = NO 1526 1527# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1528# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1529# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1530# (.qch) of the generated HTML documentation. 1531# The default value is: NO. 1532# This tag requires that the tag GENERATE_HTML is set to YES. 1533 1534GENERATE_QHP = NO 1535 1536# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1537# the file name of the resulting .qch file. The path specified is relative to 1538# the HTML output folder. 1539# This tag requires that the tag GENERATE_QHP is set to YES. 1540 1541QCH_FILE = 1542 1543# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1544# Project output. For more information please see Qt Help Project / Namespace 1545# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). 1546# The default value is: org.doxygen.Project. 1547# This tag requires that the tag GENERATE_QHP is set to YES. 1548 1549QHP_NAMESPACE = org.doxygen.Project 1550 1551# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1552# Help Project output. For more information please see Qt Help Project / Virtual 1553# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). 1554# The default value is: doc. 1555# This tag requires that the tag GENERATE_QHP is set to YES. 1556 1557QHP_VIRTUAL_FOLDER = doc 1558 1559# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1560# filter to add. For more information please see Qt Help Project / Custom 1561# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). 1562# This tag requires that the tag GENERATE_QHP is set to YES. 1563 1564QHP_CUST_FILTER_NAME = 1565 1566# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1567# custom filter to add. For more information please see Qt Help Project / Custom 1568# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). 1569# This tag requires that the tag GENERATE_QHP is set to YES. 1570 1571QHP_CUST_FILTER_ATTRS = 1572 1573# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1574# project's filter section matches. Qt Help Project / Filter Attributes (see: 1575# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). 1576# This tag requires that the tag GENERATE_QHP is set to YES. 1577 1578QHP_SECT_FILTER_ATTRS = 1579 1580# The QHG_LOCATION tag can be used to specify the location of Qt's 1581# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1582# generated .qhp file. 1583# This tag requires that the tag GENERATE_QHP is set to YES. 1584 1585QHG_LOCATION = 1586 1587# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1588# generated, together with the HTML files, they form an Eclipse help plugin. To 1589# install this plugin and make it available under the help contents menu in 1590# Eclipse, the contents of the directory containing the HTML and XML files needs 1591# to be copied into the plugins directory of eclipse. The name of the directory 1592# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1593# After copying Eclipse needs to be restarted before the help appears. 1594# The default value is: NO. 1595# This tag requires that the tag GENERATE_HTML is set to YES. 1596 1597GENERATE_ECLIPSEHELP = NO 1598 1599# A unique identifier for the Eclipse help plugin. When installing the plugin 1600# the directory name containing the HTML and XML files should also have this 1601# name. Each documentation set should have its own identifier. 1602# The default value is: org.doxygen.Project. 1603# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1604 1605ECLIPSE_DOC_ID = org.doxygen.Project 1606 1607# If you want full control over the layout of the generated HTML pages it might 1608# be necessary to disable the index and replace it with your own. The 1609# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1610# of each HTML page. A value of NO enables the index and the value YES disables 1611# it. Since the tabs in the index contain the same information as the navigation 1612# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1613# The default value is: NO. 1614# This tag requires that the tag GENERATE_HTML is set to YES. 1615 1616DISABLE_INDEX = YES 1617 1618# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1619# structure should be generated to display hierarchical information. If the tag 1620# value is set to YES, a side panel will be generated containing a tree-like 1621# index structure (just like the one that is generated for HTML Help). For this 1622# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1623# (i.e. any modern browser). Windows users are probably better off using the 1624# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1625# further fine-tune the look of the index. As an example, the default style 1626# sheet generated by doxygen has an example that shows how to put an image at 1627# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1628# the same information as the tab index, you could consider setting 1629# DISABLE_INDEX to YES when enabling this option. 1630# The default value is: NO. 1631# This tag requires that the tag GENERATE_HTML is set to YES. 1632 1633GENERATE_TREEVIEW = YES 1634 1635# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1636# doxygen will group on one line in the generated HTML documentation. 1637# 1638# Note that a value of 0 will completely suppress the enum values from appearing 1639# in the overview section. 1640# Minimum value: 0, maximum value: 20, default value: 4. 1641# This tag requires that the tag GENERATE_HTML is set to YES. 1642 1643ENUM_VALUES_PER_LINE = 4 1644 1645# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1646# to set the initial width (in pixels) of the frame in which the tree is shown. 1647# Minimum value: 0, maximum value: 1500, default value: 250. 1648# This tag requires that the tag GENERATE_HTML is set to YES. 1649 1650TREEVIEW_WIDTH = 250 1651 1652# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1653# external symbols imported via tag files in a separate window. 1654# The default value is: NO. 1655# This tag requires that the tag GENERATE_HTML is set to YES. 1656 1657EXT_LINKS_IN_WINDOW = NO 1658 1659# Use this tag to change the font size of LaTeX formulas included as images in 1660# the HTML documentation. When you change the font size after a successful 1661# doxygen run you need to manually remove any form_*.png images from the HTML 1662# output directory to force them to be regenerated. 1663# Minimum value: 8, maximum value: 50, default value: 10. 1664# This tag requires that the tag GENERATE_HTML is set to YES. 1665 1666FORMULA_FONTSIZE = 10 1667 1668# Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1669# generated for formulas are transparent PNGs. Transparent PNGs are not 1670# supported properly for IE 6.0, but are supported on all modern browsers. 1671# 1672# Note that when changing this option you need to delete any form_*.png files in 1673# the HTML output directory before the changes have effect. 1674# The default value is: YES. 1675# This tag requires that the tag GENERATE_HTML is set to YES. 1676 1677FORMULA_TRANSPARENT = YES 1678 1679# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1680# https://www.mathjax.org) which uses client side Javascript for the rendering 1681# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1682# installed or if you want to formulas look prettier in the HTML output. When 1683# enabled you may also need to install MathJax separately and configure the path 1684# to it using the MATHJAX_RELPATH option. 1685# The default value is: NO. 1686# This tag requires that the tag GENERATE_HTML is set to YES. 1687 1688USE_MATHJAX = NO 1689 1690# When MathJax is enabled you can set the default output format to be used for 1691# the MathJax output. See the MathJax site (see: 1692# http://docs.mathjax.org/en/latest/output.html) for more details. 1693# Possible values are: HTML-CSS (which is slower, but has the best 1694# compatibility), NativeMML (i.e. MathML) and SVG. 1695# The default value is: HTML-CSS. 1696# This tag requires that the tag USE_MATHJAX is set to YES. 1697 1698MATHJAX_FORMAT = HTML-CSS 1699 1700# When MathJax is enabled you need to specify the location relative to the HTML 1701# output directory using the MATHJAX_RELPATH option. The destination directory 1702# should contain the MathJax.js script. For instance, if the mathjax directory 1703# is located at the same level as the HTML output directory, then 1704# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1705# Content Delivery Network so you can quickly see the result without installing 1706# MathJax. However, it is strongly recommended to install a local copy of 1707# MathJax from https://www.mathjax.org before deployment. 1708# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. 1709# This tag requires that the tag USE_MATHJAX is set to YES. 1710 1711MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1712 1713# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1714# extension names that should be enabled during MathJax rendering. For example 1715# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1716# This tag requires that the tag USE_MATHJAX is set to YES. 1717 1718MATHJAX_EXTENSIONS = 1719 1720# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1721# of code that will be used on startup of the MathJax code. See the MathJax site 1722# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1723# example see the documentation. 1724# This tag requires that the tag USE_MATHJAX is set to YES. 1725 1726MATHJAX_CODEFILE = 1727 1728# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1729# the HTML output. The underlying search engine uses javascript and DHTML and 1730# should work on any modern browser. Note that when using HTML help 1731# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1732# there is already a search function so this one should typically be disabled. 1733# For large projects the javascript based search engine can be slow, then 1734# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1735# search using the keyboard; to jump to the search box use <access key> + S 1736# (what the <access key> is depends on the OS and browser, but it is typically 1737# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1738# key> to jump into the search results window, the results can be navigated 1739# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1740# the search. The filter options can be selected when the cursor is inside the 1741# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1742# to select a filter and <Enter> or <escape> to activate or cancel the filter 1743# option. 1744# The default value is: YES. 1745# This tag requires that the tag GENERATE_HTML is set to YES. 1746 1747SEARCHENGINE = NO 1748 1749# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1750# implemented using a web server instead of a web client using Javascript. There 1751# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1752# setting. When disabled, doxygen will generate a PHP script for searching and 1753# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1754# and searching needs to be provided by external tools. See the section 1755# "External Indexing and Searching" for details. 1756# The default value is: NO. 1757# This tag requires that the tag SEARCHENGINE is set to YES. 1758 1759SERVER_BASED_SEARCH = NO 1760 1761# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1762# script for searching. Instead the search results are written to an XML file 1763# which needs to be processed by an external indexer. Doxygen will invoke an 1764# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1765# search results. 1766# 1767# Doxygen ships with an example indexer (doxyindexer) and search engine 1768# (doxysearch.cgi) which are based on the open source search engine library 1769# Xapian (see: https://xapian.org/). 1770# 1771# See the section "External Indexing and Searching" for details. 1772# The default value is: NO. 1773# This tag requires that the tag SEARCHENGINE is set to YES. 1774 1775EXTERNAL_SEARCH = NO 1776 1777# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1778# which will return the search results when EXTERNAL_SEARCH is enabled. 1779# 1780# Doxygen ships with an example indexer (doxyindexer) and search engine 1781# (doxysearch.cgi) which are based on the open source search engine library 1782# Xapian (see: https://xapian.org/). See the section "External Indexing and 1783# Searching" for details. 1784# This tag requires that the tag SEARCHENGINE is set to YES. 1785 1786SEARCHENGINE_URL = 1787 1788# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1789# search data is written to a file for indexing by an external tool. With the 1790# SEARCHDATA_FILE tag the name of this file can be specified. 1791# The default file is: searchdata.xml. 1792# This tag requires that the tag SEARCHENGINE is set to YES. 1793 1794SEARCHDATA_FILE = searchdata.xml 1795 1796# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1797# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1798# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1799# projects and redirect the results back to the right project. 1800# This tag requires that the tag SEARCHENGINE is set to YES. 1801 1802EXTERNAL_SEARCH_ID = 1803 1804# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1805# projects other than the one defined by this configuration file, but that are 1806# all added to the same external search index. Each project needs to have a 1807# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1808# to a relative location where the documentation can be found. The format is: 1809# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1810# This tag requires that the tag SEARCHENGINE is set to YES. 1811 1812EXTRA_SEARCH_MAPPINGS = 1813 1814#--------------------------------------------------------------------------- 1815# Configuration options related to the LaTeX output 1816#--------------------------------------------------------------------------- 1817 1818# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1819# The default value is: YES. 1820 1821GENERATE_LATEX = @do_latex@ 1822 1823# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1824# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1825# it. 1826# The default directory is: latex. 1827# This tag requires that the tag GENERATE_LATEX is set to YES. 1828 1829LATEX_OUTPUT = latex 1830 1831# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1832# invoked. 1833# 1834# Note that when enabling USE_PDFLATEX this option is only used for generating 1835# bitmaps for formulas in the HTML output, but not in the Makefile that is 1836# written to the output directory. 1837# The default file is: latex. 1838# This tag requires that the tag GENERATE_LATEX is set to YES. 1839 1840LATEX_CMD_NAME = 1841 1842# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1843# index for LaTeX. 1844# The default file is: makeindex. 1845# This tag requires that the tag GENERATE_LATEX is set to YES. 1846 1847MAKEINDEX_CMD_NAME = makeindex 1848 1849# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1850# documents. This may be useful for small projects and may help to save some 1851# trees in general. 1852# The default value is: NO. 1853# This tag requires that the tag GENERATE_LATEX is set to YES. 1854 1855COMPACT_LATEX = YES 1856 1857# The PAPER_TYPE tag can be used to set the paper type that is used by the 1858# printer. 1859# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1860# 14 inches) and executive (7.25 x 10.5 inches). 1861# The default value is: a4. 1862# This tag requires that the tag GENERATE_LATEX is set to YES. 1863 1864PAPER_TYPE = letter 1865 1866# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1867# that should be included in the LaTeX output. The package can be specified just 1868# by its name or with the correct syntax as to be used with the LaTeX 1869# \usepackage command. To get the times font for instance you can specify : 1870# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1871# To use the option intlimits with the amsmath package you can specify: 1872# EXTRA_PACKAGES=[intlimits]{amsmath} 1873# If left blank no extra packages will be included. 1874# This tag requires that the tag GENERATE_LATEX is set to YES. 1875 1876EXTRA_PACKAGES = amsmath 1877 1878# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1879# generated LaTeX document. The header should contain everything until the first 1880# chapter. If it is left blank doxygen will generate a standard header. See 1881# section "Doxygen usage" for information on how to let doxygen write the 1882# default header to a separate file. 1883# 1884# Note: Only use a user-defined header if you know what you are doing! The 1885# following commands have a special meaning inside the header: $title, 1886# $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1887# $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1888# string, for the replacement values of the other commands the user is referred 1889# to HTML_HEADER. 1890# This tag requires that the tag GENERATE_LATEX is set to YES. 1891 1892LATEX_HEADER = 1893 1894# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1895# generated LaTeX document. The footer should contain everything after the last 1896# chapter. If it is left blank doxygen will generate a standard footer. See 1897# LATEX_HEADER for more information on how to generate a default footer and what 1898# special commands can be used inside the footer. 1899# 1900# Note: Only use a user-defined footer if you know what you are doing! 1901# This tag requires that the tag GENERATE_LATEX is set to YES. 1902 1903LATEX_FOOTER = 1904 1905# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1906# LaTeX style sheets that are included after the standard style sheets created 1907# by doxygen. Using this option one can overrule certain style aspects. Doxygen 1908# will copy the style sheet files to the output directory. 1909# Note: The order of the extra style sheet files is of importance (e.g. the last 1910# style sheet in the list overrules the setting of the previous ones in the 1911# list). 1912# This tag requires that the tag GENERATE_LATEX is set to YES. 1913 1914LATEX_EXTRA_STYLESHEET = 1915 1916# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1917# other source files which should be copied to the LATEX_OUTPUT output 1918# directory. Note that the files will be copied as-is; there are no commands or 1919# markers available. 1920# This tag requires that the tag GENERATE_LATEX is set to YES. 1921 1922LATEX_EXTRA_FILES = 1923 1924# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1925# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1926# contain links (just like the HTML output) instead of page references. This 1927# makes the output suitable for online browsing using a PDF viewer. 1928# The default value is: YES. 1929# This tag requires that the tag GENERATE_LATEX is set to YES. 1930 1931PDF_HYPERLINKS = YES 1932 1933# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1934# the PDF file directly from the LaTeX files. Set this option to YES, to get a 1935# higher quality PDF documentation. 1936# The default value is: YES. 1937# This tag requires that the tag GENERATE_LATEX is set to YES. 1938 1939USE_PDFLATEX = YES 1940 1941# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1942# command to the generated LaTeX files. This will instruct LaTeX to keep running 1943# if errors occur, instead of asking the user for help. This option is also used 1944# when generating formulas in HTML. 1945# The default value is: NO. 1946# This tag requires that the tag GENERATE_LATEX is set to YES. 1947 1948LATEX_BATCHMODE = YES 1949 1950# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1951# index chapters (such as File Index, Compound Index, etc.) in the output. 1952# The default value is: NO. 1953# This tag requires that the tag GENERATE_LATEX is set to YES. 1954 1955LATEX_HIDE_INDICES = YES 1956 1957# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1958# code with syntax highlighting in the LaTeX output. 1959# 1960# Note that which sources are shown also depends on other settings such as 1961# SOURCE_BROWSER. 1962# The default value is: NO. 1963# This tag requires that the tag GENERATE_LATEX is set to YES. 1964 1965LATEX_SOURCE_CODE = NO 1966 1967# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1968# bibliography, e.g. plainnat, or ieeetr. See 1969# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1970# The default value is: plain. 1971# This tag requires that the tag GENERATE_LATEX is set to YES. 1972 1973LATEX_BIB_STYLE = plain 1974 1975# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1976# page will contain the date and time when the page was generated. Setting this 1977# to NO can help when comparing the output of multiple runs. 1978# The default value is: NO. 1979# This tag requires that the tag GENERATE_LATEX is set to YES. 1980 1981LATEX_TIMESTAMP = NO 1982 1983#--------------------------------------------------------------------------- 1984# Configuration options related to the RTF output 1985#--------------------------------------------------------------------------- 1986 1987# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1988# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1989# readers/editors. 1990# The default value is: NO. 1991 1992GENERATE_RTF = NO 1993 1994# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1995# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1996# it. 1997# The default directory is: rtf. 1998# This tag requires that the tag GENERATE_RTF is set to YES. 1999 2000RTF_OUTPUT = rtf 2001 2002# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 2003# documents. This may be useful for small projects and may help to save some 2004# trees in general. 2005# The default value is: NO. 2006# This tag requires that the tag GENERATE_RTF is set to YES. 2007 2008COMPACT_RTF = NO 2009 2010# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 2011# contain hyperlink fields. The RTF file will contain links (just like the HTML 2012# output) instead of page references. This makes the output suitable for online 2013# browsing using Word or some other Word compatible readers that support those 2014# fields. 2015# 2016# Note: WordPad (write) and others do not support links. 2017# The default value is: NO. 2018# This tag requires that the tag GENERATE_RTF is set to YES. 2019 2020RTF_HYPERLINKS = NO 2021 2022# Load stylesheet definitions from file. Syntax is similar to doxygen's config 2023# file, i.e. a series of assignments. You only have to provide replacements, 2024# missing definitions are set to their default value. 2025# 2026# See also section "Doxygen usage" for information on how to generate the 2027# default style sheet that doxygen normally uses. 2028# This tag requires that the tag GENERATE_RTF is set to YES. 2029 2030RTF_STYLESHEET_FILE = 2031 2032# Set optional variables used in the generation of an RTF document. Syntax is 2033# similar to doxygen's config file. A template extensions file can be generated 2034# using doxygen -e rtf extensionFile. 2035# This tag requires that the tag GENERATE_RTF is set to YES. 2036 2037RTF_EXTENSIONS_FILE = 2038 2039# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 2040# with syntax highlighting in the RTF output. 2041# 2042# Note that which sources are shown also depends on other settings such as 2043# SOURCE_BROWSER. 2044# The default value is: NO. 2045# This tag requires that the tag GENERATE_RTF is set to YES. 2046 2047RTF_SOURCE_CODE = NO 2048 2049#--------------------------------------------------------------------------- 2050# Configuration options related to the man page output 2051#--------------------------------------------------------------------------- 2052 2053# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 2054# classes and files. 2055# The default value is: NO. 2056 2057GENERATE_MAN = @do_man@ 2058 2059# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 2060# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2061# it. A directory man3 will be created inside the directory specified by 2062# MAN_OUTPUT. 2063# The default directory is: man. 2064# This tag requires that the tag GENERATE_MAN is set to YES. 2065 2066MAN_OUTPUT = man 2067 2068# The MAN_EXTENSION tag determines the extension that is added to the generated 2069# man pages. In case the manual section does not start with a number, the number 2070# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 2071# optional. 2072# The default value is: .3. 2073# This tag requires that the tag GENERATE_MAN is set to YES. 2074 2075MAN_EXTENSION = .3 2076 2077# The MAN_SUBDIR tag determines the name of the directory created within 2078# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 2079# MAN_EXTENSION with the initial . removed. 2080# This tag requires that the tag GENERATE_MAN is set to YES. 2081 2082MAN_SUBDIR = 2083 2084# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 2085# will generate one additional man file for each entity documented in the real 2086# man page(s). These additional files only source the real man page, but without 2087# them the man command would be unable to find the correct page. 2088# The default value is: NO. 2089# This tag requires that the tag GENERATE_MAN is set to YES. 2090 2091MAN_LINKS = NO 2092 2093#--------------------------------------------------------------------------- 2094# Configuration options related to the XML output 2095#--------------------------------------------------------------------------- 2096 2097# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 2098# captures the structure of the code including all documentation. 2099# The default value is: NO. 2100 2101GENERATE_XML = @do_xml@ 2102 2103# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 2104# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2105# it. 2106# The default directory is: xml. 2107# This tag requires that the tag GENERATE_XML is set to YES. 2108 2109XML_OUTPUT = xml 2110 2111# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 2112# listings (including syntax highlighting and cross-referencing information) to 2113# the XML output. Note that enabling this will significantly increase the size 2114# of the XML output. 2115# The default value is: YES. 2116# This tag requires that the tag GENERATE_XML is set to YES. 2117 2118XML_PROGRAMLISTING = NO 2119 2120#--------------------------------------------------------------------------- 2121# Configuration options related to the DOCBOOK output 2122#--------------------------------------------------------------------------- 2123 2124# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 2125# that can be used to generate PDF. 2126# The default value is: NO. 2127 2128GENERATE_DOCBOOK = NO 2129 2130# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 2131# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 2132# front of it. 2133# The default directory is: docbook. 2134# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2135 2136DOCBOOK_OUTPUT = docbook 2137 2138# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 2139# program listings (including syntax highlighting and cross-referencing 2140# information) to the DOCBOOK output. Note that enabling this will significantly 2141# increase the size of the DOCBOOK output. 2142# The default value is: NO. 2143# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2144 2145DOCBOOK_PROGRAMLISTING = NO 2146 2147#--------------------------------------------------------------------------- 2148# Configuration options for the AutoGen Definitions output 2149#--------------------------------------------------------------------------- 2150 2151# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 2152# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2153# the structure of the code including all documentation. Note that this feature 2154# is still experimental and incomplete at the moment. 2155# The default value is: NO. 2156 2157GENERATE_AUTOGEN_DEF = NO 2158 2159#--------------------------------------------------------------------------- 2160# Configuration options related to the Perl module output 2161#--------------------------------------------------------------------------- 2162 2163# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 2164# file that captures the structure of the code including all documentation. 2165# 2166# Note that this feature is still experimental and incomplete at the moment. 2167# The default value is: NO. 2168 2169GENERATE_PERLMOD = NO 2170 2171# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2172# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2173# output from the Perl module output. 2174# The default value is: NO. 2175# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2176 2177PERLMOD_LATEX = NO 2178 2179# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2180# formatted so it can be parsed by a human reader. This is useful if you want to 2181# understand what is going on. On the other hand, if this tag is set to NO, the 2182# size of the Perl module output will be much smaller and Perl will parse it 2183# just the same. 2184# The default value is: YES. 2185# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2186 2187PERLMOD_PRETTY = YES 2188 2189# The names of the make variables in the generated doxyrules.make file are 2190# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2191# so different doxyrules.make files included by the same Makefile don't 2192# overwrite each other's variables. 2193# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2194 2195PERLMOD_MAKEVAR_PREFIX = 2196 2197#--------------------------------------------------------------------------- 2198# Configuration options related to the preprocessor 2199#--------------------------------------------------------------------------- 2200 2201# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2202# C-preprocessor directives found in the sources and include files. 2203# The default value is: YES. 2204 2205ENABLE_PREPROCESSING = YES 2206 2207# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2208# in the source code. If set to NO, only conditional compilation will be 2209# performed. Macro expansion can be done in a controlled way by setting 2210# EXPAND_ONLY_PREDEF to YES. 2211# The default value is: NO. 2212# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2213 2214MACRO_EXPANSION = YES 2215 2216# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2217# the macro expansion is limited to the macros specified with the PREDEFINED and 2218# EXPAND_AS_DEFINED tags. 2219# The default value is: NO. 2220# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2221 2222EXPAND_ONLY_PREDEF = NO 2223 2224# If the SEARCH_INCLUDES tag is set to YES, the include files in the 2225# INCLUDE_PATH will be searched if a #include is found. 2226# The default value is: YES. 2227# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2228 2229SEARCH_INCLUDES = YES 2230 2231# The INCLUDE_PATH tag can be used to specify one or more directories that 2232# contain include files that are not input files but should be processed by the 2233# preprocessor. 2234# This tag requires that the tag SEARCH_INCLUDES is set to YES. 2235 2236INCLUDE_PATH = include 2237 2238# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2239# patterns (like *.h and *.hpp) to filter out the header-files in the 2240# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2241# used. 2242# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2243 2244INCLUDE_FILE_PATTERNS = 2245 2246# The PREDEFINED tag can be used to specify one or more macro names that are 2247# defined before the preprocessor is started (similar to the -D option of e.g. 2248# gcc). The argument of the tag is a list of macros of the form: name or 2249# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2250# is assumed. To prevent a macro definition from being undefined via #undef or 2251# recursively expanded use the := operator instead of the = operator. 2252# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2253 2254PREDEFINED = __cplusplus=201402L \ 2255 __GTHREADS \ 2256 _GLIBCXX_HAS_GTHREADS \ 2257 _GLIBCXX_HAVE_TLS \ 2258 _GLIBCXX_INCLUDE_AS_CXX11 \ 2259 "_GLIBCXX_PURE= " \ 2260 "_GLIBCXX_CONST= " \ 2261 "_GLIBCXX_NODISCARD=[[nodiscard]]" \ 2262 "_GLIBCXX_NORETURN= " \ 2263 "_GLIBCXX_NOEXCEPT_PARM= " \ 2264 "_GLIBCXX_NOEXCEPT_QUAL= " \ 2265 "_GLIBCXX_STD_C= " \ 2266 "_GLIBCXX_STD_A= " \ 2267 "_GLIBCXX_TXN_SAFE_DYN= " \ 2268 "_GLIBCXX_VISIBILITY(V)= " \ 2269 "_GLIBCXX_BEGIN_NAMESPACE_VERSION= " \ 2270 "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \ 2271 "_GLIBCXX_BEGIN_NAMESPACE_CONTAINER= " \ 2272 "_GLIBCXX_BEGIN_NAMESPACE_CXX11= " \ 2273 "_GLIBCXX_BEGIN_NAMESPACE_LDBL= " \ 2274 "_GLIBCXX_END_NAMESPACE_VERSION= " \ 2275 "_GLIBCXX_END_NAMESPACE_ALGO= " \ 2276 "_GLIBCXX_END_NAMESPACE_CONTAINER= " \ 2277 "_GLIBCXX_END_NAMESPACE_CXX11= " \ 2278 "_GLIBCXX_END_NAMESPACE_LDBL= " \ 2279 "_GLIBCXX_TEMPLATE_ARGS=... " \ 2280 _GLIBCXX_DEPRECATED \ 2281 _GLIBCXX_CONSTEXPR=constexpr \ 2282 _GLIBCXX_USE_CONSTEXPR=constexpr \ 2283 "_GLIBCXX_THROW(E)= " \ 2284 _GLIBCXX_NOEXCEPT=noexcept \ 2285 "_GLIBCXX_NOEXCEPT_IF(C)=noexcept(/*conditional*/)" \ 2286 _GLIBCXX_NOTHROW=noexcept \ 2287 _GLIBCXX_USE_NOEXCEPT=noexcept \ 2288 _GLIBCXX_USE_WCHAR_T \ 2289 _GLIBCXX_USE_LONG_LONG \ 2290 _GLIBCXX_USE_C99_STDINT_TR1 \ 2291 _GLIBCXX_USE_SCHED_YIELD \ 2292 _GLIBCXX_USE_NANOSLEEP \ 2293 __cpp_exceptions \ 2294 __cpp_rtti \ 2295 ATOMIC_INT_LOCK_FREE=2 \ 2296 PB_DS_DATA_TRUE_INDICATOR \ 2297 PB_DS_STATIC_ASSERT=// \ 2298 "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \ 2299 "_GLIBCXX_END_NAMESPACE_ALGO= " \ 2300 __glibcxx_function_requires=// \ 2301 __glibcxx_class_requires=// \ 2302 __glibcxx_class_requires2=// \ 2303 __glibcxx_class_requires3=// \ 2304 __glibcxx_class_requires4=// \ 2305 "__attribute__(X)=" \ 2306 _GLIBCXX14_CONSTEXPR=constexpr \ 2307 _GLIBCXX17_CONSTEXPR=constexpr \ 2308 _GLIBCXX20_CONSTEXPR=constexpr \ 2309 _GLIBCXX17_DEPRECATED= \ 2310 _GLIBCXX17_INLINE=inline \ 2311 2312# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2313# tag can be used to specify a list of macro names that should be expanded. The 2314# macro definition that is found in the sources will be used. Use the PREDEFINED 2315# tag if you want to use a different macro definition that overrules the 2316# definition found in the source code. 2317# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2318 2319EXPAND_AS_DEFINED = 2320 2321# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2322# remove all references to function-like macros that are alone on a line, have 2323# an all uppercase name, and do not end with a semicolon. Such function macros 2324# are typically used for boiler-plate code, and will confuse the parser if not 2325# removed. 2326# The default value is: YES. 2327# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2328 2329SKIP_FUNCTION_MACROS = YES 2330 2331#--------------------------------------------------------------------------- 2332# Configuration options related to external references 2333#--------------------------------------------------------------------------- 2334 2335# The TAGFILES tag can be used to specify one or more tag files. For each tag 2336# file the location of the external documentation should be added. The format of 2337# a tag file without this location is as follows: 2338# TAGFILES = file1 file2 ... 2339# Adding location for the tag files is done as follows: 2340# TAGFILES = file1=loc1 "file2 = loc2" ... 2341# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2342# section "Linking to external documentation" for more information about the use 2343# of tag files. 2344# Note: Each tag file must have a unique name (where the name does NOT include 2345# the path). If a tag file is not located in the directory in which doxygen is 2346# run, you must also specify the path to the tagfile here. 2347 2348TAGFILES = 2349 2350# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2351# tag file that is based on the input files it reads. See section "Linking to 2352# external documentation" for more information about the usage of tag files. 2353 2354GENERATE_TAGFILE = @generate_tagfile@ 2355 2356# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2357# the class index. If set to NO, only the inherited external classes will be 2358# listed. 2359# The default value is: NO. 2360 2361ALLEXTERNALS = YES 2362 2363# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2364# in the modules index. If set to NO, only the current project's groups will be 2365# listed. 2366# The default value is: YES. 2367 2368EXTERNAL_GROUPS = YES 2369 2370# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2371# the related pages index. If set to NO, only the current project's pages will 2372# be listed. 2373# The default value is: YES. 2374 2375EXTERNAL_PAGES = YES 2376 2377# The PERL_PATH should be the absolute path and name of the perl script 2378# interpreter (i.e. the result of 'which perl'). 2379# The default file (with absolute path) is: /usr/bin/perl. 2380 2381PERL_PATH = /usr/bin/perl 2382 2383#--------------------------------------------------------------------------- 2384# Configuration options related to the dot tool 2385#--------------------------------------------------------------------------- 2386 2387# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2388# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2389# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2390# disabled, but it is recommended to install and use dot, since it yields more 2391# powerful graphs. 2392# The default value is: YES. 2393 2394CLASS_DIAGRAMS = YES 2395 2396# You can define message sequence charts within doxygen comments using the \msc 2397# command. Doxygen will then run the mscgen tool (see: 2398# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2399# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2400# the mscgen tool resides. If left empty the tool is assumed to be found in the 2401# default search path. 2402 2403MSCGEN_PATH = 2404 2405# You can include diagrams made with dia in doxygen documentation. Doxygen will 2406# then run dia to produce the diagram and insert it in the documentation. The 2407# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2408# If left empty dia is assumed to be found in the default search path. 2409 2410DIA_PATH = 2411 2412# If set to YES the inheritance and collaboration graphs will hide inheritance 2413# and usage relations if the target is undocumented or is not a class. 2414# The default value is: YES. 2415 2416HIDE_UNDOC_RELATIONS = NO 2417 2418# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2419# available from the path. This tool is part of Graphviz (see: 2420# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2421# Bell Labs. The other options in this section have no effect if this option is 2422# set to NO 2423# The default value is: NO. 2424 2425HAVE_DOT = YES 2426 2427# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2428# to run in parallel. When set to 0 doxygen will base this on the number of 2429# processors available in the system. You can set it explicitly to a value 2430# larger than 0 to get control over the balance between CPU load and processing 2431# speed. 2432# Minimum value: 0, maximum value: 32, default value: 0. 2433# This tag requires that the tag HAVE_DOT is set to YES. 2434 2435DOT_NUM_THREADS = 0 2436 2437# When you want a differently looking font in the dot files that doxygen 2438# generates you can specify the font name using DOT_FONTNAME. You need to make 2439# sure dot is able to find the font, which can be done by putting it in a 2440# standard location or by setting the DOTFONTPATH environment variable or by 2441# setting DOT_FONTPATH to the directory containing the font. 2442# The default value is: Helvetica. 2443# This tag requires that the tag HAVE_DOT is set to YES. 2444 2445DOT_FONTNAME = 2446 2447# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2448# dot graphs. 2449# Minimum value: 4, maximum value: 24, default value: 10. 2450# This tag requires that the tag HAVE_DOT is set to YES. 2451 2452DOT_FONTSIZE = 9 2453 2454# By default doxygen will tell dot to use the default font as specified with 2455# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2456# the path where dot can find it using this tag. 2457# This tag requires that the tag HAVE_DOT is set to YES. 2458 2459DOT_FONTPATH = 2460 2461# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2462# each documented class showing the direct and indirect inheritance relations. 2463# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2464# The default value is: YES. 2465# This tag requires that the tag HAVE_DOT is set to YES. 2466 2467CLASS_GRAPH = YES 2468 2469# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2470# graph for each documented class showing the direct and indirect implementation 2471# dependencies (inheritance, containment, and class references variables) of the 2472# class with other documented classes. 2473# The default value is: YES. 2474# This tag requires that the tag HAVE_DOT is set to YES. 2475 2476COLLABORATION_GRAPH = NO 2477 2478# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2479# groups, showing the direct groups dependencies. 2480# The default value is: YES. 2481# This tag requires that the tag HAVE_DOT is set to YES. 2482 2483GROUP_GRAPHS = YES 2484 2485# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2486# collaboration diagrams in a style similar to the OMG's Unified Modeling 2487# Language. 2488# The default value is: NO. 2489# This tag requires that the tag HAVE_DOT is set to YES. 2490 2491UML_LOOK = NO 2492 2493# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2494# class node. If there are many fields or methods and many nodes the graph may 2495# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2496# number of items for each type to make the size more manageable. Set this to 0 2497# for no limit. Note that the threshold may be exceeded by 50% before the limit 2498# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2499# but if the number exceeds 15, the total amount of fields shown is limited to 2500# 10. 2501# Minimum value: 0, maximum value: 100, default value: 10. 2502# This tag requires that the tag HAVE_DOT is set to YES. 2503 2504UML_LIMIT_NUM_FIELDS = 10 2505 2506# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2507# collaboration graphs will show the relations between templates and their 2508# instances. 2509# The default value is: NO. 2510# This tag requires that the tag HAVE_DOT is set to YES. 2511 2512TEMPLATE_RELATIONS = NO 2513 2514# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2515# YES then doxygen will generate a graph for each documented file showing the 2516# direct and indirect include dependencies of the file with other documented 2517# files. 2518# The default value is: YES. 2519# This tag requires that the tag HAVE_DOT is set to YES. 2520 2521INCLUDE_GRAPH = NO 2522 2523# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2524# set to YES then doxygen will generate a graph for each documented file showing 2525# the direct and indirect include dependencies of the file with other documented 2526# files. 2527# The default value is: YES. 2528# This tag requires that the tag HAVE_DOT is set to YES. 2529 2530INCLUDED_BY_GRAPH = NO 2531 2532# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2533# dependency graph for every global function or class method. 2534# 2535# Note that enabling this option will significantly increase the time of a run. 2536# So in most cases it will be better to enable call graphs for selected 2537# functions only using the \callgraph command. Disabling a call graph can be 2538# accomplished by means of the command \hidecallgraph. 2539# The default value is: NO. 2540# This tag requires that the tag HAVE_DOT is set to YES. 2541 2542CALL_GRAPH = NO 2543 2544# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2545# dependency graph for every global function or class method. 2546# 2547# Note that enabling this option will significantly increase the time of a run. 2548# So in most cases it will be better to enable caller graphs for selected 2549# functions only using the \callergraph command. Disabling a caller graph can be 2550# accomplished by means of the command \hidecallergraph. 2551# The default value is: NO. 2552# This tag requires that the tag HAVE_DOT is set to YES. 2553 2554CALLER_GRAPH = NO 2555 2556# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2557# hierarchy of all classes instead of a textual one. 2558# The default value is: YES. 2559# This tag requires that the tag HAVE_DOT is set to YES. 2560 2561GRAPHICAL_HIERARCHY = YES 2562 2563# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2564# dependencies a directory has on other directories in a graphical way. The 2565# dependency relations are determined by the #include relations between the 2566# files in the directories. 2567# The default value is: YES. 2568# This tag requires that the tag HAVE_DOT is set to YES. 2569 2570DIRECTORY_GRAPH = NO 2571 2572# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2573# generated by dot. For an explanation of the image formats see the section 2574# output formats in the documentation of the dot tool (Graphviz (see: 2575# http://www.graphviz.org/)). 2576# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2577# to make the SVG files visible in IE 9+ (other browsers do not have this 2578# requirement). 2579# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2580# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2581# png:gdiplus:gdiplus. 2582# The default value is: png. 2583# This tag requires that the tag HAVE_DOT is set to YES. 2584 2585DOT_IMAGE_FORMAT = svg 2586 2587# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2588# enable generation of interactive SVG images that allow zooming and panning. 2589# 2590# Note that this requires a modern browser other than Internet Explorer. Tested 2591# and working are Firefox, Chrome, Safari, and Opera. 2592# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2593# the SVG files visible. Older versions of IE do not have SVG support. 2594# The default value is: NO. 2595# This tag requires that the tag HAVE_DOT is set to YES. 2596 2597INTERACTIVE_SVG = YES 2598 2599# The DOT_PATH tag can be used to specify the path where the dot tool can be 2600# found. If left blank, it is assumed the dot tool can be found in the path. 2601# This tag requires that the tag HAVE_DOT is set to YES. 2602 2603DOT_PATH = 2604 2605# The DOTFILE_DIRS tag can be used to specify one or more directories that 2606# contain dot files that are included in the documentation (see the \dotfile 2607# command). 2608# This tag requires that the tag HAVE_DOT is set to YES. 2609 2610DOTFILE_DIRS = 2611 2612# The MSCFILE_DIRS tag can be used to specify one or more directories that 2613# contain msc files that are included in the documentation (see the \mscfile 2614# command). 2615 2616MSCFILE_DIRS = 2617 2618# The DIAFILE_DIRS tag can be used to specify one or more directories that 2619# contain dia files that are included in the documentation (see the \diafile 2620# command). 2621 2622DIAFILE_DIRS = 2623 2624# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2625# path where java can find the plantuml.jar file. If left blank, it is assumed 2626# PlantUML is not used or called during a preprocessing step. Doxygen will 2627# generate a warning when it encounters a \startuml command in this case and 2628# will not generate output for the diagram. 2629 2630PLANTUML_JAR_PATH = 2631 2632# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2633# configuration file for plantuml. 2634 2635PLANTUML_CFG_FILE = 2636 2637# When using plantuml, the specified paths are searched for files specified by 2638# the !include statement in a plantuml block. 2639 2640PLANTUML_INCLUDE_PATH = 2641 2642# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2643# that will be shown in the graph. If the number of nodes in a graph becomes 2644# larger than this value, doxygen will truncate the graph, which is visualized 2645# by representing a node as a red box. Note that doxygen if the number of direct 2646# children of the root node in a graph is already larger than 2647# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2648# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2649# Minimum value: 0, maximum value: 10000, default value: 50. 2650# This tag requires that the tag HAVE_DOT is set to YES. 2651 2652DOT_GRAPH_MAX_NODES = 50 2653 2654# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2655# generated by dot. A depth value of 3 means that only nodes reachable from the 2656# root by following a path via at most 3 edges will be shown. Nodes that lay 2657# further from the root node will be omitted. Note that setting this option to 1 2658# or 2 may greatly reduce the computation time needed for large code bases. Also 2659# note that the size of a graph can be further restricted by 2660# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2661# Minimum value: 0, maximum value: 1000, default value: 0. 2662# This tag requires that the tag HAVE_DOT is set to YES. 2663 2664MAX_DOT_GRAPH_DEPTH = 0 2665 2666# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2667# background. This is disabled by default, because dot on Windows does not seem 2668# to support this out of the box. 2669# 2670# Warning: Depending on the platform used, enabling this option may lead to 2671# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2672# read). 2673# The default value is: NO. 2674# This tag requires that the tag HAVE_DOT is set to YES. 2675 2676DOT_TRANSPARENT = NO 2677 2678# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2679# files in one run (i.e. multiple -o and -T options on the command line). This 2680# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2681# this, this feature is disabled by default. 2682# The default value is: NO. 2683# This tag requires that the tag HAVE_DOT is set to YES. 2684 2685DOT_MULTI_TARGETS = YES 2686 2687# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2688# explaining the meaning of the various boxes and arrows in the dot generated 2689# graphs. 2690# The default value is: YES. 2691# This tag requires that the tag HAVE_DOT is set to YES. 2692 2693GENERATE_LEGEND = YES 2694 2695# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2696# files that are used to generate the various graphs. 2697# The default value is: YES. 2698# This tag requires that the tag HAVE_DOT is set to YES. 2699 2700DOT_CLEANUP = YES 2701