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