cvm
/
Doxyfile
2658 строк · 113.7 Кб
1# Doxyfile 1.9.12# This file describes the settings to be used by the documentation system4# doxygen (www.doxygen.org) for a project.5#6# All text after a double hash (##) is considered a comment and is placed in7# front of the TAG it is preceding.8#9# All text after a single hash (#) is considered a comment and will be ignored.10# The format is:11# TAG = value [value, ...]12# For lists, items can also be appended using:13# TAG += value [value, ...]14# Values that contain spaces should be placed between quotes (\" \").15#---------------------------------------------------------------------------17# Project related configuration options18#---------------------------------------------------------------------------19# This tag specifies the encoding used for all characters in the configuration21# file that follow. The default is UTF-8 which is also the encoding used for all22# text before the first occurrence of this tag. Doxygen uses libiconv (or the23# iconv built into libc) for the transcoding. See24# https://www.gnu.org/software/libiconv/ for the list of possible encodings.25# The default value is: UTF-8.26DOXYFILE_ENCODING = UTF-828# 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.34PROJECT_NAME = "C"36# 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.40PROJECT_NUMBER =42# 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.46PROJECT_BRIEF =48# 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.53PROJECT_LOGO =55# 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.60OUTPUT_DIRECTORY = doxygen62# 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.70CREATE_SUBDIRS = NO72# 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.78ALLOW_UNICODE_NAMES = NO80# 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.93OUTPUT_LANGUAGE = English95# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all97# documentation generated by doxygen is written. Doxygen will use this98# information to generate all generated output in the proper direction.99# Possible values are: None, LTR, RTL and Context.100# The default value is: None.101OUTPUT_TEXT_DIRECTION = None103# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member105# descriptions after the members that are listed in the file and class106# documentation (similar to Javadoc). Set to NO to disable this.107# The default value is: YES.108BRIEF_MEMBER_DESC = YES110# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief112# description of a member or function before the detailed description113#114# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the115# brief descriptions will be completely suppressed.116# The default value is: YES.117REPEAT_BRIEF = YES119# This tag implements a quasi-intelligent brief description abbreviator that is121# used to form the text in various listings. Each string in this list, if found122# as the leading text of the brief description, will be stripped from the text123# and the result, after processing the whole list, is used as the annotated124# text. Otherwise, the brief description is used as-is. If left blank, the125# following values are used ($name is automatically replaced with the name of126# the entity):The $name class, The $name widget, The $name file, is, provides,127# specifies, contains, represents, a, an and the.128ABBREVIATE_BRIEF = "The $name class" \130"The $name widget" \131"The $name file" \132is \133provides \134specifies \135contains \136represents \137a \138an \139the140# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then142# doxygen will generate a detailed section even if there is only a brief143# description.144# The default value is: NO.145ALWAYS_DETAILED_SEC = NO147# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all149# inherited members of a class in the documentation of that class as if those150# members were ordinary class members. Constructors, destructors and assignment151# operators of the base classes will not be shown.152# The default value is: NO.153INLINE_INHERITED_MEMB = NO155# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path157# before files name in the file list and in the header files. If set to NO the158# shortest path that makes the file name unique will be used159# The default value is: YES.160FULL_PATH_NAMES = YES162# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.164# Stripping is only done if one of the specified strings matches the left-hand165# part of the path. The tag can be used to show relative paths in the file list.166# If left blank the directory from which doxygen is run is used as the path to167# strip.168#169# Note that you can specify absolute paths here, but also relative paths, which170# will be relative from the directory where doxygen is started.171# This tag requires that the tag FULL_PATH_NAMES is set to YES.172STRIP_FROM_PATH =174# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the176# path mentioned in the documentation of a class, which tells the reader which177# header file to include in order to use a class. If left blank only the name of178# the header file containing the class definition is used. Otherwise one should179# specify the list of include paths that are normally passed to the compiler180# using the -I flag.181STRIP_FROM_INC_PATH =183# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but185# less readable) file names. This can be useful is your file systems doesn't186# support long names like on DOS, Mac, or CD-ROM.187# The default value is: NO.188SHORT_NAMES = NO190# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the192# first line (until the first dot) of a Javadoc-style comment as the brief193# description. If set to NO, the Javadoc-style will behave just like regular Qt-194# style comments (thus requiring an explicit @brief command for a brief195# description.)196# The default value is: NO.197JAVADOC_AUTOBRIEF = NO199# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line201# such as202# /***************203# as being the beginning of a Javadoc-style comment "banner". If set to NO, the204# Javadoc-style will behave just like regular comments and it will not be205# interpreted by doxygen.206# The default value is: NO.207JAVADOC_BANNER = NO209# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first211# line (until the first dot) of a Qt-style comment as the brief description. If212# set to NO, the Qt-style will behave just like regular Qt-style comments (thus213# requiring an explicit \brief command for a brief description.)214# The default value is: NO.215QT_AUTOBRIEF = NO217# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a219# multi-line C++ special comment block (i.e. a block of //! or /// comments) as220# a brief description. This used to be the default behavior. The new default is221# to treat a multi-line C++ comment block as a detailed description. Set this222# tag to YES if you prefer the old behavior instead.223#224# Note that setting this tag to YES also means that rational rose comments are225# not recognized any more.226# The default value is: NO.227MULTILINE_CPP_IS_BRIEF = NO229# By default Python docstrings are displayed as preformatted text and doxygen's231# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the232# doxygen's special commands can be used and the contents of the docstring233# documentation blocks is shown as doxygen documentation.234# The default value is: YES.235PYTHON_DOCSTRING = YES237# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the239# documentation from any documented member that it re-implements.240# The default value is: YES.241INHERIT_DOCS = YES243# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new245# page for each member. If set to NO, the documentation of a member will be part246# of the file/class/namespace that contains it.247# The default value is: NO.248SEPARATE_MEMBER_PAGES = NO250# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen252# uses this value to replace tabs by spaces in code fragments.253# Minimum value: 1, maximum value: 16, default value: 4.254TAB_SIZE = 4256# This tag can be used to specify a number of aliases that act as commands in258# the documentation. An alias has the form:259# name=value260# For example adding261# "sideeffect=@par Side Effects:\n"262# will allow you to put the command \sideeffect (or @sideeffect) in the263# documentation, which will result in a user-defined paragraph with heading264# "Side Effects:". You can put \n's in the value part of an alias to insert265# newlines (in the resulting output). You can put ^^ in the value part of an266# alias to insert a newline as if a physical newline was in the original file.267# When you need a literal { or } or , in the value part of an alias you have to268# escape them by means of a backslash (\), this can lead to conflicts with the269# commands \{ and \} for these it is advised to use the version @{ and @} or use270# a double escape (\\{ and \\})271ALIASES =273# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources275# only. Doxygen will then generate output that is more tailored for C. For276# instance, some of the names that are used will be different. The list of all277# members will be omitted, etc.278# The default value is: NO.279OPTIMIZE_OUTPUT_FOR_C = NO281# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or283# Python sources only. Doxygen will then generate output that is more tailored284# for that language. For instance, namespaces will be presented as packages,285# qualified scopes will look different, etc.286# The default value is: NO.287OPTIMIZE_OUTPUT_JAVA = NO289# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran291# sources. Doxygen will then generate output that is tailored for Fortran.292# The default value is: NO.293OPTIMIZE_FOR_FORTRAN = NO295# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL297# sources. Doxygen will then generate output that is tailored for VHDL.298# The default value is: NO.299OPTIMIZE_OUTPUT_VHDL = NO301# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice303# sources only. Doxygen will then generate output that is more tailored for that304# language. For instance, namespaces will be presented as modules, types will be305# separated into more groups, etc.306# The default value is: NO.307OPTIMIZE_OUTPUT_SLICE = NO309# Doxygen selects the parser to use depending on the extension of the files it311# parses. With this tag you can assign which parser to use for a given312# extension. Doxygen has a built-in mapping, but you can override or extend it313# using this tag. The format is ext=language, where ext is a file extension, and314# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,315# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,316# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:317# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser318# tries to guess whether the code is fixed or free formatted code, this is the319# default for Fortran type files). For instance to make doxygen treat .inc files320# as Fortran files (default is PHP), and .f files as C (default is Fortran),321# use: inc=Fortran f=C.322#323# Note: For files without extension you can use no_extension as a placeholder.324#325# Note that for custom extensions you also need to set FILE_PATTERNS otherwise326# the files are not read by doxygen. When specifying no_extension you should add327# * to the FILE_PATTERNS.328#329# Note see also the list of default file extension mappings.330EXTENSION_MAPPING =332# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments334# according to the Markdown format, which allows for more readable335# documentation. See https://daringfireball.net/projects/markdown/ for details.336# The output of markdown processing is further processed by doxygen, so you can337# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in338# case of backward compatibilities issues.339# The default value is: YES.340MARKDOWN_SUPPORT = YES342# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up344# to that level are automatically included in the table of contents, even if345# they do not have an id attribute.346# Note: This feature currently applies only to Markdown headings.347# Minimum value: 0, maximum value: 99, default value: 5.348# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.349TOC_INCLUDE_HEADINGS = 5351# When enabled doxygen tries to link words that correspond to documented353# classes, or namespaces to their corresponding documentation. Such a link can354# be prevented in individual cases by putting a % sign in front of the word or355# globally by setting AUTOLINK_SUPPORT to NO.356# The default value is: YES.357AUTOLINK_SUPPORT = YES359# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want361# to include (a tag file for) the STL sources as input, then you should set this362# tag to YES in order to let doxygen match functions declarations and363# definitions whose arguments contain STL classes (e.g. func(std::string);364# versus func(std::string) {}). This also make the inheritance and collaboration365# diagrams that involve STL classes more complete and accurate.366# The default value is: NO.367BUILTIN_STL_SUPPORT = NO369# If you use Microsoft's C++/CLI language, you should set this option to YES to371# enable parsing support.372# The default value is: NO.373CPP_CLI_SUPPORT = NO375# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:377# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen378# will parse them like normal C++ but will assume all classes use public instead379# of private inheritance when no explicit protection keyword is present.380# The default value is: NO.381SIP_SUPPORT = NO383# For Microsoft's IDL there are propget and propput attributes to indicate385# getter and setter methods for a property. Setting this option to YES will make386# doxygen to replace the get and set methods by a property in the documentation.387# This will only work if the methods are indeed getting or setting a simple388# type. If this is not the case, or you want to show the methods anyway, you389# should set this option to NO.390# The default value is: YES.391IDL_PROPERTY_SUPPORT = YES393# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC395# tag is set to YES then doxygen will reuse the documentation of the first396# member in the group (if any) for the other members of the group. By default397# all members of a group must be documented explicitly.398# The default value is: NO.399DISTRIBUTE_GROUP_DOC = NO401# If one adds a struct or class to a group and this option is enabled, then also403# any nested class or struct is added to the same group. By default this option404# is disabled and one has to add nested compounds explicitly via \ingroup.405# The default value is: NO.406GROUP_NESTED_COMPOUNDS = NO408# Set the SUBGROUPING tag to YES to allow class member groups of the same type410# (for instance a group of public functions) to be put as a subgroup of that411# type (e.g. under the Public Functions section). Set it to NO to prevent412# subgrouping. Alternatively, this can be done per class using the413# \nosubgrouping command.414# The default value is: YES.415SUBGROUPING = YES417# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions419# are shown inside the group in which they are included (e.g. using \ingroup)420# instead of on a separate page (for HTML and Man pages) or section (for LaTeX421# and RTF).422#423# Note that this feature does not work in combination with424# SEPARATE_MEMBER_PAGES.425# The default value is: NO.426INLINE_GROUPED_CLASSES = NO428# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions430# with only public data fields or simple typedef fields will be shown inline in431# the documentation of the scope in which they are defined (i.e. file,432# namespace, or group documentation), provided this scope is documented. If set433# to NO, structs, classes, and unions are shown on a separate page (for HTML and434# Man pages) or section (for LaTeX and RTF).435# The default value is: NO.436INLINE_SIMPLE_STRUCTS = NO438# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or440# enum is documented as struct, union, or enum with the name of the typedef. So441# typedef struct TypeS {} TypeT, will appear in the documentation as a struct442# with name TypeT. When disabled the typedef will appear as a member of a file,443# namespace, or class. And the struct will be named TypeS. This can typically be444# useful for C code in case the coding convention dictates that all compound445# types are typedef'ed and only the typedef is referenced, never the tag name.446# The default value is: NO.447TYPEDEF_HIDES_STRUCT = NO449# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This451# cache is used to resolve symbols given their name and scope. Since this can be452# an expensive process and often the same symbol appears multiple times in the453# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small454# doxygen will become slower. If the cache is too large, memory is wasted. The455# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range456# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536457# symbols. At the end of a run doxygen will report the cache usage and suggest458# the optimal cache size from a speed point of view.459# Minimum value: 0, maximum value: 9, default value: 0.460LOOKUP_CACHE_SIZE = 0462# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use464# during processing. When set to 0 doxygen will based this on the number of465# cores available in the system. You can set it explicitly to a value larger466# than 0 to get more control over the balance between CPU load and processing467# speed. At this moment only the input processing can be done using multiple468# threads. Since this is still an experimental feature the default is set to 1,469# which efficively disables parallel processing. Please report any issues you470# encounter. Generating dot graphs in parallel is controlled by the471# DOT_NUM_THREADS setting.472# Minimum value: 0, maximum value: 32, default value: 1.473NUM_PROC_THREADS = 1475#---------------------------------------------------------------------------477# Build related configuration options478#---------------------------------------------------------------------------479# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in481# documentation are documented, even if no documentation was available. Private482# class members and static file members will be hidden unless the483# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.484# Note: This will also disable the warnings about undocumented members that are485# normally produced when WARNINGS is set to YES.486# The default value is: NO.487EXTRACT_ALL = NO489# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will491# be included in the documentation.492# The default value is: NO.493EXTRACT_PRIVATE = NO495# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual497# methods of a class will be included in the documentation.498# The default value is: NO.499EXTRACT_PRIV_VIRTUAL = NO501# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal503# scope will be included in the documentation.504# The default value is: NO.505EXTRACT_PACKAGE = NO507# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be509# included in the documentation.510# The default value is: NO.511EXTRACT_STATIC = NO513# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined515# locally in source files will be included in the documentation. If set to NO,516# only classes defined in header files are included. Does not have any effect517# for Java sources.518# The default value is: YES.519EXTRACT_LOCAL_CLASSES = YES521# This flag is only useful for Objective-C code. If set to YES, local methods,523# which are defined in the implementation section but not in the interface are524# included in the documentation. If set to NO, only methods in the interface are525# included.526# The default value is: NO.527EXTRACT_LOCAL_METHODS = NO529# If this flag is set to YES, the members of anonymous namespaces will be531# extracted and appear in the documentation as a namespace called532# 'anonymous_namespace{file}', where file will be replaced with the base name of533# the file that contains the anonymous namespace. By default anonymous namespace534# are hidden.535# The default value is: NO.536EXTRACT_ANON_NSPACES = NO538# If this flag is set to YES, the name of an unnamed parameter in a declaration540# will be determined by the corresponding definition. By default unnamed541# parameters remain unnamed in the output.542# The default value is: YES.543RESOLVE_UNNAMED_PARAMS = YES545# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all547# undocumented members inside documented classes or files. If set to NO these548# members will be included in the various overviews, but no documentation549# section is generated. This option has no effect if EXTRACT_ALL is enabled.550# The default value is: NO.551HIDE_UNDOC_MEMBERS = NO553# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all555# undocumented classes that are normally visible in the class hierarchy. If set556# to NO, these classes will be included in the various overviews. This option557# has no effect if EXTRACT_ALL is enabled.558# The default value is: NO.559HIDE_UNDOC_CLASSES = NO561# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend563# declarations. If set to NO, these declarations will be included in the564# documentation.565# The default value is: NO.566HIDE_FRIEND_COMPOUNDS = NO568# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any570# documentation blocks found inside the body of a function. If set to NO, these571# blocks will be appended to the function's detailed documentation block.572# The default value is: NO.573HIDE_IN_BODY_DOCS = NO575# The INTERNAL_DOCS tag determines if documentation that is typed after a577# \internal command is included. If the tag is set to NO then the documentation578# will be excluded. Set it to YES to include the internal documentation.579# The default value is: NO.580INTERNAL_DOCS = NO582# With the correct setting of option CASE_SENSE_NAMES doxygen will better be584# able to match the capabilities of the underlying filesystem. In case the585# filesystem is case sensitive (i.e. it supports files in the same directory586# whose names only differ in casing), the option must be set to YES to properly587# deal with such files in case they appear in the input. For filesystems that588# are not case sensitive the option should be be set to NO to properly deal with589# output files written for symbols that only differ in casing, such as for two590# classes, one named CLASS and the other named Class, and to also support591# references to files without having to specify the exact matching casing. On592# Windows (including Cygwin) and MacOS, users should typically set this option593# to NO, whereas on Linux or other Unix flavors it should typically be set to594# YES.595# The default value is: system dependent.596CASE_SENSE_NAMES = YES598# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with600# their full class and namespace scopes in the documentation. If set to YES, the601# scope will be hidden.602# The default value is: NO.603HIDE_SCOPE_NAMES = NO605# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will607# append additional text to a page's title, such as Class Reference. If set to608# YES the compound reference will be hidden.609# The default value is: NO.610HIDE_COMPOUND_REFERENCE= NO612# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of614# the files that are included by a file in the documentation of that file.615# The default value is: YES.616SHOW_INCLUDE_FILES = YES618# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each620# grouped member an include statement to the documentation, telling the reader621# which file to include in order to use the member.622# The default value is: NO.623SHOW_GROUPED_MEMB_INC = NO625# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include627# files with double quotes in the documentation rather than with sharp brackets.628# The default value is: NO.629FORCE_LOCAL_INCLUDES = NO631# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the633# documentation for inline members.634# The default value is: YES.635INLINE_INFO = YES637# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the639# (detailed) documentation of file and class members alphabetically by member640# name. If set to NO, the members will appear in declaration order.641# The default value is: YES.642SORT_MEMBER_DOCS = YES644# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief646# descriptions of file, namespace and class members alphabetically by member647# name. If set to NO, the members will appear in declaration order. Note that648# this will also influence the order of the classes in the class list.649# The default value is: NO.650SORT_BRIEF_DOCS = NO652# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the654# (brief and detailed) documentation of class members so that constructors and655# destructors are listed first. If set to NO the constructors will appear in the656# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.657# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief658# member documentation.659# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting660# detailed member documentation.661# The default value is: NO.662SORT_MEMBERS_CTORS_1ST = NO664# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy666# of group names into alphabetical order. If set to NO the group names will667# appear in their defined order.668# The default value is: NO.669SORT_GROUP_NAMES = NO671# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by673# fully-qualified names, including namespaces. If set to NO, the class list will674# be sorted only by class name, not including the namespace part.675# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.676# Note: This option applies only to the class list, not to the alphabetical677# list.678# The default value is: NO.679SORT_BY_SCOPE_NAME = NO681# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper683# type resolution of all parameters of a function it will reject a match between684# the prototype and the implementation of a member function even if there is685# only one candidate or it is obvious which candidate to choose by doing a686# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still687# accept a match between prototype and implementation in such cases.688# The default value is: NO.689STRICT_PROTO_MATCHING = NO691# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo693# list. This list is created by putting \todo commands in the documentation.694# The default value is: YES.695GENERATE_TODOLIST = YES697# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test699# list. This list is created by putting \test commands in the documentation.700# The default value is: YES.701GENERATE_TESTLIST = YES703# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug705# list. This list is created by putting \bug commands in the documentation.706# The default value is: YES.707GENERATE_BUGLIST = YES709# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)711# the deprecated list. This list is created by putting \deprecated commands in712# the documentation.713# The default value is: YES.714GENERATE_DEPRECATEDLIST= YES716# The ENABLED_SECTIONS tag can be used to enable conditional documentation718# sections, marked by \if <section_label> ... \endif and \cond <section_label>719# ... \endcond blocks.720ENABLED_SECTIONS =722# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the724# initial value of a variable or macro / define can have for it to appear in the725# documentation. If the initializer consists of more lines than specified here726# it will be hidden. Use a value of 0 to hide initializers completely. The727# appearance of the value of individual variables and macros / defines can be728# controlled using \showinitializer or \hideinitializer command in the729# documentation regardless of this setting.730# Minimum value: 0, maximum value: 10000, default value: 30.731MAX_INITIALIZER_LINES = 30733# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at735# the bottom of the documentation of classes and structs. If set to YES, the736# list will mention the files that were used to generate the documentation.737# The default value is: YES.738SHOW_USED_FILES = YES740# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This742# will remove the Files entry from the Quick Index and from the Folder Tree View743# (if specified).744# The default value is: YES.745SHOW_FILES = YES747# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces749# page. This will remove the Namespaces entry from the Quick Index and from the750# Folder Tree View (if specified).751# The default value is: YES.752SHOW_NAMESPACES = YES754# The FILE_VERSION_FILTER tag can be used to specify a program or script that756# doxygen should invoke to get the current version for each file (typically from757# the version control system). Doxygen will invoke the program by executing (via758# popen()) the command command input-file, where command is the value of the759# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided760# by doxygen. Whatever the program writes to standard output is used as the file761# version. For an example see the documentation.762FILE_VERSION_FILTER =764# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed766# by doxygen. The layout file controls the global structure of the generated767# output files in an output format independent way. To create the layout file768# that represents doxygen's defaults, run doxygen with the -l option. You can769# optionally specify a file name after the option, if omitted DoxygenLayout.xml770# will be used as the name of the layout file.771#772# Note that if you run doxygen from a directory containing a file called773# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE774# tag is left empty.775LAYOUT_FILE =777# The CITE_BIB_FILES tag can be used to specify one or more bib files containing779# the reference definitions. This must be a list of .bib files. The .bib780# extension is automatically appended if omitted. This requires the bibtex tool781# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.782# For LaTeX the style of the bibliography can be controlled using783# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the784# search path. See also \cite for info how to create references.785CITE_BIB_FILES =787#---------------------------------------------------------------------------789# Configuration options related to warning and progress messages790#---------------------------------------------------------------------------791# The QUIET tag can be used to turn on/off the messages that are generated to793# standard output by doxygen. If QUIET is set to YES this implies that the794# messages are off.795# The default value is: NO.796QUIET = NO798# The WARNINGS tag can be used to turn on/off the warning messages that are800# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES801# this implies that the warnings are on.802#803# Tip: Turn warnings on while writing the documentation.804# The default value is: YES.805WARNINGS = YES807# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate809# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag810# will automatically be disabled.811# The default value is: YES.812WARN_IF_UNDOCUMENTED = YES814# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for816# potential errors in the documentation, such as not documenting some parameters817# in a documented function, or documenting parameters that don't exist or using818# markup commands wrongly.819# The default value is: YES.820WARN_IF_DOC_ERROR = YES822# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that824# are documented, but have no documentation for their parameters or return825# value. If set to NO, doxygen will only warn about wrong or incomplete826# parameter documentation, but not about the absence of documentation. If827# EXTRACT_ALL is set to YES then this flag will automatically be disabled.828# The default value is: NO.829WARN_NO_PARAMDOC = NO831# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when833# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS834# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but835# at the end of the doxygen process doxygen will return with a non-zero status.836# Possible values are: NO, YES and FAIL_ON_WARNINGS.837# The default value is: NO.838WARN_AS_ERROR = NO840# The WARN_FORMAT tag determines the format of the warning messages that doxygen842# can produce. The string should contain the $file, $line, and $text tags, which843# will be replaced by the file and line number from which the warning originated844# and the warning text. Optionally the format may contain $version, which will845# be replaced by the version of the file (if it could be obtained via846# FILE_VERSION_FILTER)847# The default value is: $file:$line: $text.848WARN_FORMAT = "$file:$line: $text"850# The WARN_LOGFILE tag can be used to specify a file to which warning and error852# messages should be written. If left blank the output is written to standard853# error (stderr).854WARN_LOGFILE =856#---------------------------------------------------------------------------858# Configuration options related to the input files859#---------------------------------------------------------------------------860# The INPUT tag is used to specify the files and/or directories that contain862# documented source files. You may enter file names like myfile.cpp or863# directories like /usr/src/myproject. Separate the files or directories with864# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING865# Note: If this tag is empty the current directory is searched.866INPUT = src/pointer/types868# This tag can be used to specify the character encoding of the source files870# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses871# libiconv (or the iconv built into libc) for the transcoding. See the libiconv872# documentation (see:873# https://www.gnu.org/software/libiconv/) for the list of possible encodings.874# The default value is: UTF-8.875INPUT_ENCODING = UTF-8877# If the value of the INPUT tag contains directories, you can use the879# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and880# *.h) to filter out the source-files in the directories.881#882# Note that for custom extensions or not directly supported extensions you also883# need to set EXTENSION_MAPPING for the extension otherwise the files are not884# read by doxygen.885#886# Note the list of default checked file patterns might differ from the list of887# default file extension mappings.888#889# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,890# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,891# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,892# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),893# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,894# *.ucf, *.qsf and *.ice.895FILE_PATTERNS = *.c \897*.cc \898*.cxx \899*.cpp \900*.c++ \901*.java \902*.ii \903*.ixx \904*.ipp \905*.i++ \906*.inl \907*.idl \908*.ddl \909*.odl \910*.h \911*.hh \912*.hxx \913*.hpp \914*.h++ \915*.cs \916*.d \917*.php \918*.php4 \919*.php5 \920*.phtml \921*.inc \922*.m \923*.markdown \924*.md \925*.mm \926*.dox \927*.py \928*.pyw \929*.f90 \930*.f95 \931*.f03 \932*.f08 \933*.f18 \934*.f \935*.for \936*.vhd \937*.vhdl \938*.ucf \939*.qsf \940*.ice941# The RECURSIVE tag can be used to specify whether or not subdirectories should943# be searched for input files as well.944# The default value is: NO.945RECURSIVE = YES947# The EXCLUDE tag can be used to specify files and/or directories that should be949# excluded from the INPUT source files. This way you can easily exclude a950# subdirectory from a directory tree whose root is specified with the INPUT tag.951#952# Note that relative paths are relative to the directory from which doxygen is953# run.954EXCLUDE =956# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or958# directories that are symbolic links (a Unix file system feature) are excluded959# from the input.960# The default value is: NO.961EXCLUDE_SYMLINKS = NO963# If the value of the INPUT tag contains directories, you can use the965# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude966# certain files from those directories.967#968# Note that the wildcards are matched against the file with absolute path, so to969# exclude all test directories for example use the pattern */test/*970EXCLUDE_PATTERNS =972# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names974# (namespaces, classes, functions, etc.) that should be excluded from the975# output. The symbol name can be a fully qualified name, a word, or if the976# wildcard * is used, a substring. Examples: ANamespace, AClass,977# AClass::ANamespace, ANamespace::*Test978#979# Note that the wildcards are matched against the file with absolute path, so to980# exclude all test directories use the pattern */test/*981EXCLUDE_SYMBOLS =983# The EXAMPLE_PATH tag can be used to specify one or more files or directories985# that contain example code fragments that are included (see the \include986# command).987EXAMPLE_PATH =989# If the value of the EXAMPLE_PATH tag contains directories, you can use the991# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and992# *.h) to filter out the source-files in the directories. If left blank all993# files are included.994EXAMPLE_PATTERNS = *996# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be998# searched for input files to be used with the \include or \dontinclude commands999# irrespective of the value of the RECURSIVE tag.1000# The default value is: NO.1001EXAMPLE_RECURSIVE = NO1003# The IMAGE_PATH tag can be used to specify one or more files or directories1005# that contain images that are to be included in the documentation (see the1006# \image command).1007IMAGE_PATH = resources1009# The INPUT_FILTER tag can be used to specify a program that doxygen should1011# invoke to filter for each input file. Doxygen will invoke the filter program1012# by executing (via popen()) the command:1013#1014# <filter> <input-file>1015#1016# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the1017# name of an input file. Doxygen will then use the output that the filter1018# program writes to standard output. If FILTER_PATTERNS is specified, this tag1019# will be ignored.1020#1021# Note that the filter must not add or remove lines; it is applied before the1022# code is scanned, but not when the output code is generated. If lines are added1023# or removed, the anchors will not be placed correctly.1024#1025# Note that for custom extensions or not directly supported extensions you also1026# need to set EXTENSION_MAPPING for the extension otherwise the files are not1027# properly processed by doxygen.1028INPUT_FILTER =1030# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern1032# basis. Doxygen will compare the file name with each pattern and apply the1033# filter if there is a match. The filters are a list of the form: pattern=filter1034# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how1035# filters are used. If the FILTER_PATTERNS tag is empty or if none of the1036# patterns match the file name, INPUT_FILTER is applied.1037#1038# Note that for custom extensions or not directly supported extensions you also1039# need to set EXTENSION_MAPPING for the extension otherwise the files are not1040# properly processed by doxygen.1041FILTER_PATTERNS =1043# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using1045# INPUT_FILTER) will also be used to filter the input files that are used for1046# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).1047# The default value is: NO.1048FILTER_SOURCE_FILES = NO1050# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file1052# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and1053# it is also possible to disable source filtering for a specific pattern using1054# *.ext= (so without naming a filter).1055# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.1056FILTER_SOURCE_PATTERNS =1058# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that1060# is part of the input, its contents will be placed on the main page1061# (index.html). This can be useful if you have a project on for instance GitHub1062# and want to reuse the introduction page also for the doxygen output.1063USE_MDFILE_AS_MAINPAGE =1065#---------------------------------------------------------------------------1067# Configuration options related to source browsing1068#---------------------------------------------------------------------------1069# If the SOURCE_BROWSER tag is set to YES then a list of source files will be1071# generated. Documented entities will be cross-referenced with these sources.1072#1073# Note: To get rid of all source code in the generated output, make sure that1074# also VERBATIM_HEADERS is set to NO.1075# The default value is: NO.1076SOURCE_BROWSER = NO1078# Setting the INLINE_SOURCES tag to YES will include the body of functions,1080# classes and enums directly into the documentation.1081# The default value is: NO.1082INLINE_SOURCES = NO1084# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any1086# special comment blocks from generated source code fragments. Normal C, C++ and1087# Fortran comments will always remain visible.1088# The default value is: YES.1089STRIP_CODE_COMMENTS = YES1091# If the REFERENCED_BY_RELATION tag is set to YES then for each documented1093# entity all documented functions referencing it will be listed.1094# The default value is: NO.1095REFERENCED_BY_RELATION = NO1097# If the REFERENCES_RELATION tag is set to YES then for each documented function1099# all documented entities called/used by that function will be listed.1100# The default value is: NO.1101REFERENCES_RELATION = NO1103# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set1105# to YES then the hyperlinks from functions in REFERENCES_RELATION and1106# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will1107# link to the documentation.1108# The default value is: YES.1109REFERENCES_LINK_SOURCE = YES1111# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the1113# source code will show a tooltip with additional information such as prototype,1114# brief description and links to the definition and documentation. Since this1115# will make the HTML file larger and loading of large files a bit slower, you1116# can opt to disable this feature.1117# The default value is: YES.1118# This tag requires that the tag SOURCE_BROWSER is set to YES.1119SOURCE_TOOLTIPS = YES1121# If the USE_HTAGS tag is set to YES then the references to source code will1123# point to the HTML generated by the htags(1) tool instead of doxygen built-in1124# source browser. The htags tool is part of GNU's global source tagging system1125# (see https://www.gnu.org/software/global/global.html). You will need version1126# 4.8.6 or higher.1127#1128# To use it do the following:1129# - Install the latest version of global1130# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file1131# - Make sure the INPUT points to the root of the source tree1132# - Run doxygen as normal1133#1134# Doxygen will invoke htags (and that will in turn invoke gtags), so these1135# tools must be available from the command line (i.e. in the search path).1136#1137# The result: instead of the source browser generated by doxygen, the links to1138# source code will now point to the output of htags.1139# The default value is: NO.1140# This tag requires that the tag SOURCE_BROWSER is set to YES.1141USE_HTAGS = NO1143# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a1145# verbatim copy of the header file for each class for which an include is1146# specified. Set to NO to disable this.1147# See also: Section \class.1148# The default value is: YES.1149VERBATIM_HEADERS = YES1151# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the1153# clang parser (see:1154# http://clang.llvm.org/) for more accurate parsing at the cost of reduced1155# performance. This can be particularly helpful with template rich C++ code for1156# which doxygen's built-in parser lacks the necessary type information.1157# Note: The availability of this option depends on whether or not doxygen was1158# generated with the -Duse_libclang=ON option for CMake.1159# The default value is: NO.1160CLANG_ASSISTED_PARSING = NO1162# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to1164# YES then doxygen will add the directory of each input to the include path.1165# The default value is: YES.1166CLANG_ADD_INC_PATHS = YES1168# If clang assisted parsing is enabled you can provide the compiler with command1170# line options that you would normally use when invoking the compiler. Note that1171# the include paths will already be set by doxygen for the files and directories1172# specified with INPUT and INCLUDE_PATH.1173# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.1174CLANG_OPTIONS =1176# If clang assisted parsing is enabled you can provide the clang parser with the1178# path to the directory containing a file called compile_commands.json. This1179# file is the compilation database (see:1180# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the1181# options used when the source files were built. This is equivalent to1182# specifying the -p option to a clang tool, such as clang-check. These options1183# will then be passed to the parser. Any options specified with CLANG_OPTIONS1184# will be added as well.1185# Note: The availability of this option depends on whether or not doxygen was1186# generated with the -Duse_libclang=ON option for CMake.1187CLANG_DATABASE_PATH =1189#---------------------------------------------------------------------------1191# Configuration options related to the alphabetical class index1192#---------------------------------------------------------------------------1193# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all1195# compounds will be generated. Enable this if the project contains a lot of1196# classes, structs, unions or interfaces.1197# The default value is: YES.1198ALPHABETICAL_INDEX = YES1200# In case all classes in a project start with a common prefix, all classes will1202# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag1203# can be used to specify a prefix (or a list of prefixes) that should be ignored1204# while generating the index headers.1205# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1206IGNORE_PREFIX =1208#---------------------------------------------------------------------------1210# Configuration options related to the HTML output1211#---------------------------------------------------------------------------1212# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output1214# The default value is: YES.1215GENERATE_HTML = YES1217# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1219# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1220# it.1221# The default directory is: html.1222# This tag requires that the tag GENERATE_HTML is set to YES.1223HTML_OUTPUT = html1225# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1227# generated HTML page (for example: .htm, .php, .asp).1228# The default value is: .html.1229# This tag requires that the tag GENERATE_HTML is set to YES.1230HTML_FILE_EXTENSION = .html1232# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1234# each generated HTML page. If the tag is left blank doxygen will generate a1235# standard header.1236#1237# To get valid HTML the header file that includes any scripts and style sheets1238# that doxygen needs, which is dependent on the configuration options used (e.g.1239# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1240# default header using1241# doxygen -w html new_header.html new_footer.html new_stylesheet.css1242# YourConfigFile1243# and then modify the file new_header.html. See also section "Doxygen usage"1244# for information on how to generate the default header that doxygen normally1245# uses.1246# Note: The header is subject to change so you typically have to regenerate the1247# default header when upgrading to a newer version of doxygen. For a description1248# of the possible markers and block names see the documentation.1249# This tag requires that the tag GENERATE_HTML is set to YES.1250HTML_HEADER =1252# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1254# generated HTML page. If the tag is left blank doxygen will generate a standard1255# footer. See HTML_HEADER for more information on how to generate a default1256# footer and what special commands can be used inside the footer. See also1257# section "Doxygen usage" for information on how to generate the default footer1258# that doxygen normally uses.1259# This tag requires that the tag GENERATE_HTML is set to YES.1260HTML_FOOTER =1262# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1264# sheet that is used by each HTML page. It can be used to fine-tune the look of1265# the HTML output. If left blank doxygen will generate a default style sheet.1266# See also section "Doxygen usage" for information on how to generate the style1267# sheet that doxygen normally uses.1268# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1269# it is more robust and this tag (HTML_STYLESHEET) will in the future become1270# obsolete.1271# This tag requires that the tag GENERATE_HTML is set to YES.1272HTML_STYLESHEET =1274# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined1276# cascading style sheets that are included after the standard style sheets1277# created by doxygen. Using this option one can overrule certain style aspects.1278# This is preferred over using HTML_STYLESHEET since it does not replace the1279# standard style sheet and is therefore more robust against future updates.1280# Doxygen will copy the style sheet files to the output directory.1281# Note: The order of the extra style sheet files is of importance (e.g. the last1282# style sheet in the list overrules the setting of the previous ones in the1283# list). For an example see the documentation.1284# This tag requires that the tag GENERATE_HTML is set to YES.1285HTML_EXTRA_STYLESHEET =1287# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1289# other source files which should be copied to the HTML output directory. Note1290# that these files will be copied to the base HTML output directory. Use the1291# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1292# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1293# files will be copied as-is; there are no commands or markers available.1294# This tag requires that the tag GENERATE_HTML is set to YES.1295HTML_EXTRA_FILES =1297# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1299# will adjust the colors in the style sheet and background images according to1300# this color. Hue is specified as an angle on a colorwheel, see1301# https://en.wikipedia.org/wiki/Hue for more information. For instance the value1302# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001303# purple, and 360 is red again.1304# Minimum value: 0, maximum value: 359, default value: 220.1305# This tag requires that the tag GENERATE_HTML is set to YES.1306HTML_COLORSTYLE_HUE = 2201308# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1310# in the HTML output. For a value of 0 the output will use grayscales only. A1311# value of 255 will produce the most vivid colors.1312# Minimum value: 0, maximum value: 255, default value: 100.1313# This tag requires that the tag GENERATE_HTML is set to YES.1314HTML_COLORSTYLE_SAT = 1001316# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1318# luminance component of the colors in the HTML output. Values below 1001319# gradually make the output lighter, whereas values above 100 make the output1320# darker. The value divided by 100 is the actual gamma applied, so 80 represents1321# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1322# change the gamma.1323# Minimum value: 40, maximum value: 240, default value: 80.1324# This tag requires that the tag GENERATE_HTML is set to YES.1325HTML_COLORSTYLE_GAMMA = 801327# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1329# page will contain the date and time when the page was generated. Setting this1330# to YES can help to show when doxygen was last run and thus if the1331# documentation is up to date.1332# The default value is: NO.1333# This tag requires that the tag GENERATE_HTML is set to YES.1334HTML_TIMESTAMP = NO1336# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML1338# documentation will contain a main index with vertical navigation menus that1339# are dynamically created via JavaScript. If disabled, the navigation index will1340# consists of multiple levels of tabs that are statically embedded in every HTML1341# page. Disable this option to support browsers that do not have JavaScript,1342# like the Qt help browser.1343# The default value is: YES.1344# This tag requires that the tag GENERATE_HTML is set to YES.1345HTML_DYNAMIC_MENUS = YES1347# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1349# documentation will contain sections that can be hidden and shown after the1350# page has loaded.1351# The default value is: NO.1352# This tag requires that the tag GENERATE_HTML is set to YES.1353HTML_DYNAMIC_SECTIONS = NO1355# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1357# shown in the various tree structured indices initially; the user can expand1358# and collapse entries dynamically later on. Doxygen will expand the tree to1359# such a level that at most the specified number of entries are visible (unless1360# a fully collapsed tree already exceeds this amount). So setting the number of1361# entries 1 will produce a full collapsed tree by default. 0 is a special value1362# representing an infinite number of entries and will result in a full expanded1363# tree by default.1364# Minimum value: 0, maximum value: 9999, default value: 100.1365# This tag requires that the tag GENERATE_HTML is set to YES.1366HTML_INDEX_NUM_ENTRIES = 1001368# If the GENERATE_DOCSET tag is set to YES, additional index files will be1370# generated that can be used as input for Apple's Xcode 3 integrated development1371# environment (see:1372# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To1373# create a documentation set, doxygen will generate a Makefile in the HTML1374# output directory. Running make will produce the docset in that directory and1375# running make install will install the docset in1376# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1377# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy1378# genXcode/_index.html for more information.1379# The default value is: NO.1380# This tag requires that the tag GENERATE_HTML is set to YES.1381GENERATE_DOCSET = NO1383# This tag determines the name of the docset feed. A documentation feed provides1385# an umbrella under which multiple documentation sets from a single provider1386# (such as a company or product suite) can be grouped.1387# The default value is: Doxygen generated docs.1388# This tag requires that the tag GENERATE_DOCSET is set to YES.1389DOCSET_FEEDNAME = "Doxygen generated docs"1391# This tag specifies a string that should uniquely identify the documentation1393# set bundle. This should be a reverse domain-name style string, e.g.1394# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1395# The default value is: org.doxygen.Project.1396# This tag requires that the tag GENERATE_DOCSET is set to YES.1397DOCSET_BUNDLE_ID = org.doxygen.Project1399# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1401# the documentation publisher. This should be a reverse domain-name style1402# string, e.g. com.mycompany.MyDocSet.documentation.1403# The default value is: org.doxygen.Publisher.1404# This tag requires that the tag GENERATE_DOCSET is set to YES.1405DOCSET_PUBLISHER_ID = org.doxygen.Publisher1407# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1409# The default value is: Publisher.1410# This tag requires that the tag GENERATE_DOCSET is set to YES.1411DOCSET_PUBLISHER_NAME = Publisher1413# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1415# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1416# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1417# (see:1418# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.1419#1420# The HTML Help Workshop contains a compiler that can convert all HTML output1421# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1422# files are now used as the Windows 98 help format, and will replace the old1423# Windows help format (.hlp) on all Windows platforms in the future. Compressed1424# HTML files also contain an index, a table of contents, and you can search for1425# words in the documentation. The HTML workshop also contains a viewer for1426# compressed HTML files.1427# The default value is: NO.1428# This tag requires that the tag GENERATE_HTML is set to YES.1429GENERATE_HTMLHELP = NO1431# The CHM_FILE tag can be used to specify the file name of the resulting .chm1433# file. You can add a path in front of the file if the result should not be1434# written to the html output directory.1435# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1436CHM_FILE =1438# The HHC_LOCATION tag can be used to specify the location (absolute path1440# including file name) of the HTML help compiler (hhc.exe). If non-empty,1441# doxygen will try to run the HTML help compiler on the generated index.hhp.1442# The file has to be specified with full path.1443# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1444HHC_LOCATION =1446# The GENERATE_CHI flag controls if a separate .chi index file is generated1448# (YES) or that it should be included in the main .chm file (NO).1449# The default value is: NO.1450# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1451GENERATE_CHI = NO1453# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)1455# and project file content.1456# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1457CHM_INDEX_ENCODING =1459# The BINARY_TOC flag controls whether a binary table of contents is generated1461# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it1462# enables the Previous and Next buttons.1463# The default value is: NO.1464# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1465BINARY_TOC = NO1467# The TOC_EXPAND flag can be set to YES to add extra items for group members to1469# the table of contents of the HTML help documentation and to the tree view.1470# The default value is: NO.1471# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1472TOC_EXPAND = NO1474# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1476# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1477# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1478# (.qch) of the generated HTML documentation.1479# The default value is: NO.1480# This tag requires that the tag GENERATE_HTML is set to YES.1481GENERATE_QHP = NO1483# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1485# the file name of the resulting .qch file. The path specified is relative to1486# the HTML output folder.1487# This tag requires that the tag GENERATE_QHP is set to YES.1488QCH_FILE =1490# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1492# Project output. For more information please see Qt Help Project / Namespace1493# (see:1494# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).1495# The default value is: org.doxygen.Project.1496# This tag requires that the tag GENERATE_QHP is set to YES.1497QHP_NAMESPACE = org.doxygen.Project1499# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1501# Help Project output. For more information please see Qt Help Project / Virtual1502# Folders (see:1503# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).1504# The default value is: doc.1505# This tag requires that the tag GENERATE_QHP is set to YES.1506QHP_VIRTUAL_FOLDER = doc1508# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1510# filter to add. For more information please see Qt Help Project / Custom1511# Filters (see:1512# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).1513# This tag requires that the tag GENERATE_QHP is set to YES.1514QHP_CUST_FILTER_NAME =1516# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1518# custom filter to add. For more information please see Qt Help Project / Custom1519# Filters (see:1520# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).1521# This tag requires that the tag GENERATE_QHP is set to YES.1522QHP_CUST_FILTER_ATTRS =1524# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1526# project's filter section matches. Qt Help Project / Filter Attributes (see:1527# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).1528# This tag requires that the tag GENERATE_QHP is set to YES.1529QHP_SECT_FILTER_ATTRS =1531# The QHG_LOCATION tag can be used to specify the location (absolute path1533# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to1534# run qhelpgenerator on the generated .qhp file.1535# This tag requires that the tag GENERATE_QHP is set to YES.1536QHG_LOCATION =1538# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1540# generated, together with the HTML files, they form an Eclipse help plugin. To1541# install this plugin and make it available under the help contents menu in1542# Eclipse, the contents of the directory containing the HTML and XML files needs1543# to be copied into the plugins directory of eclipse. The name of the directory1544# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1545# After copying Eclipse needs to be restarted before the help appears.1546# The default value is: NO.1547# This tag requires that the tag GENERATE_HTML is set to YES.1548GENERATE_ECLIPSEHELP = NO1550# A unique identifier for the Eclipse help plugin. When installing the plugin1552# the directory name containing the HTML and XML files should also have this1553# name. Each documentation set should have its own identifier.1554# The default value is: org.doxygen.Project.1555# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1556ECLIPSE_DOC_ID = org.doxygen.Project1558# If you want full control over the layout of the generated HTML pages it might1560# be necessary to disable the index and replace it with your own. The1561# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1562# of each HTML page. A value of NO enables the index and the value YES disables1563# it. Since the tabs in the index contain the same information as the navigation1564# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1565# The default value is: NO.1566# This tag requires that the tag GENERATE_HTML is set to YES.1567DISABLE_INDEX = NO1569# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1571# structure should be generated to display hierarchical information. If the tag1572# value is set to YES, a side panel will be generated containing a tree-like1573# index structure (just like the one that is generated for HTML Help). For this1574# to work a browser that supports JavaScript, DHTML, CSS and frames is required1575# (i.e. any modern browser). Windows users are probably better off using the1576# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can1577# further fine-tune the look of the index. As an example, the default style1578# sheet generated by doxygen has an example that shows how to put an image at1579# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1580# the same information as the tab index, you could consider setting1581# DISABLE_INDEX to YES when enabling this option.1582# The default value is: NO.1583# This tag requires that the tag GENERATE_HTML is set to YES.1584GENERATE_TREEVIEW = NO1586# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1588# doxygen will group on one line in the generated HTML documentation.1589#1590# Note that a value of 0 will completely suppress the enum values from appearing1591# in the overview section.1592# Minimum value: 0, maximum value: 20, default value: 4.1593# This tag requires that the tag GENERATE_HTML is set to YES.1594ENUM_VALUES_PER_LINE = 41596# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1598# to set the initial width (in pixels) of the frame in which the tree is shown.1599# Minimum value: 0, maximum value: 1500, default value: 250.1600# This tag requires that the tag GENERATE_HTML is set to YES.1601TREEVIEW_WIDTH = 2501603# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to1605# external symbols imported via tag files in a separate window.1606# The default value is: NO.1607# This tag requires that the tag GENERATE_HTML is set to YES.1608EXT_LINKS_IN_WINDOW = NO1610# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg1612# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see1613# https://inkscape.org) to generate formulas as SVG images instead of PNGs for1614# the HTML output. These images will generally look nicer at scaled resolutions.1615# Possible values are: png (the default) and svg (looks nicer but requires the1616# pdf2svg or inkscape tool).1617# The default value is: png.1618# This tag requires that the tag GENERATE_HTML is set to YES.1619HTML_FORMULA_FORMAT = png1621# Use this tag to change the font size of LaTeX formulas included as images in1623# the HTML documentation. When you change the font size after a successful1624# doxygen run you need to manually remove any form_*.png images from the HTML1625# output directory to force them to be regenerated.1626# Minimum value: 8, maximum value: 50, default value: 10.1627# This tag requires that the tag GENERATE_HTML is set to YES.1628FORMULA_FONTSIZE = 101630# Use the FORMULA_TRANSPARENT tag to determine whether or not the images1632# generated for formulas are transparent PNGs. Transparent PNGs are not1633# supported properly for IE 6.0, but are supported on all modern browsers.1634#1635# Note that when changing this option you need to delete any form_*.png files in1636# the HTML output directory before the changes have effect.1637# The default value is: YES.1638# This tag requires that the tag GENERATE_HTML is set to YES.1639FORMULA_TRANSPARENT = YES1641# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands1643# to create new LaTeX commands to be used in formulas as building blocks. See1644# the section "Including formulas" for details.1645FORMULA_MACROFILE =1647# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1649# https://www.mathjax.org) which uses client side JavaScript for the rendering1650# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX1651# installed or if you want to formulas look prettier in the HTML output. When1652# enabled you may also need to install MathJax separately and configure the path1653# to it using the MATHJAX_RELPATH option.1654# The default value is: NO.1655# This tag requires that the tag GENERATE_HTML is set to YES.1656USE_MATHJAX = NO1658# When MathJax is enabled you can set the default output format to be used for1660# the MathJax output. See the MathJax site (see:1661# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.1662# Possible values are: HTML-CSS (which is slower, but has the best1663# compatibility), NativeMML (i.e. MathML) and SVG.1664# The default value is: HTML-CSS.1665# This tag requires that the tag USE_MATHJAX is set to YES.1666MATHJAX_FORMAT = HTML-CSS1668# When MathJax is enabled you need to specify the location relative to the HTML1670# output directory using the MATHJAX_RELPATH option. The destination directory1671# should contain the MathJax.js script. For instance, if the mathjax directory1672# is located at the same level as the HTML output directory, then1673# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1674# Content Delivery Network so you can quickly see the result without installing1675# MathJax. However, it is strongly recommended to install a local copy of1676# MathJax from https://www.mathjax.org before deployment.1677# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.1678# This tag requires that the tag USE_MATHJAX is set to YES.1679MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@21681# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1683# extension names that should be enabled during MathJax rendering. For example1684# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1685# This tag requires that the tag USE_MATHJAX is set to YES.1686MATHJAX_EXTENSIONS =1688# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1690# of code that will be used on startup of the MathJax code. See the MathJax site1691# (see:1692# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an1693# example see the documentation.1694# This tag requires that the tag USE_MATHJAX is set to YES.1695MATHJAX_CODEFILE =1697# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1699# the HTML output. The underlying search engine uses javascript and DHTML and1700# should work on any modern browser. Note that when using HTML help1701# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1702# there is already a search function so this one should typically be disabled.1703# For large projects the javascript based search engine can be slow, then1704# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1705# search using the keyboard; to jump to the search box use <access key> + S1706# (what the <access key> is depends on the OS and browser, but it is typically1707# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1708# key> to jump into the search results window, the results can be navigated1709# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1710# the search. The filter options can be selected when the cursor is inside the1711# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1712# to select a filter and <Enter> or <escape> to activate or cancel the filter1713# option.1714# The default value is: YES.1715# This tag requires that the tag GENERATE_HTML is set to YES.1716SEARCHENGINE = YES1718# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1720# implemented using a web server instead of a web client using JavaScript. There1721# are two flavors of web server based searching depending on the EXTERNAL_SEARCH1722# setting. When disabled, doxygen will generate a PHP script for searching and1723# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing1724# and searching needs to be provided by external tools. See the section1725# "External Indexing and Searching" for details.1726# The default value is: NO.1727# This tag requires that the tag SEARCHENGINE is set to YES.1728SERVER_BASED_SEARCH = NO1730# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1732# script for searching. Instead the search results are written to an XML file1733# which needs to be processed by an external indexer. Doxygen will invoke an1734# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1735# search results.1736#1737# Doxygen ships with an example indexer (doxyindexer) and search engine1738# (doxysearch.cgi) which are based on the open source search engine library1739# Xapian (see:1740# https://xapian.org/).1741#1742# See the section "External Indexing and Searching" for details.1743# The default value is: NO.1744# This tag requires that the tag SEARCHENGINE is set to YES.1745EXTERNAL_SEARCH = NO1747# The SEARCHENGINE_URL should point to a search engine hosted by a web server1749# which will return the search results when EXTERNAL_SEARCH is enabled.1750#1751# Doxygen ships with an example indexer (doxyindexer) and search engine1752# (doxysearch.cgi) which are based on the open source search engine library1753# Xapian (see:1754# https://xapian.org/). See the section "External Indexing and Searching" for1755# details.1756# This tag requires that the tag SEARCHENGINE is set to YES.1757SEARCHENGINE_URL =1759# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1761# search data is written to a file for indexing by an external tool. With the1762# SEARCHDATA_FILE tag the name of this file can be specified.1763# The default file is: searchdata.xml.1764# This tag requires that the tag SEARCHENGINE is set to YES.1765SEARCHDATA_FILE = searchdata.xml1767# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1769# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1770# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1771# projects and redirect the results back to the right project.1772# This tag requires that the tag SEARCHENGINE is set to YES.1773EXTERNAL_SEARCH_ID =1775# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1777# projects other than the one defined by this configuration file, but that are1778# all added to the same external search index. Each project needs to have a1779# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1780# to a relative location where the documentation can be found. The format is:1781# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1782# This tag requires that the tag SEARCHENGINE is set to YES.1783EXTRA_SEARCH_MAPPINGS =1785#---------------------------------------------------------------------------1787# Configuration options related to the LaTeX output1788#---------------------------------------------------------------------------1789# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.1791# The default value is: YES.1792GENERATE_LATEX = YES1794# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1796# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1797# it.1798# The default directory is: latex.1799# This tag requires that the tag GENERATE_LATEX is set to YES.1800LATEX_OUTPUT = latex1802# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1804# invoked.1805#1806# Note that when not enabling USE_PDFLATEX the default is latex when enabling1807# USE_PDFLATEX the default is pdflatex and when in the later case latex is1808# chosen this is overwritten by pdflatex. For specific output languages the1809# default can have been set differently, this depends on the implementation of1810# the output language.1811# This tag requires that the tag GENERATE_LATEX is set to YES.1812LATEX_CMD_NAME =1814# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1816# index for LaTeX.1817# Note: This tag is used in the Makefile / make.bat.1818# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file1819# (.tex).1820# The default file is: makeindex.1821# This tag requires that the tag GENERATE_LATEX is set to YES.1822MAKEINDEX_CMD_NAME = makeindex1824# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to1826# generate index for LaTeX. In case there is no backslash (\) as first character1827# it will be automatically added in the LaTeX code.1828# Note: This tag is used in the generated output file (.tex).1829# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.1830# The default value is: makeindex.1831# This tag requires that the tag GENERATE_LATEX is set to YES.1832LATEX_MAKEINDEX_CMD = makeindex1834# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX1836# documents. This may be useful for small projects and may help to save some1837# trees in general.1838# The default value is: NO.1839# This tag requires that the tag GENERATE_LATEX is set to YES.1840COMPACT_LATEX = NO1842# The PAPER_TYPE tag can be used to set the paper type that is used by the1844# printer.1845# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1846# 14 inches) and executive (7.25 x 10.5 inches).1847# The default value is: a4.1848# This tag requires that the tag GENERATE_LATEX is set to YES.1849PAPER_TYPE = a41851# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1853# that should be included in the LaTeX output. The package can be specified just1854# by its name or with the correct syntax as to be used with the LaTeX1855# \usepackage command. To get the times font for instance you can specify :1856# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}1857# To use the option intlimits with the amsmath package you can specify:1858# EXTRA_PACKAGES=[intlimits]{amsmath}1859# If left blank no extra packages will be included.1860# This tag requires that the tag GENERATE_LATEX is set to YES.1861EXTRA_PACKAGES =1863# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1865# generated LaTeX document. The header should contain everything until the first1866# chapter. If it is left blank doxygen will generate a standard header. See1867# section "Doxygen usage" for information on how to let doxygen write the1868# default header to a separate file.1869#1870# Note: Only use a user-defined header if you know what you are doing! The1871# following commands have a special meaning inside the header: $title,1872# $datetime, $date, $doxygenversion, $projectname, $projectnumber,1873# $projectbrief, $projectlogo. Doxygen will replace $title with the empty1874# string, for the replacement values of the other commands the user is referred1875# to HTML_HEADER.1876# This tag requires that the tag GENERATE_LATEX is set to YES.1877LATEX_HEADER =1879# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1881# generated LaTeX document. The footer should contain everything after the last1882# chapter. If it is left blank doxygen will generate a standard footer. See1883# LATEX_HEADER for more information on how to generate a default footer and what1884# special commands can be used inside the footer.1885#1886# Note: Only use a user-defined footer if you know what you are doing!1887# This tag requires that the tag GENERATE_LATEX is set to YES.1888LATEX_FOOTER =1890# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined1892# LaTeX style sheets that are included after the standard style sheets created1893# by doxygen. Using this option one can overrule certain style aspects. Doxygen1894# will copy the style sheet files to the output directory.1895# Note: The order of the extra style sheet files is of importance (e.g. the last1896# style sheet in the list overrules the setting of the previous ones in the1897# list).1898# This tag requires that the tag GENERATE_LATEX is set to YES.1899LATEX_EXTRA_STYLESHEET =1901# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1903# other source files which should be copied to the LATEX_OUTPUT output1904# directory. Note that the files will be copied as-is; there are no commands or1905# markers available.1906# This tag requires that the tag GENERATE_LATEX is set to YES.1907LATEX_EXTRA_FILES =1909# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1911# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1912# contain links (just like the HTML output) instead of page references. This1913# makes the output suitable for online browsing using a PDF viewer.1914# The default value is: YES.1915# This tag requires that the tag GENERATE_LATEX is set to YES.1916PDF_HYPERLINKS = YES1918# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as1920# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX1921# files. Set this option to YES, to get a higher quality PDF documentation.1922#1923# See also section LATEX_CMD_NAME for selecting the engine.1924# The default value is: YES.1925# This tag requires that the tag GENERATE_LATEX is set to YES.1926USE_PDFLATEX = YES1928# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1930# command to the generated LaTeX files. This will instruct LaTeX to keep running1931# if errors occur, instead of asking the user for help. This option is also used1932# when generating formulas in HTML.1933# The default value is: NO.1934# This tag requires that the tag GENERATE_LATEX is set to YES.1935LATEX_BATCHMODE = NO1937# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1939# index chapters (such as File Index, Compound Index, etc.) in the output.1940# The default value is: NO.1941# This tag requires that the tag GENERATE_LATEX is set to YES.1942LATEX_HIDE_INDICES = NO1944# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1946# code with syntax highlighting in the LaTeX output.1947#1948# Note that which sources are shown also depends on other settings such as1949# SOURCE_BROWSER.1950# The default value is: NO.1951# This tag requires that the tag GENERATE_LATEX is set to YES.1952LATEX_SOURCE_CODE = NO1954# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1956# bibliography, e.g. plainnat, or ieeetr. See1957# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.1958# The default value is: plain.1959# This tag requires that the tag GENERATE_LATEX is set to YES.1960LATEX_BIB_STYLE = plain1962# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated1964# page will contain the date and time when the page was generated. Setting this1965# to NO can help when comparing the output of multiple runs.1966# The default value is: NO.1967# This tag requires that the tag GENERATE_LATEX is set to YES.1968LATEX_TIMESTAMP = NO1970# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)1972# path from which the emoji images will be read. If a relative path is entered,1973# it will be relative to the LATEX_OUTPUT directory. If left blank the1974# LATEX_OUTPUT directory will be used.1975# This tag requires that the tag GENERATE_LATEX is set to YES.1976LATEX_EMOJI_DIRECTORY =1978#---------------------------------------------------------------------------1980# Configuration options related to the RTF output1981#---------------------------------------------------------------------------1982# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The1984# RTF output is optimized for Word 97 and may not look too pretty with other RTF1985# readers/editors.1986# The default value is: NO.1987GENERATE_RTF = NO1989# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1991# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1992# it.1993# The default directory is: rtf.1994# This tag requires that the tag GENERATE_RTF is set to YES.1995RTF_OUTPUT = rtf1997# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF1999# documents. This may be useful for small projects and may help to save some2000# trees in general.2001# The default value is: NO.2002# This tag requires that the tag GENERATE_RTF is set to YES.2003COMPACT_RTF = NO2005# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will2007# contain hyperlink fields. The RTF file will contain links (just like the HTML2008# output) instead of page references. This makes the output suitable for online2009# browsing using Word or some other Word compatible readers that support those2010# fields.2011#2012# Note: WordPad (write) and others do not support links.2013# The default value is: NO.2014# This tag requires that the tag GENERATE_RTF is set to YES.2015RTF_HYPERLINKS = NO2017# Load stylesheet definitions from file. Syntax is similar to doxygen's2019# configuration file, i.e. a series of assignments. You only have to provide2020# replacements, missing definitions are set to their default value.2021#2022# See also section "Doxygen usage" for information on how to generate the2023# default style sheet that doxygen normally uses.2024# This tag requires that the tag GENERATE_RTF is set to YES.2025RTF_STYLESHEET_FILE =2027# Set optional variables used in the generation of an RTF document. Syntax is2029# similar to doxygen's configuration file. A template extensions file can be2030# generated using doxygen -e rtf extensionFile.2031# This tag requires that the tag GENERATE_RTF is set to YES.2032RTF_EXTENSIONS_FILE =2034# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code2036# with syntax highlighting in the RTF output.2037#2038# Note that which sources are shown also depends on other settings such as2039# SOURCE_BROWSER.2040# The default value is: NO.2041# This tag requires that the tag GENERATE_RTF is set to YES.2042RTF_SOURCE_CODE = NO2044#---------------------------------------------------------------------------2046# Configuration options related to the man page output2047#---------------------------------------------------------------------------2048# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for2050# classes and files.2051# The default value is: NO.2052GENERATE_MAN = NO2054# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a2056# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of2057# it. A directory man3 will be created inside the directory specified by2058# MAN_OUTPUT.2059# The default directory is: man.2060# This tag requires that the tag GENERATE_MAN is set to YES.2061MAN_OUTPUT = man2063# The MAN_EXTENSION tag determines the extension that is added to the generated2065# man pages. In case the manual section does not start with a number, the number2066# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is2067# optional.2068# The default value is: .3.2069# This tag requires that the tag GENERATE_MAN is set to YES.2070MAN_EXTENSION = .32072# The MAN_SUBDIR tag determines the name of the directory created within2074# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by2075# MAN_EXTENSION with the initial . removed.2076# This tag requires that the tag GENERATE_MAN is set to YES.2077MAN_SUBDIR =2079# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it2081# will generate one additional man file for each entity documented in the real2082# man page(s). These additional files only source the real man page, but without2083# them the man command would be unable to find the correct page.2084# The default value is: NO.2085# This tag requires that the tag GENERATE_MAN is set to YES.2086MAN_LINKS = NO2088#---------------------------------------------------------------------------2090# Configuration options related to the XML output2091#---------------------------------------------------------------------------2092# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that2094# captures the structure of the code including all documentation.2095# The default value is: NO.2096GENERATE_XML = NO2098# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a2100# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of2101# it.2102# The default directory is: xml.2103# This tag requires that the tag GENERATE_XML is set to YES.2104XML_OUTPUT = xml2106# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program2108# listings (including syntax highlighting and cross-referencing information) to2109# the XML output. Note that enabling this will significantly increase the size2110# of the XML output.2111# The default value is: YES.2112# This tag requires that the tag GENERATE_XML is set to YES.2113XML_PROGRAMLISTING = YES2115# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include2117# namespace members in file scope as well, matching the HTML output.2118# The default value is: NO.2119# This tag requires that the tag GENERATE_XML is set to YES.2120XML_NS_MEMB_FILE_SCOPE = NO2122#---------------------------------------------------------------------------2124# Configuration options related to the DOCBOOK output2125#---------------------------------------------------------------------------2126# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files2128# that can be used to generate PDF.2129# The default value is: NO.2130GENERATE_DOCBOOK = NO2132# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.2134# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in2135# front of it.2136# The default directory is: docbook.2137# This tag requires that the tag GENERATE_DOCBOOK is set to YES.2138DOCBOOK_OUTPUT = docbook2140# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the2142# program listings (including syntax highlighting and cross-referencing2143# information) to the DOCBOOK output. Note that enabling this will significantly2144# increase the size of the DOCBOOK output.2145# The default value is: NO.2146# This tag requires that the tag GENERATE_DOCBOOK is set to YES.2147DOCBOOK_PROGRAMLISTING = NO2149#---------------------------------------------------------------------------2151# Configuration options for the AutoGen Definitions output2152#---------------------------------------------------------------------------2153# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an2155# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures2156# the structure of the code including all documentation. Note that this feature2157# is still experimental and incomplete at the moment.2158# The default value is: NO.2159GENERATE_AUTOGEN_DEF = NO2161#---------------------------------------------------------------------------2163# Configuration options related to the Perl module output2164#---------------------------------------------------------------------------2165# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module2167# file that captures the structure of the code including all documentation.2168#2169# Note that this feature is still experimental and incomplete at the moment.2170# The default value is: NO.2171GENERATE_PERLMOD = NO2173# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary2175# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI2176# output from the Perl module output.2177# The default value is: NO.2178# This tag requires that the tag GENERATE_PERLMOD is set to YES.2179PERLMOD_LATEX = NO2181# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely2183# formatted so it can be parsed by a human reader. This is useful if you want to2184# understand what is going on. On the other hand, if this tag is set to NO, the2185# size of the Perl module output will be much smaller and Perl will parse it2186# just the same.2187# The default value is: YES.2188# This tag requires that the tag GENERATE_PERLMOD is set to YES.2189PERLMOD_PRETTY = YES2191# The names of the make variables in the generated doxyrules.make file are2193# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful2194# so different doxyrules.make files included by the same Makefile don't2195# overwrite each other's variables.2196# This tag requires that the tag GENERATE_PERLMOD is set to YES.2197PERLMOD_MAKEVAR_PREFIX =2199#---------------------------------------------------------------------------2201# Configuration options related to the preprocessor2202#---------------------------------------------------------------------------2203# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all2205# C-preprocessor directives found in the sources and include files.2206# The default value is: YES.2207ENABLE_PREPROCESSING = YES2209# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names2211# in the source code. If set to NO, only conditional compilation will be2212# performed. Macro expansion can be done in a controlled way by setting2213# EXPAND_ONLY_PREDEF to YES.2214# The default value is: NO.2215# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2216MACRO_EXPANSION = NO2218# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then2220# the macro expansion is limited to the macros specified with the PREDEFINED and2221# EXPAND_AS_DEFINED tags.2222# The default value is: NO.2223# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2224EXPAND_ONLY_PREDEF = NO2226# If the SEARCH_INCLUDES tag is set to YES, the include files in the2228# INCLUDE_PATH will be searched if a #include is found.2229# The default value is: YES.2230# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2231SEARCH_INCLUDES = YES2233# The INCLUDE_PATH tag can be used to specify one or more directories that2235# contain include files that are not input files but should be processed by the2236# preprocessor.2237# This tag requires that the tag SEARCH_INCLUDES is set to YES.2238INCLUDE_PATH =2240# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard2242# patterns (like *.h and *.hpp) to filter out the header-files in the2243# directories. If left blank, the patterns specified with FILE_PATTERNS will be2244# used.2245# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2246INCLUDE_FILE_PATTERNS =2248# The PREDEFINED tag can be used to specify one or more macro names that are2250# defined before the preprocessor is started (similar to the -D option of e.g.2251# gcc). The argument of the tag is a list of macros of the form: name or2252# name=definition (no spaces). If the definition and the "=" are omitted, "=1"2253# is assumed. To prevent a macro definition from being undefined via #undef or2254# recursively expanded use the := operator instead of the = operator.2255# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2256PREDEFINED =2258# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this2260# tag can be used to specify a list of macro names that should be expanded. The2261# macro definition that is found in the sources will be used. Use the PREDEFINED2262# tag if you want to use a different macro definition that overrules the2263# definition found in the source code.2264# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2265EXPAND_AS_DEFINED =2267# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will2269# remove all references to function-like macros that are alone on a line, have2270# an all uppercase name, and do not end with a semicolon. Such function macros2271# are typically used for boiler-plate code, and will confuse the parser if not2272# removed.2273# The default value is: YES.2274# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2275SKIP_FUNCTION_MACROS = YES2277#---------------------------------------------------------------------------2279# Configuration options related to external references2280#---------------------------------------------------------------------------2281# The TAGFILES tag can be used to specify one or more tag files. For each tag2283# file the location of the external documentation should be added. The format of2284# a tag file without this location is as follows:2285# TAGFILES = file1 file2 ...2286# Adding location for the tag files is done as follows:2287# TAGFILES = file1=loc1 "file2 = loc2" ...2288# where loc1 and loc2 can be relative or absolute paths or URLs. See the2289# section "Linking to external documentation" for more information about the use2290# of tag files.2291# Note: Each tag file must have a unique name (where the name does NOT include2292# the path). If a tag file is not located in the directory in which doxygen is2293# run, you must also specify the path to the tagfile here.2294TAGFILES =2296# When a file name is specified after GENERATE_TAGFILE, doxygen will create a2298# tag file that is based on the input files it reads. See section "Linking to2299# external documentation" for more information about the usage of tag files.2300GENERATE_TAGFILE =2302# If the ALLEXTERNALS tag is set to YES, all external class will be listed in2304# the class index. If set to NO, only the inherited external classes will be2305# listed.2306# The default value is: NO.2307ALLEXTERNALS = NO2309# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed2311# in the modules index. If set to NO, only the current project's groups will be2312# listed.2313# The default value is: YES.2314EXTERNAL_GROUPS = YES2316# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in2318# the related pages index. If set to NO, only the current project's pages will2319# be listed.2320# The default value is: YES.2321EXTERNAL_PAGES = YES2323#---------------------------------------------------------------------------2325# Configuration options related to the dot tool2326#---------------------------------------------------------------------------2327# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram2329# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2330# NO turns the diagrams off. Note that this option also works with HAVE_DOT2331# disabled, but it is recommended to install and use dot, since it yields more2332# powerful graphs.2333# The default value is: YES.2334CLASS_DIAGRAMS = YES2336# You can include diagrams made with dia in doxygen documentation. Doxygen will2338# then run dia to produce the diagram and insert it in the documentation. The2339# DIA_PATH tag allows you to specify the directory where the dia binary resides.2340# If left empty dia is assumed to be found in the default search path.2341DIA_PATH =2343# If set to YES the inheritance and collaboration graphs will hide inheritance2345# and usage relations if the target is undocumented or is not a class.2346# The default value is: YES.2347HIDE_UNDOC_RELATIONS = YES2349# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2351# available from the path. This tool is part of Graphviz (see:2352# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2353# Bell Labs. The other options in this section have no effect if this option is2354# set to NO2355# The default value is: YES.2356HAVE_DOT = YES2358# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2360# to run in parallel. When set to 0 doxygen will base this on the number of2361# processors available in the system. You can set it explicitly to a value2362# larger than 0 to get control over the balance between CPU load and processing2363# speed.2364# Minimum value: 0, maximum value: 32, default value: 0.2365# This tag requires that the tag HAVE_DOT is set to YES.2366DOT_NUM_THREADS = 02368# When you want a differently looking font in the dot files that doxygen2370# generates you can specify the font name using DOT_FONTNAME. You need to make2371# sure dot is able to find the font, which can be done by putting it in a2372# standard location or by setting the DOTFONTPATH environment variable or by2373# setting DOT_FONTPATH to the directory containing the font.2374# The default value is: Helvetica.2375# This tag requires that the tag HAVE_DOT is set to YES.2376DOT_FONTNAME = Helvetica2378# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2380# dot graphs.2381# Minimum value: 4, maximum value: 24, default value: 10.2382# This tag requires that the tag HAVE_DOT is set to YES.2383DOT_FONTSIZE = 102385# By default doxygen will tell dot to use the default font as specified with2387# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2388# the path where dot can find it using this tag.2389# This tag requires that the tag HAVE_DOT is set to YES.2390DOT_FONTPATH =2392# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2394# each documented class showing the direct and indirect inheritance relations.2395# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2396# The default value is: YES.2397# This tag requires that the tag HAVE_DOT is set to YES.2398CLASS_GRAPH = YES2400# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2402# graph for each documented class showing the direct and indirect implementation2403# dependencies (inheritance, containment, and class references variables) of the2404# class with other documented classes.2405# The default value is: YES.2406# This tag requires that the tag HAVE_DOT is set to YES.2407COLLABORATION_GRAPH = YES2409# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2411# groups, showing the direct groups dependencies.2412# The default value is: YES.2413# This tag requires that the tag HAVE_DOT is set to YES.2414GROUP_GRAPHS = YES2416# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and2418# collaboration diagrams in a style similar to the OMG's Unified Modeling2419# Language.2420# The default value is: NO.2421# This tag requires that the tag HAVE_DOT is set to YES.2422UML_LOOK = NO2424# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2426# class node. If there are many fields or methods and many nodes the graph may2427# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2428# number of items for each type to make the size more manageable. Set this to 02429# for no limit. Note that the threshold may be exceeded by 50% before the limit2430# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2431# but if the number exceeds 15, the total amount of fields shown is limited to2432# 10.2433# Minimum value: 0, maximum value: 100, default value: 10.2434# This tag requires that the tag UML_LOOK is set to YES.2435UML_LIMIT_NUM_FIELDS = 102437# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and2439# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS2440# tag is set to YES, doxygen will add type and arguments for attributes and2441# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen2442# will not generate fields with class member information in the UML graphs. The2443# class diagrams will look similar to the default class diagrams but using UML2444# notation for the relationships.2445# Possible values are: NO, YES and NONE.2446# The default value is: NO.2447# This tag requires that the tag UML_LOOK is set to YES.2448DOT_UML_DETAILS = NO2450# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters2452# to display on a single line. If the actual line length exceeds this threshold2453# significantly it will wrapped across multiple lines. Some heuristics are apply2454# to avoid ugly line breaks.2455# Minimum value: 0, maximum value: 1000, default value: 17.2456# This tag requires that the tag HAVE_DOT is set to YES.2457DOT_WRAP_THRESHOLD = 172459# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2461# collaboration graphs will show the relations between templates and their2462# instances.2463# The default value is: NO.2464# This tag requires that the tag HAVE_DOT is set to YES.2465TEMPLATE_RELATIONS = NO2467# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2469# YES then doxygen will generate a graph for each documented file showing the2470# direct and indirect include dependencies of the file with other documented2471# files.2472# The default value is: YES.2473# This tag requires that the tag HAVE_DOT is set to YES.2474INCLUDE_GRAPH = YES2476# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2478# set to YES then doxygen will generate a graph for each documented file showing2479# the direct and indirect include dependencies of the file with other documented2480# files.2481# The default value is: YES.2482# This tag requires that the tag HAVE_DOT is set to YES.2483INCLUDED_BY_GRAPH = YES2485# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2487# dependency graph for every global function or class method.2488#2489# Note that enabling this option will significantly increase the time of a run.2490# So in most cases it will be better to enable call graphs for selected2491# functions only using the \callgraph command. Disabling a call graph can be2492# accomplished by means of the command \hidecallgraph.2493# The default value is: NO.2494# This tag requires that the tag HAVE_DOT is set to YES.2495CALL_GRAPH = NO2497# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2499# dependency graph for every global function or class method.2500#2501# Note that enabling this option will significantly increase the time of a run.2502# So in most cases it will be better to enable caller graphs for selected2503# functions only using the \callergraph command. Disabling a caller graph can be2504# accomplished by means of the command \hidecallergraph.2505# The default value is: NO.2506# This tag requires that the tag HAVE_DOT is set to YES.2507CALLER_GRAPH = NO2509# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2511# hierarchy of all classes instead of a textual one.2512# The default value is: YES.2513# This tag requires that the tag HAVE_DOT is set to YES.2514GRAPHICAL_HIERARCHY = YES2516# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2518# dependencies a directory has on other directories in a graphical way. The2519# dependency relations are determined by the #include relations between the2520# files in the directories.2521# The default value is: YES.2522# This tag requires that the tag HAVE_DOT is set to YES.2523DIRECTORY_GRAPH = YES2525# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2527# generated by dot. For an explanation of the image formats see the section2528# output formats in the documentation of the dot tool (Graphviz (see:2529# http://www.graphviz.org/)).2530# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2531# to make the SVG files visible in IE 9+ (other browsers do not have this2532# requirement).2533# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,2534# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,2535# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,2536# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and2537# png:gdiplus:gdiplus.2538# The default value is: png.2539# This tag requires that the tag HAVE_DOT is set to YES.2540DOT_IMAGE_FORMAT = png2542# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2544# enable generation of interactive SVG images that allow zooming and panning.2545#2546# Note that this requires a modern browser other than Internet Explorer. Tested2547# and working are Firefox, Chrome, Safari, and Opera.2548# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2549# the SVG files visible. Older versions of IE do not have SVG support.2550# The default value is: NO.2551# This tag requires that the tag HAVE_DOT is set to YES.2552INTERACTIVE_SVG = NO2554# The DOT_PATH tag can be used to specify the path where the dot tool can be2556# found. If left blank, it is assumed the dot tool can be found in the path.2557# This tag requires that the tag HAVE_DOT is set to YES.2558DOT_PATH =2560# The DOTFILE_DIRS tag can be used to specify one or more directories that2562# contain dot files that are included in the documentation (see the \dotfile2563# command).2564# This tag requires that the tag HAVE_DOT is set to YES.2565DOTFILE_DIRS =2567# The MSCFILE_DIRS tag can be used to specify one or more directories that2569# contain msc files that are included in the documentation (see the \mscfile2570# command).2571MSCFILE_DIRS =2573# The DIAFILE_DIRS tag can be used to specify one or more directories that2575# contain dia files that are included in the documentation (see the \diafile2576# command).2577DIAFILE_DIRS =2579# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the2581# path where java can find the plantuml.jar file. If left blank, it is assumed2582# PlantUML is not used or called during a preprocessing step. Doxygen will2583# generate a warning when it encounters a \startuml command in this case and2584# will not generate output for the diagram.2585PLANTUML_JAR_PATH =2587# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a2589# configuration file for plantuml.2590PLANTUML_CFG_FILE =2592# When using plantuml, the specified paths are searched for files specified by2594# the !include statement in a plantuml block.2595PLANTUML_INCLUDE_PATH =2597# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2599# that will be shown in the graph. If the number of nodes in a graph becomes2600# larger than this value, doxygen will truncate the graph, which is visualized2601# by representing a node as a red box. Note that doxygen if the number of direct2602# children of the root node in a graph is already larger than2603# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2604# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2605# Minimum value: 0, maximum value: 10000, default value: 50.2606# This tag requires that the tag HAVE_DOT is set to YES.2607DOT_GRAPH_MAX_NODES = 502609# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2611# generated by dot. A depth value of 3 means that only nodes reachable from the2612# root by following a path via at most 3 edges will be shown. Nodes that lay2613# further from the root node will be omitted. Note that setting this option to 12614# or 2 may greatly reduce the computation time needed for large code bases. Also2615# note that the size of a graph can be further restricted by2616# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2617# Minimum value: 0, maximum value: 1000, default value: 0.2618# This tag requires that the tag HAVE_DOT is set to YES.2619MAX_DOT_GRAPH_DEPTH = 02621# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2623# background. This is disabled by default, because dot on Windows does not seem2624# to support this out of the box.2625#2626# Warning: Depending on the platform used, enabling this option may lead to2627# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2628# read).2629# The default value is: NO.2630# This tag requires that the tag HAVE_DOT is set to YES.2631DOT_TRANSPARENT = NO2633# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output2635# files in one run (i.e. multiple -o and -T options on the command line). This2636# makes dot run faster, but since only newer versions of dot (>1.8.10) support2637# this, this feature is disabled by default.2638# The default value is: NO.2639# This tag requires that the tag HAVE_DOT is set to YES.2640DOT_MULTI_TARGETS = NO2642# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2644# explaining the meaning of the various boxes and arrows in the dot generated2645# graphs.2646# The default value is: YES.2647# This tag requires that the tag HAVE_DOT is set to YES.2648GENERATE_LEGEND = YES2650# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate2652# files that are used to generate the various graphs.2653#2654# Note: This setting is not only used for dot files but also for msc and2655# plantuml temporary files.2656# The default value is: YES.2657DOT_CLEANUP = YES