2311 lines · plain
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 = "BOLT"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 = @PACKAGE_VERSION@42 43# Using the PROJECT_BRIEF tag one can provide an optional one line description44# for a project that appears at the top of each page and should give viewer a45# quick idea about the purpose of the project. Keep the description short.46 47PROJECT_BRIEF =48 49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in50# the documentation. The maximum height of the logo should not exceed 55 pixels51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo52# to the output directory.53 54PROJECT_LOGO =55 56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path57# into which the generated documentation will be written. If a relative path is58# entered, it will be relative to the location where doxygen was started. If59# left blank the current directory will be used.60 61OUTPUT_DIRECTORY = @abs_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@/../tools/ \752 @abs_top_srcdir@/../README.md \753 @abs_top_srcdir@/doxygen-mainpage.dox754 755# This tag can be used to specify the character encoding of the source files756# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses757# libiconv (or the iconv built into libc) for the transcoding. See the libiconv758# documentation (see: http://www.gnu.org/software/libiconv) for the list of759# possible encodings.760# The default value is: UTF-8.761 762INPUT_ENCODING = UTF-8763 764# If the value of the INPUT tag contains directories, you can use the765# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and766# *.h) to filter out the source-files in the directories. If left blank the767# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,768# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,769# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,770# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,771# *.qsf, *.as and *.js.772 773FILE_PATTERNS =774 775# The RECURSIVE tag can be used to specify whether or not subdirectories should776# be searched for input files as well.777# The default value is: NO.778 779RECURSIVE = YES780 781# The EXCLUDE tag can be used to specify files and/or directories that should be782# excluded from the INPUT source files. This way you can easily exclude a783# subdirectory from a directory tree whose root is specified with the INPUT tag.784#785# Note that relative paths are relative to the directory from which doxygen is786# run.787 788EXCLUDE =789 790# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or791# directories that are symbolic links (a Unix file system feature) are excluded792# from the input.793# The default value is: NO.794 795EXCLUDE_SYMLINKS = NO796 797# If the value of the INPUT tag contains directories, you can use the798# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude799# certain files from those directories.800#801# Note that the wildcards are matched against the file with absolute path, so to802# exclude all test directories for example use the pattern */test/*803 804EXCLUDE_PATTERNS =805 806# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names807# (namespaces, classes, functions, etc.) that should be excluded from the808# output. The symbol name can be a fully qualified name, a word, or if the809# wildcard * is used, a substring. Examples: ANamespace, AClass,810# AClass::ANamespace, ANamespace::*Test811#812# Note that the wildcards are matched against the file with absolute path, so to813# exclude all test directories use the pattern */test/*814 815EXCLUDE_SYMBOLS =816 817# The EXAMPLE_PATH tag can be used to specify one or more files or directories818# that contain example code fragments that are included (see the \include819# command).820 821EXAMPLE_PATH =822 823# If the value of the EXAMPLE_PATH tag contains directories, you can use the824# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and825# *.h) to filter out the source-files in the directories. If left blank all826# files are included.827 828EXAMPLE_PATTERNS =829 830# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be831# searched for input files to be used with the \include or \dontinclude commands832# irrespective of the value of the RECURSIVE tag.833# The default value is: NO.834 835EXAMPLE_RECURSIVE = NO836 837# The IMAGE_PATH tag can be used to specify one or more files or directories838# that contain images that are to be included in the documentation (see the839# \image command).840 841IMAGE_PATH =842 843# The INPUT_FILTER tag can be used to specify a program that doxygen should844# invoke to filter for each input file. Doxygen will invoke the filter program845# by executing (via popen()) the command:846#847# <filter> <input-file>848#849# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the850# name of an input file. Doxygen will then use the output that the filter851# program writes to standard output. If FILTER_PATTERNS is specified, this tag852# will be ignored.853#854# Note that the filter must not add or remove lines; it is applied before the855# code is scanned, but not when the output code is generated. If lines are added856# or removed, the anchors will not be placed correctly.857 858INPUT_FILTER =859 860# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern861# basis. Doxygen will compare the file name with each pattern and apply the862# filter if there is a match. The filters are a list of the form: pattern=filter863# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how864# filters are used. If the FILTER_PATTERNS tag is empty or if none of the865# patterns match the file name, INPUT_FILTER is applied.866 867FILTER_PATTERNS =868 869# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using870# INPUT_FILTER ) will also be used to filter the input files that are used for871# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).872# The default value is: NO.873 874FILTER_SOURCE_FILES = NO875 876# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file877# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and878# it is also possible to disable source filtering for a specific pattern using879# *.ext= (so without naming a filter).880# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.881 882FILTER_SOURCE_PATTERNS =883 884# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that885# is part of the input, its contents will be placed on the main page886# (index.html). This can be useful if you have a project on for instance GitHub887# and want to reuse the introduction page also for the doxygen output.888 889USE_MDFILE_AS_MAINPAGE =890 891#---------------------------------------------------------------------------892# Configuration options related to source browsing893#---------------------------------------------------------------------------894 895# If the SOURCE_BROWSER tag is set to YES then a list of source files will be896# generated. Documented entities will be cross-referenced with these sources.897#898# Note: To get rid of all source code in the generated output, make sure that899# also VERBATIM_HEADERS is set to NO.900# The default value is: NO.901 902SOURCE_BROWSER = NO903 904# Setting the INLINE_SOURCES tag to YES will include the body of functions,905# classes and enums directly into the documentation.906# The default value is: NO.907 908INLINE_SOURCES = NO909 910# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any911# special comment blocks from generated source code fragments. Normal C, C++ and912# Fortran comments will always remain visible.913# The default value is: YES.914 915STRIP_CODE_COMMENTS = YES916 917# If the REFERENCED_BY_RELATION tag is set to YES then for each documented918# function all documented functions referencing it will be listed.919# The default value is: NO.920 921REFERENCED_BY_RELATION = NO922 923# If the REFERENCES_RELATION tag is set to YES then for each documented function924# all documented entities called/used by that function will be listed.925# The default value is: NO.926 927REFERENCES_RELATION = NO928 929# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set930# to YES, then the hyperlinks from functions in REFERENCES_RELATION and931# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will932# link to the documentation.933# The default value is: YES.934 935REFERENCES_LINK_SOURCE = YES936 937# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the938# source code will show a tooltip with additional information such as prototype,939# brief description and links to the definition and documentation. Since this940# will make the HTML file larger and loading of large files a bit slower, you941# can opt to disable this feature.942# The default value is: YES.943# This tag requires that the tag SOURCE_BROWSER is set to YES.944 945SOURCE_TOOLTIPS = YES946 947# If the USE_HTAGS tag is set to YES then the references to source code will948# point to the HTML generated by the htags(1) tool instead of doxygen built-in949# source browser. The htags tool is part of GNU's global source tagging system950# (see http://www.gnu.org/software/global/global.html). You will need version951# 4.8.6 or higher.952#953# To use it do the following:954# - Install the latest version of global955# - Enable SOURCE_BROWSER and USE_HTAGS in the config file956# - Make sure the INPUT points to the root of the source tree957# - Run doxygen as normal958#959# Doxygen will invoke htags (and that will in turn invoke gtags), so these960# tools must be available from the command line (i.e. in the search path).961#962# The result: instead of the source browser generated by doxygen, the links to963# source code will now point to the output of htags.964# The default value is: NO.965# This tag requires that the tag SOURCE_BROWSER is set to YES.966 967USE_HTAGS = NO968 969# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a970# verbatim copy of the header file for each class for which an include is971# specified. Set to NO to disable this.972# See also: Section \class.973# The default value is: YES.974 975VERBATIM_HEADERS = YES976 977#---------------------------------------------------------------------------978# Configuration options related to the alphabetical class index979#---------------------------------------------------------------------------980 981# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all982# compounds will be generated. Enable this if the project contains a lot of983# classes, structs, unions or interfaces.984# The default value is: YES.985 986ALPHABETICAL_INDEX = YES987 988# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in989# which the alphabetical index list will be split.990# Minimum value: 1, maximum value: 20, default value: 5.991# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.992 993COLS_IN_ALPHA_INDEX = 5994 995# In case all classes in a project start with a common prefix, all classes will996# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag997# can be used to specify a prefix (or a list of prefixes) that should be ignored998# while generating the index headers.999# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1000 1001IGNORE_PREFIX =1002 1003#---------------------------------------------------------------------------1004# Configuration options related to the HTML output1005#---------------------------------------------------------------------------1006 1007# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1008# The default value is: YES.1009 1010GENERATE_HTML = YES1011 1012# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1013# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1014# it.1015# The default directory is: html.1016# This tag requires that the tag GENERATE_HTML is set to YES.1017 1018HTML_OUTPUT = html1019 1020# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1021# generated HTML page (for example: .htm, .php, .asp).1022# The default value is: .html.1023# This tag requires that the tag GENERATE_HTML is set to YES.1024 1025HTML_FILE_EXTENSION = .html1026 1027# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1028# each generated HTML page. If the tag is left blank doxygen will generate a1029# standard header.1030#1031# To get valid HTML the header file that includes any scripts and style sheets1032# that doxygen needs, which is dependent on the configuration options used (e.g.1033# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1034# default header using1035# doxygen -w html new_header.html new_footer.html new_stylesheet.css1036# YourConfigFile1037# and then modify the file new_header.html. See also section "Doxygen usage"1038# for information on how to generate the default header that doxygen normally1039# uses.1040# Note: The header is subject to change so you typically have to regenerate the1041# default header when upgrading to a newer version of doxygen. For a description1042# of the possible markers and block names see the documentation.1043# This tag requires that the tag GENERATE_HTML is set to YES.1044 1045HTML_HEADER =1046 1047# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1048# generated HTML page. If the tag is left blank doxygen will generate a standard1049# footer. See HTML_HEADER for more information on how to generate a default1050# footer and what special commands can be used inside the footer. See also1051# section "Doxygen usage" for information on how to generate the default footer1052# that doxygen normally uses.1053# This tag requires that the tag GENERATE_HTML is set to YES.1054 1055HTML_FOOTER =1056 1057# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1058# sheet that is used by each HTML page. It can be used to fine-tune the look of1059# the HTML output. If left blank doxygen will generate a default style sheet.1060# See also section "Doxygen usage" for information on how to generate the style1061# sheet that doxygen normally uses.1062# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1063# it is more robust and this tag (HTML_STYLESHEET) will in the future become1064# obsolete.1065# This tag requires that the tag GENERATE_HTML is set to YES.1066 1067HTML_STYLESHEET =1068 1069# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-1070# defined cascading style sheet that is included after the standard style sheets1071# created by doxygen. Using this option one can overrule certain style aspects.1072# This is preferred over using HTML_STYLESHEET since it does not replace the1073# standard style sheet and is therefore more robust against future updates.1074# Doxygen will copy the style sheet file to the output directory. For an example1075# see the documentation.1076# This tag requires that the tag GENERATE_HTML is set to YES.1077 1078HTML_EXTRA_STYLESHEET =1079 1080# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1081# other source files which should be copied to the HTML output directory. Note1082# that these files will be copied to the base HTML output directory. Use the1083# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1084# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1085# files will be copied as-is; there are no commands or markers available.1086# This tag requires that the tag GENERATE_HTML is set to YES.1087 1088HTML_EXTRA_FILES =1089 1090# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1091# will adjust the colors in the stylesheet and background images according to1092# this color. Hue is specified as an angle on a colorwheel, see1093# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1094# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001095# purple, and 360 is red again.1096# Minimum value: 0, maximum value: 359, default value: 220.1097# This tag requires that the tag GENERATE_HTML is set to YES.1098 1099HTML_COLORSTYLE_HUE = 2201100 1101# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1102# in the HTML output. For a value of 0 the output will use grayscales only. A1103# value of 255 will produce the most vivid colors.1104# Minimum value: 0, maximum value: 255, default value: 100.1105# This tag requires that the tag GENERATE_HTML is set to YES.1106 1107HTML_COLORSTYLE_SAT = 1001108 1109# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1110# luminance component of the colors in the HTML output. Values below 1001111# gradually make the output lighter, whereas values above 100 make the output1112# darker. The value divided by 100 is the actual gamma applied, so 80 represents1113# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1114# change the gamma.1115# Minimum value: 40, maximum value: 240, default value: 80.1116# This tag requires that the tag GENERATE_HTML is set to YES.1117 1118HTML_COLORSTYLE_GAMMA = 801119 1120# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1121# page will contain the date and time when the page was generated. Setting this1122# to NO can help when comparing the output of multiple runs.1123# The default value is: YES.1124# This tag requires that the tag GENERATE_HTML is set to YES.1125 1126HTML_TIMESTAMP = YES1127 1128# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1129# documentation will contain sections that can be hidden and shown after the1130# page has loaded.1131# The default value is: NO.1132# This tag requires that the tag GENERATE_HTML is set to YES.1133 1134HTML_DYNAMIC_SECTIONS = NO1135 1136# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1137# shown in the various tree structured indices initially; the user can expand1138# and collapse entries dynamically later on. Doxygen will expand the tree to1139# such a level that at most the specified number of entries are visible (unless1140# a fully collapsed tree already exceeds this amount). So setting the number of1141# entries 1 will produce a full collapsed tree by default. 0 is a special value1142# representing an infinite number of entries and will result in a full expanded1143# tree by default.1144# Minimum value: 0, maximum value: 9999, default value: 100.1145# This tag requires that the tag GENERATE_HTML is set to YES.1146 1147HTML_INDEX_NUM_ENTRIES = 1001148 1149# If the GENERATE_DOCSET tag is set to YES, additional index files will be1150# generated that can be used as input for Apple's Xcode 3 integrated development1151# environment (see: http://developer.apple.com/tools/xcode/), introduced with1152# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1153# Makefile in the HTML output directory. Running make will produce the docset in1154# that directory and running make install will install the docset in1155# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1156# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1157# for more information.1158# The default value is: NO.1159# This tag requires that the tag GENERATE_HTML is set to YES.1160 1161GENERATE_DOCSET = NO1162 1163# This tag determines the name of the docset feed. A documentation feed provides1164# an umbrella under which multiple documentation sets from a single provider1165# (such as a company or product suite) can be grouped.1166# The default value is: Doxygen generated docs.1167# This tag requires that the tag GENERATE_DOCSET is set to YES.1168 1169DOCSET_FEEDNAME = "Doxygen generated docs"1170 1171# This tag specifies a string that should uniquely identify the documentation1172# set bundle. This should be a reverse domain-name style string, e.g.1173# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1174# The default value is: org.doxygen.Project.1175# This tag requires that the tag GENERATE_DOCSET is set to YES.1176 1177DOCSET_BUNDLE_ID = org.doxygen.Project1178 1179# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1180# the documentation publisher. This should be a reverse domain-name style1181# string, e.g. com.mycompany.MyDocSet.documentation.1182# The default value is: org.doxygen.Publisher.1183# This tag requires that the tag GENERATE_DOCSET is set to YES.1184 1185DOCSET_PUBLISHER_ID = org.doxygen.Publisher1186 1187# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1188# The default value is: Publisher.1189# This tag requires that the tag GENERATE_DOCSET is set to YES.1190 1191DOCSET_PUBLISHER_NAME = Publisher1192 1193# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1194# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1195# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1196# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1197# Windows.1198#1199# The HTML Help Workshop contains a compiler that can convert all HTML output1200# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1201# files are now used as the Windows 98 help format, and will replace the old1202# Windows help format (.hlp) on all Windows platforms in the future. Compressed1203# HTML files also contain an index, a table of contents, and you can search for1204# words in the documentation. The HTML workshop also contains a viewer for1205# compressed HTML files.1206# The default value is: NO.1207# This tag requires that the tag GENERATE_HTML is set to YES.1208 1209GENERATE_HTMLHELP = NO1210 1211# The CHM_FILE tag can be used to specify the file name of the resulting .chm1212# file. You can add a path in front of the file if the result should not be1213# written to the html output directory.1214# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1215 1216CHM_FILE =1217 1218# The HHC_LOCATION tag can be used to specify the location (absolute path1219# including file name) of the HTML help compiler ( hhc.exe). If non-empty1220# doxygen will try to run the HTML help compiler on the generated index.hhp.1221# The file has to be specified with full path.1222# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1223 1224HHC_LOCATION =1225 1226# The GENERATE_CHI flag controls if a separate .chi index file is generated (1227# YES) or that it should be included in the main .chm file ( NO).1228# The default value is: NO.1229# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1230 1231GENERATE_CHI = NO1232 1233# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)1234# and project file content.1235# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1236 1237CHM_INDEX_ENCODING =1238 1239# The BINARY_TOC flag controls whether a binary table of contents is generated (1240# YES) or a normal table of contents ( NO) in the .chm file.1241# The default value is: NO.1242# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1243 1244BINARY_TOC = NO1245 1246# The TOC_EXPAND flag can be set to YES to add extra items for group members to1247# the table of contents of the HTML help documentation and to the tree view.1248# The default value is: NO.1249# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1250 1251TOC_EXPAND = NO1252 1253# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1254# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1255# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1256# (.qch) of the generated HTML documentation.1257# The default value is: NO.1258# This tag requires that the tag GENERATE_HTML is set to YES.1259 1260GENERATE_QHP = @llvm_doxygen_generate_qhp@1261 1262# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1263# the file name of the resulting .qch file. The path specified is relative to1264# the HTML output folder.1265# This tag requires that the tag GENERATE_QHP is set to YES.1266 1267QCH_FILE = @llvm_doxygen_qch_filename@1268 1269# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1270# Project output. For more information please see Qt Help Project / Namespace1271# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1272# The default value is: org.doxygen.Project.1273# This tag requires that the tag GENERATE_QHP is set to YES.1274 1275QHP_NAMESPACE = @llvm_doxygen_qhp_namespace@1276 1277# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1278# Help Project output. For more information please see Qt Help Project / Virtual1279# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1280# folders).1281# The default value is: doc.1282# This tag requires that the tag GENERATE_QHP is set to YES.1283 1284QHP_VIRTUAL_FOLDER = doc1285 1286# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1287# filter to add. For more information please see Qt Help Project / Custom1288# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1289# filters).1290# This tag requires that the tag GENERATE_QHP is set to YES.1291 1292QHP_CUST_FILTER_NAME = @llvm_doxygen_qhp_cust_filter_name@1293 1294# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1295# custom filter to add. For more information please see Qt Help Project / Custom1296# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1297# filters).1298# This tag requires that the tag GENERATE_QHP is set to YES.1299 1300QHP_CUST_FILTER_ATTRS = @llvm_doxygen_qhp_cust_filter_attrs@1301 1302# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1303# project's filter section matches. Qt Help Project / Filter Attributes (see:1304# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1305# This tag requires that the tag GENERATE_QHP is set to YES.1306 1307QHP_SECT_FILTER_ATTRS =1308 1309# The QHG_LOCATION tag can be used to specify the location of Qt's1310# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1311# generated .qhp file.1312# This tag requires that the tag GENERATE_QHP is set to YES.1313 1314QHG_LOCATION =1315 1316# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1317# generated, together with the HTML files, they form an Eclipse help plugin. To1318# install this plugin and make it available under the help contents menu in1319# Eclipse, the contents of the directory containing the HTML and XML files needs1320# to be copied into the plugins directory of eclipse. The name of the directory1321# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1322# After copying Eclipse needs to be restarted before the help appears.1323# The default value is: NO.1324# This tag requires that the tag GENERATE_HTML is set to YES.1325 1326GENERATE_ECLIPSEHELP = NO1327 1328# A unique identifier for the Eclipse help plugin. When installing the plugin1329# the directory name containing the HTML and XML files should also have this1330# name. Each documentation set should have its own identifier.1331# The default value is: org.doxygen.Project.1332# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1333 1334ECLIPSE_DOC_ID = org.doxygen.Project1335 1336# If you want full control over the layout of the generated HTML pages it might1337# be necessary to disable the index and replace it with your own. The1338# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1339# of each HTML page. A value of NO enables the index and the value YES disables1340# it. Since the tabs in the index contain the same information as the navigation1341# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1342# The default value is: NO.1343# This tag requires that the tag GENERATE_HTML is set to YES.1344 1345DISABLE_INDEX = NO1346 1347# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1348# structure should be generated to display hierarchical information. If the tag1349# value is set to YES, a side panel will be generated containing a tree-like1350# index structure (just like the one that is generated for HTML Help). For this1351# to work a browser that supports JavaScript, DHTML, CSS and frames is required1352# (i.e. any modern browser). Windows users are probably better off using the1353# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can1354# further fine-tune the look of the index. As an example, the default style1355# sheet generated by doxygen has an example that shows how to put an image at1356# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1357# the same information as the tab index, you could consider setting1358# DISABLE_INDEX to YES when enabling this option.1359# The default value is: NO.1360# This tag requires that the tag GENERATE_HTML is set to YES.1361 1362GENERATE_TREEVIEW = NO1363 1364# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1365# doxygen will group on one line in the generated HTML documentation.1366#1367# Note that a value of 0 will completely suppress the enum values from appearing1368# in the overview section.1369# Minimum value: 0, maximum value: 20, default value: 4.1370# This tag requires that the tag GENERATE_HTML is set to YES.1371 1372ENUM_VALUES_PER_LINE = 41373 1374# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1375# to set the initial width (in pixels) of the frame in which the tree is shown.1376# Minimum value: 0, maximum value: 1500, default value: 250.1377# This tag requires that the tag GENERATE_HTML is set to YES.1378 1379TREEVIEW_WIDTH = 2501380 1381# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to1382# external symbols imported via tag files in a separate window.1383# The default value is: NO.1384# This tag requires that the tag GENERATE_HTML is set to YES.1385 1386EXT_LINKS_IN_WINDOW = NO1387 1388# Use this tag to change the font size of LaTeX formulas included as images in1389# the HTML documentation. When you change the font size after a successful1390# doxygen run you need to manually remove any form_*.png images from the HTML1391# output directory to force them to be regenerated.1392# Minimum value: 8, maximum value: 50, default value: 10.1393# This tag requires that the tag GENERATE_HTML is set to YES.1394 1395FORMULA_FONTSIZE = 101396 1397# Use the FORMULA_TRANPARENT tag to determine whether or not the images1398# generated for formulas are transparent PNGs. Transparent PNGs are not1399# supported properly for IE 6.0, but are supported on all modern browsers.1400#1401# Note that when changing this option you need to delete any form_*.png files in1402# the HTML output directory before the changes have effect.1403# The default value is: YES.1404# This tag requires that the tag GENERATE_HTML is set to YES.1405 1406FORMULA_TRANSPARENT = YES1407 1408# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1409# http://www.mathjax.org) which uses client side Javascript for the rendering1410# instead of using prerendered bitmaps. Use this if you do not have LaTeX1411# installed or if you want to formulas look prettier in the HTML output. When1412# enabled you may also need to install MathJax separately and configure the path1413# to it using the MATHJAX_RELPATH option.1414# The default value is: NO.1415# This tag requires that the tag GENERATE_HTML is set to YES.1416 1417USE_MATHJAX = NO1418 1419# When MathJax is enabled you can set the default output format to be used for1420# the MathJax output. See the MathJax site (see:1421# http://docs.mathjax.org/en/latest/output.html) for more details.1422# Possible values are: HTML-CSS (which is slower, but has the best1423# compatibility), NativeMML (i.e. MathML) and SVG.1424# The default value is: HTML-CSS.1425# This tag requires that the tag USE_MATHJAX is set to YES.1426 1427MATHJAX_FORMAT = HTML-CSS1428 1429# When MathJax is enabled you need to specify the location relative to the HTML1430# output directory using the MATHJAX_RELPATH option. The destination directory1431# should contain the MathJax.js script. For instance, if the mathjax directory1432# is located at the same level as the HTML output directory, then1433# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1434# Content Delivery Network so you can quickly see the result without installing1435# MathJax. However, it is strongly recommended to install a local copy of1436# MathJax from http://www.mathjax.org before deployment.1437# The default value is: http://cdn.mathjax.org/mathjax/latest.1438# This tag requires that the tag USE_MATHJAX is set to YES.1439 1440MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest1441 1442# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1443# extension names that should be enabled during MathJax rendering. For example1444# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1445# This tag requires that the tag USE_MATHJAX is set to YES.1446 1447MATHJAX_EXTENSIONS =1448 1449# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1450# of code that will be used on startup of the MathJax code. See the MathJax site1451# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1452# example see the documentation.1453# This tag requires that the tag USE_MATHJAX is set to YES.1454 1455MATHJAX_CODEFILE =1456 1457# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1458# the HTML output. The underlying search engine uses javascript and DHTML and1459# should work on any modern browser. Note that when using HTML help1460# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1461# there is already a search function so this one should typically be disabled.1462# For large projects the javascript based search engine can be slow, then1463# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1464# search using the keyboard; to jump to the search box use <access key> + S1465# (what the <access key> is depends on the OS and browser, but it is typically1466# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1467# key> to jump into the search results window, the results can be navigated1468# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1469# the search. The filter options can be selected when the cursor is inside the1470# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1471# to select a filter and <Enter> or <escape> to activate or cancel the filter1472# option.1473# The default value is: YES.1474# This tag requires that the tag GENERATE_HTML is set to YES.1475 1476SEARCHENGINE = @enable_searchengine@1477 1478# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1479# implemented using a web server instead of a web client using Javascript. There1480# are two flavours of web server based searching depending on the1481# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1482# searching and an index file used by the script. When EXTERNAL_SEARCH is1483# enabled the indexing and searching needs to be provided by external tools. See1484# the section "External Indexing and Searching" for details.1485# The default value is: NO.1486# This tag requires that the tag SEARCHENGINE is set to YES.1487 1488SERVER_BASED_SEARCH = @enable_server_based_search@1489 1490# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1491# script for searching. Instead the search results are written to an XML file1492# which needs to be processed by an external indexer. Doxygen will invoke an1493# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1494# search results.1495#1496# Doxygen ships with an example indexer ( doxyindexer) and search engine1497# (doxysearch.cgi) which are based on the open source search engine library1498# Xapian (see: http://xapian.org/).1499#1500# See the section "External Indexing and Searching" for details.1501# The default value is: NO.1502# This tag requires that the tag SEARCHENGINE is set to YES.1503 1504EXTERNAL_SEARCH = @enable_external_search@1505 1506# The SEARCHENGINE_URL should point to a search engine hosted by a web server1507# which will return the search results when EXTERNAL_SEARCH is enabled.1508#1509# Doxygen ships with an example indexer ( doxyindexer) and search engine1510# (doxysearch.cgi) which are based on the open source search engine library1511# Xapian (see: http://xapian.org/). See the section "External Indexing and1512# Searching" for details.1513# This tag requires that the tag SEARCHENGINE is set to YES.1514 1515SEARCHENGINE_URL = @searchengine_url@1516 1517# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1518# search data is written to a file for indexing by an external tool. With the1519# SEARCHDATA_FILE tag the name of this file can be specified.1520# The default file is: searchdata.xml.1521# This tag requires that the tag SEARCHENGINE is set to YES.1522 1523SEARCHDATA_FILE = searchdata.xml1524 1525# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1526# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1527# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1528# projects and redirect the results back to the right project.1529# This tag requires that the tag SEARCHENGINE is set to YES.1530 1531EXTERNAL_SEARCH_ID = bolt1532 1533# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1534# projects other than the one defined by this configuration file, but that are1535# all added to the same external search index. Each project needs to have a1536# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1537# to a relative location where the documentation can be found. The format is:1538# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1539# This tag requires that the tag SEARCHENGINE is set to YES.1540 1541EXTRA_SEARCH_MAPPINGS = @extra_search_mappings@1542 1543#---------------------------------------------------------------------------1544# Configuration options related to the LaTeX output1545#---------------------------------------------------------------------------1546 1547# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1548# The default value is: YES.1549 1550GENERATE_LATEX = YES1551 1552# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1553# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1554# it.1555# The default directory is: latex.1556# This tag requires that the tag GENERATE_LATEX is set to YES.1557 1558LATEX_OUTPUT = latex1559 1560# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1561# invoked.1562#1563# Note that when enabling USE_PDFLATEX this option is only used for generating1564# bitmaps for formulas in the HTML output, but not in the Makefile that is1565# written to the output directory.1566# The default file is: latex.1567# This tag requires that the tag GENERATE_LATEX is set to YES.1568 1569LATEX_CMD_NAME = latex1570 1571# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1572# index for LaTeX.1573# The default file is: makeindex.1574# This tag requires that the tag GENERATE_LATEX is set to YES.1575 1576MAKEINDEX_CMD_NAME = makeindex1577 1578# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX1579# documents. This may be useful for small projects and may help to save some1580# trees in general.1581# The default value is: NO.1582# This tag requires that the tag GENERATE_LATEX is set to YES.1583 1584COMPACT_LATEX = NO1585 1586# The PAPER_TYPE tag can be used to set the paper type that is used by the1587# printer.1588# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1589# 14 inches) and executive (7.25 x 10.5 inches).1590# The default value is: a4.1591# This tag requires that the tag GENERATE_LATEX is set to YES.1592 1593PAPER_TYPE = a41594 1595# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1596# that should be included in the LaTeX output. To get the times font for1597# instance you can specify1598# EXTRA_PACKAGES=times1599# If left blank no extra packages will be included.1600# This tag requires that the tag GENERATE_LATEX is set to YES.1601 1602EXTRA_PACKAGES =1603 1604# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1605# generated LaTeX document. The header should contain everything until the first1606# chapter. If it is left blank doxygen will generate a standard header. See1607# section "Doxygen usage" for information on how to let doxygen write the1608# default header to a separate file.1609#1610# Note: Only use a user-defined header if you know what you are doing! The1611# following commands have a special meaning inside the header: $title,1612# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will1613# replace them by respectively the title of the page, the current date and time,1614# only the current date, the version number of doxygen, the project name (see1615# PROJECT_NAME), or the project number (see PROJECT_NUMBER).1616# This tag requires that the tag GENERATE_LATEX is set to YES.1617 1618LATEX_HEADER =1619 1620# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1621# generated LaTeX document. The footer should contain everything after the last1622# chapter. If it is left blank doxygen will generate a standard footer.1623#1624# Note: Only use a user-defined footer if you know what you are doing!1625# This tag requires that the tag GENERATE_LATEX is set to YES.1626 1627LATEX_FOOTER =1628 1629# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1630# other source files which should be copied to the LATEX_OUTPUT output1631# directory. Note that the files will be copied as-is; there are no commands or1632# markers available.1633# This tag requires that the tag GENERATE_LATEX is set to YES.1634 1635LATEX_EXTRA_FILES =1636 1637# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1638# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1639# contain links (just like the HTML output) instead of page references. This1640# makes the output suitable for online browsing using a PDF viewer.1641# The default value is: YES.1642# This tag requires that the tag GENERATE_LATEX is set to YES.1643 1644PDF_HYPERLINKS = YES1645 1646# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1647# the PDF file directly from the LaTeX files. Set this option to YES to get a1648# higher quality PDF documentation.1649# The default value is: YES.1650# This tag requires that the tag GENERATE_LATEX is set to YES.1651 1652USE_PDFLATEX = YES1653 1654# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1655# command to the generated LaTeX files. This will instruct LaTeX to keep running1656# if errors occur, instead of asking the user for help. This option is also used1657# when generating formulas in HTML.1658# The default value is: NO.1659# This tag requires that the tag GENERATE_LATEX is set to YES.1660 1661LATEX_BATCHMODE = NO1662 1663# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1664# index chapters (such as File Index, Compound Index, etc.) in the output.1665# The default value is: NO.1666# This tag requires that the tag GENERATE_LATEX is set to YES.1667 1668LATEX_HIDE_INDICES = NO1669 1670# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1671# code with syntax highlighting in the LaTeX output.1672#1673# Note that which sources are shown also depends on other settings such as1674# SOURCE_BROWSER.1675# The default value is: NO.1676# This tag requires that the tag GENERATE_LATEX is set to YES.1677 1678LATEX_SOURCE_CODE = NO1679 1680# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1681# bibliography, e.g. plainnat, or ieeetr. See1682# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1683# The default value is: plain.1684# This tag requires that the tag GENERATE_LATEX is set to YES.1685 1686LATEX_BIB_STYLE = plain1687 1688#---------------------------------------------------------------------------1689# Configuration options related to the RTF output1690#---------------------------------------------------------------------------1691 1692# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1693# RTF output is optimized for Word 97 and may not look too pretty with other RTF1694# readers/editors.1695# The default value is: NO.1696 1697GENERATE_RTF = NO1698 1699# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1700# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1701# it.1702# The default directory is: rtf.1703# This tag requires that the tag GENERATE_RTF is set to YES.1704 1705RTF_OUTPUT = rtf1706 1707# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1708# documents. This may be useful for small projects and may help to save some1709# trees in general.1710# The default value is: NO.1711# This tag requires that the tag GENERATE_RTF is set to YES.1712 1713COMPACT_RTF = NO1714 1715# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1716# contain hyperlink fields. The RTF file will contain links (just like the HTML1717# output) instead of page references. This makes the output suitable for online1718# browsing using Word or some other Word compatible readers that support those1719# fields.1720#1721# Note: WordPad (write) and others do not support links.1722# The default value is: NO.1723# This tag requires that the tag GENERATE_RTF is set to YES.1724 1725RTF_HYPERLINKS = NO1726 1727# Load stylesheet definitions from file. Syntax is similar to doxygen's config1728# file, i.e. a series of assignments. You only have to provide replacements,1729# missing definitions are set to their default value.1730#1731# See also section "Doxygen usage" for information on how to generate the1732# default style sheet that doxygen normally uses.1733# This tag requires that the tag GENERATE_RTF is set to YES.1734 1735RTF_STYLESHEET_FILE =1736 1737# Set optional variables used in the generation of an RTF document. Syntax is1738# similar to doxygen's config file. A template extensions file can be generated1739# using doxygen -e rtf extensionFile.1740# This tag requires that the tag GENERATE_RTF is set to YES.1741 1742RTF_EXTENSIONS_FILE =1743 1744#---------------------------------------------------------------------------1745# Configuration options related to the man page output1746#---------------------------------------------------------------------------1747 1748# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1749# classes and files.1750# The default value is: NO.1751 1752GENERATE_MAN = NO1753 1754# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1755# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1756# it. A directory man3 will be created inside the directory specified by1757# MAN_OUTPUT.1758# The default directory is: man.1759# This tag requires that the tag GENERATE_MAN is set to YES.1760 1761MAN_OUTPUT = man1762 1763# The MAN_EXTENSION tag determines the extension that is added to the generated1764# man pages. In case the manual section does not start with a number, the number1765# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1766# optional.1767# The default value is: .3.1768# This tag requires that the tag GENERATE_MAN is set to YES.1769 1770MAN_EXTENSION = .31771 1772# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1773# will generate one additional man file for each entity documented in the real1774# man page(s). These additional files only source the real man page, but without1775# them the man command would be unable to find the correct page.1776# The default value is: NO.1777# This tag requires that the tag GENERATE_MAN is set to YES.1778 1779MAN_LINKS = NO1780 1781#---------------------------------------------------------------------------1782# Configuration options related to the XML output1783#---------------------------------------------------------------------------1784 1785# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1786# captures the structure of the code including all documentation.1787# The default value is: NO.1788 1789GENERATE_XML = NO1790 1791# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1792# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1793# it.1794# The default directory is: xml.1795# This tag requires that the tag GENERATE_XML is set to YES.1796 1797XML_OUTPUT = xml1798 1799# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a1800# validating XML parser to check the syntax of the XML files.1801# This tag requires that the tag GENERATE_XML is set to YES.1802 1803XML_SCHEMA =1804 1805# The XML_DTD tag can be used to specify a XML DTD, which can be used by a1806# validating XML parser to check the syntax of the XML files.1807# This tag requires that the tag GENERATE_XML is set to YES.1808 1809XML_DTD =1810 1811# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1812# listings (including syntax highlighting and cross-referencing information) to1813# the XML output. Note that enabling this will significantly increase the size1814# of the XML output.1815# The default value is: YES.1816# This tag requires that the tag GENERATE_XML is set to YES.1817 1818XML_PROGRAMLISTING = YES1819 1820#---------------------------------------------------------------------------1821# Configuration options related to the DOCBOOK output1822#---------------------------------------------------------------------------1823 1824# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1825# that can be used to generate PDF.1826# The default value is: NO.1827 1828GENERATE_DOCBOOK = NO1829 1830# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1831# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1832# front of it.1833# The default directory is: docbook.1834# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1835 1836DOCBOOK_OUTPUT = docbook1837 1838#---------------------------------------------------------------------------1839# Configuration options for the AutoGen Definitions output1840#---------------------------------------------------------------------------1841 1842# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1843# Definitions (see http://autogen.sf.net) file that captures the structure of1844# the code including all documentation. Note that this feature is still1845# experimental and incomplete at the moment.1846# The default value is: NO.1847 1848GENERATE_AUTOGEN_DEF = NO1849 1850#---------------------------------------------------------------------------1851# Configuration options related to the Perl module output1852#---------------------------------------------------------------------------1853 1854# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module1855# file that captures the structure of the code including all documentation.1856#1857# Note that this feature is still experimental and incomplete at the moment.1858# The default value is: NO.1859 1860GENERATE_PERLMOD = NO1861 1862# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary1863# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI1864# output from the Perl module output.1865# The default value is: NO.1866# This tag requires that the tag GENERATE_PERLMOD is set to YES.1867 1868PERLMOD_LATEX = NO1869 1870# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely1871# formatted so it can be parsed by a human reader. This is useful if you want to1872# understand what is going on. On the other hand, if this tag is set to NO the1873# size of the Perl module output will be much smaller and Perl will parse it1874# just the same.1875# The default value is: YES.1876# This tag requires that the tag GENERATE_PERLMOD is set to YES.1877 1878PERLMOD_PRETTY = YES1879 1880# The names of the make variables in the generated doxyrules.make file are1881# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful1882# so different doxyrules.make files included by the same Makefile don't1883# overwrite each other's variables.1884# This tag requires that the tag GENERATE_PERLMOD is set to YES.1885 1886PERLMOD_MAKEVAR_PREFIX =1887 1888#---------------------------------------------------------------------------1889# Configuration options related to the preprocessor1890#---------------------------------------------------------------------------1891 1892# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all1893# C-preprocessor directives found in the sources and include files.1894# The default value is: YES.1895 1896ENABLE_PREPROCESSING = YES1897 1898# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1899# in the source code. If set to NO only conditional compilation will be1900# performed. Macro expansion can be done in a controlled way by setting1901# EXPAND_ONLY_PREDEF to YES.1902# The default value is: NO.1903# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1904 1905MACRO_EXPANSION = NO1906 1907# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then1908# the macro expansion is limited to the macros specified with the PREDEFINED and1909# EXPAND_AS_DEFINED tags.1910# The default value is: NO.1911# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1912 1913EXPAND_ONLY_PREDEF = NO1914 1915# If the SEARCH_INCLUDES tag is set to YES the includes files in the1916# INCLUDE_PATH will be searched if a #include is found.1917# The default value is: YES.1918# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1919 1920SEARCH_INCLUDES = YES1921 1922# The INCLUDE_PATH tag can be used to specify one or more directories that1923# contain include files that are not input files but should be processed by the1924# preprocessor.1925# This tag requires that the tag SEARCH_INCLUDES is set to YES.1926 1927INCLUDE_PATH =1928 1929# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1930# patterns (like *.h and *.hpp) to filter out the header-files in the1931# directories. If left blank, the patterns specified with FILE_PATTERNS will be1932# used.1933# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1934 1935INCLUDE_FILE_PATTERNS =1936 1937# The PREDEFINED tag can be used to specify one or more macro names that are1938# defined before the preprocessor is started (similar to the -D option of e.g.1939# gcc). The argument of the tag is a list of macros of the form: name or1940# name=definition (no spaces). If the definition and the "=" are omitted, "=1"1941# is assumed. To prevent a macro definition from being undefined via #undef or1942# recursively expanded use the := operator instead of the = operator.1943# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1944 1945PREDEFINED =1946 1947# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this1948# tag can be used to specify a list of macro names that should be expanded. The1949# macro definition that is found in the sources will be used. Use the PREDEFINED1950# tag if you want to use a different macro definition that overrules the1951# definition found in the source code.1952# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1953 1954EXPAND_AS_DEFINED =1955 1956# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will1957# remove all references to function-like macros that are alone on a line, have an1958# all uppercase name, and do not end with a semicolon. Such function macros are1959# typically used for boiler-plate code, and will confuse the parser if not1960# removed.1961# The default value is: YES.1962# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1963 1964SKIP_FUNCTION_MACROS = YES1965 1966#---------------------------------------------------------------------------1967# Configuration options related to external references1968#---------------------------------------------------------------------------1969 1970# The TAGFILES tag can be used to specify one or more tag files. For each tag1971# file the location of the external documentation should be added. The format of1972# a tag file without this location is as follows:1973# TAGFILES = file1 file2 ...1974# Adding location for the tag files is done as follows:1975# TAGFILES = file1=loc1 "file2 = loc2" ...1976# where loc1 and loc2 can be relative or absolute paths or URLs. See the1977# section "Linking to external documentation" for more information about the use1978# of tag files.1979# Note: Each tag file must have an unique name (where the name does NOT include1980# the path). If a tag file is not located in the directory in which doxygen is1981# run, you must also specify the path to the tagfile here.1982 1983TAGFILES =1984 1985# When a file name is specified after GENERATE_TAGFILE, doxygen will create a1986# tag file that is based on the input files it reads. See section "Linking to1987# external documentation" for more information about the usage of tag files.1988 1989GENERATE_TAGFILE =1990 1991# If the ALLEXTERNALS tag is set to YES all external class will be listed in the1992# class index. If set to NO only the inherited external classes will be listed.1993# The default value is: NO.1994 1995ALLEXTERNALS = NO1996 1997# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in1998# the modules index. If set to NO, only the current project's groups will be1999# listed.2000# The default value is: YES.2001 2002EXTERNAL_GROUPS = YES2003 2004# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in2005# the related pages index. If set to NO, only the current project's pages will2006# be listed.2007# The default value is: YES.2008 2009EXTERNAL_PAGES = YES2010 2011# The PERL_PATH should be the absolute path and name of the perl script2012# interpreter (i.e. the result of 'which perl').2013# The default file (with absolute path) is: /usr/bin/perl.2014 2015PERL_PATH = /usr/bin/perl2016 2017#---------------------------------------------------------------------------2018# Configuration options related to the dot tool2019#---------------------------------------------------------------------------2020 2021# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2022# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2023# NO turns the diagrams off. Note that this option also works with HAVE_DOT2024# disabled, but it is recommended to install and use dot, since it yields more2025# powerful graphs.2026# The default value is: YES.2027 2028CLASS_DIAGRAMS = YES2029 2030# You can define message sequence charts within doxygen comments using the \msc2031# command. Doxygen will then run the mscgen tool (see:2032# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2033# documentation. The MSCGEN_PATH tag allows you to specify the directory where2034# the mscgen tool resides. If left empty the tool is assumed to be found in the2035# default search path.2036 2037MSCGEN_PATH =2038 2039# You can include diagrams made with dia in doxygen documentation. Doxygen will2040# then run dia to produce the diagram and insert it in the documentation. The2041# DIA_PATH tag allows you to specify the directory where the dia binary resides.2042# If left empty dia is assumed to be found in the default search path.2043 2044DIA_PATH =2045 2046# If set to YES, the inheritance and collaboration graphs will hide inheritance2047# and usage relations if the target is undocumented or is not a class.2048# The default value is: YES.2049 2050HIDE_UNDOC_RELATIONS = YES2051 2052# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2053# available from the path. This tool is part of Graphviz (see:2054# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2055# Bell Labs. The other options in this section have no effect if this option is2056# set to NO2057# The default value is: NO.2058 2059HAVE_DOT = NO2060 2061# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2062# to run in parallel. When set to 0 doxygen will base this on the number of2063# processors available in the system. You can set it explicitly to a value2064# larger than 0 to get control over the balance between CPU load and processing2065# speed.2066# Minimum value: 0, maximum value: 32, default value: 0.2067# This tag requires that the tag HAVE_DOT is set to YES.2068 2069DOT_NUM_THREADS = 02070 2071# When you want a differently looking font n the dot files that doxygen2072# generates you can specify the font name using DOT_FONTNAME. You need to make2073# sure dot is able to find the font, which can be done by putting it in a2074# standard location or by setting the DOTFONTPATH environment variable or by2075# setting DOT_FONTPATH to the directory containing the font.2076# The default value is: Helvetica.2077# This tag requires that the tag HAVE_DOT is set to YES.2078 2079DOT_FONTNAME = Helvetica2080 2081# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2082# dot graphs.2083# Minimum value: 4, maximum value: 24, default value: 10.2084# This tag requires that the tag HAVE_DOT is set to YES.2085 2086DOT_FONTSIZE = 102087 2088# By default doxygen will tell dot to use the default font as specified with2089# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2090# the path where dot can find it using this tag.2091# This tag requires that the tag HAVE_DOT is set to YES.2092 2093DOT_FONTPATH =2094 2095# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2096# each documented class showing the direct and indirect inheritance relations.2097# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2098# The default value is: YES.2099# This tag requires that the tag HAVE_DOT is set to YES.2100 2101CLASS_GRAPH = YES2102 2103# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2104# graph for each documented class showing the direct and indirect implementation2105# dependencies (inheritance, containment, and class references variables) of the2106# class with other documented classes.2107# The default value is: YES.2108# This tag requires that the tag HAVE_DOT is set to YES.2109 2110COLLABORATION_GRAPH = NO2111 2112# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2113# groups, showing the direct groups dependencies.2114# The default value is: YES.2115# This tag requires that the tag HAVE_DOT is set to YES.2116 2117GROUP_GRAPHS = YES2118 2119# If the UML_LOOK tag is set to YES doxygen will generate inheritance and2120# collaboration diagrams in a style similar to the OMG's Unified Modeling2121# Language.2122# The default value is: NO.2123# This tag requires that the tag HAVE_DOT is set to YES.2124 2125UML_LOOK = NO2126 2127# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2128# class node. If there are many fields or methods and many nodes the graph may2129# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2130# number of items for each type to make the size more manageable. Set this to 02131# for no limit. Note that the threshold may be exceeded by 50% before the limit2132# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2133# but if the number exceeds 15, the total amount of fields shown is limited to2134# 10.2135# Minimum value: 0, maximum value: 100, default value: 10.2136# This tag requires that the tag HAVE_DOT is set to YES.2137 2138UML_LIMIT_NUM_FIELDS = 102139 2140# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2141# collaboration graphs will show the relations between templates and their2142# instances.2143# The default value is: NO.2144# This tag requires that the tag HAVE_DOT is set to YES.2145 2146TEMPLATE_RELATIONS = NO2147 2148# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2149# YES then doxygen will generate a graph for each documented file showing the2150# direct and indirect include dependencies of the file with other documented2151# files.2152# The default value is: YES.2153# This tag requires that the tag HAVE_DOT is set to YES.2154 2155INCLUDE_GRAPH = NO2156 2157# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2158# set to YES then doxygen will generate a graph for each documented file showing2159# the direct and indirect include dependencies of the file with other documented2160# files.2161# The default value is: YES.2162# This tag requires that the tag HAVE_DOT is set to YES.2163 2164INCLUDED_BY_GRAPH = NO2165 2166# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2167# dependency graph for every global function or class method.2168#2169# Note that enabling this option will significantly increase the time of a run.2170# So in most cases it will be better to enable call graphs for selected2171# functions only using the \callgraph command.2172# The default value is: NO.2173# This tag requires that the tag HAVE_DOT is set to YES.2174 2175CALL_GRAPH = NO2176 2177# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2178# dependency graph for every global function or class method.2179#2180# Note that enabling this option will significantly increase the time of a run.2181# So in most cases it will be better to enable caller graphs for selected2182# functions only using the \callergraph command.2183# The default value is: NO.2184# This tag requires that the tag HAVE_DOT is set to YES.2185 2186CALLER_GRAPH = NO2187 2188# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2189# hierarchy of all classes instead of a textual one.2190# The default value is: YES.2191# This tag requires that the tag HAVE_DOT is set to YES.2192 2193GRAPHICAL_HIERARCHY = YES2194 2195# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2196# dependencies a directory has on other directories in a graphical way. The2197# dependency relations are determined by the #include relations between the2198# files in the directories.2199# The default value is: YES.2200# This tag requires that the tag HAVE_DOT is set to YES.2201 2202DIRECTORY_GRAPH = YES2203 2204# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2205# generated by dot.2206# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2207# to make the SVG files visible in IE 9+ (other browsers do not have this2208# requirement).2209# Possible values are: png, jpg, gif and svg.2210# The default value is: png.2211# This tag requires that the tag HAVE_DOT is set to YES.2212 2213DOT_IMAGE_FORMAT = svg2214 2215# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2216# enable generation of interactive SVG images that allow zooming and panning.2217#2218# Note that this requires a modern browser other than Internet Explorer. Tested2219# and working are Firefox, Chrome, Safari, and Opera.2220# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2221# the SVG files visible. Older versions of IE do not have SVG support.2222# The default value is: NO.2223# This tag requires that the tag HAVE_DOT is set to YES.2224 2225INTERACTIVE_SVG = NO2226 2227# The DOT_PATH tag can be used to specify the path where the dot tool can be2228# found. If left blank, it is assumed the dot tool can be found in the path.2229# This tag requires that the tag HAVE_DOT is set to YES.2230 2231DOT_PATH = @DOT@2232 2233# The DOTFILE_DIRS tag can be used to specify one or more directories that2234# contain dot files that are included in the documentation (see the \dotfile2235# command).2236# This tag requires that the tag HAVE_DOT is set to YES.2237 2238DOTFILE_DIRS =2239 2240# The MSCFILE_DIRS tag can be used to specify one or more directories that2241# contain msc files that are included in the documentation (see the \mscfile2242# command).2243 2244MSCFILE_DIRS =2245 2246# The DIAFILE_DIRS tag can be used to specify one or more directories that2247# contain dia files that are included in the documentation (see the \diafile2248# command).2249 2250DIAFILE_DIRS =2251 2252# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2253# that will be shown in the graph. If the number of nodes in a graph becomes2254# larger than this value, doxygen will truncate the graph, which is visualized2255# by representing a node as a red box. Note that doxygen if the number of direct2256# children of the root node in a graph is already larger than2257# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2258# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2259# Minimum value: 0, maximum value: 10000, default value: 50.2260# This tag requires that the tag HAVE_DOT is set to YES.2261 2262DOT_GRAPH_MAX_NODES = 502263 2264# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2265# generated by dot. A depth value of 3 means that only nodes reachable from the2266# root by following a path via at most 3 edges will be shown. Nodes that lay2267# further from the root node will be omitted. Note that setting this option to 12268# or 2 may greatly reduce the computation time needed for large code bases. Also2269# note that the size of a graph can be further restricted by2270# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2271# Minimum value: 0, maximum value: 1000, default value: 0.2272# This tag requires that the tag HAVE_DOT is set to YES.2273 2274MAX_DOT_GRAPH_DEPTH = 02275 2276# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2277# background. This is disabled by default, because dot on Windows does not seem2278# to support this out of the box.2279#2280# Warning: Depending on the platform used, enabling this option may lead to2281# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2282# read).2283# The default value is: NO.2284# This tag requires that the tag HAVE_DOT is set to YES.2285 2286DOT_TRANSPARENT = NO2287 2288# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2289# files in one run (i.e. multiple -o and -T options on the command line). This2290# makes dot run faster, but since only newer versions of dot (>1.8.10) support2291# this, this feature is disabled by default.2292# The default value is: NO.2293# This tag requires that the tag HAVE_DOT is set to YES.2294 2295DOT_MULTI_TARGETS = NO2296 2297# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2298# explaining the meaning of the various boxes and arrows in the dot generated2299# graphs.2300# The default value is: YES.2301# This tag requires that the tag HAVE_DOT is set to YES.2302 2303GENERATE_LEGEND = YES2304 2305# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2306# files that are used to generate the various graphs.2307# The default value is: YES.2308# This tag requires that the tag HAVE_DOT is set to YES.2309 2310DOT_CLEANUP = YES2311