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           = "FLANG"36 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         =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_top_builddir@/doxygen/62 63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-64# directories (in 2 levels) under the output directory of each output format 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_top_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_top_srcdir@/../include157STRIP_FROM_INC_PATH    += @abs_top_srcdir@/../lib158STRIP_FROM_INC_PATH    += @abs_top_srcdir@/../runtime159 160# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but161# less readable) file names. This can be useful is your file systems doesn't162# support long names like on DOS, Mac, or CD-ROM.163# The default value is: NO.164 165SHORT_NAMES            = NO166 167# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the168# first line (until the first dot) of a Javadoc-style comment as the brief169# description. If set to NO, the Javadoc-style will behave just like regular Qt-170# style comments (thus requiring an explicit @brief command for a brief171# description.)172# The default value is: NO.173 174JAVADOC_AUTOBRIEF      = NO175 176# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first177# line (until the first dot) of a Qt-style comment as the brief description. If178# set to NO, the Qt-style will behave just like regular Qt-style comments (thus179# requiring an explicit \brief command for a brief description.)180# The default value is: NO.181 182QT_AUTOBRIEF           = NO183 184# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a185# multi-line C++ special comment block (i.e. a block of //! or /// comments) as186# a brief description. This used to be the default behavior. The new default is187# to treat a multi-line C++ comment block as a detailed description. Set this188# tag to YES if you prefer the old behavior instead.189#190# Note that setting this tag to YES also means that rational rose comments are191# not recognized any more.192# The default value is: NO.193 194MULTILINE_CPP_IS_BRIEF = NO195 196# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the197# documentation from any documented member that it re-implements.198# The default value is: YES.199 200INHERIT_DOCS           = YES201 202# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a203# new page for each member. If set to NO, the documentation of a member will be204# part of the file/class/namespace that contains it.205# The default value is: NO.206 207SEPARATE_MEMBER_PAGES  = NO208 209# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen210# uses this value to replace tabs by spaces in code fragments.211# Minimum value: 1, maximum value: 16, default value: 4.212 213TAB_SIZE               = 4214 215# This tag can be used to specify a number of aliases that act as commands in216# the documentation. An alias has the form:217# name=value218# For example adding219# "sideeffect=@par Side Effects:\n"220# will allow you to put the command \sideeffect (or @sideeffect) in the221# documentation, which will result in a user-defined paragraph with heading222# "Side Effects:". You can put \n's in the value part of an alias to insert223# newlines.224 225ALIASES                =226 227# This tag can be used to specify a number of word-keyword mappings (TCL only).228# A mapping has the form "name=value". For example adding "class=itcl::class"229# will allow you to use the command class in the itcl::class meaning.230 231TCL_SUBST              =232 233# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources234# only. Doxygen will then generate output that is more tailored for C. For235# instance, some of the names that are used will be different. The list of all236# members will be omitted, etc.237# The default value is: NO.238 239OPTIMIZE_OUTPUT_FOR_C  = NO240 241# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or242# Python sources only. Doxygen will then generate output that is more tailored243# for that language. For instance, namespaces will be presented as packages,244# qualified scopes will look different, etc.245# The default value is: NO.246 247OPTIMIZE_OUTPUT_JAVA   = NO248 249# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran250# sources. Doxygen will then generate output that is tailored for Fortran.251# The default value is: NO.252 253OPTIMIZE_FOR_FORTRAN   = NO254 255# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL256# sources. Doxygen will then generate output that is tailored for VHDL.257# The default value is: NO.258 259OPTIMIZE_OUTPUT_VHDL   = NO260 261# Doxygen selects the parser to use depending on the extension of the files it262# parses. With this tag you can assign which parser to use for a given263# extension. Doxygen has a built-in mapping, but you can override or extend it264# using this tag. The format is ext=language, where ext is a file extension, and265# language is one of the parsers supported by doxygen: IDL, Java, Javascript,266# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make267# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C268# (default is Fortran), use: inc=Fortran f=C.269#270# Note For files without extension you can use no_extension as a placeholder.271#272# Note that for custom extensions you also need to set FILE_PATTERNS otherwise273# the files are not read by doxygen.274 275EXTENSION_MAPPING      =276 277# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments278# according to the Markdown format, which allows for more readable279# documentation. See http://daringfireball.net/projects/markdown/ for details.280# The output of markdown processing is further processed by doxygen, so you can281# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in282# case of backward compatibilities issues.283# The default value is: YES.284 285MARKDOWN_SUPPORT       = YES286 287# When enabled doxygen tries to link words that correspond to documented288# classes, or namespaces to their corresponding documentation. Such a link can289# be prevented in individual cases by by putting a % sign in front of the word290# or globally by setting AUTOLINK_SUPPORT to NO.291# The default value is: YES.292 293AUTOLINK_SUPPORT       = YES294 295# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want296# to include (a tag file for) the STL sources as input, then you should set this297# tag to YES in order to let doxygen match functions declarations and298# definitions whose arguments contain STL classes (e.g. func(std::string);299# versus func(std::string) {}). This also make the inheritance and collaboration300# diagrams that involve STL classes more complete and accurate.301# The default value is: NO.302 303BUILTIN_STL_SUPPORT    = NO304 305# If you use Microsoft's C++/CLI language, you should set this option to YES to306# enable parsing support.307# The default value is: NO.308 309CPP_CLI_SUPPORT        = NO310 311# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:312# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen313# will parse them like normal C++ but will assume all classes use public instead314# of private inheritance when no explicit protection keyword is present.315# The default value is: NO.316 317SIP_SUPPORT            = NO318 319# For Microsoft's IDL there are propget and propput attributes to indicate320# getter and setter methods for a property. Setting this option to YES will make321# doxygen to replace the get and set methods by a property in the documentation.322# This will only work if the methods are indeed getting or setting a simple323# type. If this is not the case, or you want to show the methods anyway, you324# should set this option to NO.325# The default value is: YES.326 327IDL_PROPERTY_SUPPORT   = YES328 329# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC330# tag is set to YES, then doxygen will reuse the documentation of the first331# member in the group (if any) for the other members of the group. By default332# all members of a group must be documented explicitly.333# The default value is: NO.334 335DISTRIBUTE_GROUP_DOC   = NO336 337# Set the SUBGROUPING tag to YES to allow class member groups of the same type338# (for instance a group of public functions) to be put as a subgroup of that339# type (e.g. under the Public Functions section). Set it to NO to prevent340# subgrouping. Alternatively, this can be done per class using the341# \nosubgrouping command.342# The default value is: YES.343 344SUBGROUPING            = YES345 346# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions347# are shown inside the group in which they are included (e.g. using \ingroup)348# instead of on a separate page (for HTML and Man pages) or section (for LaTeX349# and RTF).350#351# Note that this feature does not work in combination with352# SEPARATE_MEMBER_PAGES.353# The default value is: NO.354 355INLINE_GROUPED_CLASSES = NO356 357# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions358# with only public data fields or simple typedef fields will be shown inline in359# the documentation of the scope in which they are defined (i.e. file,360# namespace, or group documentation), provided this scope is documented. If set361# to NO, structs, classes, and unions are shown on a separate page (for HTML and362# Man pages) or section (for LaTeX and RTF).363# The default value is: NO.364 365INLINE_SIMPLE_STRUCTS  = NO366 367# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or368# enum is documented as struct, union, or enum with the name of the typedef. So369# typedef struct TypeS {} TypeT, will appear in the documentation as a struct370# with name TypeT. When disabled the typedef will appear as a member of a file,371# namespace, or class. And the struct will be named TypeS. This can typically be372# useful for C code in case the coding convention dictates that all compound373# types are typedef'ed and only the typedef is referenced, never the tag name.374# The default value is: NO.375 376TYPEDEF_HIDES_STRUCT   = NO377 378# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This379# cache is used to resolve symbols given their name and scope. Since this can be380# an expensive process and often the same symbol appears multiple times in the381# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small382# doxygen will become slower. If the cache is too large, memory is wasted. The383# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range384# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536385# symbols. At the end of a run doxygen will report the cache usage and suggest386# the optimal cache size from a speed point of view.387# Minimum value: 0, maximum value: 9, default value: 0.388 389LOOKUP_CACHE_SIZE      = 0390 391#---------------------------------------------------------------------------392# Build related configuration options393#---------------------------------------------------------------------------394 395# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in396# documentation are documented, even if no documentation was available. Private397# class members and static file members will be hidden unless the398# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.399# Note: This will also disable the warnings about undocumented members that are400# normally produced when WARNINGS is set to YES.401# The default value is: NO.402 403EXTRACT_ALL            = NO404 405# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will406# be included in the documentation.407# The default value is: NO.408 409EXTRACT_PRIVATE        = NO410 411# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal412# scope will be included in the documentation.413# The default value is: NO.414 415EXTRACT_PACKAGE        = NO416 417# If the EXTRACT_STATIC tag is set to YES all static members of a file will be418# included in the documentation.419# The default value is: NO.420 421EXTRACT_STATIC         = NO422 423# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined424# locally in source files will be included in the documentation. If set to NO425# only classes defined in header files are included. Does not have any effect426# for Java sources.427# The default value is: YES.428 429EXTRACT_LOCAL_CLASSES  = YES430 431# This flag is only useful for Objective-C code. When set to YES local methods,432# which are defined in the implementation section but not in the interface are433# included in the documentation. If set to NO only methods in the interface are434# included.435# The default value is: NO.436 437EXTRACT_LOCAL_METHODS  = NO438 439# If this flag is set to YES, the members of anonymous namespaces will be440# extracted and appear in the documentation as a namespace called441# 'anonymous_namespace{file}', where file will be replaced with the base name of442# the file that contains the anonymous namespace. By default anonymous namespace443# are hidden.444# The default value is: NO.445 446EXTRACT_ANON_NSPACES   = NO447 448# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all449# undocumented members inside documented classes or files. If set to NO these450# members will be included in the various overviews, but no documentation451# section is generated. This option has no effect if EXTRACT_ALL is enabled.452# The default value is: NO.453 454HIDE_UNDOC_MEMBERS     = NO455 456# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all457# undocumented classes that are normally visible in the class hierarchy. If set458# to NO these classes will be included in the various overviews. This option has459# no effect if EXTRACT_ALL is enabled.460# The default value is: NO.461 462HIDE_UNDOC_CLASSES     = NO463 464# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend465# (class|struct|union) declarations. If set to NO these declarations will be466# included in the documentation.467# The default value is: NO.468 469HIDE_FRIEND_COMPOUNDS  = NO470 471# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any472# documentation blocks found inside the body of a function. If set to NO these473# blocks will be appended to the function's detailed documentation block.474# The default value is: NO.475 476HIDE_IN_BODY_DOCS      = NO477 478# The INTERNAL_DOCS tag determines if documentation that is typed after a479# \internal command is included. If the tag is set to NO then the documentation480# will be excluded. Set it to YES to include the internal documentation.481# The default value is: NO.482 483INTERNAL_DOCS          = NO484 485# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file486# names in lower-case letters. If set to YES upper-case letters are also487# allowed. This is useful if you have classes or files whose names only differ488# in case and if your file system supports case sensitive file names. Windows489# and Mac users are advised to set this option to NO.490# The default value is: system dependent.491 492CASE_SENSE_NAMES       = YES493 494# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with495# their full class and namespace scopes in the documentation. If set to YES the496# scope will be hidden.497# The default value is: NO.498 499HIDE_SCOPE_NAMES       = NO500 501# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of502# the files that are included by a file in the documentation of that file.503# The default value is: YES.504 505SHOW_INCLUDE_FILES     = YES506 507# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each508# grouped member an include statement to the documentation, telling the reader509# which file to include in order to use the member.510# The default value is: NO.511 512SHOW_GROUPED_MEMB_INC  = NO513 514# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include515# files with double quotes in the documentation rather than with sharp brackets.516# The default value is: NO.517 518FORCE_LOCAL_INCLUDES   = NO519 520# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the521# documentation for inline members.522# The default value is: YES.523 524INLINE_INFO            = YES525 526# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the527# (detailed) documentation of file and class members alphabetically by member528# name. If set to NO the members will appear in declaration order.529# The default value is: YES.530 531SORT_MEMBER_DOCS       = YES532 533# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief534# descriptions of file, namespace and class members alphabetically by member535# name. If set to NO the members will appear in declaration order. Note that536# this will also influence the order of the classes in the class list.537# The default value is: NO.538 539SORT_BRIEF_DOCS        = NO540 541# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the542# (brief and detailed) documentation of class members so that constructors and543# destructors are listed first. If set to NO the constructors will appear in the544# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.545# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief546# member documentation.547# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting548# detailed member documentation.549# The default value is: NO.550 551SORT_MEMBERS_CTORS_1ST = NO552 553# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy554# of group names into alphabetical order. If set to NO the group names will555# appear in their defined order.556# The default value is: NO.557 558SORT_GROUP_NAMES       = NO559 560# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by561# fully-qualified names, including namespaces. If set to NO, the class list will562# be sorted only by class name, not including the namespace part.563# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.564# Note: This option applies only to the class list, not to the alphabetical565# list.566# The default value is: NO.567 568SORT_BY_SCOPE_NAME     = NO569 570# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper571# type resolution of all parameters of a function it will reject a match between572# the prototype and the implementation of a member function even if there is573# only one candidate or it is obvious which candidate to choose by doing a574# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still575# accept a match between prototype and implementation in such cases.576# The default value is: NO.577 578STRICT_PROTO_MATCHING  = NO579 580# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the581# todo list. This list is created by putting \todo commands in the582# documentation.583# The default value is: YES.584 585GENERATE_TODOLIST      = YES586 587# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the588# test list. This list is created by putting \test commands in the589# documentation.590# The default value is: YES.591 592GENERATE_TESTLIST      = YES593 594# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug595# list. This list is created by putting \bug commands in the documentation.596# The default value is: YES.597 598GENERATE_BUGLIST       = YES599 600# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)601# the deprecated list. This list is created by putting \deprecated commands in602# the documentation.603# The default value is: YES.604 605GENERATE_DEPRECATEDLIST= YES606 607# The ENABLED_SECTIONS tag can be used to enable conditional documentation608# sections, marked by \if <section_label> ... \endif and \cond <section_label>609# ... \endcond blocks.610 611ENABLED_SECTIONS       =612 613# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the614# initial value of a variable or macro / define can have for it to appear in the615# documentation. If the initializer consists of more lines than specified here616# it will be hidden. Use a value of 0 to hide initializers completely. The617# appearance of the value of individual variables and macros / defines can be618# controlled using \showinitializer or \hideinitializer command in the619# documentation regardless of this setting.620# Minimum value: 0, maximum value: 10000, default value: 30.621 622MAX_INITIALIZER_LINES  = 30623 624# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at625# the bottom of the documentation of classes and structs. If set to YES the list626# will mention the files that were used to generate the documentation.627# The default value is: YES.628 629SHOW_USED_FILES        = YES630 631# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This632# will remove the Files entry from the Quick Index and from the Folder Tree View633# (if specified).634# The default value is: YES.635 636SHOW_FILES             = YES637 638# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces639# page. This will remove the Namespaces entry from the Quick Index and from the640# Folder Tree View (if specified).641# The default value is: YES.642 643SHOW_NAMESPACES        = YES644 645# The FILE_VERSION_FILTER tag can be used to specify a program or script that646# doxygen should invoke to get the current version for each file (typically from647# the version control system). Doxygen will invoke the program by executing (via648# popen()) the command command input-file, where command is the value of the649# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided650# by doxygen. Whatever the program writes to standard output is used as the file651# version. For an example see the documentation.652 653FILE_VERSION_FILTER    =654 655# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed656# by doxygen. The layout file controls the global structure of the generated657# output files in an output format independent way. To create the layout file658# that represents doxygen's defaults, run doxygen with the -l option. You can659# optionally specify a file name after the option, if omitted DoxygenLayout.xml660# will be used as the name of the layout file.661#662# Note that if you run doxygen from a directory containing a file called663# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE664# tag is left empty.665 666LAYOUT_FILE            =667 668# The CITE_BIB_FILES tag can be used to specify one or more bib files containing669# the reference definitions. This must be a list of .bib files. The .bib670# extension is automatically appended if omitted. This requires the bibtex tool671# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.672# For LaTeX the style of the bibliography can be controlled using673# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the674# search path. Do not use file names with spaces, bibtex cannot handle them. See675# also \cite for info how to create references.676 677CITE_BIB_FILES         =678 679#---------------------------------------------------------------------------680# Configuration options related to warning and progress messages681#---------------------------------------------------------------------------682 683# The QUIET tag can be used to turn on/off the messages that are generated to684# standard output by doxygen. If QUIET is set to YES this implies that the685# messages are off.686# The default value is: NO.687 688QUIET                  = NO689 690# The WARNINGS tag can be used to turn on/off the warning messages that are691# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES692# this implies that the warnings are on.693#694# Tip: Turn warnings on while writing the documentation.695# The default value is: YES.696 697WARNINGS               = YES698 699# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate700# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag701# will automatically be disabled.702# The default value is: YES.703 704WARN_IF_UNDOCUMENTED   = YES705 706# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for707# potential errors in the documentation, such as not documenting some parameters708# in a documented function, or documenting parameters that don't exist or using709# markup commands wrongly.710# The default value is: YES.711 712WARN_IF_DOC_ERROR      = YES713 714# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that715# are documented, but have no documentation for their parameters or return716# value. If set to NO doxygen will only warn about wrong or incomplete parameter717# documentation, but not about the absence of documentation.718# The default value is: NO.719 720WARN_NO_PARAMDOC       = NO721 722# The WARN_FORMAT tag determines the format of the warning messages that doxygen723# can produce. The string should contain the $file, $line, and $text tags, which724# will be replaced by the file and line number from which the warning originated725# and the warning text. Optionally the format may contain $version, which will726# be replaced by the version of the file (if it could be obtained via727# FILE_VERSION_FILTER)728# The default value is: $file:$line: $text.729 730WARN_FORMAT            = "$file:$line: $text"731 732# The WARN_LOGFILE tag can be used to specify a file to which warning and error733# messages should be written. If left blank the output is written to standard734# error (stderr).735 736WARN_LOGFILE           =737 738#---------------------------------------------------------------------------739# Configuration options related to the input files740#---------------------------------------------------------------------------741 742# The INPUT tag is used to specify the files and/or directories that contain743# documented source files. You may enter file names like myfile.cpp or744# directories like /usr/src/myproject. Separate the files or directories with745# spaces.746# Note: If this tag is empty the current directory is searched.747 748INPUT                  = @abs_top_srcdir@/../include/ \749                         @abs_top_srcdir@/../lib/ \750                         @abs_top_srcdir@/../runtime/ \751                         @abs_top_srcdir@/doxygen-mainpage.dox752 753# This tag can be used to specify the character encoding of the source files754# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses755# libiconv (or the iconv built into libc) for the transcoding. See the libiconv756# documentation (see: http://www.gnu.org/software/libiconv) for the list of757# possible encodings.758# The default value is: UTF-8.759 760INPUT_ENCODING         = UTF-8761 762# If the value of the INPUT tag contains directories, you can use the763# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and764# *.h) to filter out the source-files in the directories. If left blank the765# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,766# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,767# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,768# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,769# *.qsf, *.as and *.js.770 771FILE_PATTERNS          =772 773# The RECURSIVE tag can be used to specify whether or not subdirectories should774# be searched for input files as well.775# The default value is: NO.776 777RECURSIVE              = YES778 779# The EXCLUDE tag can be used to specify files and/or directories that should be780# excluded from the INPUT source files. This way you can easily exclude a781# subdirectory from a directory tree whose root is specified with the INPUT tag.782#783# Note that relative paths are relative to the directory from which doxygen is784# run.785 786EXCLUDE                =787 788# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or789# directories that are symbolic links (a Unix file system feature) are excluded790# from the input.791# The default value is: NO.792 793EXCLUDE_SYMLINKS       = NO794 795# If the value of the INPUT tag contains directories, you can use the796# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude797# certain files from those directories.798#799# Note that the wildcards are matched against the file with absolute path, so to800# exclude all test directories for example use the pattern */test/*801 802EXCLUDE_PATTERNS       =803 804# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names805# (namespaces, classes, functions, etc.) that should be excluded from the806# output. The symbol name can be a fully qualified name, a word, or if the807# wildcard * is used, a substring. Examples: ANamespace, AClass,808# AClass::ANamespace, ANamespace::*Test809#810# Note that the wildcards are matched against the file with absolute path, so to811# exclude all test directories use the pattern */test/*812 813EXCLUDE_SYMBOLS        =814 815# The EXAMPLE_PATH tag can be used to specify one or more files or directories816# that contain example code fragments that are included (see the \include817# command).818 819EXAMPLE_PATH           =820 821# If the value of the EXAMPLE_PATH tag contains directories, you can use the822# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and823# *.h) to filter out the source-files in the directories. If left blank all824# files are included.825 826EXAMPLE_PATTERNS       =827 828# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be829# searched for input files to be used with the \include or \dontinclude commands830# irrespective of the value of the RECURSIVE tag.831# The default value is: NO.832 833EXAMPLE_RECURSIVE      = NO834 835# The IMAGE_PATH tag can be used to specify one or more files or directories836# that contain images that are to be included in the documentation (see the837# \image command).838 839IMAGE_PATH             =840 841# The INPUT_FILTER tag can be used to specify a program that doxygen should842# invoke to filter for each input file. Doxygen will invoke the filter program843# by executing (via popen()) the command:844#845# <filter> <input-file>846#847# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the848# name of an input file. Doxygen will then use the output that the filter849# program writes to standard output. If FILTER_PATTERNS is specified, this tag850# will be ignored.851#852# Note that the filter must not add or remove lines; it is applied before the853# code is scanned, but not when the output code is generated. If lines are added854# or removed, the anchors will not be placed correctly.855 856INPUT_FILTER           =857 858# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern859# basis. Doxygen will compare the file name with each pattern and apply the860# filter if there is a match. The filters are a list of the form: pattern=filter861# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how862# filters are used. If the FILTER_PATTERNS tag is empty or if none of the863# patterns match the file name, INPUT_FILTER is applied.864 865FILTER_PATTERNS        =866 867# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using868# INPUT_FILTER ) will also be used to filter the input files that are used for869# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).870# The default value is: NO.871 872FILTER_SOURCE_FILES    = NO873 874# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file875# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and876# it is also possible to disable source filtering for a specific pattern using877# *.ext= (so without naming a filter).878# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.879 880FILTER_SOURCE_PATTERNS =881 882# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that883# is part of the input, its contents will be placed on the main page884# (index.html). This can be useful if you have a project on for instance GitHub885# and want to reuse the introduction page also for the doxygen output.886 887USE_MDFILE_AS_MAINPAGE =888 889#---------------------------------------------------------------------------890# Configuration options related to source browsing891#---------------------------------------------------------------------------892 893# If the SOURCE_BROWSER tag is set to YES then a list of source files will be894# generated. Documented entities will be cross-referenced with these sources.895#896# Note: To get rid of all source code in the generated output, make sure that897# also VERBATIM_HEADERS is set to NO.898# The default value is: NO.899 900SOURCE_BROWSER         = NO901 902# Setting the INLINE_SOURCES tag to YES will include the body of functions,903# classes and enums directly into the documentation.904# The default value is: NO.905 906INLINE_SOURCES         = NO907 908# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any909# special comment blocks from generated source code fragments. Normal C, C++ and910# Fortran comments will always remain visible.911# The default value is: YES.912 913STRIP_CODE_COMMENTS    = YES914 915# If the REFERENCED_BY_RELATION tag is set to YES then for each documented916# function all documented functions referencing it will be listed.917# The default value is: NO.918 919REFERENCED_BY_RELATION = NO920 921# If the REFERENCES_RELATION tag is set to YES then for each documented function922# all documented entities called/used by that function will be listed.923# The default value is: NO.924 925REFERENCES_RELATION    = NO926 927# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set928# to YES, then the hyperlinks from functions in REFERENCES_RELATION and929# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will930# link to the documentation.931# The default value is: YES.932 933REFERENCES_LINK_SOURCE = YES934 935# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the936# source code will show a tooltip with additional information such as prototype,937# brief description and links to the definition and documentation. Since this938# will make the HTML file larger and loading of large files a bit slower, you939# can opt to disable this feature.940# The default value is: YES.941# This tag requires that the tag SOURCE_BROWSER is set to YES.942 943SOURCE_TOOLTIPS        = YES944 945# If the USE_HTAGS tag is set to YES then the references to source code will946# point to the HTML generated by the htags(1) tool instead of doxygen built-in947# source browser. The htags tool is part of GNU's global source tagging system948# (see http://www.gnu.org/software/global/global.html). You will need version949# 4.8.6 or higher.950#951# To use it do the following:952# - Install the latest version of global953# - Enable SOURCE_BROWSER and USE_HTAGS in the config file954# - Make sure the INPUT points to the root of the source tree955# - Run doxygen as normal956#957# Doxygen will invoke htags (and that will in turn invoke gtags), so these958# tools must be available from the command line (i.e. in the search path).959#960# The result: instead of the source browser generated by doxygen, the links to961# source code will now point to the output of htags.962# The default value is: NO.963# This tag requires that the tag SOURCE_BROWSER is set to YES.964 965USE_HTAGS              = NO966 967# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a968# verbatim copy of the header file for each class for which an include is969# specified. Set to NO to disable this.970# See also: Section \class.971# The default value is: YES.972 973VERBATIM_HEADERS       = YES974 975#---------------------------------------------------------------------------976# Configuration options related to the alphabetical class index977#---------------------------------------------------------------------------978 979# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all980# compounds will be generated. Enable this if the project contains a lot of981# classes, structs, unions or interfaces.982# The default value is: YES.983 984ALPHABETICAL_INDEX     = YES985 986# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in987# which the alphabetical index list will be split.988# Minimum value: 1, maximum value: 20, default value: 5.989# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.990 991COLS_IN_ALPHA_INDEX    = 5992 993# In case all classes in a project start with a common prefix, all classes will994# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag995# can be used to specify a prefix (or a list of prefixes) that should be ignored996# while generating the index headers.997# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.998 999IGNORE_PREFIX          =1000 1001#---------------------------------------------------------------------------1002# Configuration options related to the HTML output1003#---------------------------------------------------------------------------1004 1005# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1006# The default value is: YES.1007 1008GENERATE_HTML          = YES1009 1010# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1011# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1012# it.1013# The default directory is: html.1014# This tag requires that the tag GENERATE_HTML is set to YES.1015 1016HTML_OUTPUT            = html 1017 1018# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1019# generated HTML page (for example: .htm, .php, .asp).1020# The default value is: .html.1021# This tag requires that the tag GENERATE_HTML is set to YES.1022 1023HTML_FILE_EXTENSION    = .html1024 1025# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1026# each generated HTML page. If the tag is left blank doxygen will generate a1027# standard header.1028#1029# To get valid HTML the header file that includes any scripts and style sheets1030# that doxygen needs, which is dependent on the configuration options used (e.g.1031# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1032# default header using1033# doxygen -w html new_header.html new_footer.html new_stylesheet.css1034# YourConfigFile1035# and then modify the file new_header.html. See also section "Doxygen usage"1036# for information on how to generate the default header that doxygen normally1037# uses.1038# Note: The header is subject to change so you typically have to regenerate the1039# default header when upgrading to a newer version of doxygen. For a description1040# of the possible markers and block names see the documentation.1041# This tag requires that the tag GENERATE_HTML is set to YES.1042 1043HTML_HEADER            =1044 1045# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1046# generated HTML page. If the tag is left blank doxygen will generate a standard1047# footer. See HTML_HEADER for more information on how to generate a default1048# footer and what special commands can be used inside the footer. See also1049# section "Doxygen usage" for information on how to generate the default footer1050# that doxygen normally uses.1051# This tag requires that the tag GENERATE_HTML is set to YES.1052 1053HTML_FOOTER            =1054 1055# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1056# sheet that is used by each HTML page. It can be used to fine-tune the look of1057# the HTML output. If left blank doxygen will generate a default style sheet.1058# See also section "Doxygen usage" for information on how to generate the style1059# sheet that doxygen normally uses.1060# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1061# it is more robust and this tag (HTML_STYLESHEET) will in the future become1062# obsolete.1063# This tag requires that the tag GENERATE_HTML is set to YES.1064 1065HTML_STYLESHEET        =1066 1067# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-1068# defined cascading style sheet that is included after the standard style sheets1069# created by doxygen. Using this option one can overrule certain style aspects.1070# This is preferred over using HTML_STYLESHEET since it does not replace the1071# standard style sheet and is therefor more robust against future updates.1072# Doxygen will copy the style sheet file to the output directory. For an example1073# see the documentation.1074# This tag requires that the tag GENERATE_HTML is set to YES.1075 1076HTML_EXTRA_STYLESHEET  =1077 1078# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1079# other source files which should be copied to the HTML output directory. Note1080# that these files will be copied to the base HTML output directory. Use the1081# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1082# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1083# files will be copied as-is; there are no commands or markers available.1084# This tag requires that the tag GENERATE_HTML is set to YES.1085 1086HTML_EXTRA_FILES       =1087 1088# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1089# will adjust the colors in the stylesheet and background images according to1090# this color. Hue is specified as an angle on a colorwheel, see1091# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1092# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001093# purple, and 360 is red again.1094# Minimum value: 0, maximum value: 359, default value: 220.1095# This tag requires that the tag GENERATE_HTML is set to YES.1096 1097HTML_COLORSTYLE_HUE    = 2201098 1099# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1100# in the HTML output. For a value of 0 the output will use grayscales only. A1101# value of 255 will produce the most vivid colors.1102# Minimum value: 0, maximum value: 255, default value: 100.1103# This tag requires that the tag GENERATE_HTML is set to YES.1104 1105HTML_COLORSTYLE_SAT    = 1001106 1107# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1108# luminance component of the colors in the HTML output. Values below 1001109# gradually make the output lighter, whereas values above 100 make the output1110# darker. The value divided by 100 is the actual gamma applied, so 80 represents1111# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1112# change the gamma.1113# Minimum value: 40, maximum value: 240, default value: 80.1114# This tag requires that the tag GENERATE_HTML is set to YES.1115 1116HTML_COLORSTYLE_GAMMA  = 801117 1118# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1119# page will contain the date and time when the page was generated. Setting this1120# to NO can help when comparing the output of multiple runs.1121# The default value is: YES.1122# This tag requires that the tag GENERATE_HTML is set to YES.1123 1124HTML_TIMESTAMP         = YES1125 1126# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1127# documentation will contain sections that can be hidden and shown after the1128# page has loaded.1129# The default value is: NO.1130# This tag requires that the tag GENERATE_HTML is set to YES.1131 1132HTML_DYNAMIC_SECTIONS  = NO1133 1134# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1135# shown in the various tree structured indices initially; the user can expand1136# and collapse entries dynamically later on. Doxygen will expand the tree to1137# such a level that at most the specified number of entries are visible (unless1138# a fully collapsed tree already exceeds this amount). So setting the number of1139# entries 1 will produce a full collapsed tree by default. 0 is a special value1140# representing an infinite number of entries and will result in a full expanded1141# tree by default.1142# Minimum value: 0, maximum value: 9999, default value: 100.1143# This tag requires that the tag GENERATE_HTML is set to YES.1144 1145HTML_INDEX_NUM_ENTRIES = 1001146 1147# If the GENERATE_DOCSET tag is set to YES, additional index files will be1148# generated that can be used as input for Apple's Xcode 3 integrated development1149# environment (see: http://developer.apple.com/tools/xcode/), introduced with1150# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1151# Makefile in the HTML output directory. Running make will produce the docset in1152# that directory and running make install will install the docset in1153# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1154# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1155# for more information.1156# The default value is: NO.1157# This tag requires that the tag GENERATE_HTML is set to YES.1158 1159GENERATE_DOCSET        = NO1160 1161# This tag determines the name of the docset feed. A documentation feed provides1162# an umbrella under which multiple documentation sets from a single provider1163# (such as a company or product suite) can be grouped.1164# The default value is: Doxygen generated docs.1165# This tag requires that the tag GENERATE_DOCSET is set to YES.1166 1167DOCSET_FEEDNAME        = "Doxygen generated docs"1168 1169# This tag specifies a string that should uniquely identify the documentation1170# set bundle. This should be a reverse domain-name style string, e.g.1171# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1172# The default value is: org.doxygen.Project.1173# This tag requires that the tag GENERATE_DOCSET is set to YES.1174 1175DOCSET_BUNDLE_ID       = org.doxygen.Project1176 1177# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1178# the documentation publisher. This should be a reverse domain-name style1179# string, e.g. com.mycompany.MyDocSet.documentation.1180# The default value is: org.doxygen.Publisher.1181# This tag requires that the tag GENERATE_DOCSET is set to YES.1182 1183DOCSET_PUBLISHER_ID    = org.doxygen.Publisher1184 1185# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1186# The default value is: Publisher.1187# This tag requires that the tag GENERATE_DOCSET is set to YES.1188 1189DOCSET_PUBLISHER_NAME  = Publisher1190 1191# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1192# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1193# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1194# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1195# Windows.1196#1197# The HTML Help Workshop contains a compiler that can convert all HTML output1198# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1199# files are now used as the Windows 98 help format, and will replace the old1200# Windows help format (.hlp) on all Windows platforms in the future. Compressed1201# HTML files also contain an index, a table of contents, and you can search for1202# words in the documentation. The HTML workshop also contains a viewer for1203# compressed HTML files.1204# The default value is: NO.1205# This tag requires that the tag GENERATE_HTML is set to YES.1206 1207GENERATE_HTMLHELP      = NO1208 1209# The CHM_FILE tag can be used to specify the file name of the resulting .chm1210# file. You can add a path in front of the file if the result should not be1211# written to the html output directory.1212# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1213 1214CHM_FILE               =1215 1216# The HHC_LOCATION tag can be used to specify the location (absolute path1217# including file name) of the HTML help compiler ( hhc.exe). If non-empty1218# doxygen will try to run the HTML help compiler on the generated index.hhp.1219# The file has to be specified with full path.1220# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1221 1222HHC_LOCATION           =1223 1224# The GENERATE_CHI flag controls if a separate .chi index file is generated (1225# YES) or that it should be included in the main .chm file ( NO).1226# The default value is: NO.1227# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1228 1229GENERATE_CHI           = NO1230 1231# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)1232# and project file content.1233# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1234 1235CHM_INDEX_ENCODING     =1236 1237# The BINARY_TOC flag controls whether a binary table of contents is generated (1238# YES) or a normal table of contents ( NO) in the .chm file.1239# The default value is: NO.1240# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1241 1242BINARY_TOC             = NO1243 1244# The TOC_EXPAND flag can be set to YES to add extra items for group members to1245# the table of contents of the HTML help documentation and to the tree view.1246# The default value is: NO.1247# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1248 1249TOC_EXPAND             = NO1250 1251# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1252# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1253# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1254# (.qch) of the generated HTML documentation.1255# The default value is: NO.1256# This tag requires that the tag GENERATE_HTML is set to YES.1257 1258GENERATE_QHP           = @llvm_doxygen_generate_qhp@1259 1260# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1261# the file name of the resulting .qch file. The path specified is relative to1262# the HTML output folder.1263# This tag requires that the tag GENERATE_QHP is set to YES.1264 1265QCH_FILE               = @llvm_doxygen_qch_filename@1266 1267# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1268# Project output. For more information please see Qt Help Project / Namespace1269# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1270# The default value is: org.doxygen.Project.1271# This tag requires that the tag GENERATE_QHP is set to YES.1272 1273QHP_NAMESPACE          = @llvm_doxygen_qhp_namespace@1274 1275# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1276# Help Project output. For more information please see Qt Help Project / Virtual1277# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1278# folders).1279# The default value is: doc.1280# This tag requires that the tag GENERATE_QHP is set to YES.1281 1282QHP_VIRTUAL_FOLDER     = doc1283 1284# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1285# filter to add. For more information please see Qt Help Project / Custom1286# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1287# filters).1288# This tag requires that the tag GENERATE_QHP is set to YES.1289 1290QHP_CUST_FILTER_NAME   = @llvm_doxygen_qhp_cust_filter_name@ 1291 1292# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1293# custom filter to add. For more information please see Qt Help Project / Custom1294# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1295# filters).1296# This tag requires that the tag GENERATE_QHP is set to YES.1297 1298QHP_CUST_FILTER_ATTRS  = @llvm_doxygen_qhp_cust_filter_attrs@ 1299 1300# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1301# project's filter section matches. Qt Help Project / Filter Attributes (see:1302# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1303# This tag requires that the tag GENERATE_QHP is set to YES.1304 1305QHP_SECT_FILTER_ATTRS  =1306 1307# The QHG_LOCATION tag can be used to specify the location of Qt's1308# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1309# generated .qhp file.1310# This tag requires that the tag GENERATE_QHP is set to YES.1311 1312QHG_LOCATION           =1313 1314# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1315# generated, together with the HTML files, they form an Eclipse help plugin. To1316# install this plugin and make it available under the help contents menu in1317# Eclipse, the contents of the directory containing the HTML and XML files needs1318# to be copied into the plugins directory of eclipse. The name of the directory1319# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1320# After copying Eclipse needs to be restarted before the help appears.1321# The default value is: NO.1322# This tag requires that the tag GENERATE_HTML is set to YES.1323 1324GENERATE_ECLIPSEHELP   = NO1325 1326# A unique identifier for the Eclipse help plugin. When installing the plugin1327# the directory name containing the HTML and XML files should also have this1328# name. Each documentation set should have its own identifier.1329# The default value is: org.doxygen.Project.1330# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1331 1332ECLIPSE_DOC_ID         = org.doxygen.Project1333 1334# If you want full control over the layout of the generated HTML pages it might1335# be necessary to disable the index and replace it with your own. The1336# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1337# of each HTML page. A value of NO enables the index and the value YES disables1338# it. Since the tabs in the index contain the same information as the navigation1339# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1340# The default value is: NO.1341# This tag requires that the tag GENERATE_HTML is set to YES.1342 1343DISABLE_INDEX          = NO1344 1345# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1346# structure should be generated to display hierarchical information. If the tag1347# value is set to YES, a side panel will be generated containing a tree-like1348# index structure (just like the one that is generated for HTML Help). For this1349# to work a browser that supports JavaScript, DHTML, CSS and frames is required1350# (i.e. any modern browser). Windows users are probably better off using the1351# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can1352# further fine-tune the look of the index. As an example, the default style1353# sheet generated by doxygen has an example that shows how to put an image at1354# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1355# the same information as the tab index, you could consider setting1356# DISABLE_INDEX to YES when enabling this option.1357# The default value is: NO.1358# This tag requires that the tag GENERATE_HTML is set to YES.1359 1360GENERATE_TREEVIEW      = NO1361 1362# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1363# doxygen will group on one line in the generated HTML documentation.1364#1365# Note that a value of 0 will completely suppress the enum values from appearing1366# in the overview section.1367# Minimum value: 0, maximum value: 20, default value: 4.1368# This tag requires that the tag GENERATE_HTML is set to YES.1369 1370ENUM_VALUES_PER_LINE   = 41371 1372# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1373# to set the initial width (in pixels) of the frame in which the tree is shown.1374# Minimum value: 0, maximum value: 1500, default value: 250.1375# This tag requires that the tag GENERATE_HTML is set to YES.1376 1377TREEVIEW_WIDTH         = 2501378 1379# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to1380# external symbols imported via tag files in a separate window.1381# The default value is: NO.1382# This tag requires that the tag GENERATE_HTML is set to YES.1383 1384EXT_LINKS_IN_WINDOW    = NO1385 1386# Use this tag to change the font size of LaTeX formulas included as images in1387# the HTML documentation. When you change the font size after a successful1388# doxygen run you need to manually remove any form_*.png images from the HTML1389# output directory to force them to be regenerated.1390# Minimum value: 8, maximum value: 50, default value: 10.1391# This tag requires that the tag GENERATE_HTML is set to YES.1392 1393FORMULA_FONTSIZE       = 101394 1395# Use the FORMULA_TRANPARENT tag to determine whether or not the images1396# generated for formulas are transparent PNGs. Transparent PNGs are not1397# supported properly for IE 6.0, but are supported on all modern browsers.1398#1399# Note that when changing this option you need to delete any form_*.png files in1400# the HTML output directory before the changes have effect.1401# The default value is: YES.1402# This tag requires that the tag GENERATE_HTML is set to YES.1403 1404FORMULA_TRANSPARENT    = YES1405 1406# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1407# http://www.mathjax.org) which uses client side Javascript for the rendering1408# instead of using prerendered bitmaps. Use this if you do not have LaTeX1409# installed or if you want to formulas look prettier in the HTML output. When1410# enabled you may also need to install MathJax separately and configure the path1411# to it using the MATHJAX_RELPATH option.1412# The default value is: NO.1413# This tag requires that the tag GENERATE_HTML is set to YES.1414 1415USE_MATHJAX            = NO1416 1417# When MathJax is enabled you can set the default output format to be used for1418# the MathJax output. See the MathJax site (see:1419# http://docs.mathjax.org/en/latest/output.html) for more details.1420# Possible values are: HTML-CSS (which is slower, but has the best1421# compatibility), NativeMML (i.e. MathML) and SVG.1422# The default value is: HTML-CSS.1423# This tag requires that the tag USE_MATHJAX is set to YES.1424 1425MATHJAX_FORMAT         = HTML-CSS1426 1427# When MathJax is enabled you need to specify the location relative to the HTML1428# output directory using the MATHJAX_RELPATH option. The destination directory1429# should contain the MathJax.js script. For instance, if the mathjax directory1430# is located at the same level as the HTML output directory, then1431# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1432# Content Delivery Network so you can quickly see the result without installing1433# MathJax. However, it is strongly recommended to install a local copy of1434# MathJax from http://www.mathjax.org before deployment.1435# The default value is: http://cdn.mathjax.org/mathjax/latest.1436# This tag requires that the tag USE_MATHJAX is set to YES.1437 1438MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest1439 1440# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1441# extension names that should be enabled during MathJax rendering. For example1442# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1443# This tag requires that the tag USE_MATHJAX is set to YES.1444 1445MATHJAX_EXTENSIONS     =1446 1447# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1448# of code that will be used on startup of the MathJax code. See the MathJax site1449# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1450# example see the documentation.1451# This tag requires that the tag USE_MATHJAX is set to YES.1452 1453MATHJAX_CODEFILE       =1454 1455# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1456# the HTML output. The underlying search engine uses javascript and DHTML and1457# should work on any modern browser. Note that when using HTML help1458# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1459# there is already a search function so this one should typically be disabled.1460# For large projects the javascript based search engine can be slow, then1461# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1462# search using the keyboard; to jump to the search box use <access key> + S1463# (what the <access key> is depends on the OS and browser, but it is typically1464# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1465# key> to jump into the search results window, the results can be navigated1466# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1467# the search. The filter options can be selected when the cursor is inside the1468# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1469# to select a filter and <Enter> or <escape> to activate or cancel the filter1470# option.1471# The default value is: YES.1472# This tag requires that the tag GENERATE_HTML is set to YES.1473 1474SEARCHENGINE           = @enable_searchengine@ 1475 1476# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1477# implemented using a web server instead of a web client using Javascript. There1478# are two flavours of web server based searching depending on the1479# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1480# searching and an index file used by the script. When EXTERNAL_SEARCH is1481# enabled the indexing and searching needs to be provided by external tools. See1482# the section "External Indexing and Searching" for details.1483# The default value is: NO.1484# This tag requires that the tag SEARCHENGINE is set to YES.1485 1486SERVER_BASED_SEARCH    = @enable_server_based_search@1487 1488# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1489# script for searching. Instead the search results are written to an XML file1490# which needs to be processed by an external indexer. Doxygen will invoke an1491# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1492# search results.1493#1494# Doxygen ships with an example indexer ( doxyindexer) and search engine1495# (doxysearch.cgi) which are based on the open source search engine library1496# Xapian (see: http://xapian.org/).1497#1498# See the section "External Indexing and Searching" for details.1499# The default value is: NO.1500# This tag requires that the tag SEARCHENGINE is set to YES.1501 1502EXTERNAL_SEARCH        = @enable_external_search@1503 1504# The SEARCHENGINE_URL should point to a search engine hosted by a web server1505# which will return the search results when EXTERNAL_SEARCH is enabled.1506#1507# Doxygen ships with an example indexer ( doxyindexer) and search engine1508# (doxysearch.cgi) which are based on the open source search engine library1509# Xapian (see: http://xapian.org/). See the section "External Indexing and1510# Searching" for details.1511# This tag requires that the tag SEARCHENGINE is set to YES.1512 1513SEARCHENGINE_URL       = @searchengine_url@1514 1515# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1516# search data is written to a file for indexing by an external tool. With the1517# SEARCHDATA_FILE tag the name of this file can be specified.1518# The default file is: searchdata.xml.1519# This tag requires that the tag SEARCHENGINE is set to YES.1520 1521SEARCHDATA_FILE        = searchdata.xml1522 1523# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1524# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1525# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1526# projects and redirect the results back to the right project.1527# This tag requires that the tag SEARCHENGINE is set to YES.1528 1529EXTERNAL_SEARCH_ID     = flang1530 1531# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1532# projects other than the one defined by this configuration file, but that are1533# all added to the same external search index. Each project needs to have a1534# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1535# to a relative location where the documentation can be found. The format is:1536# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1537# This tag requires that the tag SEARCHENGINE is set to YES.1538 1539EXTRA_SEARCH_MAPPINGS  = @extra_search_mappings@1540 1541#---------------------------------------------------------------------------1542# Configuration options related to the LaTeX output1543#---------------------------------------------------------------------------1544 1545# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1546# The default value is: YES.1547 1548GENERATE_LATEX         = YES1549 1550# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1551# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1552# it.1553# The default directory is: latex.1554# This tag requires that the tag GENERATE_LATEX is set to YES.1555 1556LATEX_OUTPUT           = latex1557 1558# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1559# invoked.1560#1561# Note that when enabling USE_PDFLATEX this option is only used for generating1562# bitmaps for formulas in the HTML output, but not in the Makefile that is1563# written to the output directory.1564# The default file is: latex.1565# This tag requires that the tag GENERATE_LATEX is set to YES.1566 1567LATEX_CMD_NAME         = latex1568 1569# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1570# index for LaTeX.1571# The default file is: makeindex.1572# This tag requires that the tag GENERATE_LATEX is set to YES.1573 1574MAKEINDEX_CMD_NAME     = makeindex1575 1576# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX1577# documents. This may be useful for small projects and may help to save some1578# trees in general.1579# The default value is: NO.1580# This tag requires that the tag GENERATE_LATEX is set to YES.1581 1582COMPACT_LATEX          = NO1583 1584# The PAPER_TYPE tag can be used to set the paper type that is used by the1585# printer.1586# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1587# 14 inches) and executive (7.25 x 10.5 inches).1588# The default value is: a4.1589# This tag requires that the tag GENERATE_LATEX is set to YES.1590 1591PAPER_TYPE             = a41592 1593# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1594# that should be included in the LaTeX output. To get the times font for1595# instance you can specify1596# EXTRA_PACKAGES=times1597# If left blank no extra packages will be included.1598# This tag requires that the tag GENERATE_LATEX is set to YES.1599 1600EXTRA_PACKAGES         =1601 1602# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1603# generated LaTeX document. The header should contain everything until the first1604# chapter. If it is left blank doxygen will generate a standard header. See1605# section "Doxygen usage" for information on how to let doxygen write the1606# default header to a separate file.1607#1608# Note: Only use a user-defined header if you know what you are doing! The1609# following commands have a special meaning inside the header: $title,1610# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will1611# replace them by respectively the title of the page, the current date and time,1612# only the current date, the version number of doxygen, the project name (see1613# PROJECT_NAME), or the project number (see PROJECT_NUMBER).1614# This tag requires that the tag GENERATE_LATEX is set to YES.1615 1616LATEX_HEADER           =1617 1618# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1619# generated LaTeX document. The footer should contain everything after the last1620# chapter. If it is left blank doxygen will generate a standard footer.1621#1622# Note: Only use a user-defined footer if you know what you are doing!1623# This tag requires that the tag GENERATE_LATEX is set to YES.1624 1625LATEX_FOOTER           =1626 1627# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1628# other source files which should be copied to the LATEX_OUTPUT output1629# directory. Note that the files will be copied as-is; there are no commands or1630# markers available.1631# This tag requires that the tag GENERATE_LATEX is set to YES.1632 1633LATEX_EXTRA_FILES      =1634 1635# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1636# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1637# contain links (just like the HTML output) instead of page references. This1638# makes the output suitable for online browsing using a PDF viewer.1639# The default value is: YES.1640# This tag requires that the tag GENERATE_LATEX is set to YES.1641 1642PDF_HYPERLINKS         = YES1643 1644# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1645# the PDF file directly from the LaTeX files. Set this option to YES to get a1646# higher quality PDF documentation.1647# The default value is: YES.1648# This tag requires that the tag GENERATE_LATEX is set to YES.1649 1650USE_PDFLATEX           = YES1651 1652# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1653# command to the generated LaTeX files. This will instruct LaTeX to keep running1654# if errors occur, instead of asking the user for help. This option is also used1655# when generating formulas in HTML.1656# The default value is: NO.1657# This tag requires that the tag GENERATE_LATEX is set to YES.1658 1659LATEX_BATCHMODE        = NO1660 1661# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1662# index chapters (such as File Index, Compound Index, etc.) in the output.1663# The default value is: NO.1664# This tag requires that the tag GENERATE_LATEX is set to YES.1665 1666LATEX_HIDE_INDICES     = NO1667 1668# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1669# code with syntax highlighting in the LaTeX output.1670#1671# Note that which sources are shown also depends on other settings such as1672# SOURCE_BROWSER.1673# The default value is: NO.1674# This tag requires that the tag GENERATE_LATEX is set to YES.1675 1676LATEX_SOURCE_CODE      = NO1677 1678# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1679# bibliography, e.g. plainnat, or ieeetr. See1680# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1681# The default value is: plain.1682# This tag requires that the tag GENERATE_LATEX is set to YES.1683 1684LATEX_BIB_STYLE        = plain1685 1686#---------------------------------------------------------------------------1687# Configuration options related to the RTF output1688#---------------------------------------------------------------------------1689 1690# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1691# RTF output is optimized for Word 97 and may not look too pretty with other RTF1692# readers/editors.1693# The default value is: NO.1694 1695GENERATE_RTF           = NO1696 1697# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1698# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1699# it.1700# The default directory is: rtf.1701# This tag requires that the tag GENERATE_RTF is set to YES.1702 1703RTF_OUTPUT             = rtf1704 1705# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1706# documents. This may be useful for small projects and may help to save some1707# trees in general.1708# The default value is: NO.1709# This tag requires that the tag GENERATE_RTF is set to YES.1710 1711COMPACT_RTF            = NO1712 1713# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1714# contain hyperlink fields. The RTF file will contain links (just like the HTML1715# output) instead of page references. This makes the output suitable for online1716# browsing using Word or some other Word compatible readers that support those1717# fields.1718#1719# Note: WordPad (write) and others do not support links.1720# The default value is: NO.1721# This tag requires that the tag GENERATE_RTF is set to YES.1722 1723RTF_HYPERLINKS         = NO1724 1725# Load stylesheet definitions from file. Syntax is similar to doxygen's config1726# file, i.e. a series of assignments. You only have to provide replacements,1727# missing definitions are set to their default value.1728#1729# See also section "Doxygen usage" for information on how to generate the1730# default style sheet that doxygen normally uses.1731# This tag requires that the tag GENERATE_RTF is set to YES.1732 1733RTF_STYLESHEET_FILE    =1734 1735# Set optional variables used in the generation of an RTF document. Syntax is1736# similar to doxygen's config file. A template extensions file can be generated1737# using doxygen -e rtf extensionFile.1738# This tag requires that the tag GENERATE_RTF is set to YES.1739 1740RTF_EXTENSIONS_FILE    =1741 1742#---------------------------------------------------------------------------1743# Configuration options related to the man page output1744#---------------------------------------------------------------------------1745 1746# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1747# classes and files.1748# The default value is: NO.1749 1750GENERATE_MAN           = NO1751 1752# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1753# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1754# it. A directory man3 will be created inside the directory specified by1755# MAN_OUTPUT.1756# The default directory is: man.1757# This tag requires that the tag GENERATE_MAN is set to YES.1758 1759MAN_OUTPUT             = man1760 1761# The MAN_EXTENSION tag determines the extension that is added to the generated1762# man pages. In case the manual section does not start with a number, the number1763# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1764# optional.1765# The default value is: .3.1766# This tag requires that the tag GENERATE_MAN is set to YES.1767 1768MAN_EXTENSION          = .31769 1770# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1771# will generate one additional man file for each entity documented in the real1772# man page(s). These additional files only source the real man page, but without1773# them the man command would be unable to find the correct page.1774# The default value is: NO.1775# This tag requires that the tag GENERATE_MAN is set to YES.1776 1777MAN_LINKS              = NO1778 1779#---------------------------------------------------------------------------1780# Configuration options related to the XML output1781#---------------------------------------------------------------------------1782 1783# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1784# captures the structure of the code including all documentation.1785# The default value is: NO.1786 1787GENERATE_XML           = NO1788 1789# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1790# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1791# it.1792# The default directory is: xml.1793# This tag requires that the tag GENERATE_XML is set to YES.1794 1795XML_OUTPUT             = xml1796 1797# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a1798# validating XML parser to check the syntax of the XML files.1799# This tag requires that the tag GENERATE_XML is set to YES.1800 1801XML_SCHEMA             =1802 1803# The XML_DTD tag can be used to specify a XML DTD, which can be used by a1804# validating XML parser to check the syntax of the XML files.1805# This tag requires that the tag GENERATE_XML is set to YES.1806 1807XML_DTD                =1808 1809# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1810# listings (including syntax highlighting and cross-referencing information) to1811# the XML output. Note that enabling this will significantly increase the size1812# of the XML output.1813# The default value is: YES.1814# This tag requires that the tag GENERATE_XML is set to YES.1815 1816XML_PROGRAMLISTING     = YES1817 1818#---------------------------------------------------------------------------1819# Configuration options related to the DOCBOOK output1820#---------------------------------------------------------------------------1821 1822# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1823# that can be used to generate PDF.1824# The default value is: NO.1825 1826GENERATE_DOCBOOK       = NO1827 1828# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1829# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1830# front of it.1831# The default directory is: docbook.1832# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1833 1834DOCBOOK_OUTPUT         = docbook1835 1836#---------------------------------------------------------------------------1837# Configuration options for the AutoGen Definitions output1838#---------------------------------------------------------------------------1839 1840# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1841# Definitions (see http://autogen.sf.net) file that captures the structure of1842# the code including all documentation. Note that this feature is still1843# experimental and incomplete at the moment.1844# The default value is: NO.1845 1846GENERATE_AUTOGEN_DEF   = NO1847 1848#---------------------------------------------------------------------------1849# Configuration options related to the Perl module output1850#---------------------------------------------------------------------------1851 1852# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module1853# file that captures the structure of the code including all documentation.1854#1855# Note that this feature is still experimental and incomplete at the moment.1856# The default value is: NO.1857 1858GENERATE_PERLMOD       = NO1859 1860# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary1861# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI1862# output from the Perl module output.1863# The default value is: NO.1864# This tag requires that the tag GENERATE_PERLMOD is set to YES.1865 1866PERLMOD_LATEX          = NO1867 1868# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely1869# formatted so it can be parsed by a human reader. This is useful if you want to1870# understand what is going on. On the other hand, if this tag is set to NO the1871# size of the Perl module output will be much smaller and Perl will parse it1872# just the same.1873# The default value is: YES.1874# This tag requires that the tag GENERATE_PERLMOD is set to YES.1875 1876PERLMOD_PRETTY         = YES1877 1878# The names of the make variables in the generated doxyrules.make file are1879# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful1880# so different doxyrules.make files included by the same Makefile don't1881# overwrite each other's variables.1882# This tag requires that the tag GENERATE_PERLMOD is set to YES.1883 1884PERLMOD_MAKEVAR_PREFIX =1885 1886#---------------------------------------------------------------------------1887# Configuration options related to the preprocessor1888#---------------------------------------------------------------------------1889 1890# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all1891# C-preprocessor directives found in the sources and include files.1892# The default value is: YES.1893 1894ENABLE_PREPROCESSING   = YES1895 1896# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1897# in the source code. If set to NO only conditional compilation will be1898# performed. Macro expansion can be done in a controlled way by setting1899# EXPAND_ONLY_PREDEF to YES.1900# The default value is: NO.1901# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1902 1903MACRO_EXPANSION        = NO1904 1905# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then1906# the macro expansion is limited to the macros specified with the PREDEFINED and1907# EXPAND_AS_DEFINED tags.1908# The default value is: NO.1909# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1910 1911EXPAND_ONLY_PREDEF     = NO1912 1913# If the SEARCH_INCLUDES tag is set to YES the includes files in the1914# INCLUDE_PATH will be searched if a #include is found.1915# The default value is: YES.1916# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1917 1918SEARCH_INCLUDES        = YES1919 1920# The INCLUDE_PATH tag can be used to specify one or more directories that1921# contain include files that are not input files but should be processed by the1922# preprocessor.1923# This tag requires that the tag SEARCH_INCLUDES is set to YES.1924 1925INCLUDE_PATH           =1926 1927# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1928# patterns (like *.h and *.hpp) to filter out the header-files in the1929# directories. If left blank, the patterns specified with FILE_PATTERNS will be1930# used.1931# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1932 1933INCLUDE_FILE_PATTERNS  =1934 1935# The PREDEFINED tag can be used to specify one or more macro names that are1936# defined before the preprocessor is started (similar to the -D option of e.g.1937# gcc). The argument of the tag is a list of macros of the form: name or1938# name=definition (no spaces). If the definition and the "=" are omitted, "=1"1939# is assumed. To prevent a macro definition from being undefined via #undef or1940# recursively expanded use the := operator instead of the = operator.1941# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1942 1943PREDEFINED             =1944 1945# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this1946# tag can be used to specify a list of macro names that should be expanded. The1947# macro definition that is found in the sources will be used. Use the PREDEFINED1948# tag if you want to use a different macro definition that overrules the1949# definition found in the source code.1950# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1951 1952EXPAND_AS_DEFINED      =1953 1954# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will1955# remove all refrences to function-like macros that are alone on a line, have an1956# all uppercase name, and do not end with a semicolon. Such function macros are1957# typically used for boiler-plate code, and will confuse the parser if not1958# removed.1959# The default value is: YES.1960# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1961 1962SKIP_FUNCTION_MACROS   = YES1963 1964#---------------------------------------------------------------------------1965# Configuration options related to external references1966#---------------------------------------------------------------------------1967 1968# The TAGFILES tag can be used to specify one or more tag files. For each tag1969# file the location of the external documentation should be added. The format of1970# a tag file without this location is as follows:1971# TAGFILES = file1 file2 ...1972# Adding location for the tag files is done as follows:1973# TAGFILES = file1=loc1 "file2 = loc2" ...1974# where loc1 and loc2 can be relative or absolute paths or URLs. See the1975# section "Linking to external documentation" for more information about the use1976# of tag files.1977# Note: Each tag file must have an unique name (where the name does NOT include1978# the path). If a tag file is not located in the directory in which doxygen is1979# run, you must also specify the path to the tagfile here.1980 1981TAGFILES               =1982 1983# When a file name is specified after GENERATE_TAGFILE, doxygen will create a1984# tag file that is based on the input files it reads. See section "Linking to1985# external documentation" for more information about the usage of tag files.1986 1987GENERATE_TAGFILE       =1988 1989# If the ALLEXTERNALS tag is set to YES all external class will be listed in the1990# class index. If set to NO only the inherited external classes will be listed.1991# The default value is: NO.1992 1993ALLEXTERNALS           = NO1994 1995# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in1996# the modules index. If set to NO, only the current project's groups will be1997# listed.1998# The default value is: YES.1999 2000EXTERNAL_GROUPS        = YES2001 2002# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in2003# the related pages index. If set to NO, only the current project's pages will2004# be listed.2005# The default value is: YES.2006 2007EXTERNAL_PAGES         = YES2008 2009# The PERL_PATH should be the absolute path and name of the perl script2010# interpreter (i.e. the result of 'which perl').2011# The default file (with absolute path) is: /usr/bin/perl.2012 2013PERL_PATH              = /usr/bin/perl2014 2015#---------------------------------------------------------------------------2016# Configuration options related to the dot tool2017#---------------------------------------------------------------------------2018 2019# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2020# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2021# NO turns the diagrams off. Note that this option also works with HAVE_DOT2022# disabled, but it is recommended to install and use dot, since it yields more2023# powerful graphs.2024# The default value is: YES.2025 2026CLASS_DIAGRAMS         = YES2027 2028# You can define message sequence charts within doxygen comments using the \msc2029# command. Doxygen will then run the mscgen tool (see:2030# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2031# documentation. The MSCGEN_PATH tag allows you to specify the directory where2032# the mscgen tool resides. If left empty the tool is assumed to be found in the2033# default search path.2034 2035MSCGEN_PATH            =2036 2037# You can include diagrams made with dia in doxygen documentation. Doxygen will2038# then run dia to produce the diagram and insert it in the documentation. The2039# DIA_PATH tag allows you to specify the directory where the dia binary resides.2040# If left empty dia is assumed to be found in the default search path.2041 2042DIA_PATH               =2043 2044# If set to YES, the inheritance and collaboration graphs will hide inheritance2045# and usage relations if the target is undocumented or is not a class.2046# The default value is: YES.2047 2048HIDE_UNDOC_RELATIONS   = YES2049 2050# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2051# available from the path. This tool is part of Graphviz (see:2052# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2053# Bell Labs. The other options in this section have no effect if this option is2054# set to NO2055# The default value is: NO.2056 2057HAVE_DOT               = NO2058 2059# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2060# to run in parallel. When set to 0 doxygen will base this on the number of2061# processors available in the system. You can set it explicitly to a value2062# larger than 0 to get control over the balance between CPU load and processing2063# speed.2064# Minimum value: 0, maximum value: 32, default value: 0.2065# This tag requires that the tag HAVE_DOT is set to YES.2066 2067DOT_NUM_THREADS        = 02068 2069# When you want a differently looking font n the dot files that doxygen2070# generates you can specify the font name using DOT_FONTNAME. You need to make2071# sure dot is able to find the font, which can be done by putting it in a2072# standard location or by setting the DOTFONTPATH environment variable or by2073# setting DOT_FONTPATH to the directory containing the font.2074# The default value is: Helvetica.2075# This tag requires that the tag HAVE_DOT is set to YES.2076 2077DOT_FONTNAME           = Helvetica2078 2079# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2080# dot graphs.2081# Minimum value: 4, maximum value: 24, default value: 10.2082# This tag requires that the tag HAVE_DOT is set to YES.2083 2084DOT_FONTSIZE           = 102085 2086# By default doxygen will tell dot to use the default font as specified with2087# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2088# the path where dot can find it using this tag.2089# This tag requires that the tag HAVE_DOT is set to YES.2090 2091DOT_FONTPATH           =2092 2093# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2094# each documented class showing the direct and indirect inheritance relations.2095# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2096# The default value is: YES.2097# This tag requires that the tag HAVE_DOT is set to YES.2098 2099CLASS_GRAPH            = YES2100 2101# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2102# graph for each documented class showing the direct and indirect implementation2103# dependencies (inheritance, containment, and class references variables) of the2104# class with other documented classes.2105# The default value is: YES.2106# This tag requires that the tag HAVE_DOT is set to YES.2107 2108COLLABORATION_GRAPH    = NO2109 2110# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2111# groups, showing the direct groups dependencies.2112# The default value is: YES.2113# This tag requires that the tag HAVE_DOT is set to YES.2114 2115GROUP_GRAPHS           = YES2116 2117# If the UML_LOOK tag is set to YES doxygen will generate inheritance and2118# collaboration diagrams in a style similar to the OMG's Unified Modeling2119# Language.2120# The default value is: NO.2121# This tag requires that the tag HAVE_DOT is set to YES.2122 2123UML_LOOK               = NO2124 2125# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2126# class node. If there are many fields or methods and many nodes the graph may2127# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2128# number of items for each type to make the size more manageable. Set this to 02129# for no limit. Note that the threshold may be exceeded by 50% before the limit2130# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2131# but if the number exceeds 15, the total amount of fields shown is limited to2132# 10.2133# Minimum value: 0, maximum value: 100, default value: 10.2134# This tag requires that the tag HAVE_DOT is set to YES.2135 2136UML_LIMIT_NUM_FIELDS   = 102137 2138# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2139# collaboration graphs will show the relations between templates and their2140# instances.2141# The default value is: NO.2142# This tag requires that the tag HAVE_DOT is set to YES.2143 2144TEMPLATE_RELATIONS     = NO2145 2146# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2147# YES then doxygen will generate a graph for each documented file showing the2148# direct and indirect include dependencies of the file with other documented2149# files.2150# The default value is: YES.2151# This tag requires that the tag HAVE_DOT is set to YES.2152 2153INCLUDE_GRAPH          = NO2154 2155# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2156# set to YES then doxygen will generate a graph for each documented file showing2157# the direct and indirect include dependencies of the file with other documented2158# files.2159# The default value is: YES.2160# This tag requires that the tag HAVE_DOT is set to YES.2161 2162INCLUDED_BY_GRAPH      = NO2163 2164# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2165# dependency graph for every global function or class method.2166#2167# Note that enabling this option will significantly increase the time of a run.2168# So in most cases it will be better to enable call graphs for selected2169# functions only using the \callgraph command.2170# The default value is: NO.2171# This tag requires that the tag HAVE_DOT is set to YES.2172 2173CALL_GRAPH             = NO2174 2175# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2176# dependency graph for every global function or class method.2177#2178# Note that enabling this option will significantly increase the time of a run.2179# So in most cases it will be better to enable caller graphs for selected2180# functions only using the \callergraph command.2181# The default value is: NO.2182# This tag requires that the tag HAVE_DOT is set to YES.2183 2184CALLER_GRAPH           = NO2185 2186# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2187# hierarchy of all classes instead of a textual one.2188# The default value is: YES.2189# This tag requires that the tag HAVE_DOT is set to YES.2190 2191GRAPHICAL_HIERARCHY    = YES2192 2193# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2194# dependencies a directory has on other directories in a graphical way. The2195# dependency relations are determined by the #include relations between the2196# files in the directories.2197# The default value is: YES.2198# This tag requires that the tag HAVE_DOT is set to YES.2199 2200DIRECTORY_GRAPH        = YES2201 2202# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2203# generated by dot.2204# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2205# to make the SVG files visible in IE 9+ (other browsers do not have this2206# requirement).2207# Possible values are: png, jpg, gif and svg.2208# The default value is: png.2209# This tag requires that the tag HAVE_DOT is set to YES.2210 2211DOT_IMAGE_FORMAT       = svg2212 2213# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2214# enable generation of interactive SVG images that allow zooming and panning.2215#2216# Note that this requires a modern browser other than Internet Explorer. Tested2217# and working are Firefox, Chrome, Safari, and Opera.2218# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2219# the SVG files visible. Older versions of IE do not have SVG support.2220# The default value is: NO.2221# This tag requires that the tag HAVE_DOT is set to YES.2222 2223INTERACTIVE_SVG        = NO2224 2225# The DOT_PATH tag can be used to specify the path where the dot tool can be2226# found. If left blank, it is assumed the dot tool can be found in the path.2227# This tag requires that the tag HAVE_DOT is set to YES.2228 2229DOT_PATH               = @DOT@2230 2231# The DOTFILE_DIRS tag can be used to specify one or more directories that2232# contain dot files that are included in the documentation (see the \dotfile2233# command).2234# This tag requires that the tag HAVE_DOT is set to YES.2235 2236DOTFILE_DIRS           =2237 2238# The MSCFILE_DIRS tag can be used to specify one or more directories that2239# contain msc files that are included in the documentation (see the \mscfile2240# command).2241 2242MSCFILE_DIRS           =2243 2244# The DIAFILE_DIRS tag can be used to specify one or more directories that2245# contain dia files that are included in the documentation (see the \diafile2246# command).2247 2248DIAFILE_DIRS           =2249 2250# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2251# that will be shown in the graph. If the number of nodes in a graph becomes2252# larger than this value, doxygen will truncate the graph, which is visualized2253# by representing a node as a red box. Note that doxygen if the number of direct2254# children of the root node in a graph is already larger than2255# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2256# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2257# Minimum value: 0, maximum value: 10000, default value: 50.2258# This tag requires that the tag HAVE_DOT is set to YES.2259 2260DOT_GRAPH_MAX_NODES    = 502261 2262# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2263# generated by dot. A depth value of 3 means that only nodes reachable from the2264# root by following a path via at most 3 edges will be shown. Nodes that lay2265# further from the root node will be omitted. Note that setting this option to 12266# or 2 may greatly reduce the computation time needed for large code bases. Also2267# note that the size of a graph can be further restricted by2268# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2269# Minimum value: 0, maximum value: 1000, default value: 0.2270# This tag requires that the tag HAVE_DOT is set to YES.2271 2272MAX_DOT_GRAPH_DEPTH    = 02273 2274# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2275# background. This is disabled by default, because dot on Windows does not seem2276# to support this out of the box.2277#2278# Warning: Depending on the platform used, enabling this option may lead to2279# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2280# read).2281# The default value is: NO.2282# This tag requires that the tag HAVE_DOT is set to YES.2283 2284DOT_TRANSPARENT        = NO2285 2286# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2287# files in one run (i.e. multiple -o and -T options on the command line). This2288# makes dot run faster, but since only newer versions of dot (>1.8.10) support2289# this, this feature is disabled by default.2290# The default value is: NO.2291# This tag requires that the tag HAVE_DOT is set to YES.2292 2293DOT_MULTI_TARGETS      = NO2294 2295# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2296# explaining the meaning of the various boxes and arrows in the dot generated2297# graphs.2298# The default value is: YES.2299# This tag requires that the tag HAVE_DOT is set to YES.2300 2301GENERATE_LEGEND        = YES2302 2303# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2304# files that are used to generate the various graphs.2305# The default value is: YES.2306# This tag requires that the tag HAVE_DOT is set to YES.2307 2308DOT_CLEANUP            = YES2309