brintos / llvm-project-archived public Read only

1# Doxyfile 1.8.62 3# This file describes the settings to be used by the documentation system4# doxygen (www.doxygen.org) for a project.5#6# All text after a double hash (##) is considered a comment and is placed in7# front of the TAG it is preceding.8#9# All text after a single hash (#) is considered a comment and will be ignored.10# The format is:11# TAG = value [value, ...]12# For lists, items can also be appended using:13# TAG += value [value, ...]14# Values that contain spaces should be placed between quotes (\" \").15 16#---------------------------------------------------------------------------17# Project related configuration options18#---------------------------------------------------------------------------19 20# This tag specifies the encoding used for all characters in the config file21# that follow. The default is UTF-8 which is also the encoding used for all text22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv24# for the list of possible encodings.25# The default value is: UTF-8.26 27DOXYFILE_ENCODING      = UTF-828 29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by30# double-quotes, unless you are using Doxywizard) that should identify the31# project for which the documentation is generated. This name is used in the32# title of most generated pages and in a few other places.33# The default value is: My Project.34 35PROJECT_NAME           = Polly36 37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This38# could be handy for archiving the generated documentation or if some version39# control system is used.40 41PROJECT_NUMBER         = @PACKAGE_VERSION@42 43# Using the PROJECT_BRIEF tag one can provide an optional one line description44# for a project that appears at the top of each page and should give viewer a45# quick idea about the purpose of the project. Keep the description short.46 47PROJECT_BRIEF          =48 49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in50# the documentation. The maximum height of the logo should not exceed 55 pixels51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo52# to the output directory.53 54PROJECT_LOGO           =55 56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path57# into which the generated documentation will be written. If a relative path is58# entered, it will be relative to the location where doxygen was started. If59# left blank the current directory will be used.60 61OUTPUT_DIRECTORY       = @abs_builddir@/doxygen62 63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-64# directories (in 2 levels) under the output directory of each output format and65# will distribute the generated files over these directories. Enabling this66# option can be useful when feeding doxygen a huge amount of source files, where67# putting all generated files in the same directory would otherwise causes68# performance problems for the file system.69# The default value is: NO.70 71CREATE_SUBDIRS         = NO72 73# The OUTPUT_LANGUAGE tag is used to specify the language in which all74# documentation generated by doxygen is written. Doxygen will use this75# information to generate all constant output in the proper language.76# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,77# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),78# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,79# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),80# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,81# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,82# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,83# Ukrainian and Vietnamese.84# The default value is: English.85 86OUTPUT_LANGUAGE        = English87 88# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member89# descriptions after the members that are listed in the file and class90# documentation (similar to Javadoc). Set to NO to disable this.91# The default value is: YES.92 93BRIEF_MEMBER_DESC      = YES94 95# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief96# description of a member or function before the detailed description97#98# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the99# brief descriptions will be completely suppressed.100# The default value is: YES.101 102REPEAT_BRIEF           = YES103 104# This tag implements a quasi-intelligent brief description abbreviator that is105# used to form the text in various listings. Each string in this list, if found106# as the leading text of the brief description, will be stripped from the text107# and the result, after processing the whole list, is used as the annotated108# text. Otherwise, the brief description is used as-is. If left blank, the109# following values are used ($name is automatically replaced with the name of110# the entity):The $name class, The $name widget, The $name file, is, provides,111# specifies, contains, represents, a, an and the.112 113ABBREVIATE_BRIEF       =114 115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then116# doxygen will generate a detailed section even if there is only a brief117# description.118# The default value is: NO.119 120ALWAYS_DETAILED_SEC    = NO121 122# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all123# inherited members of a class in the documentation of that class as if those124# members were ordinary class members. Constructors, destructors and assignment125# operators of the base classes will not be shown.126# The default value is: NO.127 128INLINE_INHERITED_MEMB  = NO129 130# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path131# before files name in the file list and in the header files. If set to NO the132# shortest path that makes the file name unique will be used133# The default value is: YES.134 135FULL_PATH_NAMES        = NO136 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        = ../..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    =157 158# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but159# less readable) file names. This can be useful is your file systems doesn't160# support long names like on DOS, Mac, or CD-ROM.161# The default value is: NO.162 163SHORT_NAMES            = NO164 165# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the166# first line (until the first dot) of a Javadoc-style comment as the brief167# description. If set to NO, the Javadoc-style will behave just like regular Qt-168# style comments (thus requiring an explicit @brief command for a brief169# description.)170# The default value is: NO.171 172JAVADOC_AUTOBRIEF      = YES173 174# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first175# line (until the first dot) of a Qt-style comment as the brief description. If176# set to NO, the Qt-style will behave just like regular Qt-style comments (thus177# requiring an explicit \brief command for a brief description.)178# The default value is: NO.179 180QT_AUTOBRIEF           = YES181 182# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a183# multi-line C++ special comment block (i.e. a block of //! or /// comments) as184# a brief description. This used to be the default behavior. The new default is185# to treat a multi-line C++ comment block as a detailed description. Set this186# tag to YES if you prefer the old behavior instead.187#188# Note that setting this tag to YES also means that rational rose comments are189# not recognized any more.190# The default value is: NO.191 192MULTILINE_CPP_IS_BRIEF = NO193 194# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the195# documentation from any documented member that it re-implements.196# The default value is: YES.197 198INHERIT_DOCS           = YES199 200# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a201# new page for each member. If set to NO, the documentation of a member will be202# part of the file/class/namespace that contains it.203# The default value is: NO.204 205SEPARATE_MEMBER_PAGES  = NO206 207# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen208# uses this value to replace tabs by spaces in code fragments.209# Minimum value: 1, maximum value: 16, default value: 4.210 211TAB_SIZE               = 2212 213# This tag can be used to specify a number of aliases that act as commands in214# the documentation. An alias has the form:215# name=value216# For example adding217# "sideeffect=@par Side Effects:\n"218# will allow you to put the command \sideeffect (or @sideeffect) in the219# documentation, which will result in a user-defined paragraph with heading220# "Side Effects:". You can put \n's in the value part of an alias to insert221# newlines.222 223ALIASES                =224 225# This tag can be used to specify a number of word-keyword mappings (TCL only).226# A mapping has the form "name=value". For example adding "class=itcl::class"227# will allow you to use the command class in the itcl::class meaning.228 229TCL_SUBST              =230 231# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources232# only. Doxygen will then generate output that is more tailored for C. For233# instance, some of the names that are used will be different. The list of all234# members will be omitted, etc.235# The default value is: NO.236 237OPTIMIZE_OUTPUT_FOR_C  = NO238 239# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or240# Python sources only. Doxygen will then generate output that is more tailored241# for that language. For instance, namespaces will be presented as packages,242# qualified scopes will look different, etc.243# The default value is: NO.244 245OPTIMIZE_OUTPUT_JAVA   = NO246 247# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran248# sources. Doxygen will then generate output that is tailored for Fortran.249# The default value is: NO.250 251OPTIMIZE_FOR_FORTRAN   = NO252 253# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL254# sources. Doxygen will then generate output that is tailored for VHDL.255# The default value is: NO.256 257OPTIMIZE_OUTPUT_VHDL   = NO258 259# Doxygen selects the parser to use depending on the extension of the files it260# parses. With this tag you can assign which parser to use for a given261# extension. Doxygen has a built-in mapping, but you can override or extend it262# using this tag. The format is ext=language, where ext is a file extension, and263# language is one of the parsers supported by doxygen: IDL, Java, Javascript,264# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make265# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C266# (default is Fortran), use: inc=Fortran f=C.267#268# Note For files without extension you can use no_extension as a placeholder.269#270# Note that for custom extensions you also need to set FILE_PATTERNS otherwise271# the files are not read by doxygen.272 273EXTENSION_MAPPING      =274 275# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments276# according to the Markdown format, which allows for more readable277# documentation. See http://daringfireball.net/projects/markdown/ for details.278# The output of markdown processing is further processed by doxygen, so you can279# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in280# case of backward compatibilities issues.281# The default value is: YES.282 283MARKDOWN_SUPPORT       = YES284 285# When enabled doxygen tries to link words that correspond to documented286# classes, or namespaces to their corresponding documentation. Such a link can287# be prevented in individual cases by by putting a % sign in front of the word288# or globally by setting AUTOLINK_SUPPORT to NO.289# The default value is: YES.290 291AUTOLINK_SUPPORT       = YES292 293# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want294# to include (a tag file for) the STL sources as input, then you should set this295# tag to YES in order to let doxygen match functions declarations and296# definitions whose arguments contain STL classes (e.g. func(std::string);297# versus func(std::string) {}). This also make the inheritance and collaboration298# diagrams that involve STL classes more complete and accurate.299# The default value is: NO.300 301BUILTIN_STL_SUPPORT    = NO302 303# If you use Microsoft's C++/CLI language, you should set this option to YES to304# enable parsing support.305# The default value is: NO.306 307CPP_CLI_SUPPORT        = NO308 309# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:310# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen311# will parse them like normal C++ but will assume all classes use public instead312# of private inheritance when no explicit protection keyword is present.313# The default value is: NO.314 315SIP_SUPPORT            = NO316 317# For Microsoft's IDL there are propget and propput attributes to indicate318# getter and setter methods for a property. Setting this option to YES will make319# doxygen to replace the get and set methods by a property in the documentation.320# This will only work if the methods are indeed getting or setting a simple321# type. If this is not the case, or you want to show the methods anyway, you322# should set this option to NO.323# The default value is: YES.324 325IDL_PROPERTY_SUPPORT   = YES326 327# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC328# tag is set to YES, then doxygen will reuse the documentation of the first329# member in the group (if any) for the other members of the group. By default330# all members of a group must be documented explicitly.331# The default value is: NO.332 333DISTRIBUTE_GROUP_DOC   = NO334 335# Set the SUBGROUPING tag to YES to allow class member groups of the same type336# (for instance a group of public functions) to be put as a subgroup of that337# type (e.g. under the Public Functions section). Set it to NO to prevent338# subgrouping. Alternatively, this can be done per class using the339# \nosubgrouping command.340# The default value is: YES.341 342SUBGROUPING            = YES343 344# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions345# are shown inside the group in which they are included (e.g. using \ingroup)346# instead of on a separate page (for HTML and Man pages) or section (for LaTeX347# and RTF).348#349# Note that this feature does not work in combination with350# SEPARATE_MEMBER_PAGES.351# The default value is: NO.352 353INLINE_GROUPED_CLASSES = NO354 355# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions356# with only public data fields or simple typedef fields will be shown inline in357# the documentation of the scope in which they are defined (i.e. file,358# namespace, or group documentation), provided this scope is documented. If set359# to NO, structs, classes, and unions are shown on a separate page (for HTML and360# Man pages) or section (for LaTeX and RTF).361# The default value is: NO.362 363INLINE_SIMPLE_STRUCTS  = NO364 365# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or366# enum is documented as struct, union, or enum with the name of the typedef. So367# typedef struct TypeS {} TypeT, will appear in the documentation as a struct368# with name TypeT. When disabled the typedef will appear as a member of a file,369# namespace, or class. And the struct will be named TypeS. This can typically be370# useful for C code in case the coding convention dictates that all compound371# types are typedef'ed and only the typedef is referenced, never the tag name.372# The default value is: NO.373 374TYPEDEF_HIDES_STRUCT   = NO375 376# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This377# cache is used to resolve symbols given their name and scope. Since this can be378# an expensive process and often the same symbol appears multiple times in the379# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small380# doxygen will become slower. If the cache is too large, memory is wasted. The381# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range382# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536383# symbols. At the end of a run doxygen will report the cache usage and suggest384# the optimal cache size from a speed point of view.385# Minimum value: 0, maximum value: 9, default value: 0.386 387LOOKUP_CACHE_SIZE      = 2388 389#---------------------------------------------------------------------------390# Build related configuration options391#---------------------------------------------------------------------------392 393# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in394# documentation are documented, even if no documentation was available. Private395# class members and static file members will be hidden unless the396# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.397# Note: This will also disable the warnings about undocumented members that are398# normally produced when WARNINGS is set to YES.399# The default value is: NO.400 401EXTRACT_ALL            = YES402 403# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will404# be included in the documentation.405# The default value is: NO.406 407EXTRACT_PRIVATE        = YES408 409# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal410# scope will be included in the documentation.411# The default value is: NO.412 413EXTRACT_PACKAGE        = NO414 415# If the EXTRACT_STATIC tag is set to YES all static members of a file will be416# included in the documentation.417# The default value is: NO.418 419EXTRACT_STATIC         = YES420 421# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined422# locally in source files will be included in the documentation. If set to NO423# only classes defined in header files are included. Does not have any effect424# for Java sources.425# The default value is: YES.426 427EXTRACT_LOCAL_CLASSES  = YES428 429# This flag is only useful for Objective-C code. When set to YES local methods,430# which are defined in the implementation section but not in the interface are431# included in the documentation. If set to NO only methods in the interface are432# included.433# The default value is: NO.434 435EXTRACT_LOCAL_METHODS  = NO436 437# If this flag is set to YES, the members of anonymous namespaces will be438# extracted and appear in the documentation as a namespace called439# 'anonymous_namespace{file}', where file will be replaced with the base name of440# the file that contains the anonymous namespace. By default anonymous namespace441# are hidden.442# The default value is: NO.443 444EXTRACT_ANON_NSPACES   = NO445 446# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all447# undocumented members inside documented classes or files. If set to NO these448# members will be included in the various overviews, but no documentation449# section is generated. This option has no effect if EXTRACT_ALL is enabled.450# The default value is: NO.451 452HIDE_UNDOC_MEMBERS     = NO453 454# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all455# undocumented classes that are normally visible in the class hierarchy. If set456# to NO these classes will be included in the various overviews. This option has457# no effect if EXTRACT_ALL is enabled.458# The default value is: NO.459 460HIDE_UNDOC_CLASSES     = NO461 462# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend463# (class|struct|union) declarations. If set to NO these declarations will be464# included in the documentation.465# The default value is: NO.466 467HIDE_FRIEND_COMPOUNDS  = NO468 469# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any470# documentation blocks found inside the body of a function. If set to NO these471# blocks will be appended to the function's detailed documentation block.472# The default value is: NO.473 474HIDE_IN_BODY_DOCS      = NO475 476# The INTERNAL_DOCS tag determines if documentation that is typed after a477# \internal command is included. If the tag is set to NO then the documentation478# will be excluded. Set it to YES to include the internal documentation.479# The default value is: NO.480 481INTERNAL_DOCS          = NO482 483# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file484# names in lower-case letters. If set to YES upper-case letters are also485# allowed. This is useful if you have classes or files whose names only differ486# in case and if your file system supports case sensitive file names. Windows487# and Mac users are advised to set this option to NO.488# The default value is: system dependent.489 490CASE_SENSE_NAMES       = YES491 492# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with493# their full class and namespace scopes in the documentation. If set to YES the494# scope will be hidden.495# The default value is: NO.496 497HIDE_SCOPE_NAMES       = NO498 499# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of500# the files that are included by a file in the documentation of that file.501# The default value is: YES.502 503SHOW_INCLUDE_FILES     = YES504 505# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each506# grouped member an include statement to the documentation, telling the reader507# which file to include in order to use the member.508# The default value is: NO.509 510SHOW_GROUPED_MEMB_INC  = NO511 512# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include513# files with double quotes in the documentation rather than with sharp brackets.514# The default value is: NO.515 516FORCE_LOCAL_INCLUDES   = NO517 518# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the519# documentation for inline members.520# The default value is: YES.521 522INLINE_INFO            = YES523 524# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the525# (detailed) documentation of file and class members alphabetically by member526# name. If set to NO the members will appear in declaration order.527# The default value is: YES.528 529SORT_MEMBER_DOCS       = YES530 531# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief532# descriptions of file, namespace and class members alphabetically by member533# name. If set to NO the members will appear in declaration order. Note that534# this will also influence the order of the classes in the class list.535# The default value is: NO.536 537SORT_BRIEF_DOCS        = NO538 539# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the540# (brief and detailed) documentation of class members so that constructors and541# destructors are listed first. If set to NO the constructors will appear in the542# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.543# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief544# member documentation.545# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting546# detailed member documentation.547# The default value is: NO.548 549SORT_MEMBERS_CTORS_1ST = NO550 551# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy552# of group names into alphabetical order. If set to NO the group names will553# appear in their defined order.554# The default value is: NO.555 556SORT_GROUP_NAMES       = NO557 558# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by559# fully-qualified names, including namespaces. If set to NO, the class list will560# be sorted only by class name, not including the namespace part.561# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.562# Note: This option applies only to the class list, not to the alphabetical563# list.564# The default value is: NO.565 566SORT_BY_SCOPE_NAME     = NO567 568# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper569# type resolution of all parameters of a function it will reject a match between570# the prototype and the implementation of a member function even if there is571# only one candidate or it is obvious which candidate to choose by doing a572# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still573# accept a match between prototype and implementation in such cases.574# The default value is: NO.575 576STRICT_PROTO_MATCHING  = NO577 578# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the579# todo list. This list is created by putting \todo commands in the580# documentation.581# The default value is: YES.582 583GENERATE_TODOLIST      = YES584 585# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the586# test list. This list is created by putting \test commands in the587# documentation.588# The default value is: YES.589 590GENERATE_TESTLIST      = YES591 592# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug593# list. This list is created by putting \bug commands in the documentation.594# The default value is: YES.595 596GENERATE_BUGLIST       = YES597 598# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)599# the deprecated list. This list is created by putting \deprecated commands in600# the documentation.601# The default value is: YES.602 603GENERATE_DEPRECATEDLIST= YES604 605# The ENABLED_SECTIONS tag can be used to enable conditional documentation606# sections, marked by \if <section_label> ... \endif and \cond <section_label>607# ... \endcond blocks.608 609ENABLED_SECTIONS       =610 611# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the612# initial value of a variable or macro / define can have for it to appear in the613# documentation. If the initializer consists of more lines than specified here614# it will be hidden. Use a value of 0 to hide initializers completely. The615# appearance of the value of individual variables and macros / defines can be616# controlled using \showinitializer or \hideinitializer command in the617# documentation regardless of this setting.618# Minimum value: 0, maximum value: 10000, default value: 30.619 620MAX_INITIALIZER_LINES  = 30621 622# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at623# the bottom of the documentation of classes and structs. If set to YES the list624# will mention the files that were used to generate the documentation.625# The default value is: YES.626 627SHOW_USED_FILES        = YES628 629# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This630# will remove the Files entry from the Quick Index and from the Folder Tree View631# (if specified).632# The default value is: YES.633 634SHOW_FILES             = YES635 636# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces637# page. This will remove the Namespaces entry from the Quick Index and from the638# Folder Tree View (if specified).639# The default value is: YES.640 641SHOW_NAMESPACES        = YES642 643# The FILE_VERSION_FILTER tag can be used to specify a program or script that644# doxygen should invoke to get the current version for each file (typically from645# the version control system). Doxygen will invoke the program by executing (via646# popen()) the command command input-file, where command is the value of the647# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided648# by doxygen. Whatever the program writes to standard output is used as the file649# version. For an example see the documentation.650 651FILE_VERSION_FILTER    =652 653# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed654# by doxygen. The layout file controls the global structure of the generated655# output files in an output format independent way. To create the layout file656# that represents doxygen's defaults, run doxygen with the -l option. You can657# optionally specify a file name after the option, if omitted DoxygenLayout.xml658# will be used as the name of the layout file.659#660# Note that if you run doxygen from a directory containing a file called661# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE662# tag is left empty.663 664LAYOUT_FILE            =665 666# The CITE_BIB_FILES tag can be used to specify one or more bib files containing667# the reference definitions. This must be a list of .bib files. The .bib668# extension is automatically appended if omitted. This requires the bibtex tool669# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.670# For LaTeX the style of the bibliography can be controlled using671# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the672# search path. Do not use file names with spaces, bibtex cannot handle them. See673# also \cite for info how to create references.674 675CITE_BIB_FILES         =676 677#---------------------------------------------------------------------------678# Configuration options related to warning and progress messages679#---------------------------------------------------------------------------680 681# The QUIET tag can be used to turn on/off the messages that are generated to682# standard output by doxygen. If QUIET is set to YES this implies that the683# messages are off.684# The default value is: NO.685 686QUIET                  = NO687 688# The WARNINGS tag can be used to turn on/off the warning messages that are689# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES690# this implies that the warnings are on.691#692# Tip: Turn warnings on while writing the documentation.693# The default value is: YES.694 695WARNINGS               = NO696 697# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate698# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag699# will automatically be disabled.700# The default value is: YES.701 702WARN_IF_UNDOCUMENTED   = NO703 704# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for705# potential errors in the documentation, such as not documenting some parameters706# in a documented function, or documenting parameters that don't exist or using707# markup commands wrongly.708# The default value is: YES.709 710WARN_IF_DOC_ERROR      = YES711 712# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that713# are documented, but have no documentation for their parameters or return714# value. If set to NO doxygen will only warn about wrong or incomplete parameter715# documentation, but not about the absence of documentation.716# The default value is: NO.717 718WARN_NO_PARAMDOC       = NO719 720# The WARN_FORMAT tag determines the format of the warning messages that doxygen721# can produce. The string should contain the $file, $line, and $text tags, which722# will be replaced by the file and line number from which the warning originated723# and the warning text. Optionally the format may contain $version, which will724# be replaced by the version of the file (if it could be obtained via725# FILE_VERSION_FILTER)726# The default value is: $file:$line: $text.727 728WARN_FORMAT            = "$file:$line: $text"729 730# The WARN_LOGFILE tag can be used to specify a file to which warning and error731# messages should be written. If left blank the output is written to standard732# error (stderr).733 734WARN_LOGFILE           =735 736#---------------------------------------------------------------------------737# Configuration options related to the input files738#---------------------------------------------------------------------------739 740# The INPUT tag is used to specify the files and/or directories that contain741# documented source files. You may enter file names like myfile.cpp or742# directories like /usr/src/myproject. Separate the files or directories with743# spaces.744# Note: If this tag is empty the current directory is searched.745 746INPUT                  = @abs_srcdir@/../include \747                         @abs_srcdir@/../lib \748                         @abs_srcdir@/doxygen.intro749 750# This tag can be used to specify the character encoding of the source files751# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses752# libiconv (or the iconv built into libc) for the transcoding. See the libiconv753# documentation (see: http://www.gnu.org/software/libiconv) for the list of754# possible encodings.755# The default value is: UTF-8.756 757INPUT_ENCODING         = UTF-8758 759# If the value of the INPUT tag contains directories, you can use the760# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and761# *.h) to filter out the source-files in the directories. If left blank the762# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,763# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,764# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,765# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,766# *.qsf, *.as and *.js.767 768FILE_PATTERNS          =769 770# The RECURSIVE tag can be used to specify whether or not subdirectories should771# be searched for input files as well.772# The default value is: NO.773 774RECURSIVE              = YES775 776# The EXCLUDE tag can be used to specify files and/or directories that should be777# excluded from the INPUT source files. This way you can easily exclude a778# subdirectory from a directory tree whose root is specified with the INPUT tag.779#780# Note that relative paths are relative to the directory from which doxygen is781# run.782 783EXCLUDE                =784 785# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or786# directories that are symbolic links (a Unix file system feature) are excluded787# from the input.788# The default value is: NO.789 790EXCLUDE_SYMLINKS       = NO791 792# If the value of the INPUT tag contains directories, you can use the793# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude794# certain files from those directories.795#796# Note that the wildcards are matched against the file with absolute path, so to797# exclude all test directories for example use the pattern */test/*798 799EXCLUDE_PATTERNS       = *.py800EXCLUDE_PATTERNS      += *.sh801 802# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names803# (namespaces, classes, functions, etc.) that should be excluded from the804# output. The symbol name can be a fully qualified name, a word, or if the805# wildcard * is used, a substring. Examples: ANamespace, AClass,806# AClass::ANamespace, ANamespace::*Test807#808# Note that the wildcards are matched against the file with absolute path, so to809# exclude all test directories use the pattern */test/*810 811EXCLUDE_SYMBOLS        =812 813# The EXAMPLE_PATH tag can be used to specify one or more files or directories814# that contain example code fragments that are included (see the \include815# command).816 817EXAMPLE_PATH           = @abs_srcdir@/../examples818 819# If the value of the EXAMPLE_PATH tag contains directories, you can use the820# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and821# *.h) to filter out the source-files in the directories. If left blank all822# files are included.823 824EXAMPLE_PATTERNS       =825 826# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be827# searched for input files to be used with the \include or \dontinclude commands828# irrespective of the value of the RECURSIVE tag.829# The default value is: NO.830 831EXAMPLE_RECURSIVE      = YES832 833# The IMAGE_PATH tag can be used to specify one or more files or directories834# that contain images that are to be included in the documentation (see the835# \image command).836 837IMAGE_PATH             = @abs_srcdir@/img838 839# The INPUT_FILTER tag can be used to specify a program that doxygen should840# invoke to filter for each input file. Doxygen will invoke the filter program841# by executing (via popen()) the command:842#843# <filter> <input-file>844#845# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the846# name of an input file. Doxygen will then use the output that the filter847# program writes to standard output. If FILTER_PATTERNS is specified, this tag848# will be ignored.849#850# Note that the filter must not add or remove lines; it is applied before the851# code is scanned, but not when the output code is generated. If lines are added852# or removed, the anchors will not be placed correctly.853 854INPUT_FILTER           =855 856# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern857# basis. Doxygen will compare the file name with each pattern and apply the858# filter if there is a match. The filters are a list of the form: pattern=filter859# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how860# filters are used. If the FILTER_PATTERNS tag is empty or if none of the861# patterns match the file name, INPUT_FILTER is applied.862 863FILTER_PATTERNS        =864 865# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using866# INPUT_FILTER ) will also be used to filter the input files that are used for867# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).868# The default value is: NO.869 870FILTER_SOURCE_FILES    = NO871 872# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file873# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and874# it is also possible to disable source filtering for a specific pattern using875# *.ext= (so without naming a filter).876# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.877 878FILTER_SOURCE_PATTERNS =879 880# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that881# is part of the input, its contents will be placed on the main page882# (index.html). This can be useful if you have a project on for instance GitHub883# and want to reuse the introduction page also for the doxygen output.884 885USE_MDFILE_AS_MAINPAGE =886 887#---------------------------------------------------------------------------888# Configuration options related to source browsing889#---------------------------------------------------------------------------890 891# If the SOURCE_BROWSER tag is set to YES then a list of source files will be892# generated. Documented entities will be cross-referenced with these sources.893#894# Note: To get rid of all source code in the generated output, make sure that895# also VERBATIM_HEADERS is set to NO.896# The default value is: NO.897 898SOURCE_BROWSER         = YES899 900# Setting the INLINE_SOURCES tag to YES will include the body of functions,901# classes and enums directly into the documentation.902# The default value is: NO.903 904INLINE_SOURCES         = NO905 906# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any907# special comment blocks from generated source code fragments. Normal C, C++ and908# Fortran comments will always remain visible.909# The default value is: YES.910 911STRIP_CODE_COMMENTS    = NO912 913# If the REFERENCED_BY_RELATION tag is set to YES then for each documented914# function all documented functions referencing it will be listed.915# The default value is: NO.916 917REFERENCED_BY_RELATION = YES918 919# If the REFERENCES_RELATION tag is set to YES then for each documented function920# all documented entities called/used by that function will be listed.921# The default value is: NO.922 923REFERENCES_RELATION    = YES924 925# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set926# to YES, then the hyperlinks from functions in REFERENCES_RELATION and927# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will928# link to the documentation.929# The default value is: YES.930 931REFERENCES_LINK_SOURCE = YES932 933# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the934# source code will show a tooltip with additional information such as prototype,935# brief description and links to the definition and documentation. Since this936# will make the HTML file larger and loading of large files a bit slower, you937# can opt to disable this feature.938# The default value is: YES.939# This tag requires that the tag SOURCE_BROWSER is set to YES.940 941SOURCE_TOOLTIPS        = YES942 943# If the USE_HTAGS tag is set to YES then the references to source code will944# point to the HTML generated by the htags(1) tool instead of doxygen built-in945# source browser. The htags tool is part of GNU's global source tagging system946# (see http://www.gnu.org/software/global/global.html). You will need version947# 4.8.6 or higher.948#949# To use it do the following:950# - Install the latest version of global951# - Enable SOURCE_BROWSER and USE_HTAGS in the config file952# - Make sure the INPUT points to the root of the source tree953# - Run doxygen as normal954#955# Doxygen will invoke htags (and that will in turn invoke gtags), so these956# tools must be available from the command line (i.e. in the search path).957#958# The result: instead of the source browser generated by doxygen, the links to959# source code will now point to the output of htags.960# The default value is: NO.961# This tag requires that the tag SOURCE_BROWSER is set to YES.962 963USE_HTAGS              = NO964 965# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a966# verbatim copy of the header file for each class for which an include is967# specified. Set to NO to disable this.968# See also: Section \class.969# The default value is: YES.970 971VERBATIM_HEADERS       = YES972 973#---------------------------------------------------------------------------974# Configuration options related to the alphabetical class index975#---------------------------------------------------------------------------976 977# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all978# compounds will be generated. Enable this if the project contains a lot of979# classes, structs, unions or interfaces.980# The default value is: YES.981 982ALPHABETICAL_INDEX     = YES983 984# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in985# which the alphabetical index list will be split.986# Minimum value: 1, maximum value: 20, default value: 5.987# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.988 989COLS_IN_ALPHA_INDEX    = 4990 991# In case all classes in a project start with a common prefix, all classes will992# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag993# can be used to specify a prefix (or a list of prefixes) that should be ignored994# while generating the index headers.995# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.996 997IGNORE_PREFIX          = polly::998 999#---------------------------------------------------------------------------1000# Configuration options related to the HTML output1001#---------------------------------------------------------------------------1002 1003# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1004# The default value is: YES.1005 1006GENERATE_HTML          = YES1007 1008# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1009# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1010# it.1011# The default directory is: html.1012# This tag requires that the tag GENERATE_HTML is set to YES.1013 1014HTML_OUTPUT            = html1015 1016# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1017# generated HTML page (for example: .htm, .php, .asp).1018# The default value is: .html.1019# This tag requires that the tag GENERATE_HTML is set to YES.1020 1021HTML_FILE_EXTENSION    = .html1022 1023# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1024# each generated HTML page. If the tag is left blank doxygen will generate a1025# standard header.1026#1027# To get valid HTML the header file that includes any scripts and style sheets1028# that doxygen needs, which is dependent on the configuration options used (e.g.1029# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1030# default header using1031# doxygen -w html new_header.html new_footer.html new_stylesheet.css1032# YourConfigFile1033# and then modify the file new_header.html. See also section "Doxygen usage"1034# for information on how to generate the default header that doxygen normally1035# uses.1036# Note: The header is subject to change so you typically have to regenerate the1037# default header when upgrading to a newer version of doxygen. For a description1038# of the possible markers and block names see the documentation.1039# This tag requires that the tag GENERATE_HTML is set to YES.1040 1041HTML_HEADER            =1042 1043# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1044# generated HTML page. If the tag is left blank doxygen will generate a standard1045# footer. See HTML_HEADER for more information on how to generate a default1046# footer and what special commands can be used inside the footer. See also1047# section "Doxygen usage" for information on how to generate the default footer1048# that doxygen normally uses.1049# This tag requires that the tag GENERATE_HTML is set to YES.1050 1051HTML_FOOTER            =1052 1053# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1054# sheet that is used by each HTML page. It can be used to fine-tune the look of1055# the HTML output. If left blank doxygen will generate a default style sheet.1056# See also section "Doxygen usage" for information on how to generate the style1057# sheet that doxygen normally uses.1058# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1059# it is more robust and this tag (HTML_STYLESHEET) will in the future become1060# obsolete.1061# This tag requires that the tag GENERATE_HTML is set to YES.1062 1063HTML_STYLESHEET        =1064 1065# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-1066# defined cascading style sheet that is included after the standard style sheets1067# created by doxygen. Using this option one can overrule certain style aspects.1068# This is preferred over using HTML_STYLESHEET since it does not replace the1069# standard style sheet and is therefore more robust against future updates.1070# Doxygen will copy the style sheet file to the output directory. For an example1071# see the documentation.1072# This tag requires that the tag GENERATE_HTML is set to YES.1073 1074HTML_EXTRA_STYLESHEET  =1075 1076# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1077# other source files which should be copied to the HTML output directory. Note1078# that these files will be copied to the base HTML output directory. Use the1079# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1080# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1081# files will be copied as-is; there are no commands or markers available.1082# This tag requires that the tag GENERATE_HTML is set to YES.1083 1084HTML_EXTRA_FILES       =1085 1086# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1087# will adjust the colors in the stylesheet and background images according to1088# this color. Hue is specified as an angle on a colorwheel, see1089# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1090# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001091# purple, and 360 is red again.1092# Minimum value: 0, maximum value: 359, default value: 220.1093# This tag requires that the tag GENERATE_HTML is set to YES.1094 1095HTML_COLORSTYLE_HUE    = 2201096 1097# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1098# in the HTML output. For a value of 0 the output will use grayscales only. A1099# value of 255 will produce the most vivid colors.1100# Minimum value: 0, maximum value: 255, default value: 100.1101# This tag requires that the tag GENERATE_HTML is set to YES.1102 1103HTML_COLORSTYLE_SAT    = 1001104 1105# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1106# luminance component of the colors in the HTML output. Values below 1001107# gradually make the output lighter, whereas values above 100 make the output1108# darker. The value divided by 100 is the actual gamma applied, so 80 represents1109# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1110# change the gamma.1111# Minimum value: 40, maximum value: 240, default value: 80.1112# This tag requires that the tag GENERATE_HTML is set to YES.1113 1114HTML_COLORSTYLE_GAMMA  = 801115 1116# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1117# page will contain the date and time when the page was generated. Setting this1118# to NO can help when comparing the output of multiple runs.1119# The default value is: YES.1120# This tag requires that the tag GENERATE_HTML is set to YES.1121 1122HTML_TIMESTAMP         = YES1123 1124# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1125# documentation will contain sections that can be hidden and shown after the1126# page has loaded.1127# The default value is: NO.1128# This tag requires that the tag GENERATE_HTML is set to YES.1129 1130HTML_DYNAMIC_SECTIONS  = NO1131 1132# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1133# shown in the various tree structured indices initially; the user can expand1134# and collapse entries dynamically later on. Doxygen will expand the tree to1135# such a level that at most the specified number of entries are visible (unless1136# a fully collapsed tree already exceeds this amount). So setting the number of1137# entries 1 will produce a full collapsed tree by default. 0 is a special value1138# representing an infinite number of entries and will result in a full expanded1139# tree by default.1140# Minimum value: 0, maximum value: 9999, default value: 100.1141# This tag requires that the tag GENERATE_HTML is set to YES.1142 1143HTML_INDEX_NUM_ENTRIES = 1001144 1145# If the GENERATE_DOCSET tag is set to YES, additional index files will be1146# generated that can be used as input for Apple's Xcode 3 integrated development1147# environment (see: http://developer.apple.com/tools/xcode/), introduced with1148# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1149# Makefile in the HTML output directory. Running make will produce the docset in1150# that directory and running make install will install the docset in1151# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1152# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1153# for more information.1154# The default value is: NO.1155# This tag requires that the tag GENERATE_HTML is set to YES.1156 1157GENERATE_DOCSET        = NO1158 1159# This tag determines the name of the docset feed. A documentation feed provides1160# an umbrella under which multiple documentation sets from a single provider1161# (such as a company or product suite) can be grouped.1162# The default value is: Doxygen generated docs.1163# This tag requires that the tag GENERATE_DOCSET is set to YES.1164 1165DOCSET_FEEDNAME        = "Doxygen generated docs"1166 1167# This tag specifies a string that should uniquely identify the documentation1168# set bundle. This should be a reverse domain-name style string, e.g.1169# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1170# The default value is: org.doxygen.Project.1171# This tag requires that the tag GENERATE_DOCSET is set to YES.1172 1173DOCSET_BUNDLE_ID       = org.doxygen.Project1174 1175# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1176# the documentation publisher. This should be a reverse domain-name style1177# string, e.g. com.mycompany.MyDocSet.documentation.1178# The default value is: org.doxygen.Publisher.1179# This tag requires that the tag GENERATE_DOCSET is set to YES.1180 1181DOCSET_PUBLISHER_ID    = org.doxygen.Publisher1182 1183# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1184# The default value is: Publisher.1185# This tag requires that the tag GENERATE_DOCSET is set to YES.1186 1187DOCSET_PUBLISHER_NAME  = Publisher1188 1189# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1190# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1191# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1192# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1193# Windows.1194#1195# The HTML Help Workshop contains a compiler that can convert all HTML output1196# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1197# files are now used as the Windows 98 help format, and will replace the old1198# Windows help format (.hlp) on all Windows platforms in the future. Compressed1199# HTML files also contain an index, a table of contents, and you can search for1200# words in the documentation. The HTML workshop also contains a viewer for1201# compressed HTML files.1202# The default value is: NO.1203# This tag requires that the tag GENERATE_HTML is set to YES.1204 1205GENERATE_HTMLHELP      = NO1206 1207# The CHM_FILE tag can be used to specify the file name of the resulting .chm1208# file. You can add a path in front of the file if the result should not be1209# written to the html output directory.1210# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1211 1212CHM_FILE               =1213 1214# The HHC_LOCATION tag can be used to specify the location (absolute path1215# including file name) of the HTML help compiler ( hhc.exe). If non-empty1216# doxygen will try to run the HTML help compiler on the generated index.hhp.1217# The file has to be specified with full path.1218# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1219 1220HHC_LOCATION           =1221 1222# The GENERATE_CHI flag controls if a separate .chi index file is generated (1223# YES) or that it should be included in the main .chm file ( NO).1224# The default value is: NO.1225# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1226 1227GENERATE_CHI           = NO1228 1229# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)1230# and project file content.1231# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1232 1233CHM_INDEX_ENCODING     =1234 1235# The BINARY_TOC flag controls whether a binary table of contents is generated (1236# YES) or a normal table of contents ( NO) in the .chm file.1237# The default value is: NO.1238# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1239 1240BINARY_TOC             = NO1241 1242# The TOC_EXPAND flag can be set to YES to add extra items for group members to1243# the table of contents of the HTML help documentation and to the tree view.1244# The default value is: NO.1245# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1246 1247TOC_EXPAND             = NO1248 1249# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1250# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1251# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1252# (.qch) of the generated HTML documentation.1253# The default value is: NO.1254# This tag requires that the tag GENERATE_HTML is set to YES.1255 1256GENERATE_QHP           = @polly_doxygen_generate_qhp@1257 1258# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1259# the file name of the resulting .qch file. The path specified is relative to1260# the HTML output folder.1261# This tag requires that the tag GENERATE_QHP is set to YES.1262 1263QCH_FILE               = @polly_doxygen_qch_filename@1264 1265# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1266# Project output. For more information please see Qt Help Project / Namespace1267# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1268# The default value is: org.doxygen.Project.1269# This tag requires that the tag GENERATE_QHP is set to YES.1270 1271QHP_NAMESPACE          = @polly_doxygen_qhp_namespace@1272 1273# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1274# Help Project output. For more information please see Qt Help Project / Virtual1275# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1276# folders).1277# The default value is: doc.1278# This tag requires that the tag GENERATE_QHP is set to YES.1279 1280QHP_VIRTUAL_FOLDER     = doc1281 1282# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1283# filter to add. For more information please see Qt Help Project / Custom1284# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1285# filters).1286# This tag requires that the tag GENERATE_QHP is set to YES.1287 1288QHP_CUST_FILTER_NAME   = @polly_doxygen_qhp_cust_filter_name@1289 1290# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1291# custom filter to add. For more information please see Qt Help Project / Custom1292# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1293# filters).1294# This tag requires that the tag GENERATE_QHP is set to YES.1295 1296QHP_CUST_FILTER_ATTRS  = @polly_doxygen_qhp_cust_filter_attrs@1297 1298# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1299# project's filter section matches. Qt Help Project / Filter Attributes (see:1300# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1301# This tag requires that the tag GENERATE_QHP is set to YES.1302 1303QHP_SECT_FILTER_ATTRS  =1304 1305# The QHG_LOCATION tag can be used to specify the location of Qt's1306# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1307# generated .qhp file.1308# This tag requires that the tag GENERATE_QHP is set to YES.1309 1310QHG_LOCATION           = @polly_doxygen_qhelpgenerator_path@1311 1312# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1313# generated, together with the HTML files, they form an Eclipse help plugin. To1314# install this plugin and make it available under the help contents menu in1315# Eclipse, the contents of the directory containing the HTML and XML files needs1316# to be copied into the plugins directory of eclipse. The name of the directory1317# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1318# After copying Eclipse needs to be restarted before the help appears.1319# The default value is: NO.1320# This tag requires that the tag GENERATE_HTML is set to YES.1321 1322GENERATE_ECLIPSEHELP   = NO1323 1324# A unique identifier for the Eclipse help plugin. When installing the plugin1325# the directory name containing the HTML and XML files should also have this1326# name. Each documentation set should have its own identifier.1327# The default value is: org.doxygen.Project.1328# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1329 1330ECLIPSE_DOC_ID         = org.doxygen.Project1331 1332# If you want full control over the layout of the generated HTML pages it might1333# be necessary to disable the index and replace it with your own. The1334# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1335# of each HTML page. A value of NO enables the index and the value YES disables1336# it. Since the tabs in the index contain the same information as the navigation1337# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1338# The default value is: NO.1339# This tag requires that the tag GENERATE_HTML is set to YES.1340 1341DISABLE_INDEX          = NO1342 1343# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1344# structure should be generated to display hierarchical information. If the tag1345# value is set to YES, a side panel will be generated containing a tree-like1346# index structure (just like the one that is generated for HTML Help). For this1347# to work a browser that supports JavaScript, DHTML, CSS and frames is required1348# (i.e. any modern browser). Windows users are probably better off using the1349# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can1350# further fine-tune the look of the index. As an example, the default style1351# sheet generated by doxygen has an example that shows how to put an image at1352# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1353# the same information as the tab index, you could consider setting1354# DISABLE_INDEX to YES when enabling this option.1355# The default value is: NO.1356# This tag requires that the tag GENERATE_HTML is set to YES.1357 1358GENERATE_TREEVIEW      = NO1359 1360# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1361# doxygen will group on one line in the generated HTML documentation.1362#1363# Note that a value of 0 will completely suppress the enum values from appearing1364# in the overview section.1365# Minimum value: 0, maximum value: 20, default value: 4.1366# This tag requires that the tag GENERATE_HTML is set to YES.1367 1368ENUM_VALUES_PER_LINE   = 41369 1370# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1371# to set the initial width (in pixels) of the frame in which the tree is shown.1372# Minimum value: 0, maximum value: 1500, default value: 250.1373# This tag requires that the tag GENERATE_HTML is set to YES.1374 1375TREEVIEW_WIDTH         = 2501376 1377# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to1378# external symbols imported via tag files in a separate window.1379# The default value is: NO.1380# This tag requires that the tag GENERATE_HTML is set to YES.1381 1382EXT_LINKS_IN_WINDOW    = NO1383 1384# Use this tag to change the font size of LaTeX formulas included as images in1385# the HTML documentation. When you change the font size after a successful1386# doxygen run you need to manually remove any form_*.png images from the HTML1387# output directory to force them to be regenerated.1388# Minimum value: 8, maximum value: 50, default value: 10.1389# This tag requires that the tag GENERATE_HTML is set to YES.1390 1391FORMULA_FONTSIZE       = 101392 1393# Use the FORMULA_TRANPARENT tag to determine whether or not the images1394# generated for formulas are transparent PNGs. Transparent PNGs are not1395# supported properly for IE 6.0, but are supported on all modern browsers.1396#1397# Note that when changing this option you need to delete any form_*.png files in1398# the HTML output directory before the changes have effect.1399# The default value is: YES.1400# This tag requires that the tag GENERATE_HTML is set to YES.1401 1402FORMULA_TRANSPARENT    = YES1403 1404# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1405# http://www.mathjax.org) which uses client side Javascript for the rendering1406# instead of using prerendered bitmaps. Use this if you do not have LaTeX1407# installed or if you want to formulas look prettier in the HTML output. When1408# enabled you may also need to install MathJax separately and configure the path1409# to it using the MATHJAX_RELPATH option.1410# The default value is: NO.1411# This tag requires that the tag GENERATE_HTML is set to YES.1412 1413USE_MATHJAX            = NO1414 1415# When MathJax is enabled you can set the default output format to be used for1416# the MathJax output. See the MathJax site (see:1417# http://docs.mathjax.org/en/latest/output.html) for more details.1418# Possible values are: HTML-CSS (which is slower, but has the best1419# compatibility), NativeMML (i.e. MathML) and SVG.1420# The default value is: HTML-CSS.1421# This tag requires that the tag USE_MATHJAX is set to YES.1422 1423MATHJAX_FORMAT         = HTML-CSS1424 1425# When MathJax is enabled you need to specify the location relative to the HTML1426# output directory using the MATHJAX_RELPATH option. The destination directory1427# should contain the MathJax.js script. For instance, if the mathjax directory1428# is located at the same level as the HTML output directory, then1429# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1430# Content Delivery Network so you can quickly see the result without installing1431# MathJax. However, it is strongly recommended to install a local copy of1432# MathJax from http://www.mathjax.org before deployment.1433# The default value is: http://cdn.mathjax.org/mathjax/latest.1434# This tag requires that the tag USE_MATHJAX is set to YES.1435 1436MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest1437 1438# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1439# extension names that should be enabled during MathJax rendering. For example1440# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1441# This tag requires that the tag USE_MATHJAX is set to YES.1442 1443MATHJAX_EXTENSIONS     =1444 1445# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1446# of code that will be used on startup of the MathJax code. See the MathJax site1447# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1448# example see the documentation.1449# This tag requires that the tag USE_MATHJAX is set to YES.1450 1451MATHJAX_CODEFILE       =1452 1453# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1454# the HTML output. The underlying search engine uses javascript and DHTML and1455# should work on any modern browser. Note that when using HTML help1456# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1457# there is already a search function so this one should typically be disabled.1458# For large projects the javascript based search engine can be slow, then1459# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1460# search using the keyboard; to jump to the search box use <access key> + S1461# (what the <access key> is depends on the OS and browser, but it is typically1462# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1463# key> to jump into the search results window, the results can be navigated1464# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1465# the search. The filter options can be selected when the cursor is inside the1466# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1467# to select a filter and <Enter> or <escape> to activate or cancel the filter1468# option.1469# The default value is: YES.1470# This tag requires that the tag GENERATE_HTML is set to YES.1471 1472SEARCHENGINE           = @enable_searchengine@1473 1474# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1475# implemented using a web server instead of a web client using Javascript. There1476# are two flavours of web server based searching depending on the1477# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1478# searching and an index file used by the script. When EXTERNAL_SEARCH is1479# enabled the indexing and searching needs to be provided by external tools. See1480# the section "External Indexing and Searching" for details.1481# The default value is: NO.1482# This tag requires that the tag SEARCHENGINE is set to YES.1483 1484SERVER_BASED_SEARCH    = @enable_server_based_search@1485 1486# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1487# script for searching. Instead the search results are written to an XML file1488# which needs to be processed by an external indexer. Doxygen will invoke an1489# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1490# search results.1491#1492# Doxygen ships with an example indexer ( doxyindexer) and search engine1493# (doxysearch.cgi) which are based on the open source search engine library1494# Xapian (see: http://xapian.org/).1495#1496# See the section "External Indexing and Searching" for details.1497# The default value is: NO.1498# This tag requires that the tag SEARCHENGINE is set to YES.1499 1500EXTERNAL_SEARCH        = @enable_external_search@1501 1502# The SEARCHENGINE_URL should point to a search engine hosted by a web server1503# which will return the search results when EXTERNAL_SEARCH is enabled.1504#1505# Doxygen ships with an example indexer ( doxyindexer) and search engine1506# (doxysearch.cgi) which are based on the open source search engine library1507# Xapian (see: http://xapian.org/). See the section "External Indexing and1508# Searching" for details.1509# This tag requires that the tag SEARCHENGINE is set to YES.1510 1511SEARCHENGINE_URL       = @searchengine_url@1512 1513# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1514# search data is written to a file for indexing by an external tool. With the1515# SEARCHDATA_FILE tag the name of this file can be specified.1516# The default file is: searchdata.xml.1517# This tag requires that the tag SEARCHENGINE is set to YES.1518 1519SEARCHDATA_FILE        = searchdata.xml1520 1521# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1522# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1523# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1524# projects and redirect the results back to the right project.1525# This tag requires that the tag SEARCHENGINE is set to YES.1526 1527EXTERNAL_SEARCH_ID     = polly1528 1529# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1530# projects other than the one defined by this configuration file, but that are1531# all added to the same external search index. Each project needs to have a1532# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1533# to a relative location where the documentation can be found. The format is:1534# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1535# This tag requires that the tag SEARCHENGINE is set to YES.1536 1537EXTRA_SEARCH_MAPPINGS  = @extra_search_mappings@1538 1539#---------------------------------------------------------------------------1540# Configuration options related to the LaTeX output1541#---------------------------------------------------------------------------1542 1543# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1544# The default value is: YES.1545 1546GENERATE_LATEX         = NO1547 1548# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1549# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1550# it.1551# The default directory is: latex.1552# This tag requires that the tag GENERATE_LATEX is set to YES.1553 1554LATEX_OUTPUT           = latex1555 1556# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1557# invoked.1558#1559# Note that when enabling USE_PDFLATEX this option is only used for generating1560# bitmaps for formulas in the HTML output, but not in the Makefile that is1561# written to the output directory.1562# The default file is: latex.1563# This tag requires that the tag GENERATE_LATEX is set to YES.1564 1565LATEX_CMD_NAME         = latex1566 1567# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1568# index for LaTeX.1569# The default file is: makeindex.1570# This tag requires that the tag GENERATE_LATEX is set to YES.1571 1572MAKEINDEX_CMD_NAME     = makeindex1573 1574# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX1575# documents. This may be useful for small projects and may help to save some1576# trees in general.1577# The default value is: NO.1578# This tag requires that the tag GENERATE_LATEX is set to YES.1579 1580COMPACT_LATEX          = NO1581 1582# The PAPER_TYPE tag can be used to set the paper type that is used by the1583# printer.1584# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1585# 14 inches) and executive (7.25 x 10.5 inches).1586# The default value is: a4.1587# This tag requires that the tag GENERATE_LATEX is set to YES.1588 1589PAPER_TYPE             = a41590 1591# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1592# that should be included in the LaTeX output. To get the times font for1593# instance you can specify1594# EXTRA_PACKAGES=times1595# If left blank no extra packages will be included.1596# This tag requires that the tag GENERATE_LATEX is set to YES.1597 1598EXTRA_PACKAGES         =1599 1600# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1601# generated LaTeX document. The header should contain everything until the first1602# chapter. If it is left blank doxygen will generate a standard header. See1603# section "Doxygen usage" for information on how to let doxygen write the1604# default header to a separate file.1605#1606# Note: Only use a user-defined header if you know what you are doing! The1607# following commands have a special meaning inside the header: $title,1608# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will1609# replace them by respectively the title of the page, the current date and time,1610# only the current date, the version number of doxygen, the project name (see1611# PROJECT_NAME), or the project number (see PROJECT_NUMBER).1612# This tag requires that the tag GENERATE_LATEX is set to YES.1613 1614LATEX_HEADER           =1615 1616# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1617# generated LaTeX document. The footer should contain everything after the last1618# chapter. If it is left blank doxygen will generate a standard footer.1619#1620# Note: Only use a user-defined footer if you know what you are doing!1621# This tag requires that the tag GENERATE_LATEX is set to YES.1622 1623LATEX_FOOTER           =1624 1625# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1626# other source files which should be copied to the LATEX_OUTPUT output1627# directory. Note that the files will be copied as-is; there are no commands or1628# markers available.1629# This tag requires that the tag GENERATE_LATEX is set to YES.1630 1631LATEX_EXTRA_FILES      =1632 1633# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1634# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1635# contain links (just like the HTML output) instead of page references. This1636# makes the output suitable for online browsing using a PDF viewer.1637# The default value is: YES.1638# This tag requires that the tag GENERATE_LATEX is set to YES.1639 1640PDF_HYPERLINKS         = YES1641 1642# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1643# the PDF file directly from the LaTeX files. Set this option to YES to get a1644# higher quality PDF documentation.1645# The default value is: YES.1646# This tag requires that the tag GENERATE_LATEX is set to YES.1647 1648USE_PDFLATEX           = YES1649 1650# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1651# command to the generated LaTeX files. This will instruct LaTeX to keep running1652# if errors occur, instead of asking the user for help. This option is also used1653# when generating formulas in HTML.1654# The default value is: NO.1655# This tag requires that the tag GENERATE_LATEX is set to YES.1656 1657LATEX_BATCHMODE        = NO1658 1659# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1660# index chapters (such as File Index, Compound Index, etc.) in the output.1661# The default value is: NO.1662# This tag requires that the tag GENERATE_LATEX is set to YES.1663 1664LATEX_HIDE_INDICES     = NO1665 1666# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1667# code with syntax highlighting in the LaTeX output.1668#1669# Note that which sources are shown also depends on other settings such as1670# SOURCE_BROWSER.1671# The default value is: NO.1672# This tag requires that the tag GENERATE_LATEX is set to YES.1673 1674LATEX_SOURCE_CODE      = NO1675 1676# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1677# bibliography, e.g. plainnat, or ieeetr. See1678# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1679# The default value is: plain.1680# This tag requires that the tag GENERATE_LATEX is set to YES.1681 1682LATEX_BIB_STYLE        = plain1683 1684#---------------------------------------------------------------------------1685# Configuration options related to the RTF output1686#---------------------------------------------------------------------------1687 1688# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1689# RTF output is optimized for Word 97 and may not look too pretty with other RTF1690# readers/editors.1691# The default value is: NO.1692 1693GENERATE_RTF           = NO1694 1695# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1696# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1697# it.1698# The default directory is: rtf.1699# This tag requires that the tag GENERATE_RTF is set to YES.1700 1701RTF_OUTPUT             = rtf1702 1703# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1704# documents. This may be useful for small projects and may help to save some1705# trees in general.1706# The default value is: NO.1707# This tag requires that the tag GENERATE_RTF is set to YES.1708 1709COMPACT_RTF            = NO1710 1711# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1712# contain hyperlink fields. The RTF file will contain links (just like the HTML1713# output) instead of page references. This makes the output suitable for online1714# browsing using Word or some other Word compatible readers that support those1715# fields.1716#1717# Note: WordPad (write) and others do not support links.1718# The default value is: NO.1719# This tag requires that the tag GENERATE_RTF is set to YES.1720 1721RTF_HYPERLINKS         = NO1722 1723# Load stylesheet definitions from file. Syntax is similar to doxygen's config1724# file, i.e. a series of assignments. You only have to provide replacements,1725# missing definitions are set to their default value.1726#1727# See also section "Doxygen usage" for information on how to generate the1728# default style sheet that doxygen normally uses.1729# This tag requires that the tag GENERATE_RTF is set to YES.1730 1731RTF_STYLESHEET_FILE    =1732 1733# Set optional variables used in the generation of an RTF document. Syntax is1734# similar to doxygen's config file. A template extensions file can be generated1735# using doxygen -e rtf extensionFile.1736# This tag requires that the tag GENERATE_RTF is set to YES.1737 1738RTF_EXTENSIONS_FILE    =1739 1740#---------------------------------------------------------------------------1741# Configuration options related to the man page output1742#---------------------------------------------------------------------------1743 1744# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1745# classes and files.1746# The default value is: NO.1747 1748GENERATE_MAN           = NO1749 1750# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1751# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1752# it. A directory man3 will be created inside the directory specified by1753# MAN_OUTPUT.1754# The default directory is: man.1755# This tag requires that the tag GENERATE_MAN is set to YES.1756 1757MAN_OUTPUT             = man1758 1759# The MAN_EXTENSION tag determines the extension that is added to the generated1760# man pages. In case the manual section does not start with a number, the number1761# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1762# optional.1763# The default value is: .3.1764# This tag requires that the tag GENERATE_MAN is set to YES.1765 1766MAN_EXTENSION          = .31767 1768# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1769# will generate one additional man file for each entity documented in the real1770# man page(s). These additional files only source the real man page, but without1771# them the man command would be unable to find the correct page.1772# The default value is: NO.1773# This tag requires that the tag GENERATE_MAN is set to YES.1774 1775MAN_LINKS              = NO1776 1777#---------------------------------------------------------------------------1778# Configuration options related to the XML output1779#---------------------------------------------------------------------------1780 1781# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1782# captures the structure of the code including all documentation.1783# The default value is: NO.1784 1785GENERATE_XML           = NO1786 1787# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1788# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1789# it.1790# The default directory is: xml.1791# This tag requires that the tag GENERATE_XML is set to YES.1792 1793XML_OUTPUT             = xml1794 1795# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a1796# validating XML parser to check the syntax of the XML files.1797# This tag requires that the tag GENERATE_XML is set to YES.1798 1799XML_SCHEMA             =1800 1801# The XML_DTD tag can be used to specify a XML DTD, which can be used by a1802# validating XML parser to check the syntax of the XML files.1803# This tag requires that the tag GENERATE_XML is set to YES.1804 1805XML_DTD                =1806 1807# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1808# listings (including syntax highlighting and cross-referencing information) to1809# the XML output. Note that enabling this will significantly increase the size1810# of the XML output.1811# The default value is: YES.1812# This tag requires that the tag GENERATE_XML is set to YES.1813 1814XML_PROGRAMLISTING     = YES1815 1816#---------------------------------------------------------------------------1817# Configuration options related to the DOCBOOK output1818#---------------------------------------------------------------------------1819 1820# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1821# that can be used to generate PDF.1822# The default value is: NO.1823 1824GENERATE_DOCBOOK       = NO1825 1826# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1827# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1828# front of it.1829# The default directory is: docbook.1830# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1831 1832DOCBOOK_OUTPUT         = docbook1833 1834#---------------------------------------------------------------------------1835# Configuration options for the AutoGen Definitions output1836#---------------------------------------------------------------------------1837 1838# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1839# Definitions (see http://autogen.sf.net) file that captures the structure of1840# the code including all documentation. Note that this feature is still1841# experimental and incomplete at the moment.1842# The default value is: NO.1843 1844GENERATE_AUTOGEN_DEF   = NO1845 1846#---------------------------------------------------------------------------1847# Configuration options related to the Perl module output1848#---------------------------------------------------------------------------1849 1850# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module1851# file that captures the structure of the code including all documentation.1852#1853# Note that this feature is still experimental and incomplete at the moment.1854# The default value is: NO.1855 1856GENERATE_PERLMOD       = NO1857 1858# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary1859# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI1860# output from the Perl module output.1861# The default value is: NO.1862# This tag requires that the tag GENERATE_PERLMOD is set to YES.1863 1864PERLMOD_LATEX          = NO1865 1866# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely1867# formatted so it can be parsed by a human reader. This is useful if you want to1868# understand what is going on. On the other hand, if this tag is set to NO the1869# size of the Perl module output will be much smaller and Perl will parse it1870# just the same.1871# The default value is: YES.1872# This tag requires that the tag GENERATE_PERLMOD is set to YES.1873 1874PERLMOD_PRETTY         = YES1875 1876# The names of the make variables in the generated doxyrules.make file are1877# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful1878# so different doxyrules.make files included by the same Makefile don't1879# overwrite each other's variables.1880# This tag requires that the tag GENERATE_PERLMOD is set to YES.1881 1882PERLMOD_MAKEVAR_PREFIX =1883 1884#---------------------------------------------------------------------------1885# Configuration options related to the preprocessor1886#---------------------------------------------------------------------------1887 1888# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all1889# C-preprocessor directives found in the sources and include files.1890# The default value is: YES.1891 1892ENABLE_PREPROCESSING   = YES1893 1894# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1895# in the source code. If set to NO only conditional compilation will be1896# performed. Macro expansion can be done in a controlled way by setting1897# EXPAND_ONLY_PREDEF to YES.1898# The default value is: NO.1899# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1900 1901MACRO_EXPANSION        = NO1902 1903# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then1904# the macro expansion is limited to the macros specified with the PREDEFINED and1905# EXPAND_AS_DEFINED tags.1906# The default value is: NO.1907# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1908 1909EXPAND_ONLY_PREDEF     = NO1910 1911# If the SEARCH_INCLUDES tag is set to YES the includes files in the1912# INCLUDE_PATH will be searched if a #include is found.1913# The default value is: YES.1914# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1915 1916SEARCH_INCLUDES        = YES1917 1918# The INCLUDE_PATH tag can be used to specify one or more directories that1919# contain include files that are not input files but should be processed by the1920# preprocessor.1921# This tag requires that the tag SEARCH_INCLUDES is set to YES.1922 1923INCLUDE_PATH           = ../include1924 1925# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1926# patterns (like *.h and *.hpp) to filter out the header-files in the1927# directories. If left blank, the patterns specified with FILE_PATTERNS will be1928# used.1929# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1930 1931INCLUDE_FILE_PATTERNS  =1932 1933# The PREDEFINED tag can be used to specify one or more macro names that are1934# defined before the preprocessor is started (similar to the -D option of e.g.1935# gcc). The argument of the tag is a list of macros of the form: name or1936# name=definition (no spaces). If the definition and the "=" are omitted, "=1"1937# is assumed. To prevent a macro definition from being undefined via #undef or1938# recursively expanded use the := operator instead of the = operator.1939# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1940 1941PREDEFINED             =1942 1943# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this1944# tag can be used to specify a list of macro names that should be expanded. The1945# macro definition that is found in the sources will be used. Use the PREDEFINED1946# tag if you want to use a different macro definition that overrules the1947# definition found in the source code.1948# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1949 1950EXPAND_AS_DEFINED      =1951 1952# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will1953# remove all references to function-like macros that are alone on a line, have an1954# all uppercase name, and do not end with a semicolon. Such function macros are1955# typically used for boiler-plate code, and will confuse the parser if not1956# removed.1957# The default value is: YES.1958# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1959 1960SKIP_FUNCTION_MACROS   = YES1961 1962#---------------------------------------------------------------------------1963# Configuration options related to external references1964#---------------------------------------------------------------------------1965 1966# The TAGFILES tag can be used to specify one or more tag files. For each tag1967# file the location of the external documentation should be added. The format of1968# a tag file without this location is as follows:1969# TAGFILES = file1 file2 ...1970# Adding location for the tag files is done as follows:1971# TAGFILES = file1=loc1 "file2 = loc2" ...1972# where loc1 and loc2 can be relative or absolute paths or URLs. See the1973# section "Linking to external documentation" for more information about the use1974# of tag files.1975# Note: Each tag file must have an unique name (where the name does NOT include1976# the path). If a tag file is not located in the directory in which doxygen is1977# run, you must also specify the path to the tagfile here.1978 1979TAGFILES               =1980 1981# When a file name is specified after GENERATE_TAGFILE, doxygen will create a1982# tag file that is based on the input files it reads. See section "Linking to1983# external documentation" for more information about the usage of tag files.1984 1985GENERATE_TAGFILE       =1986 1987# If the ALLEXTERNALS tag is set to YES all external class will be listed in the1988# class index. If set to NO only the inherited external classes will be listed.1989# The default value is: NO.1990 1991ALLEXTERNALS           = YES1992 1993# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in1994# the modules index. If set to NO, only the current project's groups will be1995# listed.1996# The default value is: YES.1997 1998EXTERNAL_GROUPS        = YES1999 2000# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in2001# the related pages index. If set to NO, only the current project's pages will2002# be listed.2003# The default value is: YES.2004 2005EXTERNAL_PAGES         = YES2006 2007# The PERL_PATH should be the absolute path and name of the perl script2008# interpreter (i.e. the result of 'which perl').2009# The default file (with absolute path) is: /usr/bin/perl.2010 2011PERL_PATH              = /usr/bin/perl2012 2013#---------------------------------------------------------------------------2014# Configuration options related to the dot tool2015#---------------------------------------------------------------------------2016 2017# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2018# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2019# NO turns the diagrams off. Note that this option also works with HAVE_DOT2020# disabled, but it is recommended to install and use dot, since it yields more2021# powerful graphs.2022# The default value is: YES.2023 2024CLASS_DIAGRAMS         = YES2025 2026# You can define message sequence charts within doxygen comments using the \msc2027# command. Doxygen will then run the mscgen tool (see:2028# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2029# documentation. The MSCGEN_PATH tag allows you to specify the directory where2030# the mscgen tool resides. If left empty the tool is assumed to be found in the2031# default search path.2032 2033MSCGEN_PATH            =2034 2035# You can include diagrams made with dia in doxygen documentation. Doxygen will2036# then run dia to produce the diagram and insert it in the documentation. The2037# DIA_PATH tag allows you to specify the directory where the dia binary resides.2038# If left empty dia is assumed to be found in the default search path.2039 2040DIA_PATH               =2041 2042# If set to YES, the inheritance and collaboration graphs will hide inheritance2043# and usage relations if the target is undocumented or is not a class.2044# The default value is: YES.2045 2046HIDE_UNDOC_RELATIONS   = NO2047 2048# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2049# available from the path. This tool is part of Graphviz (see:2050# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2051# Bell Labs. The other options in this section have no effect if this option is2052# set to NO2053# The default value is: NO.2054 2055HAVE_DOT               = YES2056 2057# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2058# to run in parallel. When set to 0 doxygen will base this on the number of2059# processors available in the system. You can set it explicitly to a value2060# larger than 0 to get control over the balance between CPU load and processing2061# speed.2062# Minimum value: 0, maximum value: 32, default value: 0.2063# This tag requires that the tag HAVE_DOT is set to YES.2064 2065DOT_NUM_THREADS        = 02066 2067# When you want a differently looking font n the dot files that doxygen2068# generates you can specify the font name using DOT_FONTNAME. You need to make2069# sure dot is able to find the font, which can be done by putting it in a2070# standard location or by setting the DOTFONTPATH environment variable or by2071# setting DOT_FONTPATH to the directory containing the font.2072# The default value is: Helvetica.2073# This tag requires that the tag HAVE_DOT is set to YES.2074 2075DOT_FONTNAME           = Helvetica2076 2077# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2078# dot graphs.2079# Minimum value: 4, maximum value: 24, default value: 10.2080# This tag requires that the tag HAVE_DOT is set to YES.2081 2082DOT_FONTSIZE           = 102083 2084# By default doxygen will tell dot to use the default font as specified with2085# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2086# the path where dot can find it using this tag.2087# This tag requires that the tag HAVE_DOT is set to YES.2088 2089DOT_FONTPATH           =2090 2091# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2092# each documented class showing the direct and indirect inheritance relations.2093# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2094# The default value is: YES.2095# This tag requires that the tag HAVE_DOT is set to YES.2096 2097CLASS_GRAPH            = YES2098 2099# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2100# graph for each documented class showing the direct and indirect implementation2101# dependencies (inheritance, containment, and class references variables) of the2102# class with other documented classes.2103# The default value is: YES.2104# This tag requires that the tag HAVE_DOT is set to YES.2105 2106COLLABORATION_GRAPH    = NO2107 2108# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2109# groups, showing the direct groups dependencies.2110# The default value is: YES.2111# This tag requires that the tag HAVE_DOT is set to YES.2112 2113GROUP_GRAPHS           = YES2114 2115# If the UML_LOOK tag is set to YES doxygen will generate inheritance and2116# collaboration diagrams in a style similar to the OMG's Unified Modeling2117# Language.2118# The default value is: NO.2119# This tag requires that the tag HAVE_DOT is set to YES.2120 2121UML_LOOK               = NO2122 2123# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2124# class node. If there are many fields or methods and many nodes the graph may2125# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2126# number of items for each type to make the size more manageable. Set this to 02127# for no limit. Note that the threshold may be exceeded by 50% before the limit2128# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2129# but if the number exceeds 15, the total amount of fields shown is limited to2130# 10.2131# Minimum value: 0, maximum value: 100, default value: 10.2132# This tag requires that the tag HAVE_DOT is set to YES.2133 2134UML_LIMIT_NUM_FIELDS   = 102135 2136# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2137# collaboration graphs will show the relations between templates and their2138# instances.2139# The default value is: NO.2140# This tag requires that the tag HAVE_DOT is set to YES.2141 2142TEMPLATE_RELATIONS     = YES2143 2144# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2145# YES then doxygen will generate a graph for each documented file showing the2146# direct and indirect include dependencies of the file with other documented2147# files.2148# The default value is: YES.2149# This tag requires that the tag HAVE_DOT is set to YES.2150 2151INCLUDE_GRAPH          = NO2152 2153# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2154# set to YES then doxygen will generate a graph for each documented file showing2155# the direct and indirect include dependencies of the file with other documented2156# files.2157# The default value is: YES.2158# This tag requires that the tag HAVE_DOT is set to YES.2159 2160INCLUDED_BY_GRAPH      = NO2161 2162# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2163# dependency graph for every global function or class method.2164#2165# Note that enabling this option will significantly increase the time of a run.2166# So in most cases it will be better to enable call graphs for selected2167# functions only using the \callgraph command.2168# The default value is: NO.2169# This tag requires that the tag HAVE_DOT is set to YES.2170 2171CALL_GRAPH             = NO2172 2173# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2174# dependency graph for every global function or class method.2175#2176# Note that enabling this option will significantly increase the time of a run.2177# So in most cases it will be better to enable caller graphs for selected2178# functions only using the \callergraph command.2179# The default value is: NO.2180# This tag requires that the tag HAVE_DOT is set to YES.2181 2182CALLER_GRAPH           = NO2183 2184# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2185# hierarchy of all classes instead of a textual one.2186# The default value is: YES.2187# This tag requires that the tag HAVE_DOT is set to YES.2188 2189GRAPHICAL_HIERARCHY    = YES2190 2191# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2192# dependencies a directory has on other directories in a graphical way. The2193# dependency relations are determined by the #include relations between the2194# files in the directories.2195# The default value is: YES.2196# This tag requires that the tag HAVE_DOT is set to YES.2197 2198DIRECTORY_GRAPH        = YES2199 2200# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2201# generated by dot.2202# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2203# to make the SVG files visible in IE 9+ (other browsers do not have this2204# requirement).2205# Possible values are: png, jpg, gif and svg.2206# The default value is: png.2207# This tag requires that the tag HAVE_DOT is set to YES.2208 2209DOT_IMAGE_FORMAT       = svg2210 2211# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2212# enable generation of interactive SVG images that allow zooming and panning.2213#2214# Note that this requires a modern browser other than Internet Explorer. Tested2215# and working are Firefox, Chrome, Safari, and Opera.2216# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2217# the SVG files visible. Older versions of IE do not have SVG support.2218# The default value is: NO.2219# This tag requires that the tag HAVE_DOT is set to YES.2220 2221INTERACTIVE_SVG        = NO2222 2223# The DOT_PATH tag can be used to specify the path where the dot tool can be2224# found. If left blank, it is assumed the dot tool can be found in the path.2225# This tag requires that the tag HAVE_DOT is set to YES.2226 2227DOT_PATH               = @DOT@2228 2229# The DOTFILE_DIRS tag can be used to specify one or more directories that2230# contain dot files that are included in the documentation (see the \dotfile2231# command).2232# This tag requires that the tag HAVE_DOT is set to YES.2233 2234DOTFILE_DIRS           =2235 2236# The MSCFILE_DIRS tag can be used to specify one or more directories that2237# contain msc files that are included in the documentation (see the \mscfile2238# command).2239 2240MSCFILE_DIRS           =2241 2242# The DIAFILE_DIRS tag can be used to specify one or more directories that2243# contain dia files that are included in the documentation (see the \diafile2244# command).2245 2246DIAFILE_DIRS           =2247 2248# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2249# that will be shown in the graph. If the number of nodes in a graph becomes2250# larger than this value, doxygen will truncate the graph, which is visualized2251# by representing a node as a red box. Note that doxygen if the number of direct2252# children of the root node in a graph is already larger than2253# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2254# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2255# Minimum value: 0, maximum value: 10000, default value: 50.2256# This tag requires that the tag HAVE_DOT is set to YES.2257 2258DOT_GRAPH_MAX_NODES    = 502259 2260# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2261# generated by dot. A depth value of 3 means that only nodes reachable from the2262# root by following a path via at most 3 edges will be shown. Nodes that lay2263# further from the root node will be omitted. Note that setting this option to 12264# or 2 may greatly reduce the computation time needed for large code bases. Also2265# note that the size of a graph can be further restricted by2266# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2267# Minimum value: 0, maximum value: 1000, default value: 0.2268# This tag requires that the tag HAVE_DOT is set to YES.2269 2270MAX_DOT_GRAPH_DEPTH    = 02271 2272# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2273# background. This is disabled by default, because dot on Windows does not seem2274# to support this out of the box.2275#2276# Warning: Depending on the platform used, enabling this option may lead to2277# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2278# read).2279# The default value is: NO.2280# This tag requires that the tag HAVE_DOT is set to YES.2281 2282DOT_TRANSPARENT        = YES2283 2284# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2285# files in one run (i.e. multiple -o and -T options on the command line). This2286# makes dot run faster, but since only newer versions of dot (>1.8.10) support2287# this, this feature is disabled by default.2288# The default value is: NO.2289# This tag requires that the tag HAVE_DOT is set to YES.2290 2291DOT_MULTI_TARGETS      = YES2292 2293# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2294# explaining the meaning of the various boxes and arrows in the dot generated2295# graphs.2296# The default value is: YES.2297# This tag requires that the tag HAVE_DOT is set to YES.2298 2299GENERATE_LEGEND        = YES2300 2301# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2302# files that are used to generate the various graphs.2303# The default value is: YES.2304# This tag requires that the tag HAVE_DOT is set to YES.2305 2306DOT_CLEANUP            = YES2307