1# Doxyfile 1.8.1323# 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 (\" \").1516#---------------------------------------------------------------------------17# Project related configuration options18#---------------------------------------------------------------------------1920# 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.2627DOXYFILE_ENCODING = UTF-82829# 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.3435PROJECT_NAME = "ninenano"3637# 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.4041PROJECT_NUMBER =4243# 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.4647PROJECT_BRIEF =4849# With the PROJECT_LOGO tag one can specify a logo or an icon that is included50# in the documentation. The maximum height of the logo should not exceed 5551# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy52# the logo to the output directory.5354PROJECT_LOGO =5556# 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.6061OUTPUT_DIRECTORY =6263# 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.7071CREATE_SUBDIRS = NO7273# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII74# characters to appear in the names of generated files. If set to NO, non-ASCII75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode76# U+3044.77# The default value is: NO.7879ALLOW_UNICODE_NAMES = NO8081# The OUTPUT_LANGUAGE tag is used to specify the language in which all82# documentation generated by doxygen is written. Doxygen will use this83# information to generate all constant output in the proper language.84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,91# Ukrainian and Vietnamese.92# The default value is: English.9394OUTPUT_LANGUAGE = English9596# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member97# descriptions after the members that are listed in the file and class98# documentation (similar to Javadoc). Set to NO to disable this.99# The default value is: YES.100101BRIEF_MEMBER_DESC = YES102103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief104# description of a member or function before the detailed description105#106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the107# brief descriptions will be completely suppressed.108# The default value is: YES.109110REPEAT_BRIEF = YES111112# This tag implements a quasi-intelligent brief description abbreviator that is113# used to form the text in various listings. Each string in this list, if found114# as the leading text of the brief description, will be stripped from the text115# and the result, after processing the whole list, is used as the annotated116# text. Otherwise, the brief description is used as-is. If left blank, the117# following values are used ($name is automatically replaced with the name of118# the entity):The $name class, The $name widget, The $name file, is, provides,119# specifies, contains, represents, a, an and the.120121ABBREVIATE_BRIEF = "The $name class" \122 "The $name widget" \123 "The $name file" \124 is \125 provides \126 specifies \127 contains \128 represents \129 a \130 an \131 the132133# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then134# doxygen will generate a detailed section even if there is only a brief135# description.136# The default value is: NO.137138ALWAYS_DETAILED_SEC = NO139140# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all141# inherited members of a class in the documentation of that class as if those142# members were ordinary class members. Constructors, destructors and assignment143# operators of the base classes will not be shown.144# The default value is: NO.145146INLINE_INHERITED_MEMB = NO147148# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path149# before files name in the file list and in the header files. If set to NO the150# shortest path that makes the file name unique will be used151# The default value is: YES.152153FULL_PATH_NAMES = YES154155# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.156# Stripping is only done if one of the specified strings matches the left-hand157# part of the path. The tag can be used to show relative paths in the file list.158# If left blank the directory from which doxygen is run is used as the path to159# strip.160#161# Note that you can specify absolute paths here, but also relative paths, which162# will be relative from the directory where doxygen is started.163# This tag requires that the tag FULL_PATH_NAMES is set to YES.164165STRIP_FROM_PATH =166167# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the168# path mentioned in the documentation of a class, which tells the reader which169# header file to include in order to use a class. If left blank only the name of170# the header file containing the class definition is used. Otherwise one should171# specify the list of include paths that are normally passed to the compiler172# using the -I flag.173174STRIP_FROM_INC_PATH =175176# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but177# less readable) file names. This can be useful is your file systems doesn't178# support long names like on DOS, Mac, or CD-ROM.179# The default value is: NO.180181SHORT_NAMES = NO182183# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the184# first line (until the first dot) of a Javadoc-style comment as the brief185# description. If set to NO, the Javadoc-style will behave just like regular Qt-186# style comments (thus requiring an explicit @brief command for a brief187# description.)188# The default value is: NO.189190JAVADOC_AUTOBRIEF = NO191192# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first193# line (until the first dot) of a Qt-style comment as the brief description. If194# set to NO, the Qt-style will behave just like regular Qt-style comments (thus195# requiring an explicit \brief command for a brief description.)196# The default value is: NO.197198QT_AUTOBRIEF = NO199200# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a201# multi-line C++ special comment block (i.e. a block of //! or /// comments) as202# a brief description. This used to be the default behavior. The new default is203# to treat a multi-line C++ comment block as a detailed description. Set this204# tag to YES if you prefer the old behavior instead.205#206# Note that setting this tag to YES also means that rational rose comments are207# not recognized any more.208# The default value is: NO.209210MULTILINE_CPP_IS_BRIEF = NO211212# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the213# documentation from any documented member that it re-implements.214# The default value is: YES.215216INHERIT_DOCS = YES217218# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new219# page for each member. If set to NO, the documentation of a member will be part220# of the file/class/namespace that contains it.221# The default value is: NO.222223SEPARATE_MEMBER_PAGES = NO224225# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen226# uses this value to replace tabs by spaces in code fragments.227# Minimum value: 1, maximum value: 16, default value: 4.228229TAB_SIZE = 4230231# This tag can be used to specify a number of aliases that act as commands in232# the documentation. An alias has the form:233# name=value234# For example adding235# "sideeffect=@par Side Effects:\n"236# will allow you to put the command \sideeffect (or @sideeffect) in the237# documentation, which will result in a user-defined paragraph with heading238# "Side Effects:". You can put \n's in the value part of an alias to insert239# newlines.240241ALIASES =242243# This tag can be used to specify a number of word-keyword mappings (TCL only).244# A mapping has the form "name=value". For example adding "class=itcl::class"245# will allow you to use the command class in the itcl::class meaning.246247TCL_SUBST =248249# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources250# only. Doxygen will then generate output that is more tailored for C. For251# instance, some of the names that are used will be different. The list of all252# members will be omitted, etc.253# The default value is: NO.254255OPTIMIZE_OUTPUT_FOR_C = YES256257# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or258# Python sources only. Doxygen will then generate output that is more tailored259# for that language. For instance, namespaces will be presented as packages,260# qualified scopes will look different, etc.261# The default value is: NO.262263OPTIMIZE_OUTPUT_JAVA = NO264265# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran266# sources. Doxygen will then generate output that is tailored for Fortran.267# The default value is: NO.268269OPTIMIZE_FOR_FORTRAN = NO270271# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL272# sources. Doxygen will then generate output that is tailored for VHDL.273# The default value is: NO.274275OPTIMIZE_OUTPUT_VHDL = NO276277# Doxygen selects the parser to use depending on the extension of the files it278# parses. With this tag you can assign which parser to use for a given279# extension. Doxygen has a built-in mapping, but you can override or extend it280# using this tag. The format is ext=language, where ext is a file extension, and281# language is one of the parsers supported by doxygen: IDL, Java, Javascript,282# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:283# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:284# Fortran. In the later case the parser tries to guess whether the code is fixed285# or free formatted code, this is the default for Fortran type files), VHDL. For286# instance to make doxygen treat .inc files as Fortran files (default is PHP),287# and .f files as C (default is Fortran), use: inc=Fortran f=C.288#289# Note: For files without extension you can use no_extension as a placeholder.290#291# Note that for custom extensions you also need to set FILE_PATTERNS otherwise292# the files are not read by doxygen.293294EXTENSION_MAPPING =295296# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments297# according to the Markdown format, which allows for more readable298# documentation. See http://daringfireball.net/projects/markdown/ for details.299# The output of markdown processing is further processed by doxygen, so you can300# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in301# case of backward compatibilities issues.302# The default value is: YES.303304MARKDOWN_SUPPORT = YES305306# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up307# to that level are automatically included in the table of contents, even if308# they do not have an id attribute.309# Note: This feature currently applies only to Markdown headings.310# Minimum value: 0, maximum value: 99, default value: 0.311# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.312313TOC_INCLUDE_HEADINGS = 0314315# When enabled doxygen tries to link words that correspond to documented316# classes, or namespaces to their corresponding documentation. Such a link can317# be prevented in individual cases by putting a % sign in front of the word or318# globally by setting AUTOLINK_SUPPORT to NO.319# The default value is: YES.320321AUTOLINK_SUPPORT = YES322323# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want324# to include (a tag file for) the STL sources as input, then you should set this325# tag to YES in order to let doxygen match functions declarations and326# definitions whose arguments contain STL classes (e.g. func(std::string);327# versus func(std::string) {}). This also make the inheritance and collaboration328# diagrams that involve STL classes more complete and accurate.329# The default value is: NO.330331BUILTIN_STL_SUPPORT = NO332333# If you use Microsoft's C++/CLI language, you should set this option to YES to334# enable parsing support.335# The default value is: NO.336337CPP_CLI_SUPPORT = NO338339# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:340# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen341# will parse them like normal C++ but will assume all classes use public instead342# of private inheritance when no explicit protection keyword is present.343# The default value is: NO.344345SIP_SUPPORT = NO346347# For Microsoft's IDL there are propget and propput attributes to indicate348# getter and setter methods for a property. Setting this option to YES will make349# doxygen to replace the get and set methods by a property in the documentation.350# This will only work if the methods are indeed getting or setting a simple351# type. If this is not the case, or you want to show the methods anyway, you352# should set this option to NO.353# The default value is: YES.354355IDL_PROPERTY_SUPPORT = YES356357# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC358# tag is set to YES then doxygen will reuse the documentation of the first359# member in the group (if any) for the other members of the group. By default360# all members of a group must be documented explicitly.361# The default value is: NO.362363DISTRIBUTE_GROUP_DOC = NO364365# If one adds a struct or class to a group and this option is enabled, then also366# any nested class or struct is added to the same group. By default this option367# is disabled and one has to add nested compounds explicitly via \ingroup.368# The default value is: NO.369370GROUP_NESTED_COMPOUNDS = NO371372# Set the SUBGROUPING tag to YES to allow class member groups of the same type373# (for instance a group of public functions) to be put as a subgroup of that374# type (e.g. under the Public Functions section). Set it to NO to prevent375# subgrouping. Alternatively, this can be done per class using the376# \nosubgrouping command.377# The default value is: YES.378379SUBGROUPING = YES380381# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions382# are shown inside the group in which they are included (e.g. using \ingroup)383# instead of on a separate page (for HTML and Man pages) or section (for LaTeX384# and RTF).385#386# Note that this feature does not work in combination with387# SEPARATE_MEMBER_PAGES.388# The default value is: NO.389390INLINE_GROUPED_CLASSES = NO391392# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions393# with only public data fields or simple typedef fields will be shown inline in394# the documentation of the scope in which they are defined (i.e. file,395# namespace, or group documentation), provided this scope is documented. If set396# to NO, structs, classes, and unions are shown on a separate page (for HTML and397# Man pages) or section (for LaTeX and RTF).398# The default value is: NO.399400INLINE_SIMPLE_STRUCTS = NO401402# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or403# enum is documented as struct, union, or enum with the name of the typedef. So404# typedef struct TypeS {} TypeT, will appear in the documentation as a struct405# with name TypeT. When disabled the typedef will appear as a member of a file,406# namespace, or class. And the struct will be named TypeS. This can typically be407# useful for C code in case the coding convention dictates that all compound408# types are typedef'ed and only the typedef is referenced, never the tag name.409# The default value is: NO.410411TYPEDEF_HIDES_STRUCT = NO412413# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This414# cache is used to resolve symbols given their name and scope. Since this can be415# an expensive process and often the same symbol appears multiple times in the416# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small417# doxygen will become slower. If the cache is too large, memory is wasted. The418# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range419# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536420# symbols. At the end of a run doxygen will report the cache usage and suggest421# the optimal cache size from a speed point of view.422# Minimum value: 0, maximum value: 9, default value: 0.423424LOOKUP_CACHE_SIZE = 0425426#---------------------------------------------------------------------------427# Build related configuration options428#---------------------------------------------------------------------------429430# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in431# documentation are documented, even if no documentation was available. Private432# class members and static file members will be hidden unless the433# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.434# Note: This will also disable the warnings about undocumented members that are435# normally produced when WARNINGS is set to YES.436# The default value is: NO.437438EXTRACT_ALL = YES439440# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will441# be included in the documentation.442# The default value is: NO.443444EXTRACT_PRIVATE = YES445446# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal447# scope will be included in the documentation.448# The default value is: NO.449450EXTRACT_PACKAGE = YES451452# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be453# included in the documentation.454# The default value is: NO.455456EXTRACT_STATIC = YES457458# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined459# locally in source files will be included in the documentation. If set to NO,460# only classes defined in header files are included. Does not have any effect461# for Java sources.462# The default value is: YES.463464EXTRACT_LOCAL_CLASSES = YES465466# This flag is only useful for Objective-C code. If set to YES, local methods,467# which are defined in the implementation section but not in the interface are468# included in the documentation. If set to NO, only methods in the interface are469# included.470# The default value is: NO.471472EXTRACT_LOCAL_METHODS = NO473474# If this flag is set to YES, the members of anonymous namespaces will be475# extracted and appear in the documentation as a namespace called476# 'anonymous_namespace{file}', where file will be replaced with the base name of477# the file that contains the anonymous namespace. By default anonymous namespace478# are hidden.479# The default value is: NO.480481EXTRACT_ANON_NSPACES = NO482483# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all484# undocumented members inside documented classes or files. If set to NO these485# members will be included in the various overviews, but no documentation486# section is generated. This option has no effect if EXTRACT_ALL is enabled.487# The default value is: NO.488489HIDE_UNDOC_MEMBERS = NO490491# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all492# undocumented classes that are normally visible in the class hierarchy. If set493# to NO, these classes will be included in the various overviews. This option494# has no effect if EXTRACT_ALL is enabled.495# The default value is: NO.496497HIDE_UNDOC_CLASSES = NO498499# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend500# (class|struct|union) declarations. If set to NO, these declarations will be501# included in the documentation.502# The default value is: NO.503504HIDE_FRIEND_COMPOUNDS = NO505506# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any507# documentation blocks found inside the body of a function. If set to NO, these508# blocks will be appended to the function's detailed documentation block.509# The default value is: NO.510511HIDE_IN_BODY_DOCS = NO512513# The INTERNAL_DOCS tag determines if documentation that is typed after a514# \internal command is included. If the tag is set to NO then the documentation515# will be excluded. Set it to YES to include the internal documentation.516# The default value is: NO.517518INTERNAL_DOCS = NO519520# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file521# names in lower-case letters. If set to YES, upper-case letters are also522# allowed. This is useful if you have classes or files whose names only differ523# in case and if your file system supports case sensitive file names. Windows524# and Mac users are advised to set this option to NO.525# The default value is: system dependent.526527CASE_SENSE_NAMES = YES528529# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with530# their full class and namespace scopes in the documentation. If set to YES, the531# scope will be hidden.532# The default value is: NO.533534HIDE_SCOPE_NAMES = NO535536# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will537# append additional text to a page's title, such as Class Reference. If set to538# YES the compound reference will be hidden.539# The default value is: NO.540541HIDE_COMPOUND_REFERENCE= NO542543# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of544# the files that are included by a file in the documentation of that file.545# The default value is: YES.546547SHOW_INCLUDE_FILES = YES548549# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each550# grouped member an include statement to the documentation, telling the reader551# which file to include in order to use the member.552# The default value is: NO.553554SHOW_GROUPED_MEMB_INC = NO555556# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include557# files with double quotes in the documentation rather than with sharp brackets.558# The default value is: NO.559560FORCE_LOCAL_INCLUDES = NO561562# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the563# documentation for inline members.564# The default value is: YES.565566INLINE_INFO = YES567568# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the569# (detailed) documentation of file and class members alphabetically by member570# name. If set to NO, the members will appear in declaration order.571# The default value is: YES.572573SORT_MEMBER_DOCS = YES574575# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief576# descriptions of file, namespace and class members alphabetically by member577# name. If set to NO, the members will appear in declaration order. Note that578# this will also influence the order of the classes in the class list.579# The default value is: NO.580581SORT_BRIEF_DOCS = NO582583# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the584# (brief and detailed) documentation of class members so that constructors and585# destructors are listed first. If set to NO the constructors will appear in the586# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.587# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief588# member documentation.589# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting590# detailed member documentation.591# The default value is: NO.592593SORT_MEMBERS_CTORS_1ST = NO594595# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy596# of group names into alphabetical order. If set to NO the group names will597# appear in their defined order.598# The default value is: NO.599600SORT_GROUP_NAMES = NO601602# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by603# fully-qualified names, including namespaces. If set to NO, the class list will604# be sorted only by class name, not including the namespace part.605# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.606# Note: This option applies only to the class list, not to the alphabetical607# list.608# The default value is: NO.609610SORT_BY_SCOPE_NAME = NO611612# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper613# type resolution of all parameters of a function it will reject a match between614# the prototype and the implementation of a member function even if there is615# only one candidate or it is obvious which candidate to choose by doing a616# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still617# accept a match between prototype and implementation in such cases.618# The default value is: NO.619620STRICT_PROTO_MATCHING = NO621622# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo623# list. This list is created by putting \todo commands in the documentation.624# The default value is: YES.625626GENERATE_TODOLIST = YES627628# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test629# list. This list is created by putting \test commands in the documentation.630# The default value is: YES.631632GENERATE_TESTLIST = YES633634# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug635# list. This list is created by putting \bug commands in the documentation.636# The default value is: YES.637638GENERATE_BUGLIST = YES639640# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)641# the deprecated list. This list is created by putting \deprecated commands in642# the documentation.643# The default value is: YES.644645GENERATE_DEPRECATEDLIST= YES646647# The ENABLED_SECTIONS tag can be used to enable conditional documentation648# sections, marked by \if <section_label> ... \endif and \cond <section_label>649# ... \endcond blocks.650651ENABLED_SECTIONS =652653# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the654# initial value of a variable or macro / define can have for it to appear in the655# documentation. If the initializer consists of more lines than specified here656# it will be hidden. Use a value of 0 to hide initializers completely. The657# appearance of the value of individual variables and macros / defines can be658# controlled using \showinitializer or \hideinitializer command in the659# documentation regardless of this setting.660# Minimum value: 0, maximum value: 10000, default value: 30.661662MAX_INITIALIZER_LINES = 30663664# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at665# the bottom of the documentation of classes and structs. If set to YES, the666# list will mention the files that were used to generate the documentation.667# The default value is: YES.668669SHOW_USED_FILES = YES670671# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This672# will remove the Files entry from the Quick Index and from the Folder Tree View673# (if specified).674# The default value is: YES.675676SHOW_FILES = YES677678# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces679# page. This will remove the Namespaces entry from the Quick Index and from the680# Folder Tree View (if specified).681# The default value is: YES.682683SHOW_NAMESPACES = YES684685# The FILE_VERSION_FILTER tag can be used to specify a program or script that686# doxygen should invoke to get the current version for each file (typically from687# the version control system). Doxygen will invoke the program by executing (via688# popen()) the command command input-file, where command is the value of the689# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided690# by doxygen. Whatever the program writes to standard output is used as the file691# version. For an example see the documentation.692693FILE_VERSION_FILTER =694695# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed696# by doxygen. The layout file controls the global structure of the generated697# output files in an output format independent way. To create the layout file698# that represents doxygen's defaults, run doxygen with the -l option. You can699# optionally specify a file name after the option, if omitted DoxygenLayout.xml700# will be used as the name of the layout file.701#702# Note that if you run doxygen from a directory containing a file called703# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE704# tag is left empty.705706LAYOUT_FILE =707708# The CITE_BIB_FILES tag can be used to specify one or more bib files containing709# the reference definitions. This must be a list of .bib files. The .bib710# extension is automatically appended if omitted. This requires the bibtex tool711# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.712# For LaTeX the style of the bibliography can be controlled using713# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the714# search path. See also \cite for info how to create references.715716CITE_BIB_FILES =717718#---------------------------------------------------------------------------719# Configuration options related to warning and progress messages720#---------------------------------------------------------------------------721722# The QUIET tag can be used to turn on/off the messages that are generated to723# standard output by doxygen. If QUIET is set to YES this implies that the724# messages are off.725# The default value is: NO.726727QUIET = NO728729# The WARNINGS tag can be used to turn on/off the warning messages that are730# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES731# this implies that the warnings are on.732#733# Tip: Turn warnings on while writing the documentation.734# The default value is: YES.735736WARNINGS = YES737738# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate739# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag740# will automatically be disabled.741# The default value is: YES.742743WARN_IF_UNDOCUMENTED = YES744745# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for746# potential errors in the documentation, such as not documenting some parameters747# in a documented function, or documenting parameters that don't exist or using748# markup commands wrongly.749# The default value is: YES.750751WARN_IF_DOC_ERROR = YES752753# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that754# are documented, but have no documentation for their parameters or return755# value. If set to NO, doxygen will only warn about wrong or incomplete756# parameter documentation, but not about the absence of documentation.757# The default value is: NO.758759WARN_NO_PARAMDOC = NO760761# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when762# a warning is encountered.763# The default value is: NO.764765WARN_AS_ERROR = NO766767# The WARN_FORMAT tag determines the format of the warning messages that doxygen768# can produce. The string should contain the $file, $line, and $text tags, which769# will be replaced by the file and line number from which the warning originated770# and the warning text. Optionally the format may contain $version, which will771# be replaced by the version of the file (if it could be obtained via772# FILE_VERSION_FILTER)773# The default value is: $file:$line: $text.774775WARN_FORMAT = "$file:$line: $text"776777# The WARN_LOGFILE tag can be used to specify a file to which warning and error778# messages should be written. If left blank the output is written to standard779# error (stderr).780781WARN_LOGFILE =782783#---------------------------------------------------------------------------784# Configuration options related to the input files785#---------------------------------------------------------------------------786787# The INPUT tag is used to specify the files and/or directories that contain788# documented source files. You may enter file names like myfile.cpp or789# directories like /usr/src/myproject. Separate the files or directories with790# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING791# Note: If this tag is empty the current directory is searched.792793INPUT = 9p/9p.c 9p/util.c 9pfs/9pfs.c include/9p.h include/9pfs.h README.md794795# This tag can be used to specify the character encoding of the source files796# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses797# libiconv (or the iconv built into libc) for the transcoding. See the libiconv798# documentation (see: http://www.gnu.org/software/libiconv) for the list of799# possible encodings.800# The default value is: UTF-8.801802INPUT_ENCODING = UTF-8803804# If the value of the INPUT tag contains directories, you can use the805# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and806# *.h) to filter out the source-files in the directories.807#808# Note that for custom extensions or not directly supported extensions you also809# need to set EXTENSION_MAPPING for the extension otherwise the files are not810# read by doxygen.811#812# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,813# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,814# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,815# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,816# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.817818FILE_PATTERNS = *.c \819 *.cc \820 *.cxx \821 *.cpp \822 *.c++ \823 *.java \824 *.ii \825 *.ixx \826 *.ipp \827 *.i++ \828 *.inl \829 *.idl \830 *.ddl \831 *.odl \832 *.h \833 *.hh \834 *.hxx \835 *.hpp \836 *.h++ \837 *.cs \838 *.d \839 *.php \840 *.php4 \841 *.php5 \842 *.phtml \843 *.inc \844 *.m \845 *.markdown \846 *.md \847 *.mm \848 *.dox \849 *.py \850 *.pyw \851 *.f90 \852 *.f95 \853 *.f03 \854 *.f08 \855 *.f \856 *.for \857 *.tcl \858 *.vhd \859 *.vhdl \860 *.ucf \861 *.qsf862863# The RECURSIVE tag can be used to specify whether or not subdirectories should864# be searched for input files as well.865# The default value is: NO.866867RECURSIVE = NO868869# The EXCLUDE tag can be used to specify files and/or directories that should be870# excluded from the INPUT source files. This way you can easily exclude a871# subdirectory from a directory tree whose root is specified with the INPUT tag.872#873# Note that relative paths are relative to the directory from which doxygen is874# run.875876EXCLUDE =877878# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or879# directories that are symbolic links (a Unix file system feature) are excluded880# from the input.881# The default value is: NO.882883EXCLUDE_SYMLINKS = NO884885# If the value of the INPUT tag contains directories, you can use the886# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude887# certain files from those directories.888#889# Note that the wildcards are matched against the file with absolute path, so to890# exclude all test directories for example use the pattern */test/*891892EXCLUDE_PATTERNS =893894# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names895# (namespaces, classes, functions, etc.) that should be excluded from the896# output. The symbol name can be a fully qualified name, a word, or if the897# wildcard * is used, a substring. Examples: ANamespace, AClass,898# AClass::ANamespace, ANamespace::*Test899#900# Note that the wildcards are matched against the file with absolute path, so to901# exclude all test directories use the pattern */test/*902903EXCLUDE_SYMBOLS =904905# The EXAMPLE_PATH tag can be used to specify one or more files or directories906# that contain example code fragments that are included (see the \include907# command).908909EXAMPLE_PATH =910911# If the value of the EXAMPLE_PATH tag contains directories, you can use the912# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and913# *.h) to filter out the source-files in the directories. If left blank all914# files are included.915916EXAMPLE_PATTERNS = *917918# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be919# searched for input files to be used with the \include or \dontinclude commands920# irrespective of the value of the RECURSIVE tag.921# The default value is: NO.922923EXAMPLE_RECURSIVE = NO924925# The IMAGE_PATH tag can be used to specify one or more files or directories926# that contain images that are to be included in the documentation (see the927# \image command).928929IMAGE_PATH =930931# The INPUT_FILTER tag can be used to specify a program that doxygen should932# invoke to filter for each input file. Doxygen will invoke the filter program933# by executing (via popen()) the command:934#935# <filter> <input-file>936#937# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the938# name of an input file. Doxygen will then use the output that the filter939# program writes to standard output. If FILTER_PATTERNS is specified, this tag940# will be ignored.941#942# Note that the filter must not add or remove lines; it is applied before the943# code is scanned, but not when the output code is generated. If lines are added944# or removed, the anchors will not be placed correctly.945#946# Note that for custom extensions or not directly supported extensions you also947# need to set EXTENSION_MAPPING for the extension otherwise the files are not948# properly processed by doxygen.949950INPUT_FILTER =951952# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern953# basis. Doxygen will compare the file name with each pattern and apply the954# filter if there is a match. The filters are a list of the form: pattern=filter955# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how956# filters are used. If the FILTER_PATTERNS tag is empty or if none of the957# patterns match the file name, INPUT_FILTER is applied.958#959# Note that for custom extensions or not directly supported extensions you also960# need to set EXTENSION_MAPPING for the extension otherwise the files are not961# properly processed by doxygen.962963FILTER_PATTERNS =964965# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using966# INPUT_FILTER) will also be used to filter the input files that are used for967# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).968# The default value is: NO.969970FILTER_SOURCE_FILES = NO971972# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file973# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and974# it is also possible to disable source filtering for a specific pattern using975# *.ext= (so without naming a filter).976# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.977978FILTER_SOURCE_PATTERNS =979980# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that981# is part of the input, its contents will be placed on the main page982# (index.html). This can be useful if you have a project on for instance GitHub983# and want to reuse the introduction page also for the doxygen output.984985USE_MDFILE_AS_MAINPAGE = README.md986987#---------------------------------------------------------------------------988# Configuration options related to source browsing989#---------------------------------------------------------------------------990991# If the SOURCE_BROWSER tag is set to YES then a list of source files will be992# generated. Documented entities will be cross-referenced with these sources.993#994# Note: To get rid of all source code in the generated output, make sure that995# also VERBATIM_HEADERS is set to NO.996# The default value is: NO.997998SOURCE_BROWSER = NO9991000# Setting the INLINE_SOURCES tag to YES will include the body of functions,1001# classes and enums directly into the documentation.1002# The default value is: NO.10031004INLINE_SOURCES = NO10051006# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any1007# special comment blocks from generated source code fragments. Normal C, C++ and1008# Fortran comments will always remain visible.1009# The default value is: YES.10101011STRIP_CODE_COMMENTS = YES10121013# If the REFERENCED_BY_RELATION tag is set to YES then for each documented1014# function all documented functions referencing it will be listed.1015# The default value is: NO.10161017REFERENCED_BY_RELATION = NO10181019# If the REFERENCES_RELATION tag is set to YES then for each documented function1020# all documented entities called/used by that function will be listed.1021# The default value is: NO.10221023REFERENCES_RELATION = NO10241025# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set1026# to YES then the hyperlinks from functions in REFERENCES_RELATION and1027# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will1028# link to the documentation.1029# The default value is: YES.10301031REFERENCES_LINK_SOURCE = YES10321033# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the1034# source code will show a tooltip with additional information such as prototype,1035# brief description and links to the definition and documentation. Since this1036# will make the HTML file larger and loading of large files a bit slower, you1037# can opt to disable this feature.1038# The default value is: YES.1039# This tag requires that the tag SOURCE_BROWSER is set to YES.10401041SOURCE_TOOLTIPS = YES10421043# If the USE_HTAGS tag is set to YES then the references to source code will1044# point to the HTML generated by the htags(1) tool instead of doxygen built-in1045# source browser. The htags tool is part of GNU's global source tagging system1046# (see http://www.gnu.org/software/global/global.html). You will need version1047# 4.8.6 or higher.1048#1049# To use it do the following:1050# - Install the latest version of global1051# - Enable SOURCE_BROWSER and USE_HTAGS in the config file1052# - Make sure the INPUT points to the root of the source tree1053# - Run doxygen as normal1054#1055# Doxygen will invoke htags (and that will in turn invoke gtags), so these1056# tools must be available from the command line (i.e. in the search path).1057#1058# The result: instead of the source browser generated by doxygen, the links to1059# source code will now point to the output of htags.1060# The default value is: NO.1061# This tag requires that the tag SOURCE_BROWSER is set to YES.10621063USE_HTAGS = NO10641065# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a1066# verbatim copy of the header file for each class for which an include is1067# specified. Set to NO to disable this.1068# See also: Section \class.1069# The default value is: YES.10701071VERBATIM_HEADERS = YES10721073#---------------------------------------------------------------------------1074# Configuration options related to the alphabetical class index1075#---------------------------------------------------------------------------10761077# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all1078# compounds will be generated. Enable this if the project contains a lot of1079# classes, structs, unions or interfaces.1080# The default value is: YES.10811082ALPHABETICAL_INDEX = YES10831084# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in1085# which the alphabetical index list will be split.1086# Minimum value: 1, maximum value: 20, default value: 5.1087# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.10881089COLS_IN_ALPHA_INDEX = 510901091# In case all classes in a project start with a common prefix, all classes will1092# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag1093# can be used to specify a prefix (or a list of prefixes) that should be ignored1094# while generating the index headers.1095# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.10961097IGNORE_PREFIX =10981099#---------------------------------------------------------------------------1100# Configuration options related to the HTML output1101#---------------------------------------------------------------------------11021103# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output1104# The default value is: YES.11051106GENERATE_HTML = YES11071108# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1109# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1110# it.1111# The default directory is: html.1112# This tag requires that the tag GENERATE_HTML is set to YES.11131114HTML_OUTPUT = docs11151116# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1117# generated HTML page (for example: .htm, .php, .asp).1118# The default value is: .html.1119# This tag requires that the tag GENERATE_HTML is set to YES.11201121HTML_FILE_EXTENSION = .html11221123# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1124# each generated HTML page. If the tag is left blank doxygen will generate a1125# standard header.1126#1127# To get valid HTML the header file that includes any scripts and style sheets1128# that doxygen needs, which is dependent on the configuration options used (e.g.1129# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1130# default header using1131# doxygen -w html new_header.html new_footer.html new_stylesheet.css1132# YourConfigFile1133# and then modify the file new_header.html. See also section "Doxygen usage"1134# for information on how to generate the default header that doxygen normally1135# uses.1136# Note: The header is subject to change so you typically have to regenerate the1137# default header when upgrading to a newer version of doxygen. For a description1138# of the possible markers and block names see the documentation.1139# This tag requires that the tag GENERATE_HTML is set to YES.11401141HTML_HEADER =11421143# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1144# generated HTML page. If the tag is left blank doxygen will generate a standard1145# footer. See HTML_HEADER for more information on how to generate a default1146# footer and what special commands can be used inside the footer. See also1147# section "Doxygen usage" for information on how to generate the default footer1148# that doxygen normally uses.1149# This tag requires that the tag GENERATE_HTML is set to YES.11501151HTML_FOOTER =11521153# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1154# sheet that is used by each HTML page. It can be used to fine-tune the look of1155# the HTML output. If left blank doxygen will generate a default style sheet.1156# See also section "Doxygen usage" for information on how to generate the style1157# sheet that doxygen normally uses.1158# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1159# it is more robust and this tag (HTML_STYLESHEET) will in the future become1160# obsolete.1161# This tag requires that the tag GENERATE_HTML is set to YES.11621163HTML_STYLESHEET =11641165# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined1166# cascading style sheets that are included after the standard style sheets1167# created by doxygen. Using this option one can overrule certain style aspects.1168# This is preferred over using HTML_STYLESHEET since it does not replace the1169# standard style sheet and is therefore more robust against future updates.1170# Doxygen will copy the style sheet files to the output directory.1171# Note: The order of the extra style sheet files is of importance (e.g. the last1172# style sheet in the list overrules the setting of the previous ones in the1173# list). For an example see the documentation.1174# This tag requires that the tag GENERATE_HTML is set to YES.11751176HTML_EXTRA_STYLESHEET =11771178# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1179# other source files which should be copied to the HTML output directory. Note1180# that these files will be copied to the base HTML output directory. Use the1181# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1182# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1183# files will be copied as-is; there are no commands or markers available.1184# This tag requires that the tag GENERATE_HTML is set to YES.11851186HTML_EXTRA_FILES =11871188# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1189# will adjust the colors in the style sheet and background images according to1190# this color. Hue is specified as an angle on a colorwheel, see1191# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1192# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001193# purple, and 360 is red again.1194# Minimum value: 0, maximum value: 359, default value: 220.1195# This tag requires that the tag GENERATE_HTML is set to YES.11961197HTML_COLORSTYLE_HUE = 22011981199# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1200# in the HTML output. For a value of 0 the output will use grayscales only. A1201# value of 255 will produce the most vivid colors.1202# Minimum value: 0, maximum value: 255, default value: 100.1203# This tag requires that the tag GENERATE_HTML is set to YES.12041205HTML_COLORSTYLE_SAT = 10012061207# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1208# luminance component of the colors in the HTML output. Values below 1001209# gradually make the output lighter, whereas values above 100 make the output1210# darker. The value divided by 100 is the actual gamma applied, so 80 represents1211# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1212# change the gamma.1213# Minimum value: 40, maximum value: 240, default value: 80.1214# This tag requires that the tag GENERATE_HTML is set to YES.12151216HTML_COLORSTYLE_GAMMA = 8012171218# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1219# page will contain the date and time when the page was generated. Setting this1220# to YES can help to show when doxygen was last run and thus if the1221# documentation is up to date.1222# The default value is: NO.1223# This tag requires that the tag GENERATE_HTML is set to YES.12241225HTML_TIMESTAMP = NO12261227# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1228# documentation will contain sections that can be hidden and shown after the1229# page has loaded.1230# The default value is: NO.1231# This tag requires that the tag GENERATE_HTML is set to YES.12321233HTML_DYNAMIC_SECTIONS = NO12341235# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1236# shown in the various tree structured indices initially; the user can expand1237# and collapse entries dynamically later on. Doxygen will expand the tree to1238# such a level that at most the specified number of entries are visible (unless1239# a fully collapsed tree already exceeds this amount). So setting the number of1240# entries 1 will produce a full collapsed tree by default. 0 is a special value1241# representing an infinite number of entries and will result in a full expanded1242# tree by default.1243# Minimum value: 0, maximum value: 9999, default value: 100.1244# This tag requires that the tag GENERATE_HTML is set to YES.12451246HTML_INDEX_NUM_ENTRIES = 10012471248# If the GENERATE_DOCSET tag is set to YES, additional index files will be1249# generated that can be used as input for Apple's Xcode 3 integrated development1250# environment (see: http://developer.apple.com/tools/xcode/), introduced with1251# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1252# Makefile in the HTML output directory. Running make will produce the docset in1253# that directory and running make install will install the docset in1254# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1255# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1256# for more information.1257# The default value is: NO.1258# This tag requires that the tag GENERATE_HTML is set to YES.12591260GENERATE_DOCSET = NO12611262# This tag determines the name of the docset feed. A documentation feed provides1263# an umbrella under which multiple documentation sets from a single provider1264# (such as a company or product suite) can be grouped.1265# The default value is: Doxygen generated docs.1266# This tag requires that the tag GENERATE_DOCSET is set to YES.12671268DOCSET_FEEDNAME = "Doxygen generated docs"12691270# This tag specifies a string that should uniquely identify the documentation1271# set bundle. This should be a reverse domain-name style string, e.g.1272# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1273# The default value is: org.doxygen.Project.1274# This tag requires that the tag GENERATE_DOCSET is set to YES.12751276DOCSET_BUNDLE_ID = org.doxygen.Project12771278# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1279# the documentation publisher. This should be a reverse domain-name style1280# string, e.g. com.mycompany.MyDocSet.documentation.1281# The default value is: org.doxygen.Publisher.1282# This tag requires that the tag GENERATE_DOCSET is set to YES.12831284DOCSET_PUBLISHER_ID = org.doxygen.Publisher12851286# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1287# The default value is: Publisher.1288# This tag requires that the tag GENERATE_DOCSET is set to YES.12891290DOCSET_PUBLISHER_NAME = Publisher12911292# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1293# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1294# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1295# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1296# Windows.1297#1298# The HTML Help Workshop contains a compiler that can convert all HTML output1299# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1300# files are now used as the Windows 98 help format, and will replace the old1301# Windows help format (.hlp) on all Windows platforms in the future. Compressed1302# HTML files also contain an index, a table of contents, and you can search for1303# words in the documentation. The HTML workshop also contains a viewer for1304# compressed HTML files.1305# The default value is: NO.1306# This tag requires that the tag GENERATE_HTML is set to YES.13071308GENERATE_HTMLHELP = NO13091310# The CHM_FILE tag can be used to specify the file name of the resulting .chm1311# file. You can add a path in front of the file if the result should not be1312# written to the html output directory.1313# This tag requires that the tag GENERATE_HTMLHELP is set to YES.13141315CHM_FILE =13161317# The HHC_LOCATION tag can be used to specify the location (absolute path1318# including file name) of the HTML help compiler (hhc.exe). If non-empty,1319# doxygen will try to run the HTML help compiler on the generated index.hhp.1320# The file has to be specified with full path.1321# This tag requires that the tag GENERATE_HTMLHELP is set to YES.13221323HHC_LOCATION =13241325# The GENERATE_CHI flag controls if a separate .chi index file is generated1326# (YES) or that it should be included in the master .chm file (NO).1327# The default value is: NO.1328# This tag requires that the tag GENERATE_HTMLHELP is set to YES.13291330GENERATE_CHI = NO13311332# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)1333# and project file content.1334# This tag requires that the tag GENERATE_HTMLHELP is set to YES.13351336CHM_INDEX_ENCODING =13371338# The BINARY_TOC flag controls whether a binary table of contents is generated1339# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it1340# enables the Previous and Next buttons.1341# The default value is: NO.1342# This tag requires that the tag GENERATE_HTMLHELP is set to YES.13431344BINARY_TOC = NO13451346# The TOC_EXPAND flag can be set to YES to add extra items for group members to1347# the table of contents of the HTML help documentation and to the tree view.1348# The default value is: NO.1349# This tag requires that the tag GENERATE_HTMLHELP is set to YES.13501351TOC_EXPAND = NO13521353# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1354# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1355# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1356# (.qch) of the generated HTML documentation.1357# The default value is: NO.1358# This tag requires that the tag GENERATE_HTML is set to YES.13591360GENERATE_QHP = NO13611362# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1363# the file name of the resulting .qch file. The path specified is relative to1364# the HTML output folder.1365# This tag requires that the tag GENERATE_QHP is set to YES.13661367QCH_FILE =13681369# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1370# Project output. For more information please see Qt Help Project / Namespace1371# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1372# The default value is: org.doxygen.Project.1373# This tag requires that the tag GENERATE_QHP is set to YES.13741375QHP_NAMESPACE = org.doxygen.Project13761377# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1378# Help Project output. For more information please see Qt Help Project / Virtual1379# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1380# folders).1381# The default value is: doc.1382# This tag requires that the tag GENERATE_QHP is set to YES.13831384QHP_VIRTUAL_FOLDER = doc13851386# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1387# filter to add. For more information please see Qt Help Project / Custom1388# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1389# filters).1390# This tag requires that the tag GENERATE_QHP is set to YES.13911392QHP_CUST_FILTER_NAME =13931394# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1395# custom filter to add. For more information please see Qt Help Project / Custom1396# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1397# filters).1398# This tag requires that the tag GENERATE_QHP is set to YES.13991400QHP_CUST_FILTER_ATTRS =14011402# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1403# project's filter section matches. Qt Help Project / Filter Attributes (see:1404# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1405# This tag requires that the tag GENERATE_QHP is set to YES.14061407QHP_SECT_FILTER_ATTRS =14081409# The QHG_LOCATION tag can be used to specify the location of Qt's1410# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1411# generated .qhp file.1412# This tag requires that the tag GENERATE_QHP is set to YES.14131414QHG_LOCATION =14151416# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1417# generated, together with the HTML files, they form an Eclipse help plugin. To1418# install this plugin and make it available under the help contents menu in1419# Eclipse, the contents of the directory containing the HTML and XML files needs1420# to be copied into the plugins directory of eclipse. The name of the directory1421# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1422# After copying Eclipse needs to be restarted before the help appears.1423# The default value is: NO.1424# This tag requires that the tag GENERATE_HTML is set to YES.14251426GENERATE_ECLIPSEHELP = NO14271428# A unique identifier for the Eclipse help plugin. When installing the plugin1429# the directory name containing the HTML and XML files should also have this1430# name. Each documentation set should have its own identifier.1431# The default value is: org.doxygen.Project.1432# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.14331434ECLIPSE_DOC_ID = org.doxygen.Project14351436# If you want full control over the layout of the generated HTML pages it might1437# be necessary to disable the index and replace it with your own. The1438# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1439# of each HTML page. A value of NO enables the index and the value YES disables1440# it. Since the tabs in the index contain the same information as the navigation1441# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1442# The default value is: NO.1443# This tag requires that the tag GENERATE_HTML is set to YES.14441445DISABLE_INDEX = NO14461447# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1448# structure should be generated to display hierarchical information. If the tag1449# value is set to YES, a side panel will be generated containing a tree-like1450# index structure (just like the one that is generated for HTML Help). For this1451# to work a browser that supports JavaScript, DHTML, CSS and frames is required1452# (i.e. any modern browser). Windows users are probably better off using the1453# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can1454# further fine-tune the look of the index. As an example, the default style1455# sheet generated by doxygen has an example that shows how to put an image at1456# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1457# the same information as the tab index, you could consider setting1458# DISABLE_INDEX to YES when enabling this option.1459# The default value is: NO.1460# This tag requires that the tag GENERATE_HTML is set to YES.14611462GENERATE_TREEVIEW = NO14631464# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1465# doxygen will group on one line in the generated HTML documentation.1466#1467# Note that a value of 0 will completely suppress the enum values from appearing1468# in the overview section.1469# Minimum value: 0, maximum value: 20, default value: 4.1470# This tag requires that the tag GENERATE_HTML is set to YES.14711472ENUM_VALUES_PER_LINE = 414731474# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1475# to set the initial width (in pixels) of the frame in which the tree is shown.1476# Minimum value: 0, maximum value: 1500, default value: 250.1477# This tag requires that the tag GENERATE_HTML is set to YES.14781479TREEVIEW_WIDTH = 25014801481# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to1482# external symbols imported via tag files in a separate window.1483# The default value is: NO.1484# This tag requires that the tag GENERATE_HTML is set to YES.14851486EXT_LINKS_IN_WINDOW = NO14871488# Use this tag to change the font size of LaTeX formulas included as images in1489# the HTML documentation. When you change the font size after a successful1490# doxygen run you need to manually remove any form_*.png images from the HTML1491# output directory to force them to be regenerated.1492# Minimum value: 8, maximum value: 50, default value: 10.1493# This tag requires that the tag GENERATE_HTML is set to YES.14941495FORMULA_FONTSIZE = 1014961497# Use the FORMULA_TRANPARENT tag to determine whether or not the images1498# generated for formulas are transparent PNGs. Transparent PNGs are not1499# supported properly for IE 6.0, but are supported on all modern browsers.1500#1501# Note that when changing this option you need to delete any form_*.png files in1502# the HTML output directory before the changes have effect.1503# The default value is: YES.1504# This tag requires that the tag GENERATE_HTML is set to YES.15051506FORMULA_TRANSPARENT = YES15071508# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1509# http://www.mathjax.org) which uses client side Javascript for the rendering1510# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX1511# installed or if you want to formulas look prettier in the HTML output. When1512# enabled you may also need to install MathJax separately and configure the path1513# to it using the MATHJAX_RELPATH option.1514# The default value is: NO.1515# This tag requires that the tag GENERATE_HTML is set to YES.15161517USE_MATHJAX = NO15181519# When MathJax is enabled you can set the default output format to be used for1520# the MathJax output. See the MathJax site (see:1521# http://docs.mathjax.org/en/latest/output.html) for more details.1522# Possible values are: HTML-CSS (which is slower, but has the best1523# compatibility), NativeMML (i.e. MathML) and SVG.1524# The default value is: HTML-CSS.1525# This tag requires that the tag USE_MATHJAX is set to YES.15261527MATHJAX_FORMAT = HTML-CSS15281529# When MathJax is enabled you need to specify the location relative to the HTML1530# output directory using the MATHJAX_RELPATH option. The destination directory1531# should contain the MathJax.js script. For instance, if the mathjax directory1532# is located at the same level as the HTML output directory, then1533# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1534# Content Delivery Network so you can quickly see the result without installing1535# MathJax. However, it is strongly recommended to install a local copy of1536# MathJax from http://www.mathjax.org before deployment.1537# The default value is: http://cdn.mathjax.org/mathjax/latest.1538# This tag requires that the tag USE_MATHJAX is set to YES.15391540MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest15411542# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1543# extension names that should be enabled during MathJax rendering. For example1544# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1545# This tag requires that the tag USE_MATHJAX is set to YES.15461547MATHJAX_EXTENSIONS =15481549# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1550# of code that will be used on startup of the MathJax code. See the MathJax site1551# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1552# example see the documentation.1553# This tag requires that the tag USE_MATHJAX is set to YES.15541555MATHJAX_CODEFILE =15561557# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1558# the HTML output. The underlying search engine uses javascript and DHTML and1559# should work on any modern browser. Note that when using HTML help1560# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1561# there is already a search function so this one should typically be disabled.1562# For large projects the javascript based search engine can be slow, then1563# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1564# search using the keyboard; to jump to the search box use <access key> + S1565# (what the <access key> is depends on the OS and browser, but it is typically1566# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1567# key> to jump into the search results window, the results can be navigated1568# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1569# the search. The filter options can be selected when the cursor is inside the1570# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1571# to select a filter and <Enter> or <escape> to activate or cancel the filter1572# option.1573# The default value is: YES.1574# This tag requires that the tag GENERATE_HTML is set to YES.15751576SEARCHENGINE = YES15771578# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1579# implemented using a web server instead of a web client using Javascript. There1580# are two flavors of web server based searching depending on the EXTERNAL_SEARCH1581# setting. When disabled, doxygen will generate a PHP script for searching and1582# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing1583# and searching needs to be provided by external tools. See the section1584# "External Indexing and Searching" for details.1585# The default value is: NO.1586# This tag requires that the tag SEARCHENGINE is set to YES.15871588SERVER_BASED_SEARCH = NO15891590# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1591# script for searching. Instead the search results are written to an XML file1592# which needs to be processed by an external indexer. Doxygen will invoke an1593# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1594# search results.1595#1596# Doxygen ships with an example indexer (doxyindexer) and search engine1597# (doxysearch.cgi) which are based on the open source search engine library1598# Xapian (see: http://xapian.org/).1599#1600# See the section "External Indexing and Searching" for details.1601# The default value is: NO.1602# This tag requires that the tag SEARCHENGINE is set to YES.16031604EXTERNAL_SEARCH = NO16051606# The SEARCHENGINE_URL should point to a search engine hosted by a web server1607# which will return the search results when EXTERNAL_SEARCH is enabled.1608#1609# Doxygen ships with an example indexer (doxyindexer) and search engine1610# (doxysearch.cgi) which are based on the open source search engine library1611# Xapian (see: http://xapian.org/). See the section "External Indexing and1612# Searching" for details.1613# This tag requires that the tag SEARCHENGINE is set to YES.16141615SEARCHENGINE_URL =16161617# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1618# search data is written to a file for indexing by an external tool. With the1619# SEARCHDATA_FILE tag the name of this file can be specified.1620# The default file is: searchdata.xml.1621# This tag requires that the tag SEARCHENGINE is set to YES.16221623SEARCHDATA_FILE = searchdata.xml16241625# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1626# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1627# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1628# projects and redirect the results back to the right project.1629# This tag requires that the tag SEARCHENGINE is set to YES.16301631EXTERNAL_SEARCH_ID =16321633# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1634# projects other than the one defined by this configuration file, but that are1635# all added to the same external search index. Each project needs to have a1636# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1637# to a relative location where the documentation can be found. The format is:1638# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1639# This tag requires that the tag SEARCHENGINE is set to YES.16401641EXTRA_SEARCH_MAPPINGS =16421643#---------------------------------------------------------------------------1644# Configuration options related to the LaTeX output1645#---------------------------------------------------------------------------16461647# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.1648# The default value is: YES.16491650GENERATE_LATEX = NO16511652# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1653# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1654# it.1655# The default directory is: latex.1656# This tag requires that the tag GENERATE_LATEX is set to YES.16571658LATEX_OUTPUT = latex16591660# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1661# invoked.1662#1663# Note that when enabling USE_PDFLATEX this option is only used for generating1664# bitmaps for formulas in the HTML output, but not in the Makefile that is1665# written to the output directory.1666# The default file is: latex.1667# This tag requires that the tag GENERATE_LATEX is set to YES.16681669LATEX_CMD_NAME = latex16701671# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1672# index for LaTeX.1673# The default file is: makeindex.1674# This tag requires that the tag GENERATE_LATEX is set to YES.16751676MAKEINDEX_CMD_NAME = makeindex16771678# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX1679# documents. This may be useful for small projects and may help to save some1680# trees in general.1681# The default value is: NO.1682# This tag requires that the tag GENERATE_LATEX is set to YES.16831684COMPACT_LATEX = NO16851686# The PAPER_TYPE tag can be used to set the paper type that is used by the1687# printer.1688# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1689# 14 inches) and executive (7.25 x 10.5 inches).1690# The default value is: a4.1691# This tag requires that the tag GENERATE_LATEX is set to YES.16921693PAPER_TYPE = a416941695# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1696# that should be included in the LaTeX output. The package can be specified just1697# by its name or with the correct syntax as to be used with the LaTeX1698# \usepackage command. To get the times font for instance you can specify :1699# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}1700# To use the option intlimits with the amsmath package you can specify:1701# EXTRA_PACKAGES=[intlimits]{amsmath}1702# If left blank no extra packages will be included.1703# This tag requires that the tag GENERATE_LATEX is set to YES.17041705EXTRA_PACKAGES =17061707# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1708# generated LaTeX document. The header should contain everything until the first1709# chapter. If it is left blank doxygen will generate a standard header. See1710# section "Doxygen usage" for information on how to let doxygen write the1711# default header to a separate file.1712#1713# Note: Only use a user-defined header if you know what you are doing! The1714# following commands have a special meaning inside the header: $title,1715# $datetime, $date, $doxygenversion, $projectname, $projectnumber,1716# $projectbrief, $projectlogo. Doxygen will replace $title with the empty1717# string, for the replacement values of the other commands the user is referred1718# to HTML_HEADER.1719# This tag requires that the tag GENERATE_LATEX is set to YES.17201721LATEX_HEADER =17221723# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1724# generated LaTeX document. The footer should contain everything after the last1725# chapter. If it is left blank doxygen will generate a standard footer. See1726# LATEX_HEADER for more information on how to generate a default footer and what1727# special commands can be used inside the footer.1728#1729# Note: Only use a user-defined footer if you know what you are doing!1730# This tag requires that the tag GENERATE_LATEX is set to YES.17311732LATEX_FOOTER =17331734# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined1735# LaTeX style sheets that are included after the standard style sheets created1736# by doxygen. Using this option one can overrule certain style aspects. Doxygen1737# will copy the style sheet files to the output directory.1738# Note: The order of the extra style sheet files is of importance (e.g. the last1739# style sheet in the list overrules the setting of the previous ones in the1740# list).1741# This tag requires that the tag GENERATE_LATEX is set to YES.17421743LATEX_EXTRA_STYLESHEET =17441745# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1746# other source files which should be copied to the LATEX_OUTPUT output1747# directory. Note that the files will be copied as-is; there are no commands or1748# markers available.1749# This tag requires that the tag GENERATE_LATEX is set to YES.17501751LATEX_EXTRA_FILES =17521753# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1754# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1755# contain links (just like the HTML output) instead of page references. This1756# makes the output suitable for online browsing using a PDF viewer.1757# The default value is: YES.1758# This tag requires that the tag GENERATE_LATEX is set to YES.17591760PDF_HYPERLINKS = YES17611762# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1763# the PDF file directly from the LaTeX files. Set this option to YES, to get a1764# higher quality PDF documentation.1765# The default value is: YES.1766# This tag requires that the tag GENERATE_LATEX is set to YES.17671768USE_PDFLATEX = YES17691770# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1771# command to the generated LaTeX files. This will instruct LaTeX to keep running1772# if errors occur, instead of asking the user for help. This option is also used1773# when generating formulas in HTML.1774# The default value is: NO.1775# This tag requires that the tag GENERATE_LATEX is set to YES.17761777LATEX_BATCHMODE = NO17781779# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1780# index chapters (such as File Index, Compound Index, etc.) in the output.1781# The default value is: NO.1782# This tag requires that the tag GENERATE_LATEX is set to YES.17831784LATEX_HIDE_INDICES = NO17851786# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1787# code with syntax highlighting in the LaTeX output.1788#1789# Note that which sources are shown also depends on other settings such as1790# SOURCE_BROWSER.1791# The default value is: NO.1792# This tag requires that the tag GENERATE_LATEX is set to YES.17931794LATEX_SOURCE_CODE = NO17951796# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1797# bibliography, e.g. plainnat, or ieeetr. See1798# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1799# The default value is: plain.1800# This tag requires that the tag GENERATE_LATEX is set to YES.18011802LATEX_BIB_STYLE = plain18031804# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated1805# page will contain the date and time when the page was generated. Setting this1806# to NO can help when comparing the output of multiple runs.1807# The default value is: NO.1808# This tag requires that the tag GENERATE_LATEX is set to YES.18091810LATEX_TIMESTAMP = NO18111812#---------------------------------------------------------------------------1813# Configuration options related to the RTF output1814#---------------------------------------------------------------------------18151816# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The1817# RTF output is optimized for Word 97 and may not look too pretty with other RTF1818# readers/editors.1819# The default value is: NO.18201821GENERATE_RTF = NO18221823# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1824# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1825# it.1826# The default directory is: rtf.1827# This tag requires that the tag GENERATE_RTF is set to YES.18281829RTF_OUTPUT = rtf18301831# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF1832# documents. This may be useful for small projects and may help to save some1833# trees in general.1834# The default value is: NO.1835# This tag requires that the tag GENERATE_RTF is set to YES.18361837COMPACT_RTF = NO18381839# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1840# contain hyperlink fields. The RTF file will contain links (just like the HTML1841# output) instead of page references. This makes the output suitable for online1842# browsing using Word or some other Word compatible readers that support those1843# fields.1844#1845# Note: WordPad (write) and others do not support links.1846# The default value is: NO.1847# This tag requires that the tag GENERATE_RTF is set to YES.18481849RTF_HYPERLINKS = NO18501851# Load stylesheet definitions from file. Syntax is similar to doxygen's config1852# file, i.e. a series of assignments. You only have to provide replacements,1853# missing definitions are set to their default value.1854#1855# See also section "Doxygen usage" for information on how to generate the1856# default style sheet that doxygen normally uses.1857# This tag requires that the tag GENERATE_RTF is set to YES.18581859RTF_STYLESHEET_FILE =18601861# Set optional variables used in the generation of an RTF document. Syntax is1862# similar to doxygen's config file. A template extensions file can be generated1863# using doxygen -e rtf extensionFile.1864# This tag requires that the tag GENERATE_RTF is set to YES.18651866RTF_EXTENSIONS_FILE =18671868# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code1869# with syntax highlighting in the RTF output.1870#1871# Note that which sources are shown also depends on other settings such as1872# SOURCE_BROWSER.1873# The default value is: NO.1874# This tag requires that the tag GENERATE_RTF is set to YES.18751876RTF_SOURCE_CODE = NO18771878#---------------------------------------------------------------------------1879# Configuration options related to the man page output1880#---------------------------------------------------------------------------18811882# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for1883# classes and files.1884# The default value is: NO.18851886GENERATE_MAN = NO18871888# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1889# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1890# it. A directory man3 will be created inside the directory specified by1891# MAN_OUTPUT.1892# The default directory is: man.1893# This tag requires that the tag GENERATE_MAN is set to YES.18941895MAN_OUTPUT = man18961897# The MAN_EXTENSION tag determines the extension that is added to the generated1898# man pages. In case the manual section does not start with a number, the number1899# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1900# optional.1901# The default value is: .3.1902# This tag requires that the tag GENERATE_MAN is set to YES.19031904MAN_EXTENSION = .319051906# The MAN_SUBDIR tag determines the name of the directory created within1907# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by1908# MAN_EXTENSION with the initial . removed.1909# This tag requires that the tag GENERATE_MAN is set to YES.19101911MAN_SUBDIR =19121913# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1914# will generate one additional man file for each entity documented in the real1915# man page(s). These additional files only source the real man page, but without1916# them the man command would be unable to find the correct page.1917# The default value is: NO.1918# This tag requires that the tag GENERATE_MAN is set to YES.19191920MAN_LINKS = NO19211922#---------------------------------------------------------------------------1923# Configuration options related to the XML output1924#---------------------------------------------------------------------------19251926# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that1927# captures the structure of the code including all documentation.1928# The default value is: NO.19291930GENERATE_XML = NO19311932# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1933# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1934# it.1935# The default directory is: xml.1936# This tag requires that the tag GENERATE_XML is set to YES.19371938XML_OUTPUT = xml19391940# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program1941# listings (including syntax highlighting and cross-referencing information) to1942# the XML output. Note that enabling this will significantly increase the size1943# of the XML output.1944# The default value is: YES.1945# This tag requires that the tag GENERATE_XML is set to YES.19461947XML_PROGRAMLISTING = YES19481949#---------------------------------------------------------------------------1950# Configuration options related to the DOCBOOK output1951#---------------------------------------------------------------------------19521953# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files1954# that can be used to generate PDF.1955# The default value is: NO.19561957GENERATE_DOCBOOK = NO19581959# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1960# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1961# front of it.1962# The default directory is: docbook.1963# This tag requires that the tag GENERATE_DOCBOOK is set to YES.19641965DOCBOOK_OUTPUT = docbook19661967# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the1968# program listings (including syntax highlighting and cross-referencing1969# information) to the DOCBOOK output. Note that enabling this will significantly1970# increase the size of the DOCBOOK output.1971# The default value is: NO.1972# This tag requires that the tag GENERATE_DOCBOOK is set to YES.19731974DOCBOOK_PROGRAMLISTING = NO19751976#---------------------------------------------------------------------------1977# Configuration options for the AutoGen Definitions output1978#---------------------------------------------------------------------------19791980# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an1981# AutoGen Definitions (see http://autogen.sf.net) file that captures the1982# structure of the code including all documentation. Note that this feature is1983# still experimental and incomplete at the moment.1984# The default value is: NO.19851986GENERATE_AUTOGEN_DEF = NO19871988#---------------------------------------------------------------------------1989# Configuration options related to the Perl module output1990#---------------------------------------------------------------------------19911992# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module1993# file that captures the structure of the code including all documentation.1994#1995# Note that this feature is still experimental and incomplete at the moment.1996# The default value is: NO.19971998GENERATE_PERLMOD = NO19992000# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary2001# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI2002# output from the Perl module output.2003# The default value is: NO.2004# This tag requires that the tag GENERATE_PERLMOD is set to YES.20052006PERLMOD_LATEX = NO20072008# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely2009# formatted so it can be parsed by a human reader. This is useful if you want to2010# understand what is going on. On the other hand, if this tag is set to NO, the2011# size of the Perl module output will be much smaller and Perl will parse it2012# just the same.2013# The default value is: YES.2014# This tag requires that the tag GENERATE_PERLMOD is set to YES.20152016PERLMOD_PRETTY = YES20172018# The names of the make variables in the generated doxyrules.make file are2019# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful2020# so different doxyrules.make files included by the same Makefile don't2021# overwrite each other's variables.2022# This tag requires that the tag GENERATE_PERLMOD is set to YES.20232024PERLMOD_MAKEVAR_PREFIX =20252026#---------------------------------------------------------------------------2027# Configuration options related to the preprocessor2028#---------------------------------------------------------------------------20292030# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all2031# C-preprocessor directives found in the sources and include files.2032# The default value is: YES.20332034ENABLE_PREPROCESSING = YES20352036# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names2037# in the source code. If set to NO, only conditional compilation will be2038# performed. Macro expansion can be done in a controlled way by setting2039# EXPAND_ONLY_PREDEF to YES.2040# The default value is: NO.2041# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.20422043MACRO_EXPANSION = NO20442045# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then2046# the macro expansion is limited to the macros specified with the PREDEFINED and2047# EXPAND_AS_DEFINED tags.2048# The default value is: NO.2049# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.20502051EXPAND_ONLY_PREDEF = NO20522053# If the SEARCH_INCLUDES tag is set to YES, the include files in the2054# INCLUDE_PATH will be searched if a #include is found.2055# The default value is: YES.2056# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.20572058SEARCH_INCLUDES = YES20592060# The INCLUDE_PATH tag can be used to specify one or more directories that2061# contain include files that are not input files but should be processed by the2062# preprocessor.2063# This tag requires that the tag SEARCH_INCLUDES is set to YES.20642065INCLUDE_PATH =20662067# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard2068# patterns (like *.h and *.hpp) to filter out the header-files in the2069# directories. If left blank, the patterns specified with FILE_PATTERNS will be2070# used.2071# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.20722073INCLUDE_FILE_PATTERNS =20742075# The PREDEFINED tag can be used to specify one or more macro names that are2076# defined before the preprocessor is started (similar to the -D option of e.g.2077# gcc). The argument of the tag is a list of macros of the form: name or2078# name=definition (no spaces). If the definition and the "=" are omitted, "=1"2079# is assumed. To prevent a macro definition from being undefined via #undef or2080# recursively expanded use the := operator instead of the = operator.2081# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.20822083PREDEFINED =20842085# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this2086# tag can be used to specify a list of macro names that should be expanded. The2087# macro definition that is found in the sources will be used. Use the PREDEFINED2088# tag if you want to use a different macro definition that overrules the2089# definition found in the source code.2090# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.20912092EXPAND_AS_DEFINED =20932094# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will2095# remove all references to function-like macros that are alone on a line, have2096# an all uppercase name, and do not end with a semicolon. Such function macros2097# are typically used for boiler-plate code, and will confuse the parser if not2098# removed.2099# The default value is: YES.2100# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.21012102SKIP_FUNCTION_MACROS = YES21032104#---------------------------------------------------------------------------2105# Configuration options related to external references2106#---------------------------------------------------------------------------21072108# The TAGFILES tag can be used to specify one or more tag files. For each tag2109# file the location of the external documentation should be added. The format of2110# a tag file without this location is as follows:2111# TAGFILES = file1 file2 ...2112# Adding location for the tag files is done as follows:2113# TAGFILES = file1=loc1 "file2 = loc2" ...2114# where loc1 and loc2 can be relative or absolute paths or URLs. See the2115# section "Linking to external documentation" for more information about the use2116# of tag files.2117# Note: Each tag file must have a unique name (where the name does NOT include2118# the path). If a tag file is not located in the directory in which doxygen is2119# run, you must also specify the path to the tagfile here.21202121TAGFILES =21222123# When a file name is specified after GENERATE_TAGFILE, doxygen will create a2124# tag file that is based on the input files it reads. See section "Linking to2125# external documentation" for more information about the usage of tag files.21262127GENERATE_TAGFILE =21282129# If the ALLEXTERNALS tag is set to YES, all external class will be listed in2130# the class index. If set to NO, only the inherited external classes will be2131# listed.2132# The default value is: NO.21332134ALLEXTERNALS = NO21352136# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed2137# in the modules index. If set to NO, only the current project's groups will be2138# listed.2139# The default value is: YES.21402141EXTERNAL_GROUPS = YES21422143# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in2144# the related pages index. If set to NO, only the current project's pages will2145# be listed.2146# The default value is: YES.21472148EXTERNAL_PAGES = YES21492150# The PERL_PATH should be the absolute path and name of the perl script2151# interpreter (i.e. the result of 'which perl').2152# The default file (with absolute path) is: /usr/bin/perl.21532154PERL_PATH = /usr/bin/perl21552156#---------------------------------------------------------------------------2157# Configuration options related to the dot tool2158#---------------------------------------------------------------------------21592160# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram2161# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2162# NO turns the diagrams off. Note that this option also works with HAVE_DOT2163# disabled, but it is recommended to install and use dot, since it yields more2164# powerful graphs.2165# The default value is: YES.21662167CLASS_DIAGRAMS = YES21682169# You can define message sequence charts within doxygen comments using the \msc2170# command. Doxygen will then run the mscgen tool (see:2171# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2172# documentation. The MSCGEN_PATH tag allows you to specify the directory where2173# the mscgen tool resides. If left empty the tool is assumed to be found in the2174# default search path.21752176MSCGEN_PATH =21772178# You can include diagrams made with dia in doxygen documentation. Doxygen will2179# then run dia to produce the diagram and insert it in the documentation. The2180# DIA_PATH tag allows you to specify the directory where the dia binary resides.2181# If left empty dia is assumed to be found in the default search path.21822183DIA_PATH =21842185# If set to YES the inheritance and collaboration graphs will hide inheritance2186# and usage relations if the target is undocumented or is not a class.2187# The default value is: YES.21882189HIDE_UNDOC_RELATIONS = YES21902191# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2192# available from the path. This tool is part of Graphviz (see:2193# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2194# Bell Labs. The other options in this section have no effect if this option is2195# set to NO2196# The default value is: NO.21972198HAVE_DOT = NO21992200# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2201# to run in parallel. When set to 0 doxygen will base this on the number of2202# processors available in the system. You can set it explicitly to a value2203# larger than 0 to get control over the balance between CPU load and processing2204# speed.2205# Minimum value: 0, maximum value: 32, default value: 0.2206# This tag requires that the tag HAVE_DOT is set to YES.22072208DOT_NUM_THREADS = 022092210# When you want a differently looking font in the dot files that doxygen2211# generates you can specify the font name using DOT_FONTNAME. You need to make2212# sure dot is able to find the font, which can be done by putting it in a2213# standard location or by setting the DOTFONTPATH environment variable or by2214# setting DOT_FONTPATH to the directory containing the font.2215# The default value is: Helvetica.2216# This tag requires that the tag HAVE_DOT is set to YES.22172218DOT_FONTNAME = Helvetica22192220# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2221# dot graphs.2222# Minimum value: 4, maximum value: 24, default value: 10.2223# This tag requires that the tag HAVE_DOT is set to YES.22242225DOT_FONTSIZE = 1022262227# By default doxygen will tell dot to use the default font as specified with2228# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2229# the path where dot can find it using this tag.2230# This tag requires that the tag HAVE_DOT is set to YES.22312232DOT_FONTPATH =22332234# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2235# each documented class showing the direct and indirect inheritance relations.2236# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2237# The default value is: YES.2238# This tag requires that the tag HAVE_DOT is set to YES.22392240CLASS_GRAPH = YES22412242# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2243# graph for each documented class showing the direct and indirect implementation2244# dependencies (inheritance, containment, and class references variables) of the2245# class with other documented classes.2246# The default value is: YES.2247# This tag requires that the tag HAVE_DOT is set to YES.22482249COLLABORATION_GRAPH = YES22502251# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2252# groups, showing the direct groups dependencies.2253# The default value is: YES.2254# This tag requires that the tag HAVE_DOT is set to YES.22552256GROUP_GRAPHS = YES22572258# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and2259# collaboration diagrams in a style similar to the OMG's Unified Modeling2260# Language.2261# The default value is: NO.2262# This tag requires that the tag HAVE_DOT is set to YES.22632264UML_LOOK = NO22652266# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2267# class node. If there are many fields or methods and many nodes the graph may2268# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2269# number of items for each type to make the size more manageable. Set this to 02270# for no limit. Note that the threshold may be exceeded by 50% before the limit2271# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2272# but if the number exceeds 15, the total amount of fields shown is limited to2273# 10.2274# Minimum value: 0, maximum value: 100, default value: 10.2275# This tag requires that the tag HAVE_DOT is set to YES.22762277UML_LIMIT_NUM_FIELDS = 1022782279# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2280# collaboration graphs will show the relations between templates and their2281# instances.2282# The default value is: NO.2283# This tag requires that the tag HAVE_DOT is set to YES.22842285TEMPLATE_RELATIONS = NO22862287# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2288# YES then doxygen will generate a graph for each documented file showing the2289# direct and indirect include dependencies of the file with other documented2290# files.2291# The default value is: YES.2292# This tag requires that the tag HAVE_DOT is set to YES.22932294INCLUDE_GRAPH = YES22952296# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2297# set to YES then doxygen will generate a graph for each documented file showing2298# the direct and indirect include dependencies of the file with other documented2299# files.2300# The default value is: YES.2301# This tag requires that the tag HAVE_DOT is set to YES.23022303INCLUDED_BY_GRAPH = YES23042305# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2306# dependency graph for every global function or class method.2307#2308# Note that enabling this option will significantly increase the time of a run.2309# So in most cases it will be better to enable call graphs for selected2310# functions only using the \callgraph command. Disabling a call graph can be2311# accomplished by means of the command \hidecallgraph.2312# The default value is: NO.2313# This tag requires that the tag HAVE_DOT is set to YES.23142315CALL_GRAPH = NO23162317# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2318# dependency graph for every global function or class method.2319#2320# Note that enabling this option will significantly increase the time of a run.2321# So in most cases it will be better to enable caller graphs for selected2322# functions only using the \callergraph command. Disabling a caller graph can be2323# accomplished by means of the command \hidecallergraph.2324# The default value is: NO.2325# This tag requires that the tag HAVE_DOT is set to YES.23262327CALLER_GRAPH = NO23282329# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2330# hierarchy of all classes instead of a textual one.2331# The default value is: YES.2332# This tag requires that the tag HAVE_DOT is set to YES.23332334GRAPHICAL_HIERARCHY = YES23352336# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2337# dependencies a directory has on other directories in a graphical way. The2338# dependency relations are determined by the #include relations between the2339# files in the directories.2340# The default value is: YES.2341# This tag requires that the tag HAVE_DOT is set to YES.23422343DIRECTORY_GRAPH = YES23442345# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2346# generated by dot. For an explanation of the image formats see the section2347# output formats in the documentation of the dot tool (Graphviz (see:2348# http://www.graphviz.org/)).2349# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2350# to make the SVG files visible in IE 9+ (other browsers do not have this2351# requirement).2352# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,2353# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and2354# png:gdiplus:gdiplus.2355# The default value is: png.2356# This tag requires that the tag HAVE_DOT is set to YES.23572358DOT_IMAGE_FORMAT = png23592360# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2361# enable generation of interactive SVG images that allow zooming and panning.2362#2363# Note that this requires a modern browser other than Internet Explorer. Tested2364# and working are Firefox, Chrome, Safari, and Opera.2365# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2366# the SVG files visible. Older versions of IE do not have SVG support.2367# The default value is: NO.2368# This tag requires that the tag HAVE_DOT is set to YES.23692370INTERACTIVE_SVG = NO23712372# The DOT_PATH tag can be used to specify the path where the dot tool can be2373# found. If left blank, it is assumed the dot tool can be found in the path.2374# This tag requires that the tag HAVE_DOT is set to YES.23752376DOT_PATH =23772378# The DOTFILE_DIRS tag can be used to specify one or more directories that2379# contain dot files that are included in the documentation (see the \dotfile2380# command).2381# This tag requires that the tag HAVE_DOT is set to YES.23822383DOTFILE_DIRS =23842385# The MSCFILE_DIRS tag can be used to specify one or more directories that2386# contain msc files that are included in the documentation (see the \mscfile2387# command).23882389MSCFILE_DIRS =23902391# The DIAFILE_DIRS tag can be used to specify one or more directories that2392# contain dia files that are included in the documentation (see the \diafile2393# command).23942395DIAFILE_DIRS =23962397# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the2398# path where java can find the plantuml.jar file. If left blank, it is assumed2399# PlantUML is not used or called during a preprocessing step. Doxygen will2400# generate a warning when it encounters a \startuml command in this case and2401# will not generate output for the diagram.24022403PLANTUML_JAR_PATH =24042405# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a2406# configuration file for plantuml.24072408PLANTUML_CFG_FILE =24092410# When using plantuml, the specified paths are searched for files specified by2411# the !include statement in a plantuml block.24122413PLANTUML_INCLUDE_PATH =24142415# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2416# that will be shown in the graph. If the number of nodes in a graph becomes2417# larger than this value, doxygen will truncate the graph, which is visualized2418# by representing a node as a red box. Note that doxygen if the number of direct2419# children of the root node in a graph is already larger than2420# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2421# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2422# Minimum value: 0, maximum value: 10000, default value: 50.2423# This tag requires that the tag HAVE_DOT is set to YES.24242425DOT_GRAPH_MAX_NODES = 5024262427# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2428# generated by dot. A depth value of 3 means that only nodes reachable from the2429# root by following a path via at most 3 edges will be shown. Nodes that lay2430# further from the root node will be omitted. Note that setting this option to 12431# or 2 may greatly reduce the computation time needed for large code bases. Also2432# note that the size of a graph can be further restricted by2433# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2434# Minimum value: 0, maximum value: 1000, default value: 0.2435# This tag requires that the tag HAVE_DOT is set to YES.24362437MAX_DOT_GRAPH_DEPTH = 024382439# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2440# background. This is disabled by default, because dot on Windows does not seem2441# to support this out of the box.2442#2443# Warning: Depending on the platform used, enabling this option may lead to2444# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2445# read).2446# The default value is: NO.2447# This tag requires that the tag HAVE_DOT is set to YES.24482449DOT_TRANSPARENT = NO24502451# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output2452# files in one run (i.e. multiple -o and -T options on the command line). This2453# makes dot run faster, but since only newer versions of dot (>1.8.10) support2454# this, this feature is disabled by default.2455# The default value is: NO.2456# This tag requires that the tag HAVE_DOT is set to YES.24572458DOT_MULTI_TARGETS = NO24592460# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2461# explaining the meaning of the various boxes and arrows in the dot generated2462# graphs.2463# The default value is: YES.2464# This tag requires that the tag HAVE_DOT is set to YES.24652466GENERATE_LEGEND = YES24672468# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot2469# files that are used to generate the various graphs.2470# The default value is: YES.2471# This tag requires that the tag HAVE_DOT is set to YES.24722473DOT_CLEANUP = YES