yuzu-mirror
/
Doxyfile
2372 строки · 101.0 Кб
1# SPDX-FileCopyrightText: 2014 Yuri Kunde Schlesner <yuriks@yuriks.net>2# SPDX-License-Identifier: GPL-2.0-or-later3# Doxyfile 1.8.85# This file describes the settings to be used by the documentation system7# doxygen (www.doxygen.org) for a project.8#9# All text after a double hash (##) is considered a comment and is placed in10# front of the TAG it is preceding.11#12# All text after a single hash (#) is considered a comment and will be ignored.13# The format is:14# TAG = value [value, ...]15# For lists, items can also be appended using:16# TAG += value [value, ...]17# Values that contain spaces should be placed between quotes (\" \").18#---------------------------------------------------------------------------20# Project related configuration options21#---------------------------------------------------------------------------22# This tag specifies the encoding used for all characters in the config file24# that follow. The default is UTF-8 which is also the encoding used for all text25# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv26# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv27# for the list of possible encodings.28# The default value is: UTF-8.29DOXYFILE_ENCODING = UTF-831# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by33# double-quotes, unless you are using Doxywizard) that should identify the34# project for which the documentation is generated. This name is used in the35# title of most generated pages and in a few other places.36# The default value is: My Project.37PROJECT_NAME = yuzu39# The PROJECT_NUMBER tag can be used to enter a project or revision number. This41# could be handy for archiving the generated documentation or if some version42# control system is used.43PROJECT_NUMBER =45# Using the PROJECT_BRIEF tag one can provide an optional one line description47# for a project that appears at the top of each page and should give viewer a48# quick idea about the purpose of the project. Keep the description short.49PROJECT_BRIEF = "Nintendo Switch emulator/debugger"51# With the PROJECT_LOGO tag one can specify an logo or icon that is included in53# the documentation. The maximum height of the logo should not exceed 55 pixels54# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo55# to the output directory.56PROJECT_LOGO = dist/doc-icon.png58# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path60# into which the generated documentation will be written. If a relative path is61# entered, it will be relative to the location where doxygen was started. If62# left blank the current directory will be used.63OUTPUT_DIRECTORY = doc-build/65# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-67# directories (in 2 levels) under the output directory of each output format and68# will distribute the generated files over these directories. Enabling this69# option can be useful when feeding doxygen a huge amount of source files, where70# putting all generated files in the same directory would otherwise causes71# performance problems for the file system.72# The default value is: NO.73CREATE_SUBDIRS = NO75# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII77# characters to appear in the names of generated files. If set to NO, non-ASCII78# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode79# U+3044.80# The default value is: NO.81ALLOW_UNICODE_NAMES = NO83# The OUTPUT_LANGUAGE tag is used to specify the language in which all85# documentation generated by doxygen is written. Doxygen will use this86# information to generate all constant output in the proper language.87# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,88# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),89# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,90# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),91# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,92# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,93# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,94# Ukrainian and Vietnamese.95# The default value is: English.96OUTPUT_LANGUAGE = English98# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member100# descriptions after the members that are listed in the file and class101# documentation (similar to Javadoc). Set to NO to disable this.102# The default value is: YES.103BRIEF_MEMBER_DESC = YES105# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief107# description of a member or function before the detailed description108#109# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the110# brief descriptions will be completely suppressed.111# The default value is: YES.112REPEAT_BRIEF = YES114# This tag implements a quasi-intelligent brief description abbreviator that is116# used to form the text in various listings. Each string in this list, if found117# as the leading text of the brief description, will be stripped from the text118# and the result, after processing the whole list, is used as the annotated119# text. Otherwise, the brief description is used as-is. If left blank, the120# following values are used ($name is automatically replaced with the name of121# the entity):The $name class, The $name widget, The $name file, is, provides,122# specifies, contains, represents, a, an and the.123ABBREVIATE_BRIEF = "The $name class" \125"The $name widget" \126"The $name file" \127is \128provides \129specifies \130contains \131represents \132a \133an \134the135# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then137# doxygen will generate a detailed section even if there is only a brief138# description.139# The default value is: NO.140ALWAYS_DETAILED_SEC = NO142# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all144# inherited members of a class in the documentation of that class as if those145# members were ordinary class members. Constructors, destructors and assignment146# operators of the base classes will not be shown.147# The default value is: NO.148INLINE_INHERITED_MEMB = NO150# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path152# before files name in the file list and in the header files. If set to NO the153# shortest path that makes the file name unique will be used154# The default value is: YES.155FULL_PATH_NAMES = YES157# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.159# Stripping is only done if one of the specified strings matches the left-hand160# part of the path. The tag can be used to show relative paths in the file list.161# If left blank the directory from which doxygen is run is used as the path to162# strip.163#164# Note that you can specify absolute paths here, but also relative paths, which165# will be relative from the directory where doxygen is started.166# This tag requires that the tag FULL_PATH_NAMES is set to YES.167STRIP_FROM_PATH =169# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the171# path mentioned in the documentation of a class, which tells the reader which172# header file to include in order to use a class. If left blank only the name of173# the header file containing the class definition is used. Otherwise one should174# specify the list of include paths that are normally passed to the compiler175# using the -I flag.176STRIP_FROM_INC_PATH =178# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but180# less readable) file names. This can be useful is your file systems doesn't181# support long names like on DOS, Mac, or CD-ROM.182# The default value is: NO.183SHORT_NAMES = NO185# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the187# first line (until the first dot) of a Javadoc-style comment as the brief188# description. If set to NO, the Javadoc-style will behave just like regular Qt-189# style comments (thus requiring an explicit @brief command for a brief190# description.)191# The default value is: NO.192JAVADOC_AUTOBRIEF = YES194# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first196# line (until the first dot) of a Qt-style comment as the brief description. If197# set to NO, the Qt-style will behave just like regular Qt-style comments (thus198# requiring an explicit \brief command for a brief description.)199# The default value is: NO.200QT_AUTOBRIEF = NO202# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a204# multi-line C++ special comment block (i.e. a block of //! or /// comments) as205# a brief description. This used to be the default behavior. The new default is206# to treat a multi-line C++ comment block as a detailed description. Set this207# tag to YES if you prefer the old behavior instead.208#209# Note that setting this tag to YES also means that rational rose comments are210# not recognized any more.211# The default value is: NO.212MULTILINE_CPP_IS_BRIEF = YES214# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the216# documentation from any documented member that it re-implements.217# The default value is: YES.218INHERIT_DOCS = YES220# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a222# new page for each member. If set to NO, the documentation of a member will be223# part of the file/class/namespace that contains it.224# The default value is: NO.225SEPARATE_MEMBER_PAGES = NO227# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen229# uses this value to replace tabs by spaces in code fragments.230# Minimum value: 1, maximum value: 16, default value: 4.231TAB_SIZE = 4233# This tag can be used to specify a number of aliases that act as commands in235# the documentation. An alias has the form:236# name=value237# For example adding238# "sideeffect=@par Side Effects:\n"239# will allow you to put the command \sideeffect (or @sideeffect) in the240# documentation, which will result in a user-defined paragraph with heading241# "Side Effects:". You can put \n's in the value part of an alias to insert242# newlines.243ALIASES =245# This tag can be used to specify a number of word-keyword mappings (TCL only).247# A mapping has the form "name=value". For example adding "class=itcl::class"248# will allow you to use the command class in the itcl::class meaning.249TCL_SUBST =251# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources253# only. Doxygen will then generate output that is more tailored for C. For254# instance, some of the names that are used will be different. The list of all255# members will be omitted, etc.256# The default value is: NO.257OPTIMIZE_OUTPUT_FOR_C = NO259# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or261# Python sources only. Doxygen will then generate output that is more tailored262# for that language. For instance, namespaces will be presented as packages,263# qualified scopes will look different, etc.264# The default value is: NO.265OPTIMIZE_OUTPUT_JAVA = NO267# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran269# sources. Doxygen will then generate output that is tailored for Fortran.270# The default value is: NO.271OPTIMIZE_FOR_FORTRAN = NO273# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL275# sources. Doxygen will then generate output that is tailored for VHDL.276# The default value is: NO.277OPTIMIZE_OUTPUT_VHDL = NO279# Doxygen selects the parser to use depending on the extension of the files it281# parses. With this tag you can assign which parser to use for a given282# extension. Doxygen has a built-in mapping, but you can override or extend it283# using this tag. The format is ext=language, where ext is a file extension, and284# language is one of the parsers supported by doxygen: IDL, Java, Javascript,285# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:286# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:287# Fortran. In the later case the parser tries to guess whether the code is fixed288# or free formatted code, this is the default for Fortran type files), VHDL. For289# instance to make doxygen treat .inc files as Fortran files (default is PHP),290# and .f files as C (default is Fortran), use: inc=Fortran f=C.291#292# Note For files without extension you can use no_extension as a placeholder.293#294# Note that for custom extensions you also need to set FILE_PATTERNS otherwise295# the files are not read by doxygen.296EXTENSION_MAPPING =298# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments300# according to the Markdown format, which allows for more readable301# documentation. See http://daringfireball.net/projects/markdown/ for details.302# The output of markdown processing is further processed by doxygen, so you can303# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in304# case of backward compatibilities issues.305# The default value is: YES.306MARKDOWN_SUPPORT = YES308# When enabled doxygen tries to link words that correspond to documented310# classes, or namespaces to their corresponding documentation. Such a link can311# be prevented in individual cases by by putting a % sign in front of the word312# or globally by setting AUTOLINK_SUPPORT to NO.313# The default value is: YES.314AUTOLINK_SUPPORT = YES316# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want318# to include (a tag file for) the STL sources as input, then you should set this319# tag to YES in order to let doxygen match functions declarations and320# definitions whose arguments contain STL classes (e.g. func(std::string);321# versus func(std::string) {}). This also make the inheritance and collaboration322# diagrams that involve STL classes more complete and accurate.323# The default value is: NO.324BUILTIN_STL_SUPPORT = NO326# If you use Microsoft's C++/CLI language, you should set this option to YES to328# enable parsing support.329# The default value is: NO.330CPP_CLI_SUPPORT = NO332# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:334# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen335# will parse them like normal C++ but will assume all classes use public instead336# of private inheritance when no explicit protection keyword is present.337# The default value is: NO.338SIP_SUPPORT = NO340# For Microsoft's IDL there are propget and propput attributes to indicate342# getter and setter methods for a property. Setting this option to YES will make343# doxygen to replace the get and set methods by a property in the documentation.344# This will only work if the methods are indeed getting or setting a simple345# type. If this is not the case, or you want to show the methods anyway, you346# should set this option to NO.347# The default value is: YES.348IDL_PROPERTY_SUPPORT = NO350# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC352# tag is set to YES, then doxygen will reuse the documentation of the first353# member in the group (if any) for the other members of the group. By default354# all members of a group must be documented explicitly.355# The default value is: NO.356DISTRIBUTE_GROUP_DOC = NO358# Set the SUBGROUPING tag to YES to allow class member groups of the same type360# (for instance a group of public functions) to be put as a subgroup of that361# type (e.g. under the Public Functions section). Set it to NO to prevent362# subgrouping. Alternatively, this can be done per class using the363# \nosubgrouping command.364# The default value is: YES.365SUBGROUPING = YES367# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions369# are shown inside the group in which they are included (e.g. using \ingroup)370# instead of on a separate page (for HTML and Man pages) or section (for LaTeX371# and RTF).372#373# Note that this feature does not work in combination with374# SEPARATE_MEMBER_PAGES.375# The default value is: NO.376INLINE_GROUPED_CLASSES = NO378# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions380# with only public data fields or simple typedef fields will be shown inline in381# the documentation of the scope in which they are defined (i.e. file,382# namespace, or group documentation), provided this scope is documented. If set383# to NO, structs, classes, and unions are shown on a separate page (for HTML and384# Man pages) or section (for LaTeX and RTF).385# The default value is: NO.386INLINE_SIMPLE_STRUCTS = YES388# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or390# enum is documented as struct, union, or enum with the name of the typedef. So391# typedef struct TypeS {} TypeT, will appear in the documentation as a struct392# with name TypeT. When disabled the typedef will appear as a member of a file,393# namespace, or class. And the struct will be named TypeS. This can typically be394# useful for C code in case the coding convention dictates that all compound395# types are typedef'ed and only the typedef is referenced, never the tag name.396# The default value is: NO.397TYPEDEF_HIDES_STRUCT = NO399# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This401# cache is used to resolve symbols given their name and scope. Since this can be402# an expensive process and often the same symbol appears multiple times in the403# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small404# doxygen will become slower. If the cache is too large, memory is wasted. The405# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range406# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536407# symbols. At the end of a run doxygen will report the cache usage and suggest408# the optimal cache size from a speed point of view.409# Minimum value: 0, maximum value: 9, default value: 0.410LOOKUP_CACHE_SIZE = 0412#---------------------------------------------------------------------------414# Build related configuration options415#---------------------------------------------------------------------------416# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in418# documentation are documented, even if no documentation was available. Private419# class members and static file members will be hidden unless the420# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.421# Note: This will also disable the warnings about undocumented members that are422# normally produced when WARNINGS is set to YES.423# The default value is: NO.424EXTRACT_ALL = YES426# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will428# be included in the documentation.429# The default value is: NO.430EXTRACT_PRIVATE = YES432# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal434# scope will be included in the documentation.435# The default value is: NO.436EXTRACT_PACKAGE = NO438# If the EXTRACT_STATIC tag is set to YES all static members of a file will be440# included in the documentation.441# The default value is: NO.442EXTRACT_STATIC = YES444# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined446# locally in source files will be included in the documentation. If set to NO447# only classes defined in header files are included. Does not have any effect448# for Java sources.449# The default value is: YES.450EXTRACT_LOCAL_CLASSES = YES452# This flag is only useful for Objective-C code. When set to YES local methods,454# which are defined in the implementation section but not in the interface are455# included in the documentation. If set to NO only methods in the interface are456# included.457# The default value is: NO.458EXTRACT_LOCAL_METHODS = NO460# If this flag is set to YES, the members of anonymous namespaces will be462# extracted and appear in the documentation as a namespace called463# 'anonymous_namespace{file}', where file will be replaced with the base name of464# the file that contains the anonymous namespace. By default anonymous namespace465# are hidden.466# The default value is: NO.467EXTRACT_ANON_NSPACES = NO469# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all471# undocumented members inside documented classes or files. If set to NO these472# members will be included in the various overviews, but no documentation473# section is generated. This option has no effect if EXTRACT_ALL is enabled.474# The default value is: NO.475HIDE_UNDOC_MEMBERS = NO477# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all479# undocumented classes that are normally visible in the class hierarchy. If set480# to NO these classes will be included in the various overviews. This option has481# no effect if EXTRACT_ALL is enabled.482# The default value is: NO.483HIDE_UNDOC_CLASSES = NO485# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend487# (class|struct|union) declarations. If set to NO these declarations will be488# included in the documentation.489# The default value is: NO.490HIDE_FRIEND_COMPOUNDS = NO492# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any494# documentation blocks found inside the body of a function. If set to NO these495# blocks will be appended to the function's detailed documentation block.496# The default value is: NO.497HIDE_IN_BODY_DOCS = NO499# The INTERNAL_DOCS tag determines if documentation that is typed after a501# \internal command is included. If the tag is set to NO then the documentation502# will be excluded. Set it to YES to include the internal documentation.503# The default value is: NO.504INTERNAL_DOCS = NO506# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file508# names in lower-case letters. If set to YES upper-case letters are also509# allowed. This is useful if you have classes or files whose names only differ510# in case and if your file system supports case sensitive file names. Windows511# and Mac users are advised to set this option to NO.512# The default value is: system dependent.513CASE_SENSE_NAMES = NO515# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with517# their full class and namespace scopes in the documentation. If set to YES the518# scope will be hidden.519# The default value is: NO.520HIDE_SCOPE_NAMES = NO522# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of524# the files that are included by a file in the documentation of that file.525# The default value is: YES.526SHOW_INCLUDE_FILES = YES528# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each530# grouped member an include statement to the documentation, telling the reader531# which file to include in order to use the member.532# The default value is: NO.533SHOW_GROUPED_MEMB_INC = NO535# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include537# files with double quotes in the documentation rather than with sharp brackets.538# The default value is: NO.539FORCE_LOCAL_INCLUDES = NO541# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the543# documentation for inline members.544# The default value is: YES.545INLINE_INFO = YES547# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the549# (detailed) documentation of file and class members alphabetically by member550# name. If set to NO the members will appear in declaration order.551# The default value is: YES.552SORT_MEMBER_DOCS = YES554# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief556# descriptions of file, namespace and class members alphabetically by member557# name. If set to NO the members will appear in declaration order. Note that558# this will also influence the order of the classes in the class list.559# The default value is: NO.560SORT_BRIEF_DOCS = NO562# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the564# (brief and detailed) documentation of class members so that constructors and565# destructors are listed first. If set to NO the constructors will appear in the566# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.567# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief568# member documentation.569# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting570# detailed member documentation.571# The default value is: NO.572SORT_MEMBERS_CTORS_1ST = NO574# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy576# of group names into alphabetical order. If set to NO the group names will577# appear in their defined order.578# The default value is: NO.579SORT_GROUP_NAMES = NO581# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by583# fully-qualified names, including namespaces. If set to NO, the class list will584# be sorted only by class name, not including the namespace part.585# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.586# Note: This option applies only to the class list, not to the alphabetical587# list.588# The default value is: NO.589SORT_BY_SCOPE_NAME = NO591# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper593# type resolution of all parameters of a function it will reject a match between594# the prototype and the implementation of a member function even if there is595# only one candidate or it is obvious which candidate to choose by doing a596# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still597# accept a match between prototype and implementation in such cases.598# The default value is: NO.599STRICT_PROTO_MATCHING = NO601# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the603# todo list. This list is created by putting \todo commands in the604# documentation.605# The default value is: YES.606GENERATE_TODOLIST = YES608# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the610# test list. This list is created by putting \test commands in the611# documentation.612# The default value is: YES.613GENERATE_TESTLIST = YES615# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug617# list. This list is created by putting \bug commands in the documentation.618# The default value is: YES.619GENERATE_BUGLIST = YES621# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)623# the deprecated list. This list is created by putting \deprecated commands in624# the documentation.625# The default value is: YES.626GENERATE_DEPRECATEDLIST= YES628# The ENABLED_SECTIONS tag can be used to enable conditional documentation630# sections, marked by \if <section_label> ... \endif and \cond <section_label>631# ... \endcond blocks.632ENABLED_SECTIONS =634# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the636# initial value of a variable or macro / define can have for it to appear in the637# documentation. If the initializer consists of more lines than specified here638# it will be hidden. Use a value of 0 to hide initializers completely. The639# appearance of the value of individual variables and macros / defines can be640# controlled using \showinitializer or \hideinitializer command in the641# documentation regardless of this setting.642# Minimum value: 0, maximum value: 10000, default value: 30.643MAX_INITIALIZER_LINES = 30645# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at647# the bottom of the documentation of classes and structs. If set to YES the list648# will mention the files that were used to generate the documentation.649# The default value is: YES.650SHOW_USED_FILES = YES652# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This654# will remove the Files entry from the Quick Index and from the Folder Tree View655# (if specified).656# The default value is: YES.657SHOW_FILES = YES659# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces661# page. This will remove the Namespaces entry from the Quick Index and from the662# Folder Tree View (if specified).663# The default value is: YES.664SHOW_NAMESPACES = YES666# The FILE_VERSION_FILTER tag can be used to specify a program or script that668# doxygen should invoke to get the current version for each file (typically from669# the version control system). Doxygen will invoke the program by executing (via670# popen()) the command command input-file, where command is the value of the671# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided672# by doxygen. Whatever the program writes to standard output is used as the file673# version. For an example see the documentation.674FILE_VERSION_FILTER =676# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed678# by doxygen. The layout file controls the global structure of the generated679# output files in an output format independent way. To create the layout file680# that represents doxygen's defaults, run doxygen with the -l option. You can681# optionally specify a file name after the option, if omitted DoxygenLayout.xml682# will be used as the name of the layout file.683#684# Note that if you run doxygen from a directory containing a file called685# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE686# tag is left empty.687LAYOUT_FILE =689# The CITE_BIB_FILES tag can be used to specify one or more bib files containing691# the reference definitions. This must be a list of .bib files. The .bib692# extension is automatically appended if omitted. This requires the bibtex tool693# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.694# For LaTeX the style of the bibliography can be controlled using695# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the696# search path. See also \cite for info how to create references.697CITE_BIB_FILES =699#---------------------------------------------------------------------------701# Configuration options related to warning and progress messages702#---------------------------------------------------------------------------703# The QUIET tag can be used to turn on/off the messages that are generated to705# standard output by doxygen. If QUIET is set to YES this implies that the706# messages are off.707# The default value is: NO.708QUIET = YES710# The WARNINGS tag can be used to turn on/off the warning messages that are712# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES713# this implies that the warnings are on.714#715# Tip: Turn warnings on while writing the documentation.716# The default value is: YES.717WARNINGS = YES719# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate721# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag722# will automatically be disabled.723# The default value is: YES.724WARN_IF_UNDOCUMENTED = NO726# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for728# potential errors in the documentation, such as not documenting some parameters729# in a documented function, or documenting parameters that don't exist or using730# markup commands wrongly.731# The default value is: YES.732WARN_IF_DOC_ERROR = YES734# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that736# are documented, but have no documentation for their parameters or return737# value. If set to NO doxygen will only warn about wrong or incomplete parameter738# documentation, but not about the absence of documentation.739# The default value is: NO.740WARN_NO_PARAMDOC = NO742# The WARN_FORMAT tag determines the format of the warning messages that doxygen744# can produce. The string should contain the $file, $line, and $text tags, which745# will be replaced by the file and line number from which the warning originated746# and the warning text. Optionally the format may contain $version, which will747# be replaced by the version of the file (if it could be obtained via748# FILE_VERSION_FILTER)749# The default value is: $file:$line: $text.750WARN_FORMAT = "$file:$line: $text"752# The WARN_LOGFILE tag can be used to specify a file to which warning and error754# messages should be written. If left blank the output is written to standard755# error (stderr).756WARN_LOGFILE =758#---------------------------------------------------------------------------760# Configuration options related to the input files761#---------------------------------------------------------------------------762# The INPUT tag is used to specify the files and/or directories that contain764# documented source files. You may enter file names like myfile.cpp or765# directories like /usr/src/myproject. Separate the files or directories with766# spaces.767# Note: If this tag is empty the current directory is searched.768INPUT = src/770# This tag can be used to specify the character encoding of the source files772# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses773# libiconv (or the iconv built into libc) for the transcoding. See the libiconv774# documentation (see: http://www.gnu.org/software/libiconv) for the list of775# possible encodings.776# The default value is: UTF-8.777INPUT_ENCODING = UTF-8779# If the value of the INPUT tag contains directories, you can use the781# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and782# *.h) to filter out the source-files in the directories. If left blank the783# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,784# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,785# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,786# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,787# *.qsf, *.as and *.js.788FILE_PATTERNS = *.c \790*.cc \791*.cxx \792*.cpp \793*.c++ \794*.h \795*.hh \796*.hxx \797*.hpp \798*.h++799# The RECURSIVE tag can be used to specify whether or not subdirectories should801# be searched for input files as well.802# The default value is: NO.803RECURSIVE = YES805# The EXCLUDE tag can be used to specify files and/or directories that should be807# excluded from the INPUT source files. This way you can easily exclude a808# subdirectory from a directory tree whose root is specified with the INPUT tag.809#810# Note that relative paths are relative to the directory from which doxygen is811# run.812EXCLUDE =814# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or816# directories that are symbolic links (a Unix file system feature) are excluded817# from the input.818# The default value is: NO.819EXCLUDE_SYMLINKS = NO821# If the value of the INPUT tag contains directories, you can use the823# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude824# certain files from those directories.825#826# Note that the wildcards are matched against the file with absolute path, so to827# exclude all test directories for example use the pattern */test/*828EXCLUDE_PATTERNS =830# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names832# (namespaces, classes, functions, etc.) that should be excluded from the833# output. The symbol name can be a fully qualified name, a word, or if the834# wildcard * is used, a substring. Examples: ANamespace, AClass,835# AClass::ANamespace, ANamespace::*Test836#837# Note that the wildcards are matched against the file with absolute path, so to838# exclude all test directories use the pattern */test/*839EXCLUDE_SYMBOLS =841# The EXAMPLE_PATH tag can be used to specify one or more files or directories843# that contain example code fragments that are included (see the \include844# command).845EXAMPLE_PATH =847# If the value of the EXAMPLE_PATH tag contains directories, you can use the849# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and850# *.h) to filter out the source-files in the directories. If left blank all851# files are included.852EXAMPLE_PATTERNS = *854# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be856# searched for input files to be used with the \include or \dontinclude commands857# irrespective of the value of the RECURSIVE tag.858# The default value is: NO.859EXAMPLE_RECURSIVE = NO861# The IMAGE_PATH tag can be used to specify one or more files or directories863# that contain images that are to be included in the documentation (see the864# \image command).865IMAGE_PATH =867# The INPUT_FILTER tag can be used to specify a program that doxygen should869# invoke to filter for each input file. Doxygen will invoke the filter program870# by executing (via popen()) the command:871#872# <filter> <input-file>873#874# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the875# name of an input file. Doxygen will then use the output that the filter876# program writes to standard output. If FILTER_PATTERNS is specified, this tag877# will be ignored.878#879# Note that the filter must not add or remove lines; it is applied before the880# code is scanned, but not when the output code is generated. If lines are added881# or removed, the anchors will not be placed correctly.882INPUT_FILTER =884# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern886# basis. Doxygen will compare the file name with each pattern and apply the887# filter if there is a match. The filters are a list of the form: pattern=filter888# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how889# filters are used. If the FILTER_PATTERNS tag is empty or if none of the890# patterns match the file name, INPUT_FILTER is applied.891FILTER_PATTERNS =893# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using895# INPUT_FILTER ) will also be used to filter the input files that are used for896# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).897# The default value is: NO.898FILTER_SOURCE_FILES = NO900# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file902# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and903# it is also possible to disable source filtering for a specific pattern using904# *.ext= (so without naming a filter).905# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.906FILTER_SOURCE_PATTERNS =908# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that910# is part of the input, its contents will be placed on the main page911# (index.html). This can be useful if you have a project on for instance GitHub912# and want to reuse the introduction page also for the doxygen output.913USE_MDFILE_AS_MAINPAGE =915#---------------------------------------------------------------------------917# Configuration options related to source browsing918#---------------------------------------------------------------------------919# If the SOURCE_BROWSER tag is set to YES then a list of source files will be921# generated. Documented entities will be cross-referenced with these sources.922#923# Note: To get rid of all source code in the generated output, make sure that924# also VERBATIM_HEADERS is set to NO.925# The default value is: NO.926SOURCE_BROWSER = YES928# Setting the INLINE_SOURCES tag to YES will include the body of functions,930# classes and enums directly into the documentation.931# The default value is: NO.932INLINE_SOURCES = NO934# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any936# special comment blocks from generated source code fragments. Normal C, C++ and937# Fortran comments will always remain visible.938# The default value is: YES.939STRIP_CODE_COMMENTS = YES941# If the REFERENCED_BY_RELATION tag is set to YES then for each documented943# function all documented functions referencing it will be listed.944# The default value is: NO.945REFERENCED_BY_RELATION = NO947# If the REFERENCES_RELATION tag is set to YES then for each documented function949# all documented entities called/used by that function will be listed.950# The default value is: NO.951REFERENCES_RELATION = NO953# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set955# to YES, then the hyperlinks from functions in REFERENCES_RELATION and956# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will957# link to the documentation.958# The default value is: YES.959REFERENCES_LINK_SOURCE = YES961# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the963# source code will show a tooltip with additional information such as prototype,964# brief description and links to the definition and documentation. Since this965# will make the HTML file larger and loading of large files a bit slower, you966# can opt to disable this feature.967# The default value is: YES.968# This tag requires that the tag SOURCE_BROWSER is set to YES.969SOURCE_TOOLTIPS = YES971# If the USE_HTAGS tag is set to YES then the references to source code will973# point to the HTML generated by the htags(1) tool instead of doxygen built-in974# source browser. The htags tool is part of GNU's global source tagging system975# (see http://www.gnu.org/software/global/global.html). You will need version976# 4.8.6 or higher.977#978# To use it do the following:979# - Install the latest version of global980# - Enable SOURCE_BROWSER and USE_HTAGS in the config file981# - Make sure the INPUT points to the root of the source tree982# - Run doxygen as normal983#984# Doxygen will invoke htags (and that will in turn invoke gtags), so these985# tools must be available from the command line (i.e. in the search path).986#987# The result: instead of the source browser generated by doxygen, the links to988# source code will now point to the output of htags.989# The default value is: NO.990# This tag requires that the tag SOURCE_BROWSER is set to YES.991USE_HTAGS = NO993# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a995# verbatim copy of the header file for each class for which an include is996# specified. Set to NO to disable this.997# See also: Section \class.998# The default value is: YES.999VERBATIM_HEADERS = YES1001# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the1003# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the1004# cost of reduced performance. This can be particularly helpful with template1005# rich C++ code for which doxygen's built-in parser lacks the necessary type1006# information.1007# Note: The availability of this option depends on whether or not doxygen was1008# compiled with the --with-libclang option.1009# The default value is: NO.1010CLANG_ASSISTED_PARSING = NO1012# If clang assisted parsing is enabled you can provide the compiler with command1014# line options that you would normally use when invoking the compiler. Note that1015# the include paths will already be set by doxygen for the files and directories1016# specified with INPUT and INCLUDE_PATH.1017# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.1018CLANG_OPTIONS =1020#---------------------------------------------------------------------------1022# Configuration options related to the alphabetical class index1023#---------------------------------------------------------------------------1024# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all1026# compounds will be generated. Enable this if the project contains a lot of1027# classes, structs, unions or interfaces.1028# The default value is: YES.1029ALPHABETICAL_INDEX = YES1031# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in1033# which the alphabetical index list will be split.1034# Minimum value: 1, maximum value: 20, default value: 5.1035# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1036COLS_IN_ALPHA_INDEX = 51038# In case all classes in a project start with a common prefix, all classes will1040# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag1041# can be used to specify a prefix (or a list of prefixes) that should be ignored1042# while generating the index headers.1043# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1044IGNORE_PREFIX =1046#---------------------------------------------------------------------------1048# Configuration options related to the HTML output1049#---------------------------------------------------------------------------1050# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1052# The default value is: YES.1053GENERATE_HTML = YES1055# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1057# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1058# it.1059# The default directory is: html.1060# This tag requires that the tag GENERATE_HTML is set to YES.1061HTML_OUTPUT = html1063# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1065# generated HTML page (for example: .htm, .php, .asp).1066# The default value is: .html.1067# This tag requires that the tag GENERATE_HTML is set to YES.1068HTML_FILE_EXTENSION = .html1070# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1072# each generated HTML page. If the tag is left blank doxygen will generate a1073# standard header.1074#1075# To get valid HTML the header file that includes any scripts and style sheets1076# that doxygen needs, which is dependent on the configuration options used (e.g.1077# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1078# default header using1079# doxygen -w html new_header.html new_footer.html new_stylesheet.css1080# YourConfigFile1081# and then modify the file new_header.html. See also section "Doxygen usage"1082# for information on how to generate the default header that doxygen normally1083# uses.1084# Note: The header is subject to change so you typically have to regenerate the1085# default header when upgrading to a newer version of doxygen. For a description1086# of the possible markers and block names see the documentation.1087# This tag requires that the tag GENERATE_HTML is set to YES.1088HTML_HEADER =1090# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1092# generated HTML page. If the tag is left blank doxygen will generate a standard1093# footer. See HTML_HEADER for more information on how to generate a default1094# footer and what special commands can be used inside the footer. See also1095# section "Doxygen usage" for information on how to generate the default footer1096# that doxygen normally uses.1097# This tag requires that the tag GENERATE_HTML is set to YES.1098HTML_FOOTER =1100# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1102# sheet that is used by each HTML page. It can be used to fine-tune the look of1103# the HTML output. If left blank doxygen will generate a default style sheet.1104# See also section "Doxygen usage" for information on how to generate the style1105# sheet that doxygen normally uses.1106# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1107# it is more robust and this tag (HTML_STYLESHEET) will in the future become1108# obsolete.1109# This tag requires that the tag GENERATE_HTML is set to YES.1110HTML_STYLESHEET =1112# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined1114# cascading style sheets that are included after the standard style sheets1115# created by doxygen. Using this option one can overrule certain style aspects.1116# This is preferred over using HTML_STYLESHEET since it does not replace the1117# standard style sheet and is therefor more robust against future updates.1118# Doxygen will copy the style sheet files to the output directory.1119# Note: The order of the extra stylesheet files is of importance (e.g. the last1120# stylesheet in the list overrules the setting of the previous ones in the1121# list). For an example see the documentation.1122# This tag requires that the tag GENERATE_HTML is set to YES.1123HTML_EXTRA_STYLESHEET =1125# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1127# other source files which should be copied to the HTML output directory. Note1128# that these files will be copied to the base HTML output directory. Use the1129# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1130# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1131# files will be copied as-is; there are no commands or markers available.1132# This tag requires that the tag GENERATE_HTML is set to YES.1133HTML_EXTRA_FILES =1135# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1137# will adjust the colors in the stylesheet and background images according to1138# this color. Hue is specified as an angle on a colorwheel, see1139# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1140# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001141# purple, and 360 is red again.1142# Minimum value: 0, maximum value: 359, default value: 220.1143# This tag requires that the tag GENERATE_HTML is set to YES.1144HTML_COLORSTYLE_HUE = 2201146# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1148# in the HTML output. For a value of 0 the output will use grayscales only. A1149# value of 255 will produce the most vivid colors.1150# Minimum value: 0, maximum value: 255, default value: 100.1151# This tag requires that the tag GENERATE_HTML is set to YES.1152HTML_COLORSTYLE_SAT = 1001154# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1156# luminance component of the colors in the HTML output. Values below 1001157# gradually make the output lighter, whereas values above 100 make the output1158# darker. The value divided by 100 is the actual gamma applied, so 80 represents1159# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1160# change the gamma.1161# Minimum value: 40, maximum value: 240, default value: 80.1162# This tag requires that the tag GENERATE_HTML is set to YES.1163HTML_COLORSTYLE_GAMMA = 801165# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1167# page will contain the date and time when the page was generated. Setting this1168# to NO can help when comparing the output of multiple runs.1169# The default value is: YES.1170# This tag requires that the tag GENERATE_HTML is set to YES.1171HTML_TIMESTAMP = YES1173# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1175# documentation will contain sections that can be hidden and shown after the1176# page has loaded.1177# The default value is: NO.1178# This tag requires that the tag GENERATE_HTML is set to YES.1179HTML_DYNAMIC_SECTIONS = NO1181# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1183# shown in the various tree structured indices initially; the user can expand1184# and collapse entries dynamically later on. Doxygen will expand the tree to1185# such a level that at most the specified number of entries are visible (unless1186# a fully collapsed tree already exceeds this amount). So setting the number of1187# entries 1 will produce a full collapsed tree by default. 0 is a special value1188# representing an infinite number of entries and will result in a full expanded1189# tree by default.1190# Minimum value: 0, maximum value: 9999, default value: 100.1191# This tag requires that the tag GENERATE_HTML is set to YES.1192HTML_INDEX_NUM_ENTRIES = 1001194# If the GENERATE_DOCSET tag is set to YES, additional index files will be1196# generated that can be used as input for Apple's Xcode 3 integrated development1197# environment (see: http://developer.apple.com/tools/xcode/), introduced with1198# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1199# Makefile in the HTML output directory. Running make will produce the docset in1200# that directory and running make install will install the docset in1201# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1202# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1203# for more information.1204# The default value is: NO.1205# This tag requires that the tag GENERATE_HTML is set to YES.1206GENERATE_DOCSET = NO1208# This tag determines the name of the docset feed. A documentation feed provides1210# an umbrella under which multiple documentation sets from a single provider1211# (such as a company or product suite) can be grouped.1212# The default value is: Doxygen generated docs.1213# This tag requires that the tag GENERATE_DOCSET is set to YES.1214DOCSET_FEEDNAME = "Doxygen generated docs"1216# This tag specifies a string that should uniquely identify the documentation1218# set bundle. This should be a reverse domain-name style string, e.g.1219# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1220# The default value is: org.doxygen.Project.1221# This tag requires that the tag GENERATE_DOCSET is set to YES.1222DOCSET_BUNDLE_ID = org.doxygen.Project1224# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1226# the documentation publisher. This should be a reverse domain-name style1227# string, e.g. com.mycompany.MyDocSet.documentation.1228# The default value is: org.doxygen.Publisher.1229# This tag requires that the tag GENERATE_DOCSET is set to YES.1230DOCSET_PUBLISHER_ID = org.doxygen.Publisher1232# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1234# The default value is: Publisher.1235# This tag requires that the tag GENERATE_DOCSET is set to YES.1236DOCSET_PUBLISHER_NAME = Publisher1238# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1240# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1241# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1242# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1243# Windows.1244#1245# The HTML Help Workshop contains a compiler that can convert all HTML output1246# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1247# files are now used as the Windows 98 help format, and will replace the old1248# Windows help format (.hlp) on all Windows platforms in the future. Compressed1249# HTML files also contain an index, a table of contents, and you can search for1250# words in the documentation. The HTML workshop also contains a viewer for1251# compressed HTML files.1252# The default value is: NO.1253# This tag requires that the tag GENERATE_HTML is set to YES.1254GENERATE_HTMLHELP = NO1256# The CHM_FILE tag can be used to specify the file name of the resulting .chm1258# file. You can add a path in front of the file if the result should not be1259# written to the html output directory.1260# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1261CHM_FILE =1263# The HHC_LOCATION tag can be used to specify the location (absolute path1265# including file name) of the HTML help compiler ( hhc.exe). If non-empty1266# doxygen will try to run the HTML help compiler on the generated index.hhp.1267# The file has to be specified with full path.1268# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1269HHC_LOCATION =1271# The GENERATE_CHI flag controls if a separate .chi index file is generated (1273# YES) or that it should be included in the master .chm file ( NO).1274# The default value is: NO.1275# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1276GENERATE_CHI = NO1278# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)1280# and project file content.1281# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1282CHM_INDEX_ENCODING =1284# The BINARY_TOC flag controls whether a binary table of contents is generated (1286# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it1287# enables the Previous and Next buttons.1288# The default value is: NO.1289# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1290BINARY_TOC = NO1292# The TOC_EXPAND flag can be set to YES to add extra items for group members to1294# the table of contents of the HTML help documentation and to the tree view.1295# The default value is: NO.1296# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1297TOC_EXPAND = NO1299# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1301# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1302# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1303# (.qch) of the generated HTML documentation.1304# The default value is: NO.1305# This tag requires that the tag GENERATE_HTML is set to YES.1306GENERATE_QHP = NO1308# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1310# the file name of the resulting .qch file. The path specified is relative to1311# the HTML output folder.1312# This tag requires that the tag GENERATE_QHP is set to YES.1313QCH_FILE =1315# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1317# Project output. For more information please see Qt Help Project / Namespace1318# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1319# The default value is: org.doxygen.Project.1320# This tag requires that the tag GENERATE_QHP is set to YES.1321QHP_NAMESPACE = org.doxygen.Project1323# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1325# Help Project output. For more information please see Qt Help Project / Virtual1326# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1327# folders).1328# The default value is: doc.1329# This tag requires that the tag GENERATE_QHP is set to YES.1330QHP_VIRTUAL_FOLDER = doc1332# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1334# filter to add. For more information please see Qt Help Project / Custom1335# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1336# filters).1337# This tag requires that the tag GENERATE_QHP is set to YES.1338QHP_CUST_FILTER_NAME =1340# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1342# custom filter to add. For more information please see Qt Help Project / Custom1343# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1344# filters).1345# This tag requires that the tag GENERATE_QHP is set to YES.1346QHP_CUST_FILTER_ATTRS =1348# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1350# project's filter section matches. Qt Help Project / Filter Attributes (see:1351# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1352# This tag requires that the tag GENERATE_QHP is set to YES.1353QHP_SECT_FILTER_ATTRS =1355# The QHG_LOCATION tag can be used to specify the location of Qt's1357# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1358# generated .qhp file.1359# This tag requires that the tag GENERATE_QHP is set to YES.1360QHG_LOCATION =1362# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1364# generated, together with the HTML files, they form an Eclipse help plugin. To1365# install this plugin and make it available under the help contents menu in1366# Eclipse, the contents of the directory containing the HTML and XML files needs1367# to be copied into the plugins directory of eclipse. The name of the directory1368# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1369# After copying Eclipse needs to be restarted before the help appears.1370# The default value is: NO.1371# This tag requires that the tag GENERATE_HTML is set to YES.1372GENERATE_ECLIPSEHELP = NO1374# A unique identifier for the Eclipse help plugin. When installing the plugin1376# the directory name containing the HTML and XML files should also have this1377# name. Each documentation set should have its own identifier.1378# The default value is: org.doxygen.Project.1379# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1380ECLIPSE_DOC_ID = org.doxygen.Project1382# If you want full control over the layout of the generated HTML pages it might1384# be necessary to disable the index and replace it with your own. The1385# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1386# of each HTML page. A value of NO enables the index and the value YES disables1387# it. Since the tabs in the index contain the same information as the navigation1388# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1389# The default value is: NO.1390# This tag requires that the tag GENERATE_HTML is set to YES.1391DISABLE_INDEX = NO1393# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1395# structure should be generated to display hierarchical information. If the tag1396# value is set to YES, a side panel will be generated containing a tree-like1397# index structure (just like the one that is generated for HTML Help). For this1398# to work a browser that supports JavaScript, DHTML, CSS and frames is required1399# (i.e. any modern browser). Windows users are probably better off using the1400# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can1401# further fine-tune the look of the index. As an example, the default style1402# sheet generated by doxygen has an example that shows how to put an image at1403# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1404# the same information as the tab index, you could consider setting1405# DISABLE_INDEX to YES when enabling this option.1406# The default value is: NO.1407# This tag requires that the tag GENERATE_HTML is set to YES.1408GENERATE_TREEVIEW = YES1410# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1412# doxygen will group on one line in the generated HTML documentation.1413#1414# Note that a value of 0 will completely suppress the enum values from appearing1415# in the overview section.1416# Minimum value: 0, maximum value: 20, default value: 4.1417# This tag requires that the tag GENERATE_HTML is set to YES.1418ENUM_VALUES_PER_LINE = 41420# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1422# to set the initial width (in pixels) of the frame in which the tree is shown.1423# Minimum value: 0, maximum value: 1500, default value: 250.1424# This tag requires that the tag GENERATE_HTML is set to YES.1425TREEVIEW_WIDTH = 2501427# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to1429# external symbols imported via tag files in a separate window.1430# The default value is: NO.1431# This tag requires that the tag GENERATE_HTML is set to YES.1432EXT_LINKS_IN_WINDOW = NO1434# Use this tag to change the font size of LaTeX formulas included as images in1436# the HTML documentation. When you change the font size after a successful1437# doxygen run you need to manually remove any form_*.png images from the HTML1438# output directory to force them to be regenerated.1439# Minimum value: 8, maximum value: 50, default value: 10.1440# This tag requires that the tag GENERATE_HTML is set to YES.1441FORMULA_FONTSIZE = 101443# Use the FORMULA_TRANPARENT tag to determine whether or not the images1445# generated for formulas are transparent PNGs. Transparent PNGs are not1446# supported properly for IE 6.0, but are supported on all modern browsers.1447#1448# Note that when changing this option you need to delete any form_*.png files in1449# the HTML output directory before the changes have effect.1450# The default value is: YES.1451# This tag requires that the tag GENERATE_HTML is set to YES.1452FORMULA_TRANSPARENT = YES1454# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1456# http://www.mathjax.org) which uses client side Javascript for the rendering1457# instead of using prerendered bitmaps. Use this if you do not have LaTeX1458# installed or if you want to formulas look prettier in the HTML output. When1459# enabled you may also need to install MathJax separately and configure the path1460# to it using the MATHJAX_RELPATH option.1461# The default value is: NO.1462# This tag requires that the tag GENERATE_HTML is set to YES.1463USE_MATHJAX = NO1465# When MathJax is enabled you can set the default output format to be used for1467# the MathJax output. See the MathJax site (see:1468# http://docs.mathjax.org/en/latest/output.html) for more details.1469# Possible values are: HTML-CSS (which is slower, but has the best1470# compatibility), NativeMML (i.e. MathML) and SVG.1471# The default value is: HTML-CSS.1472# This tag requires that the tag USE_MATHJAX is set to YES.1473MATHJAX_FORMAT = HTML-CSS1475# When MathJax is enabled you need to specify the location relative to the HTML1477# output directory using the MATHJAX_RELPATH option. The destination directory1478# should contain the MathJax.js script. For instance, if the mathjax directory1479# is located at the same level as the HTML output directory, then1480# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1481# Content Delivery Network so you can quickly see the result without installing1482# MathJax. However, it is strongly recommended to install a local copy of1483# MathJax from http://www.mathjax.org before deployment.1484# The default value is: http://cdn.mathjax.org/mathjax/latest.1485# This tag requires that the tag USE_MATHJAX is set to YES.1486MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest1488# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1490# extension names that should be enabled during MathJax rendering. For example1491# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1492# This tag requires that the tag USE_MATHJAX is set to YES.1493MATHJAX_EXTENSIONS =1495# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1497# of code that will be used on startup of the MathJax code. See the MathJax site1498# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1499# example see the documentation.1500# This tag requires that the tag USE_MATHJAX is set to YES.1501MATHJAX_CODEFILE =1503# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1505# the HTML output. The underlying search engine uses javascript and DHTML and1506# should work on any modern browser. Note that when using HTML help1507# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1508# there is already a search function so this one should typically be disabled.1509# For large projects the javascript based search engine can be slow, then1510# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1511# search using the keyboard; to jump to the search box use <access key> + S1512# (what the <access key> is depends on the OS and browser, but it is typically1513# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1514# key> to jump into the search results window, the results can be navigated1515# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1516# the search. The filter options can be selected when the cursor is inside the1517# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1518# to select a filter and <Enter> or <escape> to activate or cancel the filter1519# option.1520# The default value is: YES.1521# This tag requires that the tag GENERATE_HTML is set to YES.1522SEARCHENGINE = YES1524# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1526# implemented using a web server instead of a web client using Javascript. There1527# are two flavors of web server based searching depending on the EXTERNAL_SEARCH1528# setting. When disabled, doxygen will generate a PHP script for searching and1529# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing1530# and searching needs to be provided by external tools. See the section1531# "External Indexing and Searching" for details.1532# The default value is: NO.1533# This tag requires that the tag SEARCHENGINE is set to YES.1534SERVER_BASED_SEARCH = NO1536# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1538# script for searching. Instead the search results are written to an XML file1539# which needs to be processed by an external indexer. Doxygen will invoke an1540# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1541# search results.1542#1543# Doxygen ships with an example indexer ( doxyindexer) and search engine1544# (doxysearch.cgi) which are based on the open source search engine library1545# Xapian (see: http://xapian.org/).1546#1547# See the section "External Indexing and Searching" for details.1548# The default value is: NO.1549# This tag requires that the tag SEARCHENGINE is set to YES.1550EXTERNAL_SEARCH = NO1552# The SEARCHENGINE_URL should point to a search engine hosted by a web server1554# which will return the search results when EXTERNAL_SEARCH is enabled.1555#1556# Doxygen ships with an example indexer ( doxyindexer) and search engine1557# (doxysearch.cgi) which are based on the open source search engine library1558# Xapian (see: http://xapian.org/). See the section "External Indexing and1559# Searching" for details.1560# This tag requires that the tag SEARCHENGINE is set to YES.1561SEARCHENGINE_URL =1563# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1565# search data is written to a file for indexing by an external tool. With the1566# SEARCHDATA_FILE tag the name of this file can be specified.1567# The default file is: searchdata.xml.1568# This tag requires that the tag SEARCHENGINE is set to YES.1569SEARCHDATA_FILE = searchdata.xml1571# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1573# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1574# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1575# projects and redirect the results back to the right project.1576# This tag requires that the tag SEARCHENGINE is set to YES.1577EXTERNAL_SEARCH_ID =1579# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1581# projects other than the one defined by this configuration file, but that are1582# all added to the same external search index. Each project needs to have a1583# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1584# to a relative location where the documentation can be found. The format is:1585# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1586# This tag requires that the tag SEARCHENGINE is set to YES.1587EXTRA_SEARCH_MAPPINGS =1589#---------------------------------------------------------------------------1591# Configuration options related to the LaTeX output1592#---------------------------------------------------------------------------1593# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1595# The default value is: YES.1596GENERATE_LATEX = NO1598# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1600# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1601# it.1602# The default directory is: latex.1603# This tag requires that the tag GENERATE_LATEX is set to YES.1604LATEX_OUTPUT = latex1606# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1608# invoked.1609#1610# Note that when enabling USE_PDFLATEX this option is only used for generating1611# bitmaps for formulas in the HTML output, but not in the Makefile that is1612# written to the output directory.1613# The default file is: latex.1614# This tag requires that the tag GENERATE_LATEX is set to YES.1615LATEX_CMD_NAME = latex1617# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1619# index for LaTeX.1620# The default file is: makeindex.1621# This tag requires that the tag GENERATE_LATEX is set to YES.1622MAKEINDEX_CMD_NAME = makeindex1624# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX1626# documents. This may be useful for small projects and may help to save some1627# trees in general.1628# The default value is: NO.1629# This tag requires that the tag GENERATE_LATEX is set to YES.1630COMPACT_LATEX = NO1632# The PAPER_TYPE tag can be used to set the paper type that is used by the1634# printer.1635# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1636# 14 inches) and executive (7.25 x 10.5 inches).1637# The default value is: a4.1638# This tag requires that the tag GENERATE_LATEX is set to YES.1639PAPER_TYPE = a41641# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1643# that should be included in the LaTeX output. To get the times font for1644# instance you can specify1645# EXTRA_PACKAGES=times1646# If left blank no extra packages will be included.1647# This tag requires that the tag GENERATE_LATEX is set to YES.1648EXTRA_PACKAGES =1650# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1652# generated LaTeX document. The header should contain everything until the first1653# chapter. If it is left blank doxygen will generate a standard header. See1654# section "Doxygen usage" for information on how to let doxygen write the1655# default header to a separate file.1656#1657# Note: Only use a user-defined header if you know what you are doing! The1658# following commands have a special meaning inside the header: $title,1659# $datetime, $date, $doxygenversion, $projectname, $projectnumber,1660# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,1661# for the replacement values of the other commands the user is refered to1662# HTML_HEADER.1663# This tag requires that the tag GENERATE_LATEX is set to YES.1664LATEX_HEADER =1666# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1668# generated LaTeX document. The footer should contain everything after the last1669# chapter. If it is left blank doxygen will generate a standard footer. See1670# LATEX_HEADER for more information on how to generate a default footer and what1671# special commands can be used inside the footer.1672#1673# Note: Only use a user-defined footer if you know what you are doing!1674# This tag requires that the tag GENERATE_LATEX is set to YES.1675LATEX_FOOTER =1677# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1679# other source files which should be copied to the LATEX_OUTPUT output1680# directory. Note that the files will be copied as-is; there are no commands or1681# markers available.1682# This tag requires that the tag GENERATE_LATEX is set to YES.1683LATEX_EXTRA_FILES =1685# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1687# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1688# contain links (just like the HTML output) instead of page references. This1689# makes the output suitable for online browsing using a PDF viewer.1690# The default value is: YES.1691# This tag requires that the tag GENERATE_LATEX is set to YES.1692PDF_HYPERLINKS = YES1694# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1696# the PDF file directly from the LaTeX files. Set this option to YES to get a1697# higher quality PDF documentation.1698# The default value is: YES.1699# This tag requires that the tag GENERATE_LATEX is set to YES.1700USE_PDFLATEX = YES1702# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1704# command to the generated LaTeX files. This will instruct LaTeX to keep running1705# if errors occur, instead of asking the user for help. This option is also used1706# when generating formulas in HTML.1707# The default value is: NO.1708# This tag requires that the tag GENERATE_LATEX is set to YES.1709LATEX_BATCHMODE = NO1711# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1713# index chapters (such as File Index, Compound Index, etc.) in the output.1714# The default value is: NO.1715# This tag requires that the tag GENERATE_LATEX is set to YES.1716LATEX_HIDE_INDICES = NO1718# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1720# code with syntax highlighting in the LaTeX output.1721#1722# Note that which sources are shown also depends on other settings such as1723# SOURCE_BROWSER.1724# The default value is: NO.1725# This tag requires that the tag GENERATE_LATEX is set to YES.1726LATEX_SOURCE_CODE = NO1728# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1730# bibliography, e.g. plainnat, or ieeetr. See1731# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1732# The default value is: plain.1733# This tag requires that the tag GENERATE_LATEX is set to YES.1734LATEX_BIB_STYLE = plain1736#---------------------------------------------------------------------------1738# Configuration options related to the RTF output1739#---------------------------------------------------------------------------1740# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1742# RTF output is optimized for Word 97 and may not look too pretty with other RTF1743# readers/editors.1744# The default value is: NO.1745GENERATE_RTF = NO1747# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1749# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1750# it.1751# The default directory is: rtf.1752# This tag requires that the tag GENERATE_RTF is set to YES.1753RTF_OUTPUT = rtf1755# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1757# 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_RTF is set to YES.1761COMPACT_RTF = NO1763# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1765# contain hyperlink fields. The RTF file will contain links (just like the HTML1766# output) instead of page references. This makes the output suitable for online1767# browsing using Word or some other Word compatible readers that support those1768# fields.1769#1770# Note: WordPad (write) and others do not support links.1771# The default value is: NO.1772# This tag requires that the tag GENERATE_RTF is set to YES.1773RTF_HYPERLINKS = NO1775# Load stylesheet definitions from file. Syntax is similar to doxygen's config1777# file, i.e. a series of assignments. You only have to provide replacements,1778# missing definitions are set to their default value.1779#1780# See also section "Doxygen usage" for information on how to generate the1781# default style sheet that doxygen normally uses.1782# This tag requires that the tag GENERATE_RTF is set to YES.1783RTF_STYLESHEET_FILE =1785# Set optional variables used in the generation of an RTF document. Syntax is1787# similar to doxygen's config file. A template extensions file can be generated1788# using doxygen -e rtf extensionFile.1789# This tag requires that the tag GENERATE_RTF is set to YES.1790RTF_EXTENSIONS_FILE =1792#---------------------------------------------------------------------------1794# Configuration options related to the man page output1795#---------------------------------------------------------------------------1796# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1798# classes and files.1799# The default value is: NO.1800GENERATE_MAN = NO1802# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1804# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1805# it. A directory man3 will be created inside the directory specified by1806# MAN_OUTPUT.1807# The default directory is: man.1808# This tag requires that the tag GENERATE_MAN is set to YES.1809MAN_OUTPUT = man1811# The MAN_EXTENSION tag determines the extension that is added to the generated1813# man pages. In case the manual section does not start with a number, the number1814# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1815# optional.1816# The default value is: .3.1817# This tag requires that the tag GENERATE_MAN is set to YES.1818MAN_EXTENSION = .31820# The MAN_SUBDIR tag determines the name of the directory created within1822# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by1823# MAN_EXTENSION with the initial . removed.1824# This tag requires that the tag GENERATE_MAN is set to YES.1825MAN_SUBDIR =1827# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1829# will generate one additional man file for each entity documented in the real1830# man page(s). These additional files only source the real man page, but without1831# them the man command would be unable to find the correct page.1832# The default value is: NO.1833# This tag requires that the tag GENERATE_MAN is set to YES.1834MAN_LINKS = NO1836#---------------------------------------------------------------------------1838# Configuration options related to the XML output1839#---------------------------------------------------------------------------1840# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1842# captures the structure of the code including all documentation.1843# The default value is: NO.1844GENERATE_XML = NO1846# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1848# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1849# it.1850# The default directory is: xml.1851# This tag requires that the tag GENERATE_XML is set to YES.1852XML_OUTPUT = xml1854# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1856# listings (including syntax highlighting and cross-referencing information) to1857# the XML output. Note that enabling this will significantly increase the size1858# of the XML output.1859# The default value is: YES.1860# This tag requires that the tag GENERATE_XML is set to YES.1861XML_PROGRAMLISTING = YES1863#---------------------------------------------------------------------------1865# Configuration options related to the DOCBOOK output1866#---------------------------------------------------------------------------1867# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1869# that can be used to generate PDF.1870# The default value is: NO.1871GENERATE_DOCBOOK = NO1873# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1875# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1876# front of it.1877# The default directory is: docbook.1878# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1879DOCBOOK_OUTPUT = docbook1881# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the1883# program listings (including syntax highlighting and cross-referencing1884# information) to the DOCBOOK output. Note that enabling this will significantly1885# increase the size of the DOCBOOK output.1886# The default value is: NO.1887# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1888DOCBOOK_PROGRAMLISTING = NO1890#---------------------------------------------------------------------------1892# Configuration options for the AutoGen Definitions output1893#---------------------------------------------------------------------------1894# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1896# Definitions (see http://autogen.sf.net) file that captures the structure of1897# the code including all documentation. Note that this feature is still1898# experimental and incomplete at the moment.1899# The default value is: NO.1900GENERATE_AUTOGEN_DEF = NO1902#---------------------------------------------------------------------------1904# Configuration options related to the Perl module output1905#---------------------------------------------------------------------------1906# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module1908# file that captures the structure of the code including all documentation.1909#1910# Note that this feature is still experimental and incomplete at the moment.1911# The default value is: NO.1912GENERATE_PERLMOD = NO1914# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary1916# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI1917# output from the Perl module output.1918# The default value is: NO.1919# This tag requires that the tag GENERATE_PERLMOD is set to YES.1920PERLMOD_LATEX = NO1922# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely1924# formatted so it can be parsed by a human reader. This is useful if you want to1925# understand what is going on. On the other hand, if this tag is set to NO the1926# size of the Perl module output will be much smaller and Perl will parse it1927# just the same.1928# The default value is: YES.1929# This tag requires that the tag GENERATE_PERLMOD is set to YES.1930PERLMOD_PRETTY = YES1932# The names of the make variables in the generated doxyrules.make file are1934# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful1935# so different doxyrules.make files included by the same Makefile don't1936# overwrite each other's variables.1937# This tag requires that the tag GENERATE_PERLMOD is set to YES.1938PERLMOD_MAKEVAR_PREFIX =1940#---------------------------------------------------------------------------1942# Configuration options related to the preprocessor1943#---------------------------------------------------------------------------1944# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all1946# C-preprocessor directives found in the sources and include files.1947# The default value is: YES.1948ENABLE_PREPROCESSING = YES1950# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1952# in the source code. If set to NO only conditional compilation will be1953# performed. Macro expansion can be done in a controlled way by setting1954# EXPAND_ONLY_PREDEF to YES.1955# The default value is: NO.1956# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1957MACRO_EXPANSION = NO1959# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then1961# the macro expansion is limited to the macros specified with the PREDEFINED and1962# EXPAND_AS_DEFINED tags.1963# The default value is: NO.1964# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1965EXPAND_ONLY_PREDEF = NO1967# If the SEARCH_INCLUDES tag is set to YES the includes files in the1969# INCLUDE_PATH will be searched if a #include is found.1970# The default value is: YES.1971# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1972SEARCH_INCLUDES = YES1974# The INCLUDE_PATH tag can be used to specify one or more directories that1976# contain include files that are not input files but should be processed by the1977# preprocessor.1978# This tag requires that the tag SEARCH_INCLUDES is set to YES.1979INCLUDE_PATH =1981# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1983# patterns (like *.h and *.hpp) to filter out the header-files in the1984# directories. If left blank, the patterns specified with FILE_PATTERNS will be1985# used.1986# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1987INCLUDE_FILE_PATTERNS =1989# The PREDEFINED tag can be used to specify one or more macro names that are1991# defined before the preprocessor is started (similar to the -D option of e.g.1992# gcc). The argument of the tag is a list of macros of the form: name or1993# name=definition (no spaces). If the definition and the "=" are omitted, "=1"1994# is assumed. To prevent a macro definition from being undefined via #undef or1995# recursively expanded use the := operator instead of the = operator.1996# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1997PREDEFINED =1999# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this2001# tag can be used to specify a list of macro names that should be expanded. The2002# macro definition that is found in the sources will be used. Use the PREDEFINED2003# tag if you want to use a different macro definition that overrules the2004# definition found in the source code.2005# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2006EXPAND_AS_DEFINED =2008# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will2010# remove all references to function-like macros that are alone on a line, have2011# an all uppercase name, and do not end with a semicolon. Such function macros2012# are typically used for boiler-plate code, and will confuse the parser if not2013# removed.2014# The default value is: YES.2015# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.2016SKIP_FUNCTION_MACROS = YES2018#---------------------------------------------------------------------------2020# Configuration options related to external references2021#---------------------------------------------------------------------------2022# The TAGFILES tag can be used to specify one or more tag files. For each tag2024# file the location of the external documentation should be added. The format of2025# a tag file without this location is as follows:2026# TAGFILES = file1 file2 ...2027# Adding location for the tag files is done as follows:2028# TAGFILES = file1=loc1 "file2 = loc2" ...2029# where loc1 and loc2 can be relative or absolute paths or URLs. See the2030# section "Linking to external documentation" for more information about the use2031# of tag files.2032# Note: Each tag file must have a unique name (where the name does NOT include2033# the path). If a tag file is not located in the directory in which doxygen is2034# run, you must also specify the path to the tagfile here.2035TAGFILES =2037# When a file name is specified after GENERATE_TAGFILE, doxygen will create a2039# tag file that is based on the input files it reads. See section "Linking to2040# external documentation" for more information about the usage of tag files.2041GENERATE_TAGFILE =2043# If the ALLEXTERNALS tag is set to YES all external class will be listed in the2045# class index. If set to NO only the inherited external classes will be listed.2046# The default value is: NO.2047ALLEXTERNALS = NO2049# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in2051# the modules index. If set to NO, only the current project's groups will be2052# listed.2053# The default value is: YES.2054EXTERNAL_GROUPS = YES2056# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in2058# the related pages index. If set to NO, only the current project's pages will2059# be listed.2060# The default value is: YES.2061EXTERNAL_PAGES = YES2063# The PERL_PATH should be the absolute path and name of the perl script2065# interpreter (i.e. the result of 'which perl').2066# The default file (with absolute path) is: /usr/bin/perl.2067PERL_PATH = /usr/bin/perl2069#---------------------------------------------------------------------------2071# Configuration options related to the dot tool2072#---------------------------------------------------------------------------2073# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2075# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2076# NO turns the diagrams off. Note that this option also works with HAVE_DOT2077# disabled, but it is recommended to install and use dot, since it yields more2078# powerful graphs.2079# The default value is: YES.2080CLASS_DIAGRAMS = YES2082# You can define message sequence charts within doxygen comments using the \msc2084# command. Doxygen will then run the mscgen tool (see:2085# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2086# documentation. The MSCGEN_PATH tag allows you to specify the directory where2087# the mscgen tool resides. If left empty the tool is assumed to be found in the2088# default search path.2089MSCGEN_PATH =2091# You can include diagrams made with dia in doxygen documentation. Doxygen will2093# then run dia to produce the diagram and insert it in the documentation. The2094# DIA_PATH tag allows you to specify the directory where the dia binary resides.2095# If left empty dia is assumed to be found in the default search path.2096DIA_PATH =2098# If set to YES, the inheritance and collaboration graphs will hide inheritance2100# and usage relations if the target is undocumented or is not a class.2101# The default value is: YES.2102HIDE_UNDOC_RELATIONS = YES2104# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2106# available from the path. This tool is part of Graphviz (see:2107# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2108# Bell Labs. The other options in this section have no effect if this option is2109# set to NO2110# The default value is: NO.2111HAVE_DOT = NO2113# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2115# to run in parallel. When set to 0 doxygen will base this on the number of2116# processors available in the system. You can set it explicitly to a value2117# larger than 0 to get control over the balance between CPU load and processing2118# speed.2119# Minimum value: 0, maximum value: 32, default value: 0.2120# This tag requires that the tag HAVE_DOT is set to YES.2121DOT_NUM_THREADS = 02123# When you want a differently looking font in the dot files that doxygen2125# generates you can specify the font name using DOT_FONTNAME. You need to make2126# sure dot is able to find the font, which can be done by putting it in a2127# standard location or by setting the DOTFONTPATH environment variable or by2128# setting DOT_FONTPATH to the directory containing the font.2129# The default value is: Helvetica.2130# This tag requires that the tag HAVE_DOT is set to YES.2131DOT_FONTNAME = Helvetica2133# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2135# dot graphs.2136# Minimum value: 4, maximum value: 24, default value: 10.2137# This tag requires that the tag HAVE_DOT is set to YES.2138DOT_FONTSIZE = 102140# By default doxygen will tell dot to use the default font as specified with2142# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2143# the path where dot can find it using this tag.2144# This tag requires that the tag HAVE_DOT is set to YES.2145DOT_FONTPATH =2147# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2149# each documented class showing the direct and indirect inheritance relations.2150# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2151# The default value is: YES.2152# This tag requires that the tag HAVE_DOT is set to YES.2153CLASS_GRAPH = YES2155# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2157# graph for each documented class showing the direct and indirect implementation2158# dependencies (inheritance, containment, and class references variables) of the2159# class with other documented classes.2160# The default value is: YES.2161# This tag requires that the tag HAVE_DOT is set to YES.2162COLLABORATION_GRAPH = YES2164# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2166# groups, showing the direct groups dependencies.2167# The default value is: YES.2168# This tag requires that the tag HAVE_DOT is set to YES.2169GROUP_GRAPHS = YES2171# If the UML_LOOK tag is set to YES doxygen will generate inheritance and2173# collaboration diagrams in a style similar to the OMG's Unified Modeling2174# Language.2175# The default value is: NO.2176# This tag requires that the tag HAVE_DOT is set to YES.2177UML_LOOK = NO2179# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2181# class node. If there are many fields or methods and many nodes the graph may2182# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2183# number of items for each type to make the size more manageable. Set this to 02184# for no limit. Note that the threshold may be exceeded by 50% before the limit2185# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2186# but if the number exceeds 15, the total amount of fields shown is limited to2187# 10.2188# Minimum value: 0, maximum value: 100, default value: 10.2189# This tag requires that the tag HAVE_DOT is set to YES.2190UML_LIMIT_NUM_FIELDS = 102192# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2194# collaboration graphs will show the relations between templates and their2195# instances.2196# The default value is: NO.2197# This tag requires that the tag HAVE_DOT is set to YES.2198TEMPLATE_RELATIONS = NO2200# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2202# YES then doxygen will generate a graph for each documented file showing the2203# direct and indirect include dependencies of the file with other documented2204# files.2205# The default value is: YES.2206# This tag requires that the tag HAVE_DOT is set to YES.2207INCLUDE_GRAPH = YES2209# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2211# set to YES then doxygen will generate a graph for each documented file showing2212# the direct and indirect include dependencies of the file with other documented2213# files.2214# The default value is: YES.2215# This tag requires that the tag HAVE_DOT is set to YES.2216INCLUDED_BY_GRAPH = YES2218# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2220# dependency graph for every global function or class method.2221#2222# Note that enabling this option will significantly increase the time of a run.2223# So in most cases it will be better to enable call graphs for selected2224# functions only using the \callgraph command.2225# The default value is: NO.2226# This tag requires that the tag HAVE_DOT is set to YES.2227CALL_GRAPH = NO2229# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2231# dependency graph for every global function or class method.2232#2233# Note that enabling this option will significantly increase the time of a run.2234# So in most cases it will be better to enable caller graphs for selected2235# functions only using the \callergraph command.2236# The default value is: NO.2237# This tag requires that the tag HAVE_DOT is set to YES.2238CALLER_GRAPH = NO2240# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2242# hierarchy of all classes instead of a textual one.2243# The default value is: YES.2244# This tag requires that the tag HAVE_DOT is set to YES.2245GRAPHICAL_HIERARCHY = YES2247# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2249# dependencies a directory has on other directories in a graphical way. The2250# dependency relations are determined by the #include relations between the2251# files in the directories.2252# The default value is: YES.2253# This tag requires that the tag HAVE_DOT is set to YES.2254DIRECTORY_GRAPH = YES2256# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2258# generated by dot.2259# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2260# to make the SVG files visible in IE 9+ (other browsers do not have this2261# requirement).2262# Possible values are: png, jpg, gif and svg.2263# The default value is: png.2264# This tag requires that the tag HAVE_DOT is set to YES.2265DOT_IMAGE_FORMAT = png2267# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2269# enable generation of interactive SVG images that allow zooming and panning.2270#2271# Note that this requires a modern browser other than Internet Explorer. Tested2272# and working are Firefox, Chrome, Safari, and Opera.2273# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2274# the SVG files visible. Older versions of IE do not have SVG support.2275# The default value is: NO.2276# This tag requires that the tag HAVE_DOT is set to YES.2277INTERACTIVE_SVG = NO2279# The DOT_PATH tag can be used to specify the path where the dot tool can be2281# found. If left blank, it is assumed the dot tool can be found in the path.2282# This tag requires that the tag HAVE_DOT is set to YES.2283DOT_PATH =2285# The DOTFILE_DIRS tag can be used to specify one or more directories that2287# contain dot files that are included in the documentation (see the \dotfile2288# command).2289# This tag requires that the tag HAVE_DOT is set to YES.2290DOTFILE_DIRS =2292# The MSCFILE_DIRS tag can be used to specify one or more directories that2294# contain msc files that are included in the documentation (see the \mscfile2295# command).2296MSCFILE_DIRS =2298# The DIAFILE_DIRS tag can be used to specify one or more directories that2300# contain dia files that are included in the documentation (see the \diafile2301# command).2302DIAFILE_DIRS =2304# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the2306# path where java can find the plantuml.jar file. If left blank, it is assumed2307# PlantUML is not used or called during a preprocessing step. Doxygen will2308# generate a warning when it encounters a \startuml command in this case and2309# will not generate output for the diagram.2310# This tag requires that the tag HAVE_DOT is set to YES.2311PLANTUML_JAR_PATH =2313# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2315# that will be shown in the graph. If the number of nodes in a graph becomes2316# larger than this value, doxygen will truncate the graph, which is visualized2317# by representing a node as a red box. Note that doxygen if the number of direct2318# children of the root node in a graph is already larger than2319# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2320# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2321# Minimum value: 0, maximum value: 10000, default value: 50.2322# This tag requires that the tag HAVE_DOT is set to YES.2323DOT_GRAPH_MAX_NODES = 502325# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2327# generated by dot. A depth value of 3 means that only nodes reachable from the2328# root by following a path via at most 3 edges will be shown. Nodes that lay2329# further from the root node will be omitted. Note that setting this option to 12330# or 2 may greatly reduce the computation time needed for large code bases. Also2331# note that the size of a graph can be further restricted by2332# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2333# Minimum value: 0, maximum value: 1000, default value: 0.2334# This tag requires that the tag HAVE_DOT is set to YES.2335MAX_DOT_GRAPH_DEPTH = 02337# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2339# background. This is disabled by default, because dot on Windows does not seem2340# to support this out of the box.2341#2342# Warning: Depending on the platform used, enabling this option may lead to2343# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2344# read).2345# The default value is: NO.2346# This tag requires that the tag HAVE_DOT is set to YES.2347DOT_TRANSPARENT = NO2349# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2351# files in one run (i.e. multiple -o and -T options on the command line). This2352# makes dot run faster, but since only newer versions of dot (>1.8.10) support2353# this, this feature is disabled by default.2354# The default value is: NO.2355# This tag requires that the tag HAVE_DOT is set to YES.2356DOT_MULTI_TARGETS = NO2358# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2360# explaining the meaning of the various boxes and arrows in the dot generated2361# graphs.2362# The default value is: YES.2363# This tag requires that the tag HAVE_DOT is set to YES.2364GENERATE_LEGEND = YES2366# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2368# files that are used to generate the various graphs.2369# The default value is: YES.2370# This tag requires that the tag HAVE_DOT is set to YES.2371DOT_CLEANUP = YES2373