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