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