brintos / llvm-project-archived public Read only

1# Doxyfile 1.8.62 3# This file describes the settings to be used by the documentation system4# doxygen (www.doxygen.org) for a project.5#6# All text after a double hash (##) is considered a comment and is placed in7# 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 options18#---------------------------------------------------------------------------19 20# This tag specifies the encoding used for all characters in the config file21# that follow. The default is UTF-8 which is also the encoding used for all text22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv24# for the list of possible encodings.25# The default value is: UTF-8.26 27DOXYFILE_ENCODING      = UTF-828 29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by30# double-quotes, unless you are using Doxywizard) that should identify the31# project for which the documentation is generated. This name is used in the32# title of most generated pages and in a few other places.33# The default value is: My Project.34 35PROJECT_NAME           = clang36 37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This38# could be handy for archiving the generated documentation or if some version39# control system is used.40 41PROJECT_NUMBER         = @PACKAGE_VERSION@42 43# Using the PROJECT_BRIEF tag one can provide an optional one line description44# for a project that appears at the top of each page and should give viewer a45# 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 in50# the documentation. The maximum height of the logo should not exceed 55 pixels51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo52# to the output directory.53 54PROJECT_LOGO           =55 56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path57# into which the generated documentation will be written. If a relative path is58# entered, it will be relative to the location where doxygen was started. If59# left blank the current directory will be used.60 61OUTPUT_DIRECTORY       = @abs_builddir@/doxygen62 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 and65# will distribute the generated files over these directories. Enabling this66# option can be useful when feeding doxygen a huge amount of source files, where67# putting all generated files in the same directory would otherwise causes68# performance problems for the file system.69# The default value is: NO.70 71CREATE_SUBDIRS         = NO72 73# The OUTPUT_LANGUAGE tag is used to specify the language in which all74# documentation generated by doxygen is written. Doxygen will use this75# 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        = English87 88# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member89# descriptions after the members that are listed in the file and class90# documentation (similar to Javadoc). Set to NO to disable this.91# The default value is: YES.92 93BRIEF_MEMBER_DESC      = YES94 95# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief96# description of a member or function before the detailed description97#98# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the99# brief descriptions will be completely suppressed.100# The default value is: YES.101 102REPEAT_BRIEF           = YES103 104# This tag implements a quasi-intelligent brief description abbreviator that is105# used to form the text in various listings. Each string in this list, if found106# as the leading text of the brief description, will be stripped from the text107# and the result, after processing the whole list, is used as the annotated108# text. Otherwise, the brief description is used as-is. If left blank, the109# following values are used ($name is automatically replaced with the name of110# 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 then116# doxygen will generate a detailed section even if there is only a brief117# description.118# The default value is: NO.119 120ALWAYS_DETAILED_SEC    = NO121 122# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all123# inherited members of a class in the documentation of that class as if those124# members were ordinary class members. Constructors, destructors and assignment125# operators of the base classes will not be shown.126# The default value is: NO.127 128INLINE_INHERITED_MEMB  = NO129 130# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path131# before files name in the file list and in the header files. If set to NO the132# shortest path that makes the file name unique will be used133# The default value is: YES.134 135FULL_PATH_NAMES        = YES136 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-hand139# 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 to141# strip.142#143# Note that you can specify absolute paths here, but also relative paths, which144# 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        = @abs_srcdir@/..148 149# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the150# path mentioned in the documentation of a class, which tells the reader which151# header file to include in order to use a class. If left blank only the name of152# the header file containing the class definition is used. Otherwise one should153# specify the list of include paths that are normally passed to the compiler154# using the -I flag.155 156STRIP_FROM_INC_PATH    = @abs_srcdir@/../include157 158# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but159# less readable) file names. This can be useful is your file systems doesn't160# support long names like on DOS, Mac, or CD-ROM.161# The default value is: NO.162 163SHORT_NAMES            = NO164 165# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the166# first line (until the first dot) of a Javadoc-style comment as the brief167# 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 brief169# description.)170# The default value is: NO.171 172JAVADOC_AUTOBRIEF      = YES173 174# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first175# line (until the first dot) of a Qt-style comment as the brief description. If176# set to NO, the Qt-style will behave just like regular Qt-style comments (thus177# requiring an explicit command for a brief description.)178# The default value is: NO.179 180QT_AUTOBRIEF           = YES181 182# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a183# multi-line C++ special comment block (i.e. a block of //! or /// comments) as184# a brief description. This used to be the default behavior. The new default is185# to treat a multi-line C++ comment block as a detailed description. Set this186# 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 are189# not recognized any more.190# The default value is: NO.191 192MULTILINE_CPP_IS_BRIEF = NO193 194# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the195# documentation from any documented member that it re-implements.196# The default value is: YES.197 198INHERIT_DOCS           = YES199 200# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a201# new page for each member. If set to NO, the documentation of a member will be202# part of the file/class/namespace that contains it.203# The default value is: NO.204 205SEPARATE_MEMBER_PAGES  = NO206 207# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen208# uses this value to replace tabs by spaces in code fragments.209# Minimum value: 1, maximum value: 16, default value: 4.210 211TAB_SIZE               = 2212 213# This tag can be used to specify a number of aliases that act as commands in214# the documentation. An alias has the form:215# name=value216# For example adding217# "sideeffect=@par Side Effects:\n"218# will allow you to put the command \sideeffect (or @sideeffect) in the219# documentation, which will result in a user-defined paragraph with heading220# "Side Effects:". You can put \n's in the value part of an alias to insert221# newlines.222 223ALIASES                =224 225# This tag can be used to specify a number of word-keyword mappings (TCL only).226# A mapping has the form "name=value". For example adding "class=itcl::class"227# will allow you to use the command class in the itcl::class meaning.228 229TCL_SUBST              =230 231# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources232# only. Doxygen will then generate output that is more tailored for C. For233# instance, some of the names that are used will be different. The list of all234# members will be omitted, etc.235# The default value is: NO.236 237OPTIMIZE_OUTPUT_FOR_C  = NO238 239# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or240# Python sources only. Doxygen will then generate output that is more tailored241# for that language. For instance, namespaces will be presented as packages,242# qualified scopes will look different, etc.243# The default value is: NO.244 245OPTIMIZE_OUTPUT_JAVA   = NO246 247# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran248# sources. Doxygen will then generate output that is tailored for Fortran.249# The default value is: NO.250 251OPTIMIZE_FOR_FORTRAN   = NO252 253# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL254# sources. Doxygen will then generate output that is tailored for VHDL.255# The default value is: NO.256 257OPTIMIZE_OUTPUT_VHDL   = NO258 259# Doxygen selects the parser to use depending on the extension of the files it260# parses. With this tag you can assign which parser to use for a given261# extension. Doxygen has a built-in mapping, but you can override or extend it262# using this tag. The format is ext=language, where ext is a file extension, and263# language is one of the parsers supported by doxygen: IDL, Java, Javascript,264# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make265# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C266# (default is Fortran), use: inc=Fortran f=C.267#268# Note For files without extension you can use no_extension as a placeholder.269#270# Note that for custom extensions you also need to set FILE_PATTERNS otherwise271# the files are not read by doxygen.272 273EXTENSION_MAPPING      =274 275# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments276# according to the Markdown format, which allows for more readable277# documentation. See http://daringfireball.net/projects/markdown/ for details.278# The output of markdown processing is further processed by doxygen, so you can279# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in280# case of backward compatibilities issues.281# The default value is: YES.282 283MARKDOWN_SUPPORT       = YES284 285# When enabled doxygen tries to link words that correspond to documented286# classes, or namespaces to their corresponding documentation. Such a link can287# be prevented in individual cases by putting a % sign in front of the word288# or globally by setting AUTOLINK_SUPPORT to NO.289# The default value is: YES.290 291AUTOLINK_SUPPORT       = YES292 293# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want294# to include (a tag file for) the STL sources as input, then you should set this295# tag to YES in order to let doxygen match functions declarations and296# definitions whose arguments contain STL classes (e.g. func(std::string);297# versus func(std::string) {}). This also make the inheritance and collaboration298# diagrams that involve STL classes more complete and accurate.299# The default value is: NO.300 301BUILTIN_STL_SUPPORT    = NO302 303# If you use Microsoft's C++/CLI language, you should set this option to YES to304# enable parsing support.305# The default value is: NO.306 307CPP_CLI_SUPPORT        = NO308 309# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:310# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen311# will parse them like normal C++ but will assume all classes use public instead312# of private inheritance when no explicit protection keyword is present.313# The default value is: NO.314 315SIP_SUPPORT            = NO316 317# For Microsoft's IDL there are propget and propput attributes to indicate318# getter and setter methods for a property. Setting this option to YES will make319# doxygen to replace the get and set methods by a property in the documentation.320# This will only work if the methods are indeed getting or setting a simple321# type. If this is not the case, or you want to show the methods anyway, you322# should set this option to NO.323# The default value is: YES.324 325IDL_PROPERTY_SUPPORT   = YES326 327# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC328# tag is set to YES, then doxygen will reuse the documentation of the first329# member in the group (if any) for the other members of the group. By default330# all members of a group must be documented explicitly.331# The default value is: NO.332 333DISTRIBUTE_GROUP_DOC   = NO334 335# Set the SUBGROUPING tag to YES to allow class member groups of the same type336# (for instance a group of public functions) to be put as a subgroup of that337# type (e.g. under the Public Functions section). Set it to NO to prevent338# subgrouping. Alternatively, this can be done per class using the339# \nosubgrouping command.340# The default value is: YES.341 342SUBGROUPING            = YES343 344# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions345# are shown inside the group in which they are included (e.g. using \ingroup)346# instead of on a separate page (for HTML and Man pages) or section (for LaTeX347# and RTF).348#349# Note that this feature does not work in combination with350# SEPARATE_MEMBER_PAGES.351# The default value is: NO.352 353INLINE_GROUPED_CLASSES = NO354 355# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions356# with only public data fields or simple typedef fields will be shown inline in357# the documentation of the scope in which they are defined (i.e. file,358# namespace, or group documentation), provided this scope is documented. If set359# to NO, structs, classes, and unions are shown on a separate page (for HTML and360# Man pages) or section (for LaTeX and RTF).361# The default value is: NO.362 363INLINE_SIMPLE_STRUCTS  = NO364 365# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or366# enum is documented as struct, union, or enum with the name of the typedef. So367# typedef struct TypeS {} TypeT, will appear in the documentation as a struct368# with name TypeT. When disabled the typedef will appear as a member of a file,369# namespace, or class. And the struct will be named TypeS. This can typically be370# useful for C code in case the coding convention dictates that all compound371# types are typedef'ed and only the typedef is referenced, never the tag name.372# The default value is: NO.373 374TYPEDEF_HIDES_STRUCT   = NO375 376# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This377# cache is used to resolve symbols given their name and scope. Since this can be378# an expensive process and often the same symbol appears multiple times in the379# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small380# doxygen will become slower. If the cache is too large, memory is wasted. The381# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range382# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536383# symbols. At the end of a run doxygen will report the cache usage and suggest384# the optimal cache size from a speed point of view.385# Minimum value: 0, maximum value: 9, default value: 0.386 387LOOKUP_CACHE_SIZE      = 3388 389#---------------------------------------------------------------------------390# Build related configuration options391#---------------------------------------------------------------------------392 393# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in394# documentation are documented, even if no documentation was available. Private395# class members and static file members will be hidden unless the396# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.397# Note: This will also disable the warnings about undocumented members that are398# normally produced when WARNINGS is set to YES.399# The default value is: NO.400 401EXTRACT_ALL            = YES402 403# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will404# be included in the documentation.405# The default value is: NO.406 407EXTRACT_PRIVATE        = NO408 409# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal410# scope will be included in the documentation.411# The default value is: NO.412 413EXTRACT_PACKAGE        = NO414 415# If the EXTRACT_STATIC tag is set to YES all static members of a file will be416# included in the documentation.417# The default value is: NO.418 419EXTRACT_STATIC         = YES420 421# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined422# locally in source files will be included in the documentation. If set to NO423# only classes defined in header files are included. Does not have any effect424# for Java sources.425# The default value is: YES.426 427EXTRACT_LOCAL_CLASSES  = YES428 429# This flag is only useful for Objective-C code. When set to YES local methods,430# which are defined in the implementation section but not in the interface are431# included in the documentation. If set to NO only methods in the interface are432# included.433# The default value is: NO.434 435EXTRACT_LOCAL_METHODS  = NO436 437# If this flag is set to YES, the members of anonymous namespaces will be438# extracted and appear in the documentation as a namespace called439# 'anonymous_namespace{file}', where file will be replaced with the base name of440# the file that contains the anonymous namespace. By default anonymous namespace441# are hidden.442# The default value is: NO.443 444EXTRACT_ANON_NSPACES   = NO445 446# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all447# undocumented members inside documented classes or files. If set to NO these448# members will be included in the various overviews, but no documentation449# section is generated. This option has no effect if EXTRACT_ALL is enabled.450# The default value is: NO.451 452HIDE_UNDOC_MEMBERS     = NO453 454# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all455# undocumented classes that are normally visible in the class hierarchy. If set456# to NO these classes will be included in the various overviews. This option has457# no effect if EXTRACT_ALL is enabled.458# The default value is: NO.459 460HIDE_UNDOC_CLASSES     = NO461 462# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend463# (class|struct|union) declarations. If set to NO these declarations will be464# included in the documentation.465# The default value is: NO.466 467HIDE_FRIEND_COMPOUNDS  = NO468 469# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any470# documentation blocks found inside the body of a function. If set to NO these471# blocks will be appended to the function's detailed documentation block.472# The default value is: NO.473 474HIDE_IN_BODY_DOCS      = NO475 476# The INTERNAL_DOCS tag determines if documentation that is typed after a477# \internal command is included. If the tag is set to NO then the documentation478# will be excluded. Set it to YES to include the internal documentation.479# The default value is: NO.480 481INTERNAL_DOCS          = NO482 483# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file484# names in lower-case letters. If set to YES upper-case letters are also485# allowed. This is useful if you have classes or files whose names only differ486# in case and if your file system supports case sensitive file names. Windows487# and Mac users are advised to set this option to NO.488# The default value is: system dependent.489 490CASE_SENSE_NAMES       = YES491 492# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with493# their full class and namespace scopes in the documentation. If set to YES the494# scope will be hidden.495# The default value is: NO.496 497HIDE_SCOPE_NAMES       = NO498 499# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of500# the files that are included by a file in the documentation of that file.501# The default value is: YES.502 503SHOW_INCLUDE_FILES     = YES504 505# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each506# grouped member an include statement to the documentation, telling the reader507# which file to include in order to use the member.508# The default value is: NO.509 510SHOW_GROUPED_MEMB_INC  = NO511 512# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include513# files with double quotes in the documentation rather than with sharp brackets.514# The default value is: NO.515 516FORCE_LOCAL_INCLUDES   = YES517 518# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the519# documentation for inline members.520# The default value is: YES.521 522INLINE_INFO            = YES523 524# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the525# (detailed) documentation of file and class members alphabetically by member526# name. If set to NO the members will appear in declaration order.527# The default value is: YES.528 529SORT_MEMBER_DOCS       = YES530 531# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief532# descriptions of file, namespace and class members alphabetically by member533# name. If set to NO the members will appear in declaration order. Note that534# this will also influence the order of the classes in the class list.535# The default value is: NO.536 537SORT_BRIEF_DOCS        = NO538 539# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the540# (brief and detailed) documentation of class members so that constructors and541# destructors are listed first. If set to NO the constructors will appear in the542# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.543# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief544# member documentation.545# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting546# detailed member documentation.547# The default value is: NO.548 549SORT_MEMBERS_CTORS_1ST = NO550 551# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy552# of group names into alphabetical order. If set to NO the group names will553# appear in their defined order.554# The default value is: NO.555 556SORT_GROUP_NAMES       = NO557 558# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by559# fully-qualified names, including namespaces. If set to NO, the class list will560# be sorted only by class name, not including the namespace part.561# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.562# Note: This option applies only to the class list, not to the alphabetical563# list.564# The default value is: NO.565 566SORT_BY_SCOPE_NAME     = NO567 568# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper569# type resolution of all parameters of a function it will reject a match between570# the prototype and the implementation of a member function even if there is571# only one candidate or it is obvious which candidate to choose by doing a572# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still573# accept a match between prototype and implementation in such cases.574# The default value is: NO.575 576STRICT_PROTO_MATCHING  = NO577 578# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the579# todo list. This list is created by putting \todo commands in the580# documentation.581# The default value is: YES.582 583GENERATE_TODOLIST      = YES584 585# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the586# test list. This list is created by putting \test commands in the587# documentation.588# The default value is: YES.589 590GENERATE_TESTLIST      = YES591 592# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug593# list. This list is created by putting \bug commands in the documentation.594# The default value is: YES.595 596GENERATE_BUGLIST       = YES597 598# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)599# the deprecated list. This list is created by putting \deprecated commands in600# the documentation.601# The default value is: YES.602 603GENERATE_DEPRECATEDLIST= YES604 605# The ENABLED_SECTIONS tag can be used to enable conditional documentation606# sections, marked by \if <section_label> ... \endif and \cond <section_label>607# ... \endcond blocks.608 609ENABLED_SECTIONS       =610 611# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the612# initial value of a variable or macro / define can have for it to appear in the613# documentation. If the initializer consists of more lines than specified here614# it will be hidden. Use a value of 0 to hide initializers completely. The615# appearance of the value of individual variables and macros / defines can be616# controlled using \showinitializer or \hideinitializer command in the617# documentation regardless of this setting.618# Minimum value: 0, maximum value: 10000, default value: 30.619 620MAX_INITIALIZER_LINES  = 30621 622# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at623# the bottom of the documentation of classes and structs. If set to YES the list624# will mention the files that were used to generate the documentation.625# The default value is: YES.626 627SHOW_USED_FILES        = YES628 629# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This630# will remove the Files entry from the Quick Index and from the Folder Tree View631# (if specified).632# The default value is: YES.633 634SHOW_FILES             = YES635 636# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces637# page. This will remove the Namespaces entry from the Quick Index and from the638# Folder Tree View (if specified).639# The default value is: YES.640 641SHOW_NAMESPACES        = YES642 643# The FILE_VERSION_FILTER tag can be used to specify a program or script that644# doxygen should invoke to get the current version for each file (typically from645# the version control system). Doxygen will invoke the program by executing (via646# popen()) the command command input-file, where command is the value of the647# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided648# by doxygen. Whatever the program writes to standard output is used as the file649# version. For an example see the documentation.650 651FILE_VERSION_FILTER    =652 653# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed654# by doxygen. The layout file controls the global structure of the generated655# output files in an output format independent way. To create the layout file656# that represents doxygen's defaults, run doxygen with the -l option. You can657# optionally specify a file name after the option, if omitted DoxygenLayout.xml658# will be used as the name of the layout file.659#660# Note that if you run doxygen from a directory containing a file called661# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE662# tag is left empty.663 664LAYOUT_FILE            =665 666# The CITE_BIB_FILES tag can be used to specify one or more bib files containing667# the reference definitions. This must be a list of .bib files. The .bib668# extension is automatically appended if omitted. This requires the bibtex tool669# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.670# For LaTeX the style of the bibliography can be controlled using671# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the672# search path. Do not use file names with spaces, bibtex cannot handle them. See673# also \cite for info how to create references.674 675CITE_BIB_FILES         =676 677#---------------------------------------------------------------------------678# Configuration options related to warning and progress messages679#---------------------------------------------------------------------------680 681# The QUIET tag can be used to turn on/off the messages that are generated to682# standard output by doxygen. If QUIET is set to YES this implies that the683# messages are off.684# The default value is: NO.685 686QUIET                  = NO687 688# The WARNINGS tag can be used to turn on/off the warning messages that are689# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES690# this implies that the warnings are on.691#692# Tip: Turn warnings on while writing the documentation.693# The default value is: YES.694 695WARNINGS               = NO696 697# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate698# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag699# will automatically be disabled.700# The default value is: YES.701 702WARN_IF_UNDOCUMENTED   = NO703 704# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for705# potential errors in the documentation, such as not documenting some parameters706# in a documented function, or documenting parameters that don't exist or using707# markup commands wrongly.708# The default value is: YES.709 710WARN_IF_DOC_ERROR      = YES711 712# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that713# are documented, but have no documentation for their parameters or return714# value. If set to NO doxygen will only warn about wrong or incomplete parameter715# documentation, but not about the absence of documentation.716# The default value is: NO.717 718WARN_NO_PARAMDOC       = NO719 720# The WARN_FORMAT tag determines the format of the warning messages that doxygen721# can produce. The string should contain the $file, $line, and $text tags, which722# will be replaced by the file and line number from which the warning originated723# and the warning text. Optionally the format may contain $version, which will724# be replaced by the version of the file (if it could be obtained via725# FILE_VERSION_FILTER)726# The default value is: $file:$line: $text.727 728WARN_FORMAT            = "$file:$line: $text"729 730# The WARN_LOGFILE tag can be used to specify a file to which warning and error731# messages should be written. If left blank the output is written to standard732# error (stderr).733 734WARN_LOGFILE           =735 736#---------------------------------------------------------------------------737# Configuration options related to the input files738#---------------------------------------------------------------------------739 740# The INPUT tag is used to specify the files and/or directories that contain741# documented source files. You may enter file names like myfile.cpp or742# directories like /usr/src/myproject. Separate the files or directories with743# spaces.744# Note: If this tag is empty the current directory is searched.745 746INPUT                  = @abs_srcdir@/../include \747                         @abs_srcdir@/../lib \748                         @abs_srcdir@/doxygen-mainpage.dox749 750# This tag can be used to specify the character encoding of the source files751# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses752# libiconv (or the iconv built into libc) for the transcoding. See the libiconv753# documentation (see: http://www.gnu.org/software/libiconv) for the list of754# possible encodings.755# The default value is: UTF-8.756 757INPUT_ENCODING         = UTF-8758 759# If the value of the INPUT tag contains directories, you can use the760# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and761# *.h) to filter out the source-files in the directories. If left blank the762# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,763# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,764# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,765# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,766# *.qsf, *.as and *.js.767 768FILE_PATTERNS          =769 770# The RECURSIVE tag can be used to specify whether or not subdirectories should771# be searched for input files as well.772# The default value is: NO.773 774RECURSIVE              = YES775 776# The EXCLUDE tag can be used to specify files and/or directories that should be777# excluded from the INPUT source files. This way you can easily exclude a778# subdirectory from a directory tree whose root is specified with the INPUT tag.779#780# Note that relative paths are relative to the directory from which doxygen is781# run.782 783EXCLUDE                =784 785# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or786# directories that are symbolic links (a Unix file system feature) are excluded787# from the input.788# The default value is: NO.789 790EXCLUDE_SYMLINKS       = NO791 792# If the value of the INPUT tag contains directories, you can use the793# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude794# certain files from those directories.795#796# Note that the wildcards are matched against the file with absolute path, so to797# exclude all test directories for example use the pattern */test/*798 799EXCLUDE_PATTERNS       =800 801# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names802# (namespaces, classes, functions, etc.) that should be excluded from the803# output. The symbol name can be a fully qualified name, a word, or if the804# wildcard * is used, a substring. Examples: ANamespace, AClass,805# AClass::ANamespace, ANamespace::*Test806#807# Note that the wildcards are matched against the file with absolute path, so to808# exclude all test directories use the pattern */test/*809 810EXCLUDE_SYMBOLS        =811 812# The EXAMPLE_PATH tag can be used to specify one or more files or directories813# that contain example code fragments that are included (see the \include814# command).815 816EXAMPLE_PATH           = @abs_srcdir@/../examples817 818# If the value of the EXAMPLE_PATH tag contains directories, you can use the819# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and820# *.h) to filter out the source-files in the directories. If left blank all821# files are included.822 823EXAMPLE_PATTERNS       =824 825# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be826# searched for input files to be used with the \include or \dontinclude commands827# irrespective of the value of the RECURSIVE tag.828# The default value is: NO.829 830EXAMPLE_RECURSIVE      = YES831 832# The IMAGE_PATH tag can be used to specify one or more files or directories833# that contain images that are to be included in the documentation (see the834# \image command).835 836IMAGE_PATH             = @abs_srcdir@/img837 838# The INPUT_FILTER tag can be used to specify a program that doxygen should839# invoke to filter for each input file. Doxygen will invoke the filter program840# by executing (via popen()) the command:841#842# <filter> <input-file>843#844# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the845# name of an input file. Doxygen will then use the output that the filter846# program writes to standard output. If FILTER_PATTERNS is specified, this tag847# will be ignored.848#849# Note that the filter must not add or remove lines; it is applied before the850# code is scanned, but not when the output code is generated. If lines are added851# or removed, the anchors will not be placed correctly.852 853INPUT_FILTER           =854 855# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern856# basis. Doxygen will compare the file name with each pattern and apply the857# filter if there is a match. The filters are a list of the form: pattern=filter858# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how859# filters are used. If the FILTER_PATTERNS tag is empty or if none of the860# patterns match the file name, INPUT_FILTER is applied.861 862FILTER_PATTERNS        =863 864# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using865# INPUT_FILTER ) will also be used to filter the input files that are used for866# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).867# The default value is: NO.868 869FILTER_SOURCE_FILES    = NO870 871# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file872# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and873# it is also possible to disable source filtering for a specific pattern using874# *.ext= (so without naming a filter).875# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.876 877FILTER_SOURCE_PATTERNS =878 879# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that880# is part of the input, its contents will be placed on the main page881# (index.html). This can be useful if you have a project on for instance GitHub882# and want to reuse the introduction page also for the doxygen output.883 884USE_MDFILE_AS_MAINPAGE =885 886#---------------------------------------------------------------------------887# Configuration options related to source browsing888#---------------------------------------------------------------------------889 890# If the SOURCE_BROWSER tag is set to YES then a list of source files will be891# generated. Documented entities will be cross-referenced with these sources.892#893# Note: To get rid of all source code in the generated output, make sure that894# also VERBATIM_HEADERS is set to NO.895# The default value is: NO.896 897SOURCE_BROWSER         = YES898 899# Setting the INLINE_SOURCES tag to YES will include the body of functions,900# classes and enums directly into the documentation.901# The default value is: NO.902 903INLINE_SOURCES         = NO904 905# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any906# special comment blocks from generated source code fragments. Normal C, C++ and907# Fortran comments will always remain visible.908# The default value is: YES.909 910STRIP_CODE_COMMENTS    = NO911 912# If the REFERENCED_BY_RELATION tag is set to YES then for each documented913# function all documented functions referencing it will be listed.914# The default value is: NO.915 916REFERENCED_BY_RELATION = YES917 918# If the REFERENCES_RELATION tag is set to YES then for each documented function919# all documented entities called/used by that function will be listed.920# The default value is: NO.921 922REFERENCES_RELATION    = YES923 924# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set925# to YES, then the hyperlinks from functions in REFERENCES_RELATION and926# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will927# link to the documentation.928# The default value is: YES.929 930REFERENCES_LINK_SOURCE = YES931 932# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the933# source code will show a tooltip with additional information such as prototype,934# brief description and links to the definition and documentation. Since this935# will make the HTML file larger and loading of large files a bit slower, you936# can opt to disable this feature.937# The default value is: YES.938# This tag requires that the tag SOURCE_BROWSER is set to YES.939 940SOURCE_TOOLTIPS        = YES941 942# If the USE_HTAGS tag is set to YES then the references to source code will943# point to the HTML generated by the htags(1) tool instead of doxygen built-in944# source browser. The htags tool is part of GNU's global source tagging system945# (see http://www.gnu.org/software/global/global.html). You will need version946# 4.8.6 or higher.947#948# To use it do the following:949# - Install the latest version of global950# - Enable SOURCE_BROWSER and USE_HTAGS in the config file951# - Make sure the INPUT points to the root of the source tree952# - Run doxygen as normal953#954# Doxygen will invoke htags (and that will in turn invoke gtags), so these955# tools must be available from the command line (i.e. in the search path).956#957# The result: instead of the source browser generated by doxygen, the links to958# source code will now point to the output of htags.959# The default value is: NO.960# This tag requires that the tag SOURCE_BROWSER is set to YES.961 962USE_HTAGS              = NO963 964# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a965# verbatim copy of the header file for each class for which an include is966# specified. Set to NO to disable this.967# See also: Section \class.968# The default value is: YES.969 970VERBATIM_HEADERS       = YES971 972#---------------------------------------------------------------------------973# Configuration options related to the alphabetical class index974#---------------------------------------------------------------------------975 976# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all977# compounds will be generated. Enable this if the project contains a lot of978# classes, structs, unions or interfaces.979# The default value is: YES.980 981ALPHABETICAL_INDEX     = YES982 983# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in984# which the alphabetical index list will be split.985# Minimum value: 1, maximum value: 20, default value: 5.986# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.987 988COLS_IN_ALPHA_INDEX    = 4989 990# In case all classes in a project start with a common prefix, all classes will991# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag992# can be used to specify a prefix (or a list of prefixes) that should be ignored993# while generating the index headers.994# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.995 996IGNORE_PREFIX          = clang::997 998#---------------------------------------------------------------------------999# Configuration options related to the HTML output1000#---------------------------------------------------------------------------1001 1002# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1003# The default value is: YES.1004 1005GENERATE_HTML          = YES1006 1007# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1008# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1009# it.1010# The default directory is: html.1011# This tag requires that the tag GENERATE_HTML is set to YES.1012 1013HTML_OUTPUT            = html1014 1015# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1016# generated HTML page (for example: .htm, .php, .asp).1017# The default value is: .html.1018# This tag requires that the tag GENERATE_HTML is set to YES.1019 1020HTML_FILE_EXTENSION    = .html1021 1022# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1023# each generated HTML page. If the tag is left blank doxygen will generate a1024# standard header.1025#1026# To get valid HTML the header file that includes any scripts and style sheets1027# that doxygen needs, which is dependent on the configuration options used (e.g.1028# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1029# default header using1030# doxygen -w html new_header.html new_footer.html new_stylesheet.css1031# YourConfigFile1032# and then modify the file new_header.html. See also section "Doxygen usage"1033# for information on how to generate the default header that doxygen normally1034# uses.1035# Note: The header is subject to change so you typically have to regenerate the1036# default header when upgrading to a newer version of doxygen. For a description1037# of the possible markers and block names see the documentation.1038# This tag requires that the tag GENERATE_HTML is set to YES.1039 1040HTML_HEADER            =1041 1042# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1043# generated HTML page. If the tag is left blank doxygen will generate a standard1044# footer. See HTML_HEADER for more information on how to generate a default1045# footer and what special commands can be used inside the footer. See also1046# section "Doxygen usage" for information on how to generate the default footer1047# that doxygen normally uses.1048# This tag requires that the tag GENERATE_HTML is set to YES.1049 1050HTML_FOOTER            =1051 1052# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1053# sheet that is used by each HTML page. It can be used to fine-tune the look of1054# the HTML output. If left blank doxygen will generate a default style sheet.1055# See also section "Doxygen usage" for information on how to generate the style1056# sheet that doxygen normally uses.1057# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1058# it is more robust and this tag (HTML_STYLESHEET) will in the future become1059# obsolete.1060# This tag requires that the tag GENERATE_HTML is set to YES.1061 1062HTML_STYLESHEET        =1063 1064# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-1065# defined cascading style sheet that is included after the standard style sheets1066# created by doxygen. Using this option one can overrule certain style aspects.1067# This is preferred over using HTML_STYLESHEET since it does not replace the1068# standard style sheet and is therefore more robust against future updates.1069# Doxygen will copy the style sheet file to the output directory. For an example1070# see the documentation.1071# This tag requires that the tag GENERATE_HTML is set to YES.1072 1073HTML_EXTRA_STYLESHEET  =1074 1075# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1076# other source files which should be copied to the HTML output directory. Note1077# that these files will be copied to the base HTML output directory. Use the1078# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1079# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1080# files will be copied as-is; there are no commands or markers available.1081# This tag requires that the tag GENERATE_HTML is set to YES.1082 1083HTML_EXTRA_FILES       =1084 1085# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1086# will adjust the colors in the stylesheet and background images according to1087# this color. Hue is specified as an angle on a colorwheel, see1088# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1089# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001090# purple, and 360 is red again.1091# Minimum value: 0, maximum value: 359, default value: 220.1092# This tag requires that the tag GENERATE_HTML is set to YES.1093 1094HTML_COLORSTYLE_HUE    = 2201095 1096# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1097# in the HTML output. For a value of 0 the output will use grayscales only. A1098# value of 255 will produce the most vivid colors.1099# Minimum value: 0, maximum value: 255, default value: 100.1100# This tag requires that the tag GENERATE_HTML is set to YES.1101 1102HTML_COLORSTYLE_SAT    = 1001103 1104# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1105# luminance component of the colors in the HTML output. Values below 1001106# gradually make the output lighter, whereas values above 100 make the output1107# darker. The value divided by 100 is the actual gamma applied, so 80 represents1108# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1109# change the gamma.1110# Minimum value: 40, maximum value: 240, default value: 80.1111# This tag requires that the tag GENERATE_HTML is set to YES.1112 1113HTML_COLORSTYLE_GAMMA  = 801114 1115# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1116# page will contain the date and time when the page was generated. Setting this1117# to NO can help when comparing the output of multiple runs.1118# The default value is: YES.1119# This tag requires that the tag GENERATE_HTML is set to YES.1120 1121HTML_TIMESTAMP         = YES1122 1123# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1124# documentation will contain sections that can be hidden and shown after the1125# page has loaded.1126# The default value is: NO.1127# This tag requires that the tag GENERATE_HTML is set to YES.1128 1129HTML_DYNAMIC_SECTIONS  = NO1130 1131# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1132# shown in the various tree structured indices initially; the user can expand1133# and collapse entries dynamically later on. Doxygen will expand the tree to1134# such a level that at most the specified number of entries are visible (unless1135# a fully collapsed tree already exceeds this amount). So setting the number of1136# entries 1 will produce a full collapsed tree by default. 0 is a special value1137# representing an infinite number of entries and will result in a full expanded1138# tree by default.1139# Minimum value: 0, maximum value: 9999, default value: 100.1140# This tag requires that the tag GENERATE_HTML is set to YES.1141 1142HTML_INDEX_NUM_ENTRIES = 1001143 1144# If the GENERATE_DOCSET tag is set to YES, additional index files will be1145# generated that can be used as input for Apple's Xcode 3 integrated development1146# environment (see: http://developer.apple.com/tools/xcode/), introduced with1147# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1148# Makefile in the HTML output directory. Running make will produce the docset in1149# that directory and running make install will install the docset in1150# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1151# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1152# for more information.1153# The default value is: NO.1154# This tag requires that the tag GENERATE_HTML is set to YES.1155 1156GENERATE_DOCSET        = NO1157 1158# This tag determines the name of the docset feed. A documentation feed provides1159# an umbrella under which multiple documentation sets from a single provider1160# (such as a company or product suite) can be grouped.1161# The default value is: Doxygen generated docs.1162# This tag requires that the tag GENERATE_DOCSET is set to YES.1163 1164DOCSET_FEEDNAME        = "Doxygen generated docs"1165 1166# This tag specifies a string that should uniquely identify the documentation1167# set bundle. This should be a reverse domain-name style string, e.g.1168# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1169# The default value is: org.doxygen.Project.1170# This tag requires that the tag GENERATE_DOCSET is set to YES.1171 1172DOCSET_BUNDLE_ID       = org.doxygen.Project1173 1174# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1175# the documentation publisher. This should be a reverse domain-name style1176# string, e.g. com.mycompany.MyDocSet.documentation.1177# The default value is: org.doxygen.Publisher.1178# This tag requires that the tag GENERATE_DOCSET is set to YES.1179 1180DOCSET_PUBLISHER_ID    = org.doxygen.Publisher1181 1182# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1183# The default value is: Publisher.1184# This tag requires that the tag GENERATE_DOCSET is set to YES.1185 1186DOCSET_PUBLISHER_NAME  = Publisher1187 1188# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1189# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1190# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1191# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1192# Windows.1193#1194# The HTML Help Workshop contains a compiler that can convert all HTML output1195# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1196# files are now used as the Windows 98 help format, and will replace the old1197# Windows help format (.hlp) on all Windows platforms in the future. Compressed1198# HTML files also contain an index, a table of contents, and you can search for1199# words in the documentation. The HTML workshop also contains a viewer for1200# compressed HTML files.1201# The default value is: NO.1202# This tag requires that the tag GENERATE_HTML is set to YES.1203 1204GENERATE_HTMLHELP      = NO1205 1206# The CHM_FILE tag can be used to specify the file name of the resulting .chm1207# file. You can add a path in front of the file if the result should not be1208# written to the html output directory.1209# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1210 1211CHM_FILE               =1212 1213# The HHC_LOCATION tag can be used to specify the location (absolute path1214# including file name) of the HTML help compiler ( hhc.exe). If non-empty1215# doxygen will try to run the HTML help compiler on the generated index.hhp.1216# The file has to be specified with full path.1217# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1218 1219HHC_LOCATION           =1220 1221# The GENERATE_CHI flag controls if a separate .chi index file is generated (1222# YES) or that it should be included in the main .chm file ( NO).1223# The default value is: NO.1224# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1225 1226GENERATE_CHI           = NO1227 1228# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)1229# and project file content.1230# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1231 1232CHM_INDEX_ENCODING     =1233 1234# The BINARY_TOC flag controls whether a binary table of contents is generated (1235# YES) or a normal table of contents ( NO) in the .chm file.1236# The default value is: NO.1237# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1238 1239BINARY_TOC             = NO1240 1241# The TOC_EXPAND flag can be set to YES to add extra items for group members to1242# the table of contents of the HTML help documentation and to the tree view.1243# The default value is: NO.1244# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1245 1246TOC_EXPAND             = NO1247 1248# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1249# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1250# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1251# (.qch) of the generated HTML documentation.1252# The default value is: NO.1253# This tag requires that the tag GENERATE_HTML is set to YES.1254 1255GENERATE_QHP           = @clang_doxygen_generate_qhp@1256 1257# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1258# the file name of the resulting .qch file. The path specified is relative to1259# the HTML output folder.1260# This tag requires that the tag GENERATE_QHP is set to YES.1261 1262QCH_FILE               = @clang_doxygen_qch_filename@1263 1264# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1265# Project output. For more information please see Qt Help Project / Namespace1266# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1267# The default value is: org.doxygen.Project.1268# This tag requires that the tag GENERATE_QHP is set to YES.1269 1270QHP_NAMESPACE          = @clang_doxygen_qhp_namespace@1271 1272# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1273# Help Project output. For more information please see Qt Help Project / Virtual1274# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1275# folders).1276# The default value is: doc.1277# This tag requires that the tag GENERATE_QHP is set to YES.1278 1279QHP_VIRTUAL_FOLDER     = doc1280 1281# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1282# filter to add. For more information please see Qt Help Project / Custom1283# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1284# filters).1285# This tag requires that the tag GENERATE_QHP is set to YES.1286 1287QHP_CUST_FILTER_NAME   = @clang_doxygen_qhp_cust_filter_name@1288 1289# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1290# custom filter to add. For more information please see Qt Help Project / Custom1291# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1292# filters).1293# This tag requires that the tag GENERATE_QHP is set to YES.1294 1295QHP_CUST_FILTER_ATTRS  = @clang_doxygen_qhp_cust_filter_attrs@1296 1297# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1298# project's filter section matches. Qt Help Project / Filter Attributes (see:1299# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1300# This tag requires that the tag GENERATE_QHP is set to YES.1301 1302QHP_SECT_FILTER_ATTRS  =1303 1304# The QHG_LOCATION tag can be used to specify the location of Qt's1305# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1306# generated .qhp file.1307# This tag requires that the tag GENERATE_QHP is set to YES.1308 1309QHG_LOCATION           = @clang_doxygen_qhelpgenerator_path@1310 1311# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1312# generated, together with the HTML files, they form an Eclipse help plugin. To1313# install this plugin and make it available under the help contents menu in1314# Eclipse, the contents of the directory containing the HTML and XML files needs1315# to be copied into the plugins directory of eclipse. The name of the directory1316# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1317# After copying Eclipse needs to be restarted before the help appears.1318# The default value is: NO.1319# This tag requires that the tag GENERATE_HTML is set to YES.1320 1321GENERATE_ECLIPSEHELP   = NO1322 1323# A unique identifier for the Eclipse help plugin. When installing the plugin1324# the directory name containing the HTML and XML files should also have this1325# name. Each documentation set should have its own identifier.1326# The default value is: org.doxygen.Project.1327# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1328 1329ECLIPSE_DOC_ID         = org.doxygen.Project1330 1331# If you want full control over the layout of the generated HTML pages it might1332# be necessary to disable the index and replace it with your own. The1333# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1334# of each HTML page. A value of NO enables the index and the value YES disables1335# it. Since the tabs in the index contain the same information as the navigation1336# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1337# The default value is: NO.1338# This tag requires that the tag GENERATE_HTML is set to YES.1339 1340DISABLE_INDEX          = NO1341 1342# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1343# structure should be generated to display hierarchical information. If the tag1344# value is set to YES, a side panel will be generated containing a tree-like1345# index structure (just like the one that is generated for HTML Help). For this1346# to work a browser that supports JavaScript, DHTML, CSS and frames is required1347# (i.e. any modern browser). Windows users are probably better off using the1348# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can1349# further fine-tune the look of the index. As an example, the default style1350# sheet generated by doxygen has an example that shows how to put an image at1351# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1352# the same information as the tab index, you could consider setting1353# DISABLE_INDEX to YES when enabling this option.1354# The default value is: NO.1355# This tag requires that the tag GENERATE_HTML is set to YES.1356 1357GENERATE_TREEVIEW      = NO1358 1359# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1360# doxygen will group on one line in the generated HTML documentation.1361#1362# Note that a value of 0 will completely suppress the enum values from appearing1363# in the overview section.1364# Minimum value: 0, maximum value: 20, default value: 4.1365# This tag requires that the tag GENERATE_HTML is set to YES.1366 1367ENUM_VALUES_PER_LINE   = 41368 1369# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1370# to set the initial width (in pixels) of the frame in which the tree is shown.1371# Minimum value: 0, maximum value: 1500, default value: 250.1372# This tag requires that the tag GENERATE_HTML is set to YES.1373 1374TREEVIEW_WIDTH         = 2501375 1376# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to1377# external symbols imported via tag files in a separate window.1378# The default value is: NO.1379# This tag requires that the tag GENERATE_HTML is set to YES.1380 1381EXT_LINKS_IN_WINDOW    = NO1382 1383# Use this tag to change the font size of LaTeX formulas included as images in1384# the HTML documentation. When you change the font size after a successful1385# doxygen run you need to manually remove any form_*.png images from the HTML1386# output directory to force them to be regenerated.1387# Minimum value: 8, maximum value: 50, default value: 10.1388# This tag requires that the tag GENERATE_HTML is set to YES.1389 1390FORMULA_FONTSIZE       = 101391 1392# Use the FORMULA_TRANPARENT tag to determine whether or not the images1393# generated for formulas are transparent PNGs. Transparent PNGs are not1394# supported properly for IE 6.0, but are supported on all modern browsers.1395#1396# Note that when changing this option you need to delete any form_*.png files in1397# the HTML output directory before the changes have effect.1398# The default value is: YES.1399# This tag requires that the tag GENERATE_HTML is set to YES.1400 1401FORMULA_TRANSPARENT    = YES1402 1403# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1404# http://www.mathjax.org) which uses client side Javascript for the rendering1405# instead of using prerendered bitmaps. Use this if you do not have LaTeX1406# installed or if you want to formulas look prettier in the HTML output. When1407# enabled you may also need to install MathJax separately and configure the path1408# to it using the MATHJAX_RELPATH option.1409# The default value is: NO.1410# This tag requires that the tag GENERATE_HTML is set to YES.1411 1412USE_MATHJAX            = NO1413 1414# When MathJax is enabled you can set the default output format to be used for1415# the MathJax output. See the MathJax site (see:1416# http://docs.mathjax.org/en/latest/output.html) for more details.1417# Possible values are: HTML-CSS (which is slower, but has the best1418# compatibility), NativeMML (i.e. MathML) and SVG.1419# The default value is: HTML-CSS.1420# This tag requires that the tag USE_MATHJAX is set to YES.1421 1422MATHJAX_FORMAT         = HTML-CSS1423 1424# When MathJax is enabled you need to specify the location relative to the HTML1425# output directory using the MATHJAX_RELPATH option. The destination directory1426# should contain the MathJax.js script. For instance, if the mathjax directory1427# is located at the same level as the HTML output directory, then1428# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1429# Content Delivery Network so you can quickly see the result without installing1430# MathJax. However, it is strongly recommended to install a local copy of1431# MathJax from http://www.mathjax.org before deployment.1432# The default value is: http://cdn.mathjax.org/mathjax/latest.1433# This tag requires that the tag USE_MATHJAX is set to YES.1434 1435MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest1436 1437# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1438# extension names that should be enabled during MathJax rendering. For example1439# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1440# This tag requires that the tag USE_MATHJAX is set to YES.1441 1442MATHJAX_EXTENSIONS     =1443 1444# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1445# of code that will be used on startup of the MathJax code. See the MathJax site1446# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1447# example see the documentation.1448# This tag requires that the tag USE_MATHJAX is set to YES.1449 1450MATHJAX_CODEFILE       =1451 1452# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1453# the HTML output. The underlying search engine uses javascript and DHTML and1454# should work on any modern browser. Note that when using HTML help1455# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1456# there is already a search function so this one should typically be disabled.1457# For large projects the javascript based search engine can be slow, then1458# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1459# search using the keyboard; to jump to the search box use <access key> + S1460# (what the <access key> is depends on the OS and browser, but it is typically1461# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1462# key> to jump into the search results window, the results can be navigated1463# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1464# the search. The filter options can be selected when the cursor is inside the1465# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1466# to select a filter and <Enter> or <escape> to activate or cancel the filter1467# option.1468# The default value is: YES.1469# This tag requires that the tag GENERATE_HTML is set to YES.1470 1471SEARCHENGINE           = @enable_searchengine@1472 1473# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1474# implemented using a web server instead of a web client using Javascript. There1475# are two flavours of web server based searching depending on the1476# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1477# searching and an index file used by the script. When EXTERNAL_SEARCH is1478# enabled the indexing and searching needs to be provided by external tools. See1479# the section "External Indexing and Searching" for details.1480# The default value is: NO.1481# This tag requires that the tag SEARCHENGINE is set to YES.1482 1483SERVER_BASED_SEARCH    = @enable_server_based_search@1484 1485# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1486# script for searching. Instead the search results are written to an XML file1487# which needs to be processed by an external indexer. Doxygen will invoke an1488# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1489# search results.1490#1491# Doxygen ships with an example indexer ( doxyindexer) and search engine1492# (doxysearch.cgi) which are based on the open source search engine library1493# Xapian (see: http://xapian.org/).1494#1495# See the section "External Indexing and Searching" for details.1496# The default value is: NO.1497# This tag requires that the tag SEARCHENGINE is set to YES.1498 1499EXTERNAL_SEARCH        = @enable_external_search@1500 1501# The SEARCHENGINE_URL should point to a search engine hosted by a web server1502# which will return the search results when EXTERNAL_SEARCH is enabled.1503#1504# Doxygen ships with an example indexer ( doxyindexer) and search engine1505# (doxysearch.cgi) which are based on the open source search engine library1506# Xapian (see: http://xapian.org/). See the section "External Indexing and1507# Searching" for details.1508# This tag requires that the tag SEARCHENGINE is set to YES.1509 1510SEARCHENGINE_URL       = @searchengine_url@1511 1512# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1513# search data is written to a file for indexing by an external tool. With the1514# SEARCHDATA_FILE tag the name of this file can be specified.1515# The default file is: searchdata.xml.1516# This tag requires that the tag SEARCHENGINE is set to YES.1517 1518SEARCHDATA_FILE        = searchdata.xml1519 1520# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1521# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1522# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1523# projects and redirect the results back to the right project.1524# This tag requires that the tag SEARCHENGINE is set to YES.1525 1526EXTERNAL_SEARCH_ID     = clang1527 1528# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1529# projects other than the one defined by this configuration file, but that are1530# all added to the same external search index. Each project needs to have a1531# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1532# to a relative location where the documentation can be found. The format is:1533# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1534# This tag requires that the tag SEARCHENGINE is set to YES.1535 1536EXTRA_SEARCH_MAPPINGS  = @extra_search_mappings@1537 1538#---------------------------------------------------------------------------1539# Configuration options related to the LaTeX output1540#---------------------------------------------------------------------------1541 1542# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1543# The default value is: YES.1544 1545GENERATE_LATEX         = NO1546 1547# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1548# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1549# it.1550# The default directory is: latex.1551# This tag requires that the tag GENERATE_LATEX is set to YES.1552 1553LATEX_OUTPUT           = latex1554 1555# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1556# invoked.1557#1558# Note that when enabling USE_PDFLATEX this option is only used for generating1559# bitmaps for formulas in the HTML output, but not in the Makefile that is1560# written to the output directory.1561# The default file is: latex.1562# This tag requires that the tag GENERATE_LATEX is set to YES.1563 1564LATEX_CMD_NAME         = latex1565 1566# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1567# index for LaTeX.1568# The default file is: makeindex.1569# This tag requires that the tag GENERATE_LATEX is set to YES.1570 1571MAKEINDEX_CMD_NAME     = makeindex1572 1573# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX1574# documents. This may be useful for small projects and may help to save some1575# trees in general.1576# The default value is: NO.1577# This tag requires that the tag GENERATE_LATEX is set to YES.1578 1579COMPACT_LATEX          = NO1580 1581# The PAPER_TYPE tag can be used to set the paper type that is used by the1582# printer.1583# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1584# 14 inches) and executive (7.25 x 10.5 inches).1585# The default value is: a4.1586# This tag requires that the tag GENERATE_LATEX is set to YES.1587 1588PAPER_TYPE             = a41589 1590# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1591# that should be included in the LaTeX output. To get the times font for1592# instance you can specify1593# EXTRA_PACKAGES=times1594# If left blank no extra packages will be included.1595# This tag requires that the tag GENERATE_LATEX is set to YES.1596 1597EXTRA_PACKAGES         =1598 1599# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1600# generated LaTeX document. The header should contain everything until the first1601# chapter. If it is left blank doxygen will generate a standard header. See1602# section "Doxygen usage" for information on how to let doxygen write the1603# default header to a separate file.1604#1605# Note: Only use a user-defined header if you know what you are doing! The1606# following commands have a special meaning inside the header: $title,1607# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will1608# replace them by respectively the title of the page, the current date and time,1609# only the current date, the version number of doxygen, the project name (see1610# PROJECT_NAME), or the project number (see PROJECT_NUMBER).1611# This tag requires that the tag GENERATE_LATEX is set to YES.1612 1613LATEX_HEADER           =1614 1615# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1616# generated LaTeX document. The footer should contain everything after the last1617# chapter. If it is left blank doxygen will generate a standard footer.1618#1619# Note: Only use a user-defined footer if you know what you are doing!1620# This tag requires that the tag GENERATE_LATEX is set to YES.1621 1622LATEX_FOOTER           =1623 1624# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1625# other source files which should be copied to the LATEX_OUTPUT output1626# directory. Note that the files will be copied as-is; there are no commands or1627# markers available.1628# This tag requires that the tag GENERATE_LATEX is set to YES.1629 1630LATEX_EXTRA_FILES      =1631 1632# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1633# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1634# contain links (just like the HTML output) instead of page references. This1635# makes the output suitable for online browsing using a PDF viewer.1636# The default value is: YES.1637# This tag requires that the tag GENERATE_LATEX is set to YES.1638 1639PDF_HYPERLINKS         = YES1640 1641# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1642# the PDF file directly from the LaTeX files. Set this option to YES to get a1643# higher quality PDF documentation.1644# The default value is: YES.1645# This tag requires that the tag GENERATE_LATEX is set to YES.1646 1647USE_PDFLATEX           = YES1648 1649# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1650# command to the generated LaTeX files. This will instruct LaTeX to keep running1651# if errors occur, instead of asking the user for help. This option is also used1652# when generating formulas in HTML.1653# The default value is: NO.1654# This tag requires that the tag GENERATE_LATEX is set to YES.1655 1656LATEX_BATCHMODE        = NO1657 1658# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1659# index chapters (such as File Index, Compound Index, etc.) in the output.1660# The default value is: NO.1661# This tag requires that the tag GENERATE_LATEX is set to YES.1662 1663LATEX_HIDE_INDICES     = NO1664 1665# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1666# code with syntax highlighting in the LaTeX output.1667#1668# Note that which sources are shown also depends on other settings such as1669# SOURCE_BROWSER.1670# The default value is: NO.1671# This tag requires that the tag GENERATE_LATEX is set to YES.1672 1673LATEX_SOURCE_CODE      = NO1674 1675# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1676# bibliography, e.g. plainnat, or ieeetr. See1677# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1678# The default value is: plain.1679# This tag requires that the tag GENERATE_LATEX is set to YES.1680 1681LATEX_BIB_STYLE        = plain1682 1683#---------------------------------------------------------------------------1684# Configuration options related to the RTF output1685#---------------------------------------------------------------------------1686 1687# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1688# RTF output is optimized for Word 97 and may not look too pretty with other RTF1689# readers/editors.1690# The default value is: NO.1691 1692GENERATE_RTF           = NO1693 1694# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1695# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1696# it.1697# The default directory is: rtf.1698# This tag requires that the tag GENERATE_RTF is set to YES.1699 1700RTF_OUTPUT             = rtf1701 1702# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1703# documents. This may be useful for small projects and may help to save some1704# trees in general.1705# The default value is: NO.1706# This tag requires that the tag GENERATE_RTF is set to YES.1707 1708COMPACT_RTF            = NO1709 1710# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1711# contain hyperlink fields. The RTF file will contain links (just like the HTML1712# output) instead of page references. This makes the output suitable for online1713# browsing using Word or some other Word compatible readers that support those1714# fields.1715#1716# Note: WordPad (write) and others do not support links.1717# The default value is: NO.1718# This tag requires that the tag GENERATE_RTF is set to YES.1719 1720RTF_HYPERLINKS         = NO1721 1722# Load stylesheet definitions from file. Syntax is similar to doxygen's config1723# file, i.e. a series of assignments. You only have to provide replacements,1724# missing definitions are set to their default value.1725#1726# See also section "Doxygen usage" for information on how to generate the1727# default style sheet that doxygen normally uses.1728# This tag requires that the tag GENERATE_RTF is set to YES.1729 1730RTF_STYLESHEET_FILE    =1731 1732# Set optional variables used in the generation of an RTF document. Syntax is1733# similar to doxygen's config file. A template extensions file can be generated1734# using doxygen -e rtf extensionFile.1735# This tag requires that the tag GENERATE_RTF is set to YES.1736 1737RTF_EXTENSIONS_FILE    =1738 1739#---------------------------------------------------------------------------1740# Configuration options related to the man page output1741#---------------------------------------------------------------------------1742 1743# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1744# classes and files.1745# The default value is: NO.1746 1747GENERATE_MAN           = NO1748 1749# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1750# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1751# it. A directory man3 will be created inside the directory specified by1752# MAN_OUTPUT.1753# The default directory is: man.1754# This tag requires that the tag GENERATE_MAN is set to YES.1755 1756MAN_OUTPUT             = man1757 1758# The MAN_EXTENSION tag determines the extension that is added to the generated1759# man pages. In case the manual section does not start with a number, the number1760# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1761# optional.1762# The default value is: .3.1763# This tag requires that the tag GENERATE_MAN is set to YES.1764 1765MAN_EXTENSION          = .31766 1767# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1768# will generate one additional man file for each entity documented in the real1769# man page(s). These additional files only source the real man page, but without1770# them the man command would be unable to find the correct page.1771# The default value is: NO.1772# This tag requires that the tag GENERATE_MAN is set to YES.1773 1774MAN_LINKS              = NO1775 1776#---------------------------------------------------------------------------1777# Configuration options related to the XML output1778#---------------------------------------------------------------------------1779 1780# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1781# captures the structure of the code including all documentation.1782# The default value is: NO.1783 1784GENERATE_XML           = NO1785 1786# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1787# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1788# it.1789# The default directory is: xml.1790# This tag requires that the tag GENERATE_XML is set to YES.1791 1792XML_OUTPUT             = xml1793 1794# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1795# listings (including syntax highlighting and cross-referencing information) to1796# the XML output. Note that enabling this will significantly increase the size1797# of the XML output.1798# The default value is: YES.1799# This tag requires that the tag GENERATE_XML is set to YES.1800 1801XML_PROGRAMLISTING     = YES1802 1803#---------------------------------------------------------------------------1804# Configuration options related to the DOCBOOK output1805#---------------------------------------------------------------------------1806 1807# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1808# that can be used to generate PDF.1809# The default value is: NO.1810 1811GENERATE_DOCBOOK       = NO1812 1813# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1814# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1815# front of it.1816# The default directory is: docbook.1817# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1818 1819DOCBOOK_OUTPUT         = docbook1820 1821#---------------------------------------------------------------------------1822# Configuration options for the AutoGen Definitions output1823#---------------------------------------------------------------------------1824 1825# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1826# Definitions (see http://autogen.sf.net) file that captures the structure of1827# the code including all documentation. Note that this feature is still1828# experimental and incomplete at the moment.1829# The default value is: NO.1830 1831GENERATE_AUTOGEN_DEF   = NO1832 1833#---------------------------------------------------------------------------1834# Configuration options related to the Perl module output1835#---------------------------------------------------------------------------1836 1837# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module1838# file that captures the structure of the code including all documentation.1839#1840# Note that this feature is still experimental and incomplete at the moment.1841# The default value is: NO.1842 1843GENERATE_PERLMOD       = NO1844 1845# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary1846# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI1847# output from the Perl module output.1848# The default value is: NO.1849# This tag requires that the tag GENERATE_PERLMOD is set to YES.1850 1851PERLMOD_LATEX          = NO1852 1853# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely1854# formatted so it can be parsed by a human reader. This is useful if you want to1855# understand what is going on. On the other hand, if this tag is set to NO the1856# size of the Perl module output will be much smaller and Perl will parse it1857# just the same.1858# The default value is: YES.1859# This tag requires that the tag GENERATE_PERLMOD is set to YES.1860 1861PERLMOD_PRETTY         = YES1862 1863# The names of the make variables in the generated doxyrules.make file are1864# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful1865# so different doxyrules.make files included by the same Makefile don't1866# overwrite each other's variables.1867# This tag requires that the tag GENERATE_PERLMOD is set to YES.1868 1869PERLMOD_MAKEVAR_PREFIX =1870 1871#---------------------------------------------------------------------------1872# Configuration options related to the preprocessor1873#---------------------------------------------------------------------------1874 1875# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all1876# C-preprocessor directives found in the sources and include files.1877# The default value is: YES.1878 1879ENABLE_PREPROCESSING   = YES1880 1881# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1882# in the source code. If set to NO only conditional compilation will be1883# performed. Macro expansion can be done in a controlled way by setting1884# EXPAND_ONLY_PREDEF to YES.1885# The default value is: NO.1886# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1887 1888MACRO_EXPANSION        = YES1889 1890# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then1891# the macro expansion is limited to the macros specified with the PREDEFINED and1892# EXPAND_AS_DEFINED tags.1893# The default value is: NO.1894# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1895 1896EXPAND_ONLY_PREDEF     = YES1897 1898# If the SEARCH_INCLUDES tag is set to YES the includes files in the1899# INCLUDE_PATH will be searched if a #include is found.1900# The default value is: YES.1901# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1902 1903SEARCH_INCLUDES        = YES1904 1905# The INCLUDE_PATH tag can be used to specify one or more directories that1906# contain include files that are not input files but should be processed by the1907# preprocessor.1908# This tag requires that the tag SEARCH_INCLUDES is set to YES.1909 1910INCLUDE_PATH           = ../include1911 1912# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1913# patterns (like *.h and *.hpp) to filter out the header-files in the1914# directories. If left blank, the patterns specified with FILE_PATTERNS will be1915# used.1916# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1917 1918INCLUDE_FILE_PATTERNS  =1919 1920# The PREDEFINED tag can be used to specify one or more macro names that are1921# defined before the preprocessor is started (similar to the -D option of e.g.1922# gcc). The argument of the tag is a list of macros of the form: name or1923# name=definition (no spaces). If the definition and the "=" are omitted, "=1"1924# is assumed. To prevent a macro definition from being undefined via #undef or1925# recursively expanded use the := operator instead of the = operator.1926# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1927 1928PREDEFINED             =1929 1930# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this1931# tag can be used to specify a list of macro names that should be expanded. The1932# macro definition that is found in the sources will be used. Use the PREDEFINED1933# tag if you want to use a different macro definition that overrules the1934# definition found in the source code.1935# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1936 1937EXPAND_AS_DEFINED      =1938 1939# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will1940# remove all references to function-like macros that are alone on a line, have an1941# all uppercase name, and do not end with a semicolon. Such function macros are1942# typically used for boiler-plate code, and will confuse the parser if not1943# removed.1944# The default value is: YES.1945# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1946 1947SKIP_FUNCTION_MACROS   = YES1948 1949#---------------------------------------------------------------------------1950# Configuration options related to external references1951#---------------------------------------------------------------------------1952 1953# The TAGFILES tag can be used to specify one or more tag files. For each tag1954# file the location of the external documentation should be added. The format of1955# a tag file without this location is as follows:1956# TAGFILES = file1 file2 ...1957# Adding location for the tag files is done as follows:1958# TAGFILES = file1=loc1 "file2 = loc2" ...1959# where loc1 and loc2 can be relative or absolute paths or URLs. See the1960# section "Linking to external documentation" for more information about the use1961# of tag files.1962# Note: Each tag file must have an unique name (where the name does NOT include1963# the path). If a tag file is not located in the directory in which doxygen is1964# run, you must also specify the path to the tagfile here.1965 1966TAGFILES               =1967 1968# When a file name is specified after GENERATE_TAGFILE, doxygen will create a1969# tag file that is based on the input files it reads. See section "Linking to1970# external documentation" for more information about the usage of tag files.1971 1972GENERATE_TAGFILE       =1973 1974# If the ALLEXTERNALS tag is set to YES all external class will be listed in the1975# class index. If set to NO only the inherited external classes will be listed.1976# The default value is: NO.1977 1978ALLEXTERNALS           = YES1979 1980# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in1981# the modules index. If set to NO, only the current project's groups will be1982# listed.1983# The default value is: YES.1984 1985EXTERNAL_GROUPS        = YES1986 1987# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in1988# the related pages index. If set to NO, only the current project's pages will1989# be listed.1990# The default value is: YES.1991 1992EXTERNAL_PAGES         = YES1993 1994# The PERL_PATH should be the absolute path and name of the perl script1995# interpreter (i.e. the result of 'which perl').1996# The default file (with absolute path) is: /usr/bin/perl.1997 1998PERL_PATH              = /usr/bin/perl1999 2000#---------------------------------------------------------------------------2001# Configuration options related to the dot tool2002#---------------------------------------------------------------------------2003 2004# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2005# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2006# NO turns the diagrams off. Note that this option also works with HAVE_DOT2007# disabled, but it is recommended to install and use dot, since it yields more2008# powerful graphs.2009# The default value is: YES.2010 2011CLASS_DIAGRAMS         = YES2012 2013# You can define message sequence charts within doxygen comments using the \msc2014# command. Doxygen will then run the mscgen tool (see:2015# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2016# documentation. The MSCGEN_PATH tag allows you to specify the directory where2017# the mscgen tool resides. If left empty the tool is assumed to be found in the2018# default search path.2019 2020MSCGEN_PATH            =2021 2022# You can include diagrams made with dia in doxygen documentation. Doxygen will2023# then run dia to produce the diagram and insert it in the documentation. The2024# DIA_PATH tag allows you to specify the directory where the dia binary resides.2025# If left empty dia is assumed to be found in the default search path.2026 2027DIA_PATH               =2028 2029# If set to YES, the inheritance and collaboration graphs will hide inheritance2030# and usage relations if the target is undocumented or is not a class.2031# The default value is: YES.2032 2033HIDE_UNDOC_RELATIONS   = NO2034 2035# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2036# available from the path. This tool is part of Graphviz (see:2037# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2038# Bell Labs. The other options in this section have no effect if this option is2039# set to NO2040# The default value is: NO.2041 2042HAVE_DOT               = YES2043 2044# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2045# to run in parallel. When set to 0 doxygen will base this on the number of2046# processors available in the system. You can set it explicitly to a value2047# larger than 0 to get control over the balance between CPU load and processing2048# speed.2049# Minimum value: 0, maximum value: 32, default value: 0.2050# This tag requires that the tag HAVE_DOT is set to YES.2051 2052DOT_NUM_THREADS        = 02053 2054# When you want a differently looking font n the dot files that doxygen2055# generates you can specify the font name using DOT_FONTNAME. You need to make2056# sure dot is able to find the font, which can be done by putting it in a2057# standard location or by setting the DOTFONTPATH environment variable or by2058# setting DOT_FONTPATH to the directory containing the font.2059# The default value is: Helvetica.2060# This tag requires that the tag HAVE_DOT is set to YES.2061 2062DOT_FONTNAME           = Helvetica2063 2064# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2065# dot graphs.2066# Minimum value: 4, maximum value: 24, default value: 10.2067# This tag requires that the tag HAVE_DOT is set to YES.2068 2069DOT_FONTSIZE           = 102070 2071# By default doxygen will tell dot to use the default font as specified with2072# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2073# the path where dot can find it using this tag.2074# This tag requires that the tag HAVE_DOT is set to YES.2075 2076DOT_FONTPATH           =2077 2078# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2079# each documented class showing the direct and indirect inheritance relations.2080# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2081# The default value is: YES.2082# This tag requires that the tag HAVE_DOT is set to YES.2083 2084CLASS_GRAPH            = YES2085 2086# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2087# graph for each documented class showing the direct and indirect implementation2088# dependencies (inheritance, containment, and class references variables) of the2089# class with other documented classes.2090# The default value is: YES.2091# This tag requires that the tag HAVE_DOT is set to YES.2092 2093COLLABORATION_GRAPH    = NO2094 2095# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2096# groups, showing the direct groups dependencies.2097# The default value is: YES.2098# This tag requires that the tag HAVE_DOT is set to YES.2099 2100GROUP_GRAPHS           = YES2101 2102# If the UML_LOOK tag is set to YES doxygen will generate inheritance and2103# collaboration diagrams in a style similar to the OMG's Unified Modeling2104# Language.2105# The default value is: NO.2106# This tag requires that the tag HAVE_DOT is set to YES.2107 2108UML_LOOK               = NO2109 2110# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2111# class node. If there are many fields or methods and many nodes the graph may2112# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2113# number of items for each type to make the size more manageable. Set this to 02114# for no limit. Note that the threshold may be exceeded by 50% before the limit2115# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2116# but if the number exceeds 15, the total amount of fields shown is limited to2117# 10.2118# Minimum value: 0, maximum value: 100, default value: 10.2119# This tag requires that the tag HAVE_DOT is set to YES.2120 2121UML_LIMIT_NUM_FIELDS   = 102122 2123# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2124# collaboration graphs will show the relations between templates and their2125# instances.2126# The default value is: NO.2127# This tag requires that the tag HAVE_DOT is set to YES.2128 2129TEMPLATE_RELATIONS     = YES2130 2131# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2132# YES then doxygen will generate a graph for each documented file showing the2133# direct and indirect include dependencies of the file with other documented2134# files.2135# The default value is: YES.2136# This tag requires that the tag HAVE_DOT is set to YES.2137 2138INCLUDE_GRAPH          = NO2139 2140# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2141# set to YES then doxygen will generate a graph for each documented file showing2142# the direct and indirect include dependencies of the file with other documented2143# files.2144# The default value is: YES.2145# This tag requires that the tag HAVE_DOT is set to YES.2146 2147INCLUDED_BY_GRAPH      = NO2148 2149# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2150# dependency graph for every global function or class method.2151#2152# Note that enabling this option will significantly increase the time of a run.2153# So in most cases it will be better to enable call graphs for selected2154# functions only using the \callgraph command.2155# The default value is: NO.2156# This tag requires that the tag HAVE_DOT is set to YES.2157 2158CALL_GRAPH             = NO2159 2160# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2161# dependency graph for every global function or class method.2162#2163# Note that enabling this option will significantly increase the time of a run.2164# So in most cases it will be better to enable caller graphs for selected2165# functions only using the \callergraph command.2166# The default value is: NO.2167# This tag requires that the tag HAVE_DOT is set to YES.2168 2169CALLER_GRAPH           = NO2170 2171# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2172# hierarchy of all classes instead of a textual one.2173# The default value is: YES.2174# This tag requires that the tag HAVE_DOT is set to YES.2175 2176GRAPHICAL_HIERARCHY    = YES2177 2178# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2179# dependencies a directory has on other directories in a graphical way. The2180# dependency relations are determined by the #include relations between the2181# files in the directories.2182# The default value is: YES.2183# This tag requires that the tag HAVE_DOT is set to YES.2184 2185DIRECTORY_GRAPH        = YES2186 2187# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2188# generated by dot.2189# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2190# to make the SVG files visible in IE 9+ (other browsers do not have this2191# requirement).2192# Possible values are: png, jpg, gif and svg.2193# The default value is: png.2194# This tag requires that the tag HAVE_DOT is set to YES.2195 2196DOT_IMAGE_FORMAT       = svg2197 2198# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2199# enable generation of interactive SVG images that allow zooming and panning.2200#2201# Note that this requires a modern browser other than Internet Explorer. Tested2202# and working are Firefox, Chrome, Safari, and Opera.2203# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2204# the SVG files visible. Older versions of IE do not have SVG support.2205# The default value is: NO.2206# This tag requires that the tag HAVE_DOT is set to YES.2207 2208INTERACTIVE_SVG        = NO2209 2210# The DOT_PATH tag can be used to specify the path where the dot tool can be2211# found. If left blank, it is assumed the dot tool can be found in the path.2212# This tag requires that the tag HAVE_DOT is set to YES.2213 2214DOT_PATH               = @DOT@2215 2216# The DOTFILE_DIRS tag can be used to specify one or more directories that2217# contain dot files that are included in the documentation (see the \dotfile2218# command).2219# This tag requires that the tag HAVE_DOT is set to YES.2220 2221DOTFILE_DIRS           =2222 2223# The MSCFILE_DIRS tag can be used to specify one or more directories that2224# contain msc files that are included in the documentation (see the \mscfile2225# command).2226 2227MSCFILE_DIRS           =2228 2229# The DIAFILE_DIRS tag can be used to specify one or more directories that2230# contain dia files that are included in the documentation (see the \diafile2231# command).2232 2233DIAFILE_DIRS           =2234 2235# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2236# that will be shown in the graph. If the number of nodes in a graph becomes2237# larger than this value, doxygen will truncate the graph, which is visualized2238# by representing a node as a red box. Note that doxygen if the number of direct2239# children of the root node in a graph is already larger than2240# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2241# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2242# Minimum value: 0, maximum value: 10000, default value: 50.2243# This tag requires that the tag HAVE_DOT is set to YES.2244 2245DOT_GRAPH_MAX_NODES    = 502246 2247# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2248# generated by dot. A depth value of 3 means that only nodes reachable from the2249# root by following a path via at most 3 edges will be shown. Nodes that lay2250# further from the root node will be omitted. Note that setting this option to 12251# or 2 may greatly reduce the computation time needed for large code bases. Also2252# note that the size of a graph can be further restricted by2253# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2254# Minimum value: 0, maximum value: 1000, default value: 0.2255# This tag requires that the tag HAVE_DOT is set to YES.2256 2257MAX_DOT_GRAPH_DEPTH    = 02258 2259# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2260# background. This is disabled by default, because dot on Windows does not seem2261# to support this out of the box.2262#2263# Warning: Depending on the platform used, enabling this option may lead to2264# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2265# read).2266# The default value is: NO.2267# This tag requires that the tag HAVE_DOT is set to YES.2268 2269DOT_TRANSPARENT        = YES2270 2271# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2272# files in one run (i.e. multiple -o and -T options on the command line). This2273# makes dot run faster, but since only newer versions of dot (>1.8.10) support2274# this, this feature is disabled by default.2275# The default value is: NO.2276# This tag requires that the tag HAVE_DOT is set to YES.2277 2278DOT_MULTI_TARGETS      = YES2279 2280# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2281# explaining the meaning of the various boxes and arrows in the dot generated2282# graphs.2283# The default value is: YES.2284# This tag requires that the tag HAVE_DOT is set to YES.2285 2286GENERATE_LEGEND        = YES2287 2288# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2289# files that are used to generate the various graphs.2290# The default value is: YES.2291# This tag requires that the tag HAVE_DOT is set to YES.2292 2293DOT_CLEANUP            = YES2294