NBash
2553 строки · 109.6 Кб
1# Doxyfile 1.8.202# 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 = "The Bash Argsparse Library"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 = 1.842# 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 = "An high level argument parsing library for bash."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 =62# 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 =130# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then132# doxygen will generate a detailed section even if there is only a brief133# description.134# The default value is: NO.135ALWAYS_DETAILED_SEC = NO137# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all139# inherited members of a class in the documentation of that class as if those140# members were ordinary class members. Constructors, destructors and assignment141# operators of the base classes will not be shown.142# The default value is: NO.143INLINE_INHERITED_MEMB = NO145# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path147# before files name in the file list and in the header files. If set to NO the148# shortest path that makes the file name unique will be used149# The default value is: YES.150FULL_PATH_NAMES = YES152# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.154# Stripping is only done if one of the specified strings matches the left-hand155# part of the path. The tag can be used to show relative paths in the file list.156# If left blank the directory from which doxygen is run is used as the path to157# strip.158#159# Note that you can specify absolute paths here, but also relative paths, which160# will be relative from the directory where doxygen is started.161# This tag requires that the tag FULL_PATH_NAMES is set to YES.162STRIP_FROM_PATH =164# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the166# path mentioned in the documentation of a class, which tells the reader which167# header file to include in order to use a class. If left blank only the name of168# the header file containing the class definition is used. Otherwise one should169# specify the list of include paths that are normally passed to the compiler170# using the -I flag.171STRIP_FROM_INC_PATH =173# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but175# less readable) file names. This can be useful is your file systems doesn't176# support long names like on DOS, Mac, or CD-ROM.177# The default value is: NO.178SHORT_NAMES = NO180# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the182# first line (until the first dot) of a Javadoc-style comment as the brief183# description. If set to NO, the Javadoc-style will behave just like regular Qt-184# style comments (thus requiring an explicit @brief command for a brief185# description.)186# The default value is: NO.187JAVADOC_AUTOBRIEF = NO189# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line191# such as192# /***************193# as being the beginning of a Javadoc-style comment "banner". If set to NO, the194# Javadoc-style will behave just like regular comments and it will not be195# interpreted by doxygen.196# The default value is: NO.197JAVADOC_BANNER = NO199# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first201# line (until the first dot) of a Qt-style comment as the brief description. If202# set to NO, the Qt-style will behave just like regular Qt-style comments (thus203# requiring an explicit \brief command for a brief description.)204# The default value is: NO.205QT_AUTOBRIEF = NO207# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a209# multi-line C++ special comment block (i.e. a block of //! or /// comments) as210# a brief description. This used to be the default behavior. The new default is211# to treat a multi-line C++ comment block as a detailed description. Set this212# tag to YES if you prefer the old behavior instead.213#214# Note that setting this tag to YES also means that rational rose comments are215# not recognized any more.216# The default value is: NO.217MULTILINE_CPP_IS_BRIEF = NO219# By default Python docstrings are displayed as preformatted text and doxygen's221# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the222# doxygen's special commands can be used and the contents of the docstring223# documentation blocks is shown as doxygen documentation.224# The default value is: YES.225PYTHON_DOCSTRING = YES227# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the229# documentation from any documented member that it re-implements.230# The default value is: YES.231INHERIT_DOCS = YES233# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new235# page for each member. If set to NO, the documentation of a member will be part236# of the file/class/namespace that contains it.237# The default value is: NO.238SEPARATE_MEMBER_PAGES = NO240# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen242# uses this value to replace tabs by spaces in code fragments.243# Minimum value: 1, maximum value: 16, default value: 4.244TAB_SIZE = 8246# This tag can be used to specify a number of aliases that act as commands in248# the documentation. An alias has the form:249# name=value250# For example adding251# "sideeffect=@par Side Effects:\n"252# will allow you to put the command \sideeffect (or @sideeffect) in the253# documentation, which will result in a user-defined paragraph with heading254# "Side Effects:". You can put \n's in the value part of an alias to insert255# newlines (in the resulting output). You can put ^^ in the value part of an256# alias to insert a newline as if a physical newline was in the original file.257# When you need a literal { or } or , in the value part of an alias you have to258# escape them by means of a backslash (\), this can lead to conflicts with the259# commands \{ and \} for these it is advised to use the version @{ and @} or use260# a double escape (\\{ and \\})261ALIASES =263# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources265# only. Doxygen will then generate output that is more tailored for C. For266# instance, some of the names that are used will be different. The list of all267# members will be omitted, etc.268# The default value is: NO.269OPTIMIZE_OUTPUT_FOR_C = NO271# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or273# Python sources only. Doxygen will then generate output that is more tailored274# for that language. For instance, namespaces will be presented as packages,275# qualified scopes will look different, etc.276# The default value is: NO.277OPTIMIZE_OUTPUT_JAVA = NO279# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran281# sources. Doxygen will then generate output that is tailored for Fortran.282# The default value is: NO.283OPTIMIZE_FOR_FORTRAN = NO285# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL287# sources. Doxygen will then generate output that is tailored for VHDL.288# The default value is: NO.289OPTIMIZE_OUTPUT_VHDL = NO291# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice293# sources only. Doxygen will then generate output that is more tailored for that294# language. For instance, namespaces will be presented as modules, types will be295# separated into more groups, etc.296# The default value is: NO.297OPTIMIZE_OUTPUT_SLICE = NO299# Doxygen selects the parser to use depending on the extension of the files it301# parses. With this tag you can assign which parser to use for a given302# extension. Doxygen has a built-in mapping, but you can override or extend it303# using this tag. The format is ext=language, where ext is a file extension, and304# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,305# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,306# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:307# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser308# tries to guess whether the code is fixed or free formatted code, this is the309# default for Fortran type files). For instance to make doxygen treat .inc files310# as Fortran files (default is PHP), and .f files as C (default is Fortran),311# use: inc=Fortran f=C.312#313# Note: For files without extension you can use no_extension as a placeholder.314#315# Note that for custom extensions you also need to set FILE_PATTERNS otherwise316# the files are not read by doxygen.317EXTENSION_MAPPING = sh=C319# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments321# according to the Markdown format, which allows for more readable322# documentation. See https://daringfireball.net/projects/markdown/ for details.323# The output of markdown processing is further processed by doxygen, so you can324# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in325# case of backward compatibilities issues.326# The default value is: YES.327MARKDOWN_SUPPORT = YES329# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up331# to that level are automatically included in the table of contents, even if332# they do not have an id attribute.333# Note: This feature currently applies only to Markdown headings.334# Minimum value: 0, maximum value: 99, default value: 5.335# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.336TOC_INCLUDE_HEADINGS = 5338# When enabled doxygen tries to link words that correspond to documented340# classes, or namespaces to their corresponding documentation. Such a link can341# be prevented in individual cases by putting a % sign in front of the word or342# globally by setting AUTOLINK_SUPPORT to NO.343# The default value is: YES.344AUTOLINK_SUPPORT = YES346# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want348# to include (a tag file for) the STL sources as input, then you should set this349# tag to YES in order to let doxygen match functions declarations and350# definitions whose arguments contain STL classes (e.g. func(std::string);351# versus func(std::string) {}). This also make the inheritance and collaboration352# diagrams that involve STL classes more complete and accurate.353# The default value is: NO.354BUILTIN_STL_SUPPORT = NO356# If you use Microsoft's C++/CLI language, you should set this option to YES to358# enable parsing support.359# The default value is: NO.360CPP_CLI_SUPPORT = NO362# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:364# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen365# will parse them like normal C++ but will assume all classes use public instead366# of private inheritance when no explicit protection keyword is present.367# The default value is: NO.368SIP_SUPPORT = NO370# For Microsoft's IDL there are propget and propput attributes to indicate372# getter and setter methods for a property. Setting this option to YES will make373# doxygen to replace the get and set methods by a property in the documentation.374# This will only work if the methods are indeed getting or setting a simple375# type. If this is not the case, or you want to show the methods anyway, you376# should set this option to NO.377# The default value is: YES.378IDL_PROPERTY_SUPPORT = YES380# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC382# tag is set to YES then doxygen will reuse the documentation of the first383# member in the group (if any) for the other members of the group. By default384# all members of a group must be documented explicitly.385# The default value is: NO.386DISTRIBUTE_GROUP_DOC = NO388# If one adds a struct or class to a group and this option is enabled, then also390# any nested class or struct is added to the same group. By default this option391# is disabled and one has to add nested compounds explicitly via \ingroup.392# The default value is: NO.393GROUP_NESTED_COMPOUNDS = NO395# Set the SUBGROUPING tag to YES to allow class member groups of the same type397# (for instance a group of public functions) to be put as a subgroup of that398# type (e.g. under the Public Functions section). Set it to NO to prevent399# subgrouping. Alternatively, this can be done per class using the400# \nosubgrouping command.401# The default value is: YES.402SUBGROUPING = YES404# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions406# are shown inside the group in which they are included (e.g. using \ingroup)407# instead of on a separate page (for HTML and Man pages) or section (for LaTeX408# and RTF).409#410# Note that this feature does not work in combination with411# SEPARATE_MEMBER_PAGES.412# The default value is: NO.413INLINE_GROUPED_CLASSES = NO415# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions417# with only public data fields or simple typedef fields will be shown inline in418# the documentation of the scope in which they are defined (i.e. file,419# namespace, or group documentation), provided this scope is documented. If set420# to NO, structs, classes, and unions are shown on a separate page (for HTML and421# Man pages) or section (for LaTeX and RTF).422# The default value is: NO.423INLINE_SIMPLE_STRUCTS = NO425# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or427# enum is documented as struct, union, or enum with the name of the typedef. So428# typedef struct TypeS {} TypeT, will appear in the documentation as a struct429# with name TypeT. When disabled the typedef will appear as a member of a file,430# namespace, or class. And the struct will be named TypeS. This can typically be431# useful for C code in case the coding convention dictates that all compound432# types are typedef'ed and only the typedef is referenced, never the tag name.433# The default value is: NO.434TYPEDEF_HIDES_STRUCT = NO436# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This438# cache is used to resolve symbols given their name and scope. Since this can be439# an expensive process and often the same symbol appears multiple times in the440# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small441# doxygen will become slower. If the cache is too large, memory is wasted. The442# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range443# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536444# symbols. At the end of a run doxygen will report the cache usage and suggest445# the optimal cache size from a speed point of view.446# Minimum value: 0, maximum value: 9, default value: 0.447LOOKUP_CACHE_SIZE = 0449# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use451# during processing. When set to 0 doxygen will based this on the number of452# cores available in the system. You can set it explicitly to a value larger453# than 0 to get more control over the balance between CPU load and processing454# speed. At this moment only the input processing can be done using multiple455# threads. Since this is still an experimental feature the default is set to 1,456# which efficively disables parallel processing. Please report any issues you457# encounter. Generating dot graphs in parallel is controlled by the458# DOT_NUM_THREADS setting.459# Minimum value: 0, maximum value: 32, default value: 1.460NUM_PROC_THREADS = 1462#---------------------------------------------------------------------------464# Build related configuration options465#---------------------------------------------------------------------------466# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in468# documentation are documented, even if no documentation was available. Private469# class members and static file members will be hidden unless the470# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.471# Note: This will also disable the warnings about undocumented members that are472# normally produced when WARNINGS is set to YES.473# The default value is: NO.474EXTRACT_ALL = NO476# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will478# be included in the documentation.479# The default value is: NO.480EXTRACT_PRIVATE = NO482# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual484# methods of a class will be included in the documentation.485# The default value is: NO.486EXTRACT_PRIV_VIRTUAL = NO488# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal490# scope will be included in the documentation.491# The default value is: NO.492EXTRACT_PACKAGE = NO494# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be496# included in the documentation.497# The default value is: NO.498EXTRACT_STATIC = NO500# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined502# locally in source files will be included in the documentation. If set to NO,503# only classes defined in header files are included. Does not have any effect504# for Java sources.505# The default value is: YES.506EXTRACT_LOCAL_CLASSES = YES508# This flag is only useful for Objective-C code. If set to YES, local methods,510# which are defined in the implementation section but not in the interface are511# included in the documentation. If set to NO, only methods in the interface are512# included.513# The default value is: NO.514EXTRACT_LOCAL_METHODS = NO516# If this flag is set to YES, the members of anonymous namespaces will be518# extracted and appear in the documentation as a namespace called519# 'anonymous_namespace{file}', where file will be replaced with the base name of520# the file that contains the anonymous namespace. By default anonymous namespace521# are hidden.522# The default value is: NO.523EXTRACT_ANON_NSPACES = NO525# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all527# undocumented members inside documented classes or files. If set to NO these528# members will be included in the various overviews, but no documentation529# section is generated. This option has no effect if EXTRACT_ALL is enabled.530# The default value is: NO.531HIDE_UNDOC_MEMBERS = NO533# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all535# undocumented classes that are normally visible in the class hierarchy. If set536# to NO, these classes will be included in the various overviews. This option537# has no effect if EXTRACT_ALL is enabled.538# The default value is: NO.539HIDE_UNDOC_CLASSES = NO541# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend543# declarations. If set to NO, these declarations will be included in the544# documentation.545# The default value is: NO.546HIDE_FRIEND_COMPOUNDS = NO548# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any550# documentation blocks found inside the body of a function. If set to NO, these551# blocks will be appended to the function's detailed documentation block.552# The default value is: NO.553HIDE_IN_BODY_DOCS = NO555# The INTERNAL_DOCS tag determines if documentation that is typed after a557# \internal command is included. If the tag is set to NO then the documentation558# will be excluded. Set it to YES to include the internal documentation.559# The default value is: NO.560INTERNAL_DOCS = NO562# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file564# names in lower-case letters. If set to YES, upper-case letters are also565# allowed. This is useful if you have classes or files whose names only differ566# in case and if your file system supports case sensitive file names. Windows567# (including Cygwin) and Mac users are advised to set this option to NO.568# The default value is: system dependent.569CASE_SENSE_NAMES = YES571# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with573# their full class and namespace scopes in the documentation. If set to YES, the574# scope will be hidden.575# The default value is: NO.576HIDE_SCOPE_NAMES = NO578# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will580# append additional text to a page's title, such as Class Reference. If set to581# YES the compound reference will be hidden.582# The default value is: NO.583HIDE_COMPOUND_REFERENCE= NO585# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of587# the files that are included by a file in the documentation of that file.588# The default value is: YES.589SHOW_INCLUDE_FILES = YES591# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each593# grouped member an include statement to the documentation, telling the reader594# which file to include in order to use the member.595# The default value is: NO.596SHOW_GROUPED_MEMB_INC = NO598# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include600# files with double quotes in the documentation rather than with sharp brackets.601# The default value is: NO.602FORCE_LOCAL_INCLUDES = NO604# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the606# documentation for inline members.607# The default value is: YES.608INLINE_INFO = YES610# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the612# (detailed) documentation of file and class members alphabetically by member613# name. If set to NO, the members will appear in declaration order.614# The default value is: YES.615SORT_MEMBER_DOCS = YES617# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief619# descriptions of file, namespace and class members alphabetically by member620# name. If set to NO, the members will appear in declaration order. Note that621# this will also influence the order of the classes in the class list.622# The default value is: NO.623SORT_BRIEF_DOCS = YES625# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the627# (brief and detailed) documentation of class members so that constructors and628# destructors are listed first. If set to NO the constructors will appear in the629# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.630# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief631# member documentation.632# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting633# detailed member documentation.634# The default value is: NO.635SORT_MEMBERS_CTORS_1ST = NO637# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy639# of group names into alphabetical order. If set to NO the group names will640# appear in their defined order.641# The default value is: NO.642SORT_GROUP_NAMES = NO644# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by646# fully-qualified names, including namespaces. If set to NO, the class list will647# be sorted only by class name, not including the namespace part.648# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.649# Note: This option applies only to the class list, not to the alphabetical650# list.651# The default value is: NO.652SORT_BY_SCOPE_NAME = NO654# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper656# type resolution of all parameters of a function it will reject a match between657# the prototype and the implementation of a member function even if there is658# only one candidate or it is obvious which candidate to choose by doing a659# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still660# accept a match between prototype and implementation in such cases.661# The default value is: NO.662STRICT_PROTO_MATCHING = NO664# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo666# list. This list is created by putting \todo commands in the documentation.667# The default value is: YES.668GENERATE_TODOLIST = YES670# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test672# list. This list is created by putting \test commands in the documentation.673# The default value is: YES.674GENERATE_TESTLIST = YES676# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug678# list. This list is created by putting \bug commands in the documentation.679# The default value is: YES.680GENERATE_BUGLIST = YES682# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)684# the deprecated list. This list is created by putting \deprecated commands in685# the documentation.686# The default value is: YES.687GENERATE_DEPRECATEDLIST= YES689# The ENABLED_SECTIONS tag can be used to enable conditional documentation691# sections, marked by \if <section_label> ... \endif and \cond <section_label>692# ... \endcond blocks.693ENABLED_SECTIONS =695# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the697# initial value of a variable or macro / define can have for it to appear in the698# documentation. If the initializer consists of more lines than specified here699# it will be hidden. Use a value of 0 to hide initializers completely. The700# appearance of the value of individual variables and macros / defines can be701# controlled using \showinitializer or \hideinitializer command in the702# documentation regardless of this setting.703# Minimum value: 0, maximum value: 10000, default value: 30.704MAX_INITIALIZER_LINES = 30706# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at708# the bottom of the documentation of classes and structs. If set to YES, the709# list will mention the files that were used to generate the documentation.710# The default value is: YES.711SHOW_USED_FILES = YES713# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This715# will remove the Files entry from the Quick Index and from the Folder Tree View716# (if specified).717# The default value is: YES.718SHOW_FILES = YES720# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces722# page. This will remove the Namespaces entry from the Quick Index and from the723# Folder Tree View (if specified).724# The default value is: YES.725SHOW_NAMESPACES = YES727# The FILE_VERSION_FILTER tag can be used to specify a program or script that729# doxygen should invoke to get the current version for each file (typically from730# the version control system). Doxygen will invoke the program by executing (via731# popen()) the command command input-file, where command is the value of the732# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided733# by doxygen. Whatever the program writes to standard output is used as the file734# version. For an example see the documentation.735FILE_VERSION_FILTER =737# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed739# by doxygen. The layout file controls the global structure of the generated740# output files in an output format independent way. To create the layout file741# that represents doxygen's defaults, run doxygen with the -l option. You can742# optionally specify a file name after the option, if omitted DoxygenLayout.xml743# will be used as the name of the layout file.744#745# Note that if you run doxygen from a directory containing a file called746# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE747# tag is left empty.748LAYOUT_FILE =750# The CITE_BIB_FILES tag can be used to specify one or more bib files containing752# the reference definitions. This must be a list of .bib files. The .bib753# extension is automatically appended if omitted. This requires the bibtex tool754# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.755# For LaTeX the style of the bibliography can be controlled using756# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the757# search path. See also \cite for info how to create references.758CITE_BIB_FILES =760#---------------------------------------------------------------------------762# Configuration options related to warning and progress messages763#---------------------------------------------------------------------------764# The QUIET tag can be used to turn on/off the messages that are generated to766# standard output by doxygen. If QUIET is set to YES this implies that the767# messages are off.768# The default value is: NO.769QUIET = NO771# The WARNINGS tag can be used to turn on/off the warning messages that are773# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES774# this implies that the warnings are on.775#776# Tip: Turn warnings on while writing the documentation.777# The default value is: YES.778WARNINGS = YES780# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate782# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag783# will automatically be disabled.784# The default value is: YES.785WARN_IF_UNDOCUMENTED = YES787# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for789# potential errors in the documentation, such as not documenting some parameters790# in a documented function, or documenting parameters that don't exist or using791# markup commands wrongly.792# The default value is: YES.793WARN_IF_DOC_ERROR = YES795# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that797# are documented, but have no documentation for their parameters or return798# value. If set to NO, doxygen will only warn about wrong or incomplete799# parameter documentation, but not about the absence of documentation. If800# EXTRACT_ALL is set to YES then this flag will automatically be disabled.801# The default value is: NO.802WARN_NO_PARAMDOC = NO804# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when806# a warning is encountered.807# The default value is: NO.808WARN_AS_ERROR = NO810# The WARN_FORMAT tag determines the format of the warning messages that doxygen812# can produce. The string should contain the $file, $line, and $text tags, which813# will be replaced by the file and line number from which the warning originated814# and the warning text. Optionally the format may contain $version, which will815# be replaced by the version of the file (if it could be obtained via816# FILE_VERSION_FILTER)817# The default value is: $file:$line: $text.818WARN_FORMAT = "$file:$line: $text"820# The WARN_LOGFILE tag can be used to specify a file to which warning and error822# messages should be written. If left blank the output is written to standard823# error (stderr).824WARN_LOGFILE =826#---------------------------------------------------------------------------828# Configuration options related to the input files829#---------------------------------------------------------------------------830# The INPUT tag is used to specify the files and/or directories that contain832# documented source files. You may enter file names like myfile.cpp or833# directories like /usr/src/myproject. Separate the files or directories with834# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING835# Note: If this tag is empty the current directory is searched.836INPUT =838# This tag can be used to specify the character encoding of the source files840# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses841# libiconv (or the iconv built into libc) for the transcoding. See the libiconv842# documentation (see: https://www.gnu.org/software/libiconv/) for the list of843# possible encodings.844# The default value is: UTF-8.845INPUT_ENCODING = UTF-8847# If the value of the INPUT tag contains directories, you can use the849# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and850# *.h) to filter out the source-files in the directories.851#852# Note that for custom extensions or not directly supported extensions you also853# need to set EXTENSION_MAPPING for the extension otherwise the files are not854# read by doxygen.855#856# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,857# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,858# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,859# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),860# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen861# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,862# *.vhdl, *.ucf, *.qsf and *.ice.863FILE_PATTERNS = *.sh \865*.awk866# The RECURSIVE tag can be used to specify whether or not subdirectories should868# be searched for input files as well.869# The default value is: NO.870RECURSIVE = NO872# The EXCLUDE tag can be used to specify files and/or directories that should be874# excluded from the INPUT source files. This way you can easily exclude a875# subdirectory from a directory tree whose root is specified with the INPUT tag.876#877# Note that relative paths are relative to the directory from which doxygen is878# run.879EXCLUDE =881# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or883# directories that are symbolic links (a Unix file system feature) are excluded884# from the input.885# The default value is: NO.886EXCLUDE_SYMLINKS = NO888# If the value of the INPUT tag contains directories, you can use the890# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude891# certain files from those directories.892#893# Note that the wildcards are matched against the file with absolute path, so to894# exclude all test directories for example use the pattern */test/*895EXCLUDE_PATTERNS =897# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names899# (namespaces, classes, functions, etc.) that should be excluded from the900# output. The symbol name can be a fully qualified name, a word, or if the901# wildcard * is used, a substring. Examples: ANamespace, AClass,902# AClass::ANamespace, ANamespace::*Test903#904# Note that the wildcards are matched against the file with absolute path, so to905# exclude all test directories use the pattern */test/*906EXCLUDE_SYMBOLS =908# The EXAMPLE_PATH tag can be used to specify one or more files or directories910# that contain example code fragments that are included (see the \include911# command).912EXAMPLE_PATH =914# If the value of the EXAMPLE_PATH tag contains directories, you can use the916# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and917# *.h) to filter out the source-files in the directories. If left blank all918# files are included.919EXAMPLE_PATTERNS =921# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be923# searched for input files to be used with the \include or \dontinclude commands924# irrespective of the value of the RECURSIVE tag.925# The default value is: NO.926EXAMPLE_RECURSIVE = NO928# The IMAGE_PATH tag can be used to specify one or more files or directories930# that contain images that are to be included in the documentation (see the931# \image command).932IMAGE_PATH =934# The INPUT_FILTER tag can be used to specify a program that doxygen should936# invoke to filter for each input file. Doxygen will invoke the filter program937# by executing (via popen()) the command:938#939# <filter> <input-file>940#941# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the942# name of an input file. Doxygen will then use the output that the filter943# program writes to standard output. If FILTER_PATTERNS is specified, this tag944# will be ignored.945#946# Note that the filter must not add or remove lines; it is applied before the947# code is scanned, but not when the output code is generated. If lines are added948# or removed, the anchors will not be placed correctly.949#950# Note that for custom extensions or not directly supported extensions you also951# need to set EXTENSION_MAPPING for the extension otherwise the files are not952# properly processed by doxygen.953INPUT_FILTER = "sed -n -f doxygen-bash.sed -- "955# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern957# basis. Doxygen will compare the file name with each pattern and apply the958# filter if there is a match. The filters are a list of the form: pattern=filter959# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how960# filters are used. If the FILTER_PATTERNS tag is empty or if none of the961# patterns match the file name, INPUT_FILTER is applied.962#963# Note that for custom extensions or not directly supported extensions you also964# need to set EXTENSION_MAPPING for the extension otherwise the files are not965# properly processed by doxygen.966FILTER_PATTERNS =968# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using970# INPUT_FILTER) will also be used to filter the input files that are used for971# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).972# The default value is: NO.973FILTER_SOURCE_FILES = YES975# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file977# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and978# it is also possible to disable source filtering for a specific pattern using979# *.ext= (so without naming a filter).980# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.981FILTER_SOURCE_PATTERNS =983# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that985# is part of the input, its contents will be placed on the main page986# (index.html). This can be useful if you have a project on for instance GitHub987# and want to reuse the introduction page also for the doxygen output.988USE_MDFILE_AS_MAINPAGE =990#---------------------------------------------------------------------------992# Configuration options related to source browsing993#---------------------------------------------------------------------------994# If the SOURCE_BROWSER tag is set to YES then a list of source files will be996# generated. Documented entities will be cross-referenced with these sources.997#998# Note: To get rid of all source code in the generated output, make sure that999# also VERBATIM_HEADERS is set to NO.1000# The default value is: NO.1001SOURCE_BROWSER = NO1003# Setting the INLINE_SOURCES tag to YES will include the body of functions,1005# classes and enums directly into the documentation.1006# The default value is: NO.1007INLINE_SOURCES = NO1009# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any1011# special comment blocks from generated source code fragments. Normal C, C++ and1012# Fortran comments will always remain visible.1013# The default value is: YES.1014STRIP_CODE_COMMENTS = YES1016# If the REFERENCED_BY_RELATION tag is set to YES then for each documented1018# entity all documented functions referencing it will be listed.1019# The default value is: NO.1020REFERENCED_BY_RELATION = NO1022# If the REFERENCES_RELATION tag is set to YES then for each documented function1024# all documented entities called/used by that function will be listed.1025# The default value is: NO.1026REFERENCES_RELATION = NO1028# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set1030# to YES then the hyperlinks from functions in REFERENCES_RELATION and1031# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will1032# link to the documentation.1033# The default value is: YES.1034REFERENCES_LINK_SOURCE = YES1036# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the1038# source code will show a tooltip with additional information such as prototype,1039# brief description and links to the definition and documentation. Since this1040# will make the HTML file larger and loading of large files a bit slower, you1041# can opt to disable this feature.1042# The default value is: YES.1043# This tag requires that the tag SOURCE_BROWSER is set to YES.1044SOURCE_TOOLTIPS = YES1046# If the USE_HTAGS tag is set to YES then the references to source code will1048# point to the HTML generated by the htags(1) tool instead of doxygen built-in1049# source browser. The htags tool is part of GNU's global source tagging system1050# (see https://www.gnu.org/software/global/global.html). You will need version1051# 4.8.6 or higher.1052#1053# To use it do the following:1054# - Install the latest version of global1055# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file1056# - Make sure the INPUT points to the root of the source tree1057# - Run doxygen as normal1058#1059# Doxygen will invoke htags (and that will in turn invoke gtags), so these1060# tools must be available from the command line (i.e. in the search path).1061#1062# The result: instead of the source browser generated by doxygen, the links to1063# source code will now point to the output of htags.1064# The default value is: NO.1065# This tag requires that the tag SOURCE_BROWSER is set to YES.1066USE_HTAGS = NO1068# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a1070# verbatim copy of the header file for each class for which an include is1071# specified. Set to NO to disable this.1072# See also: Section \class.1073# The default value is: YES.1074VERBATIM_HEADERS = YES1076# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the1078# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the1079# cost of reduced performance. This can be particularly helpful with template1080# rich C++ code for which doxygen's built-in parser lacks the necessary type1081# information.1082# Note: The availability of this option depends on whether or not doxygen was1083# generated with the -Duse_libclang=ON option for CMake.1084# The default value is: NO.1085CLANG_ASSISTED_PARSING = NO1087# If clang assisted parsing is enabled you can provide the compiler with command1089# line options that you would normally use when invoking the compiler. Note that1090# the include paths will already be set by doxygen for the files and directories1091# specified with INPUT and INCLUDE_PATH.1092# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.1093CLANG_OPTIONS =1095# If clang assisted parsing is enabled you can provide the clang parser with the1097# path to the directory containing a file called compile_commands.json. This1098# file is the compilation database (see:1099# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the1100# options used when the source files were built. This is equivalent to1101# specifying the "-p" option to a clang tool, such as clang-check. These options1102# will then be passed to the parser. Any options specified with CLANG_OPTIONS1103# will be added as well.1104# Note: The availability of this option depends on whether or not doxygen was1105# generated with the -Duse_libclang=ON option for CMake.1106CLANG_DATABASE_PATH =1108#---------------------------------------------------------------------------1110# Configuration options related to the alphabetical class index1111#---------------------------------------------------------------------------1112# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all1114# compounds will be generated. Enable this if the project contains a lot of1115# classes, structs, unions or interfaces.1116# The default value is: YES.1117ALPHABETICAL_INDEX = YES1119# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in1121# which the alphabetical index list will be split.1122# Minimum value: 1, maximum value: 20, default value: 5.1123# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1124COLS_IN_ALPHA_INDEX = 51126# In case all classes in a project start with a common prefix, all classes will1128# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag1129# can be used to specify a prefix (or a list of prefixes) that should be ignored1130# while generating the index headers.1131# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1132IGNORE_PREFIX =1134#---------------------------------------------------------------------------1136# Configuration options related to the HTML output1137#---------------------------------------------------------------------------1138# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output1140# The default value is: YES.1141GENERATE_HTML = YES1143# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1145# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1146# it.1147# The default directory is: html.1148# This tag requires that the tag GENERATE_HTML is set to YES.1149HTML_OUTPUT = html1151# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1153# generated HTML page (for example: .htm, .php, .asp).1154# The default value is: .html.1155# This tag requires that the tag GENERATE_HTML is set to YES.1156HTML_FILE_EXTENSION = .html1158# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1160# each generated HTML page. If the tag is left blank doxygen will generate a1161# standard header.1162#1163# To get valid HTML the header file that includes any scripts and style sheets1164# that doxygen needs, which is dependent on the configuration options used (e.g.1165# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1166# default header using1167# doxygen -w html new_header.html new_footer.html new_stylesheet.css1168# YourConfigFile1169# and then modify the file new_header.html. See also section "Doxygen usage"1170# for information on how to generate the default header that doxygen normally1171# uses.1172# Note: The header is subject to change so you typically have to regenerate the1173# default header when upgrading to a newer version of doxygen. For a description1174# of the possible markers and block names see the documentation.1175# This tag requires that the tag GENERATE_HTML is set to YES.1176HTML_HEADER =1178# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1180# generated HTML page. If the tag is left blank doxygen will generate a standard1181# footer. See HTML_HEADER for more information on how to generate a default1182# footer and what special commands can be used inside the footer. See also1183# section "Doxygen usage" for information on how to generate the default footer1184# that doxygen normally uses.1185# This tag requires that the tag GENERATE_HTML is set to YES.1186HTML_FOOTER =1188# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1190# sheet that is used by each HTML page. It can be used to fine-tune the look of1191# the HTML output. If left blank doxygen will generate a default style sheet.1192# See also section "Doxygen usage" for information on how to generate the style1193# sheet that doxygen normally uses.1194# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1195# it is more robust and this tag (HTML_STYLESHEET) will in the future become1196# obsolete.1197# This tag requires that the tag GENERATE_HTML is set to YES.1198HTML_STYLESHEET =1200# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined1202# cascading style sheets that are included after the standard style sheets1203# created by doxygen. Using this option one can overrule certain style aspects.1204# This is preferred over using HTML_STYLESHEET since it does not replace the1205# standard style sheet and is therefore more robust against future updates.1206# Doxygen will copy the style sheet files to the output directory.1207# Note: The order of the extra style sheet files is of importance (e.g. the last1208# style sheet in the list overrules the setting of the previous ones in the1209# list). For an example see the documentation.1210# This tag requires that the tag GENERATE_HTML is set to YES.1211HTML_EXTRA_STYLESHEET =1213# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1215# other source files which should be copied to the HTML output directory. Note1216# that these files will be copied to the base HTML output directory. Use the1217# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1218# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1219# files will be copied as-is; there are no commands or markers available.1220# This tag requires that the tag GENERATE_HTML is set to YES.1221HTML_EXTRA_FILES =1223# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1225# will adjust the colors in the style sheet and background images according to1226# this color. Hue is specified as an angle on a colorwheel, see1227# https://en.wikipedia.org/wiki/Hue for more information. For instance the value1228# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001229# purple, and 360 is red again.1230# Minimum value: 0, maximum value: 359, default value: 220.1231# This tag requires that the tag GENERATE_HTML is set to YES.1232HTML_COLORSTYLE_HUE = 2201234# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1236# in the HTML output. For a value of 0 the output will use grayscales only. A1237# value of 255 will produce the most vivid colors.1238# Minimum value: 0, maximum value: 255, default value: 100.1239# This tag requires that the tag GENERATE_HTML is set to YES.1240HTML_COLORSTYLE_SAT = 1001242# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1244# luminance component of the colors in the HTML output. Values below 1001245# gradually make the output lighter, whereas values above 100 make the output1246# darker. The value divided by 100 is the actual gamma applied, so 80 represents1247# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1248# change the gamma.1249# Minimum value: 40, maximum value: 240, default value: 80.1250# This tag requires that the tag GENERATE_HTML is set to YES.1251HTML_COLORSTYLE_GAMMA = 801253# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1255# page will contain the date and time when the page was generated. Setting this1256# to YES can help to show when doxygen was last run and thus if the1257# documentation is up to date.1258# The default value is: NO.1259# This tag requires that the tag GENERATE_HTML is set to YES.1260HTML_TIMESTAMP = YES1262# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML1264# documentation will contain a main index with vertical navigation menus that1265# are dynamically created via JavaScript. If disabled, the navigation index will1266# consists of multiple levels of tabs that are statically embedded in every HTML1267# page. Disable this option to support browsers that do not have JavaScript,1268# like the Qt help browser.1269# The default value is: YES.1270# This tag requires that the tag GENERATE_HTML is set to YES.1271HTML_DYNAMIC_MENUS = YES1273# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1275# documentation will contain sections that can be hidden and shown after the1276# page has loaded.1277# The default value is: NO.1278# This tag requires that the tag GENERATE_HTML is set to YES.1279HTML_DYNAMIC_SECTIONS = NO1281# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1283# shown in the various tree structured indices initially; the user can expand1284# and collapse entries dynamically later on. Doxygen will expand the tree to1285# such a level that at most the specified number of entries are visible (unless1286# a fully collapsed tree already exceeds this amount). So setting the number of1287# entries 1 will produce a full collapsed tree by default. 0 is a special value1288# representing an infinite number of entries and will result in a full expanded1289# tree by default.1290# Minimum value: 0, maximum value: 9999, default value: 100.1291# This tag requires that the tag GENERATE_HTML is set to YES.1292HTML_INDEX_NUM_ENTRIES = 1001294# If the GENERATE_DOCSET tag is set to YES, additional index files will be1296# generated that can be used as input for Apple's Xcode 3 integrated development1297# environment (see: https://developer.apple.com/xcode/), introduced with OSX1298# 10.5 (Leopard). To create a documentation set, doxygen will generate a1299# Makefile in the HTML output directory. Running make will produce the docset in1300# that directory and running make install will install the docset in1301# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1302# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy1303# genXcode/_index.html for more information.1304# The default value is: NO.1305# This tag requires that the tag GENERATE_HTML is set to YES.1306GENERATE_DOCSET = NO1308# This tag determines the name of the docset feed. A documentation feed provides1310# an umbrella under which multiple documentation sets from a single provider1311# (such as a company or product suite) can be grouped.1312# The default value is: Doxygen generated docs.1313# This tag requires that the tag GENERATE_DOCSET is set to YES.1314DOCSET_FEEDNAME = "Doxygen generated docs"1316# This tag specifies a string that should uniquely identify the documentation1318# set bundle. This should be a reverse domain-name style string, e.g.1319# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1320# The default value is: org.doxygen.Project.1321# This tag requires that the tag GENERATE_DOCSET is set to YES.1322DOCSET_BUNDLE_ID = org.doxygen.Project1324# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1326# the documentation publisher. This should be a reverse domain-name style1327# string, e.g. com.mycompany.MyDocSet.documentation.1328# The default value is: org.doxygen.Publisher.1329# This tag requires that the tag GENERATE_DOCSET is set to YES.1330DOCSET_PUBLISHER_ID = org.doxygen.Publisher1332# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1334# The default value is: Publisher.1335# This tag requires that the tag GENERATE_DOCSET is set to YES.1336DOCSET_PUBLISHER_NAME = Publisher1338# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1340# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1341# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1342# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on1343# Windows.1344#1345# The HTML Help Workshop contains a compiler that can convert all HTML output1346# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1347# files are now used as the Windows 98 help format, and will replace the old1348# Windows help format (.hlp) on all Windows platforms in the future. Compressed1349# HTML files also contain an index, a table of contents, and you can search for1350# words in the documentation. The HTML workshop also contains a viewer for1351# compressed HTML files.1352# The default value is: NO.1353# This tag requires that the tag GENERATE_HTML is set to YES.1354GENERATE_HTMLHELP = NO1356# The CHM_FILE tag can be used to specify the file name of the resulting .chm1358# file. You can add a path in front of the file if the result should not be1359# written to the html output directory.1360# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1361CHM_FILE =1363# The HHC_LOCATION tag can be used to specify the location (absolute path1365# including file name) of the HTML help compiler (hhc.exe). If non-empty,1366# doxygen will try to run the HTML help compiler on the generated index.hhp.1367# The file has to be specified with full path.1368# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1369HHC_LOCATION =1371# The GENERATE_CHI flag controls if a separate .chi index file is generated1373# (YES) or that it should be included in the main .chm file (NO).1374# The default value is: NO.1375# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1376GENERATE_CHI = NO1378# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)1380# and project file content.1381# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1382CHM_INDEX_ENCODING =1384# The BINARY_TOC flag controls whether a binary table of contents is generated1386# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it1387# enables the Previous and Next buttons.1388# The default value is: NO.1389# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1390BINARY_TOC = NO1392# The TOC_EXPAND flag can be set to YES to add extra items for group members to1394# the table of contents of the HTML help documentation and to the tree view.1395# The default value is: NO.1396# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1397TOC_EXPAND = NO1399# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1401# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1402# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1403# (.qch) of the generated HTML documentation.1404# The default value is: NO.1405# This tag requires that the tag GENERATE_HTML is set to YES.1406GENERATE_QHP = NO1408# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1410# the file name of the resulting .qch file. The path specified is relative to1411# the HTML output folder.1412# This tag requires that the tag GENERATE_QHP is set to YES.1413QCH_FILE =1415# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1417# Project output. For more information please see Qt Help Project / Namespace1418# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).1419# The default value is: org.doxygen.Project.1420# This tag requires that the tag GENERATE_QHP is set to YES.1421QHP_NAMESPACE = org.doxygen.Project1423# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1425# Help Project output. For more information please see Qt Help Project / Virtual1426# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-1427# folders).1428# The default value is: doc.1429# This tag requires that the tag GENERATE_QHP is set to YES.1430QHP_VIRTUAL_FOLDER = doc1432# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1434# filter to add. For more information please see Qt Help Project / Custom1435# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-1436# filters).1437# This tag requires that the tag GENERATE_QHP is set to YES.1438QHP_CUST_FILTER_NAME =1440# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1442# custom filter to add. For more information please see Qt Help Project / Custom1443# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-1444# filters).1445# This tag requires that the tag GENERATE_QHP is set to YES.1446QHP_CUST_FILTER_ATTRS =1448# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1450# project's filter section matches. Qt Help Project / Filter Attributes (see:1451# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).1452# This tag requires that the tag GENERATE_QHP is set to YES.1453QHP_SECT_FILTER_ATTRS =1455# The QHG_LOCATION tag can be used to specify the location of Qt's1457# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1458# generated .qhp file.1459# This tag requires that the tag GENERATE_QHP is set to YES.1460QHG_LOCATION =1462# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1464# generated, together with the HTML files, they form an Eclipse help plugin. To1465# install this plugin and make it available under the help contents menu in1466# Eclipse, the contents of the directory containing the HTML and XML files needs1467# to be copied into the plugins directory of eclipse. The name of the directory1468# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1469# After copying Eclipse needs to be restarted before the help appears.1470# The default value is: NO.1471# This tag requires that the tag GENERATE_HTML is set to YES.1472GENERATE_ECLIPSEHELP = NO1474# A unique identifier for the Eclipse help plugin. When installing the plugin1476# the directory name containing the HTML and XML files should also have this1477# name. Each documentation set should have its own identifier.1478# The default value is: org.doxygen.Project.1479# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1480ECLIPSE_DOC_ID = org.doxygen.Project1482# If you want full control over the layout of the generated HTML pages it might1484# be necessary to disable the index and replace it with your own. The1485# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1486# of each HTML page. A value of NO enables the index and the value YES disables1487# it. Since the tabs in the index contain the same information as the navigation1488# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1489# The default value is: NO.1490# This tag requires that the tag GENERATE_HTML is set to YES.1491DISABLE_INDEX = NO1493# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1495# structure should be generated to display hierarchical information. If the tag1496# value is set to YES, a side panel will be generated containing a tree-like1497# index structure (just like the one that is generated for HTML Help). For this1498# to work a browser that supports JavaScript, DHTML, CSS and frames is required1499# (i.e. any modern browser). Windows users are probably better off using the1500# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can1501# further fine-tune the look of the index. As an example, the default style1502# sheet generated by doxygen has an example that shows how to put an image at1503# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1504# the same information as the tab index, you could consider setting1505# DISABLE_INDEX to YES when enabling this option.1506# The default value is: NO.1507# This tag requires that the tag GENERATE_HTML is set to YES.1508GENERATE_TREEVIEW = NO1510# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1512# doxygen will group on one line in the generated HTML documentation.1513#1514# Note that a value of 0 will completely suppress the enum values from appearing1515# in the overview section.1516# Minimum value: 0, maximum value: 20, default value: 4.1517# This tag requires that the tag GENERATE_HTML is set to YES.1518ENUM_VALUES_PER_LINE = 41520# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1522# to set the initial width (in pixels) of the frame in which the tree is shown.1523# Minimum value: 0, maximum value: 1500, default value: 250.1524# This tag requires that the tag GENERATE_HTML is set to YES.1525TREEVIEW_WIDTH = 2501527# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to1529# external symbols imported via tag files in a separate window.1530# The default value is: NO.1531# This tag requires that the tag GENERATE_HTML is set to YES.1532EXT_LINKS_IN_WINDOW = NO1534# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg1536# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see1537# https://inkscape.org) to generate formulas as SVG images instead of PNGs for1538# the HTML output. These images will generally look nicer at scaled resolutions.1539# Possible values are: png (the default) and svg (looks nicer but requires the1540# pdf2svg or inkscape tool).1541# The default value is: png.1542# This tag requires that the tag GENERATE_HTML is set to YES.1543HTML_FORMULA_FORMAT = png1545# Use this tag to change the font size of LaTeX formulas included as images in1547# the HTML documentation. When you change the font size after a successful1548# doxygen run you need to manually remove any form_*.png images from the HTML1549# output directory to force them to be regenerated.1550# Minimum value: 8, maximum value: 50, default value: 10.1551# This tag requires that the tag GENERATE_HTML is set to YES.1552FORMULA_FONTSIZE = 101554# Use the FORMULA_TRANSPARENT tag to determine whether or not the images1556# generated for formulas are transparent PNGs. Transparent PNGs are not1557# supported properly for IE 6.0, but are supported on all modern browsers.1558#1559# Note that when changing this option you need to delete any form_*.png files in1560# the HTML output directory before the changes have effect.1561# The default value is: YES.1562# This tag requires that the tag GENERATE_HTML is set to YES.1563FORMULA_TRANSPARENT = YES1565# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands1567# to create new LaTeX commands to be used in formulas as building blocks. See1568# the section "Including formulas" for details.1569FORMULA_MACROFILE =1571# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1573# https://www.mathjax.org) which uses client side JavaScript for the rendering1574# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX1575# installed or if you want to formulas look prettier in the HTML output. When1576# enabled you may also need to install MathJax separately and configure the path1577# to it using the MATHJAX_RELPATH option.1578# The default value is: NO.1579# This tag requires that the tag GENERATE_HTML is set to YES.1580USE_MATHJAX = NO1582# When MathJax is enabled you can set the default output format to be used for1584# the MathJax output. See the MathJax site (see:1585# http://docs.mathjax.org/en/latest/output.html) for more details.1586# Possible values are: HTML-CSS (which is slower, but has the best1587# compatibility), NativeMML (i.e. MathML) and SVG.1588# The default value is: HTML-CSS.1589# This tag requires that the tag USE_MATHJAX is set to YES.1590MATHJAX_FORMAT = HTML-CSS1592# When MathJax is enabled you need to specify the location relative to the HTML1594# output directory using the MATHJAX_RELPATH option. The destination directory1595# should contain the MathJax.js script. For instance, if the mathjax directory1596# is located at the same level as the HTML output directory, then1597# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1598# Content Delivery Network so you can quickly see the result without installing1599# MathJax. However, it is strongly recommended to install a local copy of1600# MathJax from https://www.mathjax.org before deployment.1601# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.1602# This tag requires that the tag USE_MATHJAX is set to YES.1603MATHJAX_RELPATH = http://www.mathjax.org/mathjax1605# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1607# extension names that should be enabled during MathJax rendering. For example1608# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1609# This tag requires that the tag USE_MATHJAX is set to YES.1610MATHJAX_EXTENSIONS =1612# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1614# of code that will be used on startup of the MathJax code. See the MathJax site1615# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1616# example see the documentation.1617# This tag requires that the tag USE_MATHJAX is set to YES.1618MATHJAX_CODEFILE =1620# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1622# the HTML output. The underlying search engine uses javascript and DHTML and1623# should work on any modern browser. Note that when using HTML help1624# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1625# there is already a search function so this one should typically be disabled.1626# For large projects the javascript based search engine can be slow, then1627# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1628# search using the keyboard; to jump to the search box use <access key> + S1629# (what the <access key> is depends on the OS and browser, but it is typically1630# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1631# key> to jump into the search results window, the results can be navigated1632# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1633# the search. The filter options can be selected when the cursor is inside the1634# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1635# to select a filter and <Enter> or <escape> to activate or cancel the filter1636# option.1637# The default value is: YES.1638# This tag requires that the tag GENERATE_HTML is set to YES.1639SEARCHENGINE = YES1641# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1643# implemented using a web server instead of a web client using JavaScript. There1644# are two flavors of web server based searching depending on the EXTERNAL_SEARCH1645# setting. When disabled, doxygen will generate a PHP script for searching and1646# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing1647# and searching needs to be provided by external tools. See the section1648# "External Indexing and Searching" for details.1649# The default value is: NO.1650# This tag requires that the tag SEARCHENGINE is set to YES.1651SERVER_BASED_SEARCH = NO1653# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1655# script for searching. Instead the search results are written to an XML file1656# which needs to be processed by an external indexer. Doxygen will invoke an1657# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1658# search results.1659#1660# Doxygen ships with an example indexer (doxyindexer) and search engine1661# (doxysearch.cgi) which are based on the open source search engine library1662# Xapian (see: https://xapian.org/).1663#1664# See the section "External Indexing and Searching" for details.1665# The default value is: NO.1666# This tag requires that the tag SEARCHENGINE is set to YES.1667EXTERNAL_SEARCH = NO1669# The SEARCHENGINE_URL should point to a search engine hosted by a web server1671# which will return the search results when EXTERNAL_SEARCH is enabled.1672#1673# Doxygen ships with an example indexer (doxyindexer) and search engine1674# (doxysearch.cgi) which are based on the open source search engine library1675# Xapian (see: https://xapian.org/). See the section "External Indexing and1676# Searching" for details.1677# This tag requires that the tag SEARCHENGINE is set to YES.1678SEARCHENGINE_URL =1680# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1682# search data is written to a file for indexing by an external tool. With the1683# SEARCHDATA_FILE tag the name of this file can be specified.1684# The default file is: searchdata.xml.1685# This tag requires that the tag SEARCHENGINE is set to YES.1686SEARCHDATA_FILE = searchdata.xml1688# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1690# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1691# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1692# projects and redirect the results back to the right project.1693# This tag requires that the tag SEARCHENGINE is set to YES.1694EXTERNAL_SEARCH_ID =1696# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1698# projects other than the one defined by this configuration file, but that are1699# all added to the same external search index. Each project needs to have a1700# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1701# to a relative location where the documentation can be found. The format is:1702# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1703# This tag requires that the tag SEARCHENGINE is set to YES.1704EXTRA_SEARCH_MAPPINGS =1706#---------------------------------------------------------------------------1708# Configuration options related to the LaTeX output1709#---------------------------------------------------------------------------1710# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.1712# The default value is: YES.1713GENERATE_LATEX = NO1715# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1717# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1718# it.1719# The default directory is: latex.1720# This tag requires that the tag GENERATE_LATEX is set to YES.1721LATEX_OUTPUT = latex1723# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1725# invoked.1726#1727# Note that when not enabling USE_PDFLATEX the default is latex when enabling1728# USE_PDFLATEX the default is pdflatex and when in the later case latex is1729# chosen this is overwritten by pdflatex. For specific output languages the1730# default can have been set differently, this depends on the implementation of1731# the output language.1732# This tag requires that the tag GENERATE_LATEX is set to YES.1733LATEX_CMD_NAME = latex1735# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1737# index for LaTeX.1738# Note: This tag is used in the Makefile / make.bat.1739# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file1740# (.tex).1741# The default file is: makeindex.1742# This tag requires that the tag GENERATE_LATEX is set to YES.1743MAKEINDEX_CMD_NAME = makeindex1745# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to1747# generate index for LaTeX. In case there is no backslash (\) as first character1748# it will be automatically added in the LaTeX code.1749# Note: This tag is used in the generated output file (.tex).1750# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.1751# The default value is: makeindex.1752# This tag requires that the tag GENERATE_LATEX is set to YES.1753LATEX_MAKEINDEX_CMD = makeindex1755# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX1757# documents. This may be useful for small projects and may help to save some1758# trees in general.1759# The default value is: NO.1760# This tag requires that the tag GENERATE_LATEX is set to YES.1761COMPACT_LATEX = NO1763# The PAPER_TYPE tag can be used to set the paper type that is used by the1765# printer.1766# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1767# 14 inches) and executive (7.25 x 10.5 inches).1768# The default value is: a4.1769# This tag requires that the tag GENERATE_LATEX is set to YES.1770PAPER_TYPE = a41772# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1774# that should be included in the LaTeX output. The package can be specified just1775# by its name or with the correct syntax as to be used with the LaTeX1776# \usepackage command. To get the times font for instance you can specify :1777# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}1778# To use the option intlimits with the amsmath package you can specify:1779# EXTRA_PACKAGES=[intlimits]{amsmath}1780# If left blank no extra packages will be included.1781# This tag requires that the tag GENERATE_LATEX is set to YES.1782EXTRA_PACKAGES =1784# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1786# generated LaTeX document. The header should contain everything until the first1787# chapter. If it is left blank doxygen will generate a standard header. See1788# section "Doxygen usage" for information on how to let doxygen write the1789# default header to a separate file.1790#1791# Note: Only use a user-defined header if you know what you are doing! The1792# following commands have a special meaning inside the header: $title,1793# $datetime, $date, $doxygenversion, $projectname, $projectnumber,1794# $projectbrief, $projectlogo. Doxygen will replace $title with the empty1795# string, for the replacement values of the other commands the user is referred1796# to HTML_HEADER.1797# This tag requires that the tag GENERATE_LATEX is set to YES.1798LATEX_HEADER =1800# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1802# generated LaTeX document. The footer should contain everything after the last1803# chapter. If it is left blank doxygen will generate a standard footer. See1804# LATEX_HEADER for more information on how to generate a default footer and what1805# special commands can be used inside the footer.1806#1807# Note: Only use a user-defined footer if you know what you are doing!1808# This tag requires that the tag GENERATE_LATEX is set to YES.1809LATEX_FOOTER =1811# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined1813# LaTeX style sheets that are included after the standard style sheets created1814# by doxygen. Using this option one can overrule certain style aspects. Doxygen1815# will copy the style sheet files to the output directory.1816# Note: The order of the extra style sheet files is of importance (e.g. the last1817# style sheet in the list overrules the setting of the previous ones in the1818# list).1819# This tag requires that the tag GENERATE_LATEX is set to YES.1820LATEX_EXTRA_STYLESHEET =1822# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1824# other source files which should be copied to the LATEX_OUTPUT output1825# directory. Note that the files will be copied as-is; there are no commands or1826# markers available.1827# This tag requires that the tag GENERATE_LATEX is set to YES.1828LATEX_EXTRA_FILES =1830# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1832# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1833# contain links (just like the HTML output) instead of page references. This1834# makes the output suitable for online browsing using a PDF viewer.1835# The default value is: YES.1836# This tag requires that the tag GENERATE_LATEX is set to YES.1837PDF_HYPERLINKS = YES1839# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as1841# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX1842# files. Set this option to YES, to get a higher quality PDF documentation.1843#1844# See also section LATEX_CMD_NAME for selecting the engine.1845# The default value is: YES.1846# This tag requires that the tag GENERATE_LATEX is set to YES.1847USE_PDFLATEX = YES1849# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1851# command to the generated LaTeX files. This will instruct LaTeX to keep running1852# if errors occur, instead of asking the user for help. This option is also used1853# when generating formulas in HTML.1854# The default value is: NO.1855# This tag requires that the tag GENERATE_LATEX is set to YES.1856LATEX_BATCHMODE = NO1858# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1860# index chapters (such as File Index, Compound Index, etc.) in the output.1861# The default value is: NO.1862# This tag requires that the tag GENERATE_LATEX is set to YES.1863LATEX_HIDE_INDICES = NO1865# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1867# code with syntax highlighting in the LaTeX output.1868#1869# Note that which sources are shown also depends on other settings such as1870# SOURCE_BROWSER.1871# The default value is: NO.1872# This tag requires that the tag GENERATE_LATEX is set to YES.1873LATEX_SOURCE_CODE = NO1875# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1877# bibliography, e.g. plainnat, or ieeetr. See1878# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.1879# The default value is: plain.1880# This tag requires that the tag GENERATE_LATEX is set to YES.1881LATEX_BIB_STYLE = plain1883# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated1885# page will contain the date and time when the page was generated. Setting this1886# to NO can help when comparing the output of multiple runs.1887# The default value is: NO.1888# This tag requires that the tag GENERATE_LATEX is set to YES.1889LATEX_TIMESTAMP = NO1891# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)1893# path from which the emoji images will be read. If a relative path is entered,1894# it will be relative to the LATEX_OUTPUT directory. If left blank the1895# LATEX_OUTPUT directory will be used.1896# This tag requires that the tag GENERATE_LATEX is set to YES.1897LATEX_EMOJI_DIRECTORY =1899#---------------------------------------------------------------------------1901# Configuration options related to the RTF output1902#---------------------------------------------------------------------------1903# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The1905# RTF output is optimized for Word 97 and may not look too pretty with other RTF1906# readers/editors.1907# The default value is: NO.1908GENERATE_RTF = NO1910# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1912# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1913# it.1914# The default directory is: rtf.1915# This tag requires that the tag GENERATE_RTF is set to YES.1916RTF_OUTPUT = rtf1918# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF1920# documents. This may be useful for small projects and may help to save some1921# trees in general.1922# The default value is: NO.1923# This tag requires that the tag GENERATE_RTF is set to YES.1924COMPACT_RTF = NO1926# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1928# contain hyperlink fields. The RTF file will contain links (just like the HTML1929# output) instead of page references. This makes the output suitable for online1930# browsing using Word or some other Word compatible readers that support those1931# fields.1932#1933# Note: WordPad (write) and others do not support links.1934# The default value is: NO.1935# This tag requires that the tag GENERATE_RTF is set to YES.1936RTF_HYPERLINKS = NO1938# Load stylesheet definitions from file. Syntax is similar to doxygen's1940# configuration file, i.e. a series of assignments. You only have to provide1941# replacements, missing definitions are set to their default value.1942#1943# See also section "Doxygen usage" for information on how to generate the1944# default style sheet that doxygen normally uses.1945# This tag requires that the tag GENERATE_RTF is set to YES.1946RTF_STYLESHEET_FILE =1948# Set optional variables used in the generation of an RTF document. Syntax is1950# similar to doxygen's configuration file. A template extensions file can be1951# generated using doxygen -e rtf extensionFile.1952# This tag requires that the tag GENERATE_RTF is set to YES.1953RTF_EXTENSIONS_FILE =1955# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code1957# with syntax highlighting in the RTF output.1958#1959# Note that which sources are shown also depends on other settings such as1960# SOURCE_BROWSER.1961# The default value is: NO.1962# This tag requires that the tag GENERATE_RTF is set to YES.1963RTF_SOURCE_CODE = NO1965#---------------------------------------------------------------------------1967# Configuration options related to the man page output1968#---------------------------------------------------------------------------1969# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for1971# classes and files.1972# The default value is: NO.1973GENERATE_MAN = NO1975# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1977# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1978# it. A directory man3 will be created inside the directory specified by1979# MAN_OUTPUT.1980# The default directory is: man.1981# This tag requires that the tag GENERATE_MAN is set to YES.1982MAN_OUTPUT = man1984# The MAN_EXTENSION tag determines the extension that is added to the generated1986# man pages. In case the manual section does not start with a number, the number1987# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1988# optional.1989# The default value is: .3.1990# This tag requires that the tag GENERATE_MAN is set to YES.1991MAN_EXTENSION = .31993# The MAN_SUBDIR tag determines the name of the directory created within1995# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by1996# MAN_EXTENSION with the initial . removed.1997# This tag requires that the tag GENERATE_MAN is set to YES.1998MAN_SUBDIR =2000# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it2002# will generate one additional man file for each entity documented in the real2003# man page(s). These additional files only source the real man page, but without2004# them the man command would be unable to find the correct page.2005# The default value is: NO.2006# This tag requires that the tag GENERATE_MAN is set to YES.2007MAN_LINKS = NO2009#---------------------------------------------------------------------------2011# Configuration options related to the XML output2012#---------------------------------------------------------------------------2013# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that2015# captures the structure of the code including all documentation.2016# The default value is: NO.2017GENERATE_XML = NO2019# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a2021# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of2022# it.2023# The default directory is: xml.2024# This tag requires that the tag GENERATE_XML is set to YES.2025XML_OUTPUT = xml2027# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program2029# listings (including syntax highlighting and cross-referencing information) to2030# the XML output. Note that enabling this will significantly increase the size2031# of the XML output.2032# The default value is: YES.2033# This tag requires that the tag GENERATE_XML is set to YES.2034XML_PROGRAMLISTING = YES2036# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include2038# namespace members in file scope as well, matching the HTML output.2039# The default value is: NO.2040# This tag requires that the tag GENERATE_XML is set to YES.2041XML_NS_MEMB_FILE_SCOPE = NO2043#---------------------------------------------------------------------------2045# Configuration options related to the DOCBOOK output2046#---------------------------------------------------------------------------2047# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files2049# that can be used to generate PDF.2050# The default value is: NO.2051GENERATE_DOCBOOK = NO2053# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.2055# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in2056# front of it.2057# The default directory is: docbook.2058# This tag requires that the tag GENERATE_DOCBOOK is set to YES.2059DOCBOOK_OUTPUT = docbook2061# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the2063# program listings (including syntax highlighting and cross-referencing2064# information) to the DOCBOOK output. Note that enabling this will significantly2065# increase the size of the DOCBOOK output.2066# The default value is: NO.2067# This tag requires that the tag GENERATE_DOCBOOK is set to YES.2068DOCBOOK_PROGRAMLISTING = NO2070#---------------------------------------------------------------------------2072# Configuration options for the AutoGen Definitions output2073#---------------------------------------------------------------------------2074# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an2076# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures2077# the structure of the code including all documentation. Note that this feature2078# is still experimental and incomplete at the moment.2079# The default value is: NO.2080GENERATE_AUTOGEN_DEF = NO2082#---------------------------------------------------------------------------2084# Configuration options related to the Perl module output2085#---------------------------------------------------------------------------2086# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module2088# file that captures the structure of the code including all documentation.2089#2090# Note that this feature is still experimental and incomplete at the moment.2091# The default value is: NO.2092GENERATE_PERLMOD = NO2094# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary2096# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI2097# output from the Perl module output.2098# The default value is: NO.2099# This tag requires that the tag GENERATE_PERLMOD is set to YES.2100PERLMOD_LATEX = NO2102# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely2104# formatted so it can be parsed by a human reader. This is useful if you want to2105# understand what is going on. On the other hand, if this tag is set to NO, the2106# size of the Perl module output will be much smaller and Perl will parse it2107# just the same.2108# The default value is: YES.2109# This tag requires that the tag GENERATE_PERLMOD is set to YES.2110PERLMOD_PRETTY = YES2112# The names of the make variables in the generated doxyrules.make file are2114# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful2115# so different doxyrules.make files included by the same Makefile don't2116# overwrite each other's variables.2117# This tag requires that the tag GENERATE_PERLMOD is set to YES.2118PERLMOD_MAKEVAR_PREFIX =2120#---------------------------------------------------------------------------2122# Configuration options related to the preprocessor2123#---------------------------------------------------------------------------2124# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all2126# C-preprocessor directives found in the sources and include files.2127# The default value is: YES.2128ENABLE_PREPROCESSING = YES2130# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names2132# in the source code. If set to NO, only conditional compilation will be2133# performed. Macro expansion can be done in a controlled way by setting2134# EXPAND_ONLY_PREDEF to YES.2135# The default value is: NO.2136# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2137MACRO_EXPANSION = NO2139# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then2141# the macro expansion is limited to the macros specified with the PREDEFINED and2142# EXPAND_AS_DEFINED tags.2143# The default value is: NO.2144# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2145EXPAND_ONLY_PREDEF = NO2147# If the SEARCH_INCLUDES tag is set to YES, the include files in the2149# INCLUDE_PATH will be searched if a #include is found.2150# The default value is: YES.2151# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2152SEARCH_INCLUDES = YES2154# The INCLUDE_PATH tag can be used to specify one or more directories that2156# contain include files that are not input files but should be processed by the2157# preprocessor.2158# This tag requires that the tag SEARCH_INCLUDES is set to YES.2159INCLUDE_PATH =2161# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard2163# patterns (like *.h and *.hpp) to filter out the header-files in the2164# directories. If left blank, the patterns specified with FILE_PATTERNS will be2165# used.2166# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2167INCLUDE_FILE_PATTERNS =2169# The PREDEFINED tag can be used to specify one or more macro names that are2171# defined before the preprocessor is started (similar to the -D option of e.g.2172# gcc). The argument of the tag is a list of macros of the form: name or2173# name=definition (no spaces). If the definition and the "=" are omitted, "=1"2174# is assumed. To prevent a macro definition from being undefined via #undef or2175# recursively expanded use the := operator instead of the = operator.2176# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2177PREDEFINED =2179# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this2181# tag can be used to specify a list of macro names that should be expanded. The2182# macro definition that is found in the sources will be used. Use the PREDEFINED2183# tag if you want to use a different macro definition that overrules the2184# definition found in the source code.2185# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2186EXPAND_AS_DEFINED =2188# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will2190# remove all references to function-like macros that are alone on a line, have2191# an all uppercase name, and do not end with a semicolon. Such function macros2192# are typically used for boiler-plate code, and will confuse the parser if not2193# removed.2194# The default value is: YES.2195# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2196SKIP_FUNCTION_MACROS = YES2198#---------------------------------------------------------------------------2200# Configuration options related to external references2201#---------------------------------------------------------------------------2202# The TAGFILES tag can be used to specify one or more tag files. For each tag2204# file the location of the external documentation should be added. The format of2205# a tag file without this location is as follows:2206# TAGFILES = file1 file2 ...2207# Adding location for the tag files is done as follows:2208# TAGFILES = file1=loc1 "file2 = loc2" ...2209# where loc1 and loc2 can be relative or absolute paths or URLs. See the2210# section "Linking to external documentation" for more information about the use2211# of tag files.2212# Note: Each tag file must have a unique name (where the name does NOT include2213# the path). If a tag file is not located in the directory in which doxygen is2214# run, you must also specify the path to the tagfile here.2215TAGFILES =2217# When a file name is specified after GENERATE_TAGFILE, doxygen will create a2219# tag file that is based on the input files it reads. See section "Linking to2220# external documentation" for more information about the usage of tag files.2221GENERATE_TAGFILE =2223# If the ALLEXTERNALS tag is set to YES, all external class will be listed in2225# the class index. If set to NO, only the inherited external classes will be2226# listed.2227# The default value is: NO.2228ALLEXTERNALS = NO2230# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed2232# in the modules index. If set to NO, only the current project's groups will be2233# listed.2234# The default value is: YES.2235EXTERNAL_GROUPS = YES2237# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in2239# the related pages index. If set to NO, only the current project's pages will2240# be listed.2241# The default value is: YES.2242EXTERNAL_PAGES = YES2244#---------------------------------------------------------------------------2246# Configuration options related to the dot tool2247#---------------------------------------------------------------------------2248# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram2250# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2251# NO turns the diagrams off. Note that this option also works with HAVE_DOT2252# disabled, but it is recommended to install and use dot, since it yields more2253# powerful graphs.2254# The default value is: YES.2255CLASS_DIAGRAMS = YES2257# You can include diagrams made with dia in doxygen documentation. Doxygen will2259# then run dia to produce the diagram and insert it in the documentation. The2260# DIA_PATH tag allows you to specify the directory where the dia binary resides.2261# If left empty dia is assumed to be found in the default search path.2262DIA_PATH =2264# If set to YES the inheritance and collaboration graphs will hide inheritance2266# and usage relations if the target is undocumented or is not a class.2267# The default value is: YES.2268HIDE_UNDOC_RELATIONS = YES2270# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2272# available from the path. This tool is part of Graphviz (see:2273# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2274# Bell Labs. The other options in this section have no effect if this option is2275# set to NO2276# The default value is: NO.2277HAVE_DOT = NO2279# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2281# to run in parallel. When set to 0 doxygen will base this on the number of2282# processors available in the system. You can set it explicitly to a value2283# larger than 0 to get control over the balance between CPU load and processing2284# speed.2285# Minimum value: 0, maximum value: 32, default value: 0.2286# This tag requires that the tag HAVE_DOT is set to YES.2287DOT_NUM_THREADS = 02289# When you want a differently looking font in the dot files that doxygen2291# generates you can specify the font name using DOT_FONTNAME. You need to make2292# sure dot is able to find the font, which can be done by putting it in a2293# standard location or by setting the DOTFONTPATH environment variable or by2294# setting DOT_FONTPATH to the directory containing the font.2295# The default value is: Helvetica.2296# This tag requires that the tag HAVE_DOT is set to YES.2297DOT_FONTNAME = Helvetica2299# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2301# dot graphs.2302# Minimum value: 4, maximum value: 24, default value: 10.2303# This tag requires that the tag HAVE_DOT is set to YES.2304DOT_FONTSIZE = 102306# By default doxygen will tell dot to use the default font as specified with2308# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2309# the path where dot can find it using this tag.2310# This tag requires that the tag HAVE_DOT is set to YES.2311DOT_FONTPATH =2313# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2315# each documented class showing the direct and indirect inheritance relations.2316# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2317# The default value is: YES.2318# This tag requires that the tag HAVE_DOT is set to YES.2319CLASS_GRAPH = YES2321# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2323# graph for each documented class showing the direct and indirect implementation2324# dependencies (inheritance, containment, and class references variables) of the2325# class with other documented classes.2326# The default value is: YES.2327# This tag requires that the tag HAVE_DOT is set to YES.2328COLLABORATION_GRAPH = YES2330# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2332# groups, showing the direct groups dependencies.2333# The default value is: YES.2334# This tag requires that the tag HAVE_DOT is set to YES.2335GROUP_GRAPHS = YES2337# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and2339# collaboration diagrams in a style similar to the OMG's Unified Modeling2340# Language.2341# The default value is: NO.2342# This tag requires that the tag HAVE_DOT is set to YES.2343UML_LOOK = NO2345# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2347# class node. If there are many fields or methods and many nodes the graph may2348# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2349# number of items for each type to make the size more manageable. Set this to 02350# for no limit. Note that the threshold may be exceeded by 50% before the limit2351# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2352# but if the number exceeds 15, the total amount of fields shown is limited to2353# 10.2354# Minimum value: 0, maximum value: 100, default value: 10.2355# This tag requires that the tag HAVE_DOT is set to YES.2356UML_LIMIT_NUM_FIELDS = 102358# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2360# collaboration graphs will show the relations between templates and their2361# instances.2362# The default value is: NO.2363# This tag requires that the tag HAVE_DOT is set to YES.2364TEMPLATE_RELATIONS = NO2366# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2368# YES then doxygen will generate a graph for each documented file showing the2369# direct and indirect include dependencies of the file with other documented2370# files.2371# The default value is: YES.2372# This tag requires that the tag HAVE_DOT is set to YES.2373INCLUDE_GRAPH = YES2375# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2377# set to YES then doxygen will generate a graph for each documented file showing2378# the direct and indirect include dependencies of the file with other documented2379# files.2380# The default value is: YES.2381# This tag requires that the tag HAVE_DOT is set to YES.2382INCLUDED_BY_GRAPH = YES2384# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2386# dependency graph for every global function or class method.2387#2388# Note that enabling this option will significantly increase the time of a run.2389# So in most cases it will be better to enable call graphs for selected2390# functions only using the \callgraph command. Disabling a call graph can be2391# accomplished by means of the command \hidecallgraph.2392# The default value is: NO.2393# This tag requires that the tag HAVE_DOT is set to YES.2394CALL_GRAPH = NO2396# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2398# dependency graph for every global function or class method.2399#2400# Note that enabling this option will significantly increase the time of a run.2401# So in most cases it will be better to enable caller graphs for selected2402# functions only using the \callergraph command. Disabling a caller graph can be2403# accomplished by means of the command \hidecallergraph.2404# The default value is: NO.2405# This tag requires that the tag HAVE_DOT is set to YES.2406CALLER_GRAPH = NO2408# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2410# hierarchy of all classes instead of a textual one.2411# The default value is: YES.2412# This tag requires that the tag HAVE_DOT is set to YES.2413GRAPHICAL_HIERARCHY = YES2415# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2417# dependencies a directory has on other directories in a graphical way. The2418# dependency relations are determined by the #include relations between the2419# files in the directories.2420# The default value is: YES.2421# This tag requires that the tag HAVE_DOT is set to YES.2422DIRECTORY_GRAPH = YES2424# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2426# generated by dot. For an explanation of the image formats see the section2427# output formats in the documentation of the dot tool (Graphviz (see:2428# http://www.graphviz.org/)).2429# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2430# to make the SVG files visible in IE 9+ (other browsers do not have this2431# requirement).2432# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,2433# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and2434# png:gdiplus:gdiplus.2435# The default value is: png.2436# This tag requires that the tag HAVE_DOT is set to YES.2437DOT_IMAGE_FORMAT = png2439# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2441# enable generation of interactive SVG images that allow zooming and panning.2442#2443# Note that this requires a modern browser other than Internet Explorer. Tested2444# and working are Firefox, Chrome, Safari, and Opera.2445# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2446# the SVG files visible. Older versions of IE do not have SVG support.2447# The default value is: NO.2448# This tag requires that the tag HAVE_DOT is set to YES.2449INTERACTIVE_SVG = NO2451# The DOT_PATH tag can be used to specify the path where the dot tool can be2453# found. If left blank, it is assumed the dot tool can be found in the path.2454# This tag requires that the tag HAVE_DOT is set to YES.2455DOT_PATH =2457# The DOTFILE_DIRS tag can be used to specify one or more directories that2459# contain dot files that are included in the documentation (see the \dotfile2460# command).2461# This tag requires that the tag HAVE_DOT is set to YES.2462DOTFILE_DIRS =2464# The MSCFILE_DIRS tag can be used to specify one or more directories that2466# contain msc files that are included in the documentation (see the \mscfile2467# command).2468MSCFILE_DIRS =2470# The DIAFILE_DIRS tag can be used to specify one or more directories that2472# contain dia files that are included in the documentation (see the \diafile2473# command).2474DIAFILE_DIRS =2476# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the2478# path where java can find the plantuml.jar file. If left blank, it is assumed2479# PlantUML is not used or called during a preprocessing step. Doxygen will2480# generate a warning when it encounters a \startuml command in this case and2481# will not generate output for the diagram.2482PLANTUML_JAR_PATH =2484# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a2486# configuration file for plantuml.2487PLANTUML_CFG_FILE =2489# When using plantuml, the specified paths are searched for files specified by2491# the !include statement in a plantuml block.2492PLANTUML_INCLUDE_PATH =2494# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2496# that will be shown in the graph. If the number of nodes in a graph becomes2497# larger than this value, doxygen will truncate the graph, which is visualized2498# by representing a node as a red box. Note that doxygen if the number of direct2499# children of the root node in a graph is already larger than2500# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2501# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2502# Minimum value: 0, maximum value: 10000, default value: 50.2503# This tag requires that the tag HAVE_DOT is set to YES.2504DOT_GRAPH_MAX_NODES = 502506# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2508# generated by dot. A depth value of 3 means that only nodes reachable from the2509# root by following a path via at most 3 edges will be shown. Nodes that lay2510# further from the root node will be omitted. Note that setting this option to 12511# or 2 may greatly reduce the computation time needed for large code bases. Also2512# note that the size of a graph can be further restricted by2513# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2514# Minimum value: 0, maximum value: 1000, default value: 0.2515# This tag requires that the tag HAVE_DOT is set to YES.2516MAX_DOT_GRAPH_DEPTH = 02518# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2520# background. This is disabled by default, because dot on Windows does not seem2521# to support this out of the box.2522#2523# Warning: Depending on the platform used, enabling this option may lead to2524# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2525# read).2526# The default value is: NO.2527# This tag requires that the tag HAVE_DOT is set to YES.2528DOT_TRANSPARENT = NO2530# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output2532# files in one run (i.e. multiple -o and -T options on the command line). This2533# makes dot run faster, but since only newer versions of dot (>1.8.10) support2534# this, this feature is disabled by default.2535# The default value is: NO.2536# This tag requires that the tag HAVE_DOT is set to YES.2537DOT_MULTI_TARGETS = YES2539# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2541# explaining the meaning of the various boxes and arrows in the dot generated2542# graphs.2543# The default value is: YES.2544# This tag requires that the tag HAVE_DOT is set to YES.2545GENERATE_LEGEND = YES2547# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot2549# files that are used to generate the various graphs.2550# The default value is: YES.2551# This tag requires that the tag HAVE_DOT is set to YES.2552DOT_CLEANUP = YES2554