caffe
/
.Doxyfile
2335 строк · 99.5 Кб
1# Doxyfile 1.8.82# This file describes the settings to be used by the documentation system4# doxygen (www.doxygen.org) for a project.5#6# All text after a double hash (##) is considered a comment and is placed in7# front of the TAG it is preceding.8#9# All text after a single hash (#) is considered a comment and will be ignored.10# The format is:11# TAG = value [value, ...]12# For lists, items can also be appended using:13# TAG += value [value, ...]14# Values that contain spaces should be placed between quotes (\" \").15#---------------------------------------------------------------------------17# Project related configuration options18#---------------------------------------------------------------------------19# This tag specifies the encoding used for all characters in the config file21# that follow. The default is UTF-8 which is also the encoding used for all text22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv24# for the list of possible encodings.25# The default value is: UTF-8.26DOXYFILE_ENCODING = UTF-828# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by30# double-quotes, unless you are using Doxywizard) that should identify the31# project for which the documentation is generated. This name is used in the32# title of most generated pages and in a few other places.33# The default value is: My Project.34PROJECT_NAME = "Caffe"36# The PROJECT_NUMBER tag can be used to enter a project or revision number. This38# could be handy for archiving the generated documentation or if some version39# control system is used.40PROJECT_NUMBER =42# Using the PROJECT_BRIEF tag one can provide an optional one line description44# for a project that appears at the top of each page and should give viewer a45# quick idea about the purpose of the project. Keep the description short.46PROJECT_BRIEF =48# With the PROJECT_LOGO tag one can specify an logo or icon that is included in50# the documentation. The maximum height of the logo should not exceed 55 pixels51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo52# to the output directory.53PROJECT_LOGO =55# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path57# into which the generated documentation will be written. If a relative path is58# entered, it will be relative to the location where doxygen was started. If59# left blank the current directory will be used.60OUTPUT_DIRECTORY = ./doxygen/62# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-64# directories (in 2 levels) under the output directory of each output format and65# will distribute the generated files over these directories. Enabling this66# option can be useful when feeding doxygen a huge amount of source files, where67# putting all generated files in the same directory would otherwise causes68# performance problems for the file system.69# The default value is: NO.70CREATE_SUBDIRS = NO72# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII74# characters to appear in the names of generated files. If set to NO, non-ASCII75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode76# U+3044.77# The default value is: NO.78ALLOW_UNICODE_NAMES = NO80# The OUTPUT_LANGUAGE tag is used to specify the language in which all82# documentation generated by doxygen is written. Doxygen will use this83# information to generate all constant output in the proper language.84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,91# Ukrainian and Vietnamese.92# The default value is: English.93OUTPUT_LANGUAGE = English95# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member97# descriptions after the members that are listed in the file and class98# documentation (similar to Javadoc). Set to NO to disable this.99# The default value is: YES.100BRIEF_MEMBER_DESC = YES102# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief104# description of a member or function before the detailed description105#106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the107# brief descriptions will be completely suppressed.108# The default value is: YES.109REPEAT_BRIEF = YES111# This tag implements a quasi-intelligent brief description abbreviator that is113# used to form the text in various listings. Each string in this list, if found114# as the leading text of the brief description, will be stripped from the text115# and the result, after processing the whole list, is used as the annotated116# text. Otherwise, the brief description is used as-is. If left blank, the117# following values are used ($name is automatically replaced with the name of118# the entity):The $name class, The $name widget, The $name file, is, provides,119# specifies, contains, represents, a, an and the.120ABBREVIATE_BRIEF =122# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then124# doxygen will generate a detailed section even if there is only a brief125# description.126# The default value is: NO.127ALWAYS_DETAILED_SEC = NO129# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all131# inherited members of a class in the documentation of that class as if those132# members were ordinary class members. Constructors, destructors and assignment133# operators of the base classes will not be shown.134# The default value is: NO.135INLINE_INHERITED_MEMB = NO137# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path139# before files name in the file list and in the header files. If set to NO the140# shortest path that makes the file name unique will be used141# The default value is: YES.142FULL_PATH_NAMES = YES144# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.146# Stripping is only done if one of the specified strings matches the left-hand147# part of the path. The tag can be used to show relative paths in the file list.148# If left blank the directory from which doxygen is run is used as the path to149# strip.150#151# Note that you can specify absolute paths here, but also relative paths, which152# will be relative from the directory where doxygen is started.153# This tag requires that the tag FULL_PATH_NAMES is set to YES.154STRIP_FROM_PATH =156# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the158# path mentioned in the documentation of a class, which tells the reader which159# header file to include in order to use a class. If left blank only the name of160# the header file containing the class definition is used. Otherwise one should161# specify the list of include paths that are normally passed to the compiler162# using the -I flag.163STRIP_FROM_INC_PATH =165# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but167# less readable) file names. This can be useful is your file systems doesn't168# support long names like on DOS, Mac, or CD-ROM.169# The default value is: NO.170SHORT_NAMES = NO172# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the174# first line (until the first dot) of a Javadoc-style comment as the brief175# description. If set to NO, the Javadoc-style will behave just like regular Qt-176# style comments (thus requiring an explicit @brief command for a brief177# description.)178# The default value is: NO.179JAVADOC_AUTOBRIEF = NO181# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first183# line (until the first dot) of a Qt-style comment as the brief description. If184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus185# requiring an explicit \brief command for a brief description.)186# The default value is: NO.187QT_AUTOBRIEF = NO189# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as192# a brief description. This used to be the default behavior. The new default is193# to treat a multi-line C++ comment block as a detailed description. Set this194# tag to YES if you prefer the old behavior instead.195#196# Note that setting this tag to YES also means that rational rose comments are197# not recognized any more.198# The default value is: NO.199MULTILINE_CPP_IS_BRIEF = NO201# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the203# documentation from any documented member that it re-implements.204# The default value is: YES.205INHERIT_DOCS = YES207# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a209# new page for each member. If set to NO, the documentation of a member will be210# part of the file/class/namespace that contains it.211# The default value is: NO.212SEPARATE_MEMBER_PAGES = NO214# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen216# uses this value to replace tabs by spaces in code fragments.217# Minimum value: 1, maximum value: 16, default value: 4.218TAB_SIZE = 8220# This tag can be used to specify a number of aliases that act as commands in222# the documentation. An alias has the form:223# name=value224# For example adding225# "sideeffect=@par Side Effects:\n"226# will allow you to put the command \sideeffect (or @sideeffect) in the227# documentation, which will result in a user-defined paragraph with heading228# "Side Effects:". You can put \n's in the value part of an alias to insert229# newlines.230ALIASES =232# This tag can be used to specify a number of word-keyword mappings (TCL only).234# A mapping has the form "name=value". For example adding "class=itcl::class"235# will allow you to use the command class in the itcl::class meaning.236TCL_SUBST =238# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources240# only. Doxygen will then generate output that is more tailored for C. For241# instance, some of the names that are used will be different. The list of all242# members will be omitted, etc.243# The default value is: NO.244OPTIMIZE_OUTPUT_FOR_C = NO246# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or248# Python sources only. Doxygen will then generate output that is more tailored249# for that language. For instance, namespaces will be presented as packages,250# qualified scopes will look different, etc.251# The default value is: NO.252OPTIMIZE_OUTPUT_JAVA = NO254# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran256# sources. Doxygen will then generate output that is tailored for Fortran.257# The default value is: NO.258OPTIMIZE_FOR_FORTRAN = NO260# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL262# sources. Doxygen will then generate output that is tailored for VHDL.263# The default value is: NO.264OPTIMIZE_OUTPUT_VHDL = NO266# Doxygen selects the parser to use depending on the extension of the files it268# parses. With this tag you can assign which parser to use for a given269# extension. Doxygen has a built-in mapping, but you can override or extend it270# using this tag. The format is ext=language, where ext is a file extension, and271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:274# Fortran. In the later case the parser tries to guess whether the code is fixed275# or free formatted code, this is the default for Fortran type files), VHDL. For276# instance to make doxygen treat .inc files as Fortran files (default is PHP),277# and .f files as C (default is Fortran), use: inc=Fortran f=C.278#279# Note For files without extension you can use no_extension as a placeholder.280#281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise282# the files are not read by doxygen.283EXTENSION_MAPPING =285# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments287# according to the Markdown format, which allows for more readable288# documentation. See http://daringfireball.net/projects/markdown/ for details.289# The output of markdown processing is further processed by doxygen, so you can290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in291# case of backward compatibilities issues.292# The default value is: YES.293MARKDOWN_SUPPORT = YES295# When enabled doxygen tries to link words that correspond to documented297# classes, or namespaces to their corresponding documentation. Such a link can298# be prevented in individual cases by by putting a % sign in front of the word299# or globally by setting AUTOLINK_SUPPORT to NO.300# The default value is: YES.301AUTOLINK_SUPPORT = YES303# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want305# to include (a tag file for) the STL sources as input, then you should set this306# tag to YES in order to let doxygen match functions declarations and307# definitions whose arguments contain STL classes (e.g. func(std::string);308# versus func(std::string) {}). This also make the inheritance and collaboration309# diagrams that involve STL classes more complete and accurate.310# The default value is: NO.311BUILTIN_STL_SUPPORT = NO313# If you use Microsoft's C++/CLI language, you should set this option to YES to315# enable parsing support.316# The default value is: NO.317CPP_CLI_SUPPORT = NO319# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen322# will parse them like normal C++ but will assume all classes use public instead323# of private inheritance when no explicit protection keyword is present.324# The default value is: NO.325SIP_SUPPORT = NO327# For Microsoft's IDL there are propget and propput attributes to indicate329# getter and setter methods for a property. Setting this option to YES will make330# doxygen to replace the get and set methods by a property in the documentation.331# This will only work if the methods are indeed getting or setting a simple332# type. If this is not the case, or you want to show the methods anyway, you333# should set this option to NO.334# The default value is: YES.335IDL_PROPERTY_SUPPORT = YES337# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC339# tag is set to YES, then doxygen will reuse the documentation of the first340# member in the group (if any) for the other members of the group. By default341# all members of a group must be documented explicitly.342# The default value is: NO.343DISTRIBUTE_GROUP_DOC = NO345# Set the SUBGROUPING tag to YES to allow class member groups of the same type347# (for instance a group of public functions) to be put as a subgroup of that348# type (e.g. under the Public Functions section). Set it to NO to prevent349# subgrouping. Alternatively, this can be done per class using the350# \nosubgrouping command.351# The default value is: YES.352SUBGROUPING = YES354# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions356# are shown inside the group in which they are included (e.g. using \ingroup)357# instead of on a separate page (for HTML and Man pages) or section (for LaTeX358# and RTF).359#360# Note that this feature does not work in combination with361# SEPARATE_MEMBER_PAGES.362# The default value is: NO.363INLINE_GROUPED_CLASSES = NO365# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions367# with only public data fields or simple typedef fields will be shown inline in368# the documentation of the scope in which they are defined (i.e. file,369# namespace, or group documentation), provided this scope is documented. If set370# to NO, structs, classes, and unions are shown on a separate page (for HTML and371# Man pages) or section (for LaTeX and RTF).372# The default value is: NO.373INLINE_SIMPLE_STRUCTS = NO375# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or377# enum is documented as struct, union, or enum with the name of the typedef. So378# typedef struct TypeS {} TypeT, will appear in the documentation as a struct379# with name TypeT. When disabled the typedef will appear as a member of a file,380# namespace, or class. And the struct will be named TypeS. This can typically be381# useful for C code in case the coding convention dictates that all compound382# types are typedef'ed and only the typedef is referenced, never the tag name.383# The default value is: NO.384TYPEDEF_HIDES_STRUCT = NO386# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This388# cache is used to resolve symbols given their name and scope. Since this can be389# an expensive process and often the same symbol appears multiple times in the390# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small391# doxygen will become slower. If the cache is too large, memory is wasted. The392# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range393# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536394# symbols. At the end of a run doxygen will report the cache usage and suggest395# the optimal cache size from a speed point of view.396# Minimum value: 0, maximum value: 9, default value: 0.397LOOKUP_CACHE_SIZE = 0399#---------------------------------------------------------------------------401# Build related configuration options402#---------------------------------------------------------------------------403# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in405# documentation are documented, even if no documentation was available. Private406# class members and static file members will be hidden unless the407# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.408# Note: This will also disable the warnings about undocumented members that are409# normally produced when WARNINGS is set to YES.410# The default value is: NO.411EXTRACT_ALL = NO413# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will415# be included in the documentation.416# The default value is: NO.417EXTRACT_PRIVATE = NO419# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal421# scope will be included in the documentation.422# The default value is: NO.423EXTRACT_PACKAGE = NO425# If the EXTRACT_STATIC tag is set to YES all static members of a file will be427# included in the documentation.428# The default value is: NO.429EXTRACT_STATIC = NO431# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined433# locally in source files will be included in the documentation. If set to NO434# only classes defined in header files are included. Does not have any effect435# for Java sources.436# The default value is: YES.437EXTRACT_LOCAL_CLASSES = YES439# This flag is only useful for Objective-C code. When set to YES local methods,441# which are defined in the implementation section but not in the interface are442# included in the documentation. If set to NO only methods in the interface are443# included.444# The default value is: NO.445EXTRACT_LOCAL_METHODS = NO447# If this flag is set to YES, the members of anonymous namespaces will be449# extracted and appear in the documentation as a namespace called450# 'anonymous_namespace{file}', where file will be replaced with the base name of451# the file that contains the anonymous namespace. By default anonymous namespace452# are hidden.453# The default value is: NO.454EXTRACT_ANON_NSPACES = NO456# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all458# undocumented members inside documented classes or files. If set to NO these459# members will be included in the various overviews, but no documentation460# section is generated. This option has no effect if EXTRACT_ALL is enabled.461# The default value is: NO.462HIDE_UNDOC_MEMBERS = NO464# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all466# undocumented classes that are normally visible in the class hierarchy. If set467# to NO these classes will be included in the various overviews. This option has468# no effect if EXTRACT_ALL is enabled.469# The default value is: NO.470HIDE_UNDOC_CLASSES = NO472# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend474# (class|struct|union) declarations. If set to NO these declarations will be475# included in the documentation.476# The default value is: NO.477HIDE_FRIEND_COMPOUNDS = NO479# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any481# documentation blocks found inside the body of a function. If set to NO these482# blocks will be appended to the function's detailed documentation block.483# The default value is: NO.484HIDE_IN_BODY_DOCS = NO486# The INTERNAL_DOCS tag determines if documentation that is typed after a488# \internal command is included. If the tag is set to NO then the documentation489# will be excluded. Set it to YES to include the internal documentation.490# The default value is: NO.491INTERNAL_DOCS = NO493# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file495# names in lower-case letters. If set to YES upper-case letters are also496# allowed. This is useful if you have classes or files whose names only differ497# in case and if your file system supports case sensitive file names. Windows498# and Mac users are advised to set this option to NO.499# The default value is: system dependent.500CASE_SENSE_NAMES = YES502# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with504# their full class and namespace scopes in the documentation. If set to YES the505# scope will be hidden.506# The default value is: NO.507HIDE_SCOPE_NAMES = NO509# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of511# the files that are included by a file in the documentation of that file.512# The default value is: YES.513SHOW_INCLUDE_FILES = YES515# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each517# grouped member an include statement to the documentation, telling the reader518# which file to include in order to use the member.519# The default value is: NO.520SHOW_GROUPED_MEMB_INC = NO522# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include524# files with double quotes in the documentation rather than with sharp brackets.525# The default value is: NO.526FORCE_LOCAL_INCLUDES = NO528# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the530# documentation for inline members.531# The default value is: YES.532INLINE_INFO = YES534# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the536# (detailed) documentation of file and class members alphabetically by member537# name. If set to NO the members will appear in declaration order.538# The default value is: YES.539SORT_MEMBER_DOCS = YES541# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief543# descriptions of file, namespace and class members alphabetically by member544# name. If set to NO the members will appear in declaration order. Note that545# this will also influence the order of the classes in the class list.546# The default value is: NO.547SORT_BRIEF_DOCS = NO549# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the551# (brief and detailed) documentation of class members so that constructors and552# destructors are listed first. If set to NO the constructors will appear in the553# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.554# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief555# member documentation.556# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting557# detailed member documentation.558# The default value is: NO.559SORT_MEMBERS_CTORS_1ST = NO561# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy563# of group names into alphabetical order. If set to NO the group names will564# appear in their defined order.565# The default value is: NO.566SORT_GROUP_NAMES = NO568# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by570# fully-qualified names, including namespaces. If set to NO, the class list will571# be sorted only by class name, not including the namespace part.572# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.573# Note: This option applies only to the class list, not to the alphabetical574# list.575# The default value is: NO.576SORT_BY_SCOPE_NAME = NO578# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper580# type resolution of all parameters of a function it will reject a match between581# the prototype and the implementation of a member function even if there is582# only one candidate or it is obvious which candidate to choose by doing a583# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still584# accept a match between prototype and implementation in such cases.585# The default value is: NO.586STRICT_PROTO_MATCHING = NO588# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the590# todo list. This list is created by putting \todo commands in the591# documentation.592# The default value is: YES.593GENERATE_TODOLIST = YES595# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the597# test list. This list is created by putting \test commands in the598# documentation.599# The default value is: YES.600GENERATE_TESTLIST = YES602# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug604# list. This list is created by putting \bug commands in the documentation.605# The default value is: YES.606GENERATE_BUGLIST = YES608# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)610# the deprecated list. This list is created by putting \deprecated commands in611# the documentation.612# The default value is: YES.613GENERATE_DEPRECATEDLIST= YES615# The ENABLED_SECTIONS tag can be used to enable conditional documentation617# sections, marked by \if <section_label> ... \endif and \cond <section_label>618# ... \endcond blocks.619ENABLED_SECTIONS =621# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the623# initial value of a variable or macro / define can have for it to appear in the624# documentation. If the initializer consists of more lines than specified here625# it will be hidden. Use a value of 0 to hide initializers completely. The626# appearance of the value of individual variables and macros / defines can be627# controlled using \showinitializer or \hideinitializer command in the628# documentation regardless of this setting.629# Minimum value: 0, maximum value: 10000, default value: 30.630MAX_INITIALIZER_LINES = 30632# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at634# the bottom of the documentation of classes and structs. If set to YES the list635# will mention the files that were used to generate the documentation.636# The default value is: YES.637SHOW_USED_FILES = YES639# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This641# will remove the Files entry from the Quick Index and from the Folder Tree View642# (if specified).643# The default value is: YES.644SHOW_FILES = YES646# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces648# page. This will remove the Namespaces entry from the Quick Index and from the649# Folder Tree View (if specified).650# The default value is: YES.651SHOW_NAMESPACES = YES653# The FILE_VERSION_FILTER tag can be used to specify a program or script that655# doxygen should invoke to get the current version for each file (typically from656# the version control system). Doxygen will invoke the program by executing (via657# popen()) the command command input-file, where command is the value of the658# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided659# by doxygen. Whatever the program writes to standard output is used as the file660# version. For an example see the documentation.661FILE_VERSION_FILTER =663# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed665# by doxygen. The layout file controls the global structure of the generated666# output files in an output format independent way. To create the layout file667# that represents doxygen's defaults, run doxygen with the -l option. You can668# optionally specify a file name after the option, if omitted DoxygenLayout.xml669# will be used as the name of the layout file.670#671# Note that if you run doxygen from a directory containing a file called672# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE673# tag is left empty.674LAYOUT_FILE =676# The CITE_BIB_FILES tag can be used to specify one or more bib files containing678# the reference definitions. This must be a list of .bib files. The .bib679# extension is automatically appended if omitted. This requires the bibtex tool680# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.681# For LaTeX the style of the bibliography can be controlled using682# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the683# search path. See also \cite for info how to create references.684CITE_BIB_FILES =686#---------------------------------------------------------------------------688# Configuration options related to warning and progress messages689#---------------------------------------------------------------------------690# The QUIET tag can be used to turn on/off the messages that are generated to692# standard output by doxygen. If QUIET is set to YES this implies that the693# messages are off.694# The default value is: NO.695QUIET = YES697# The WARNINGS tag can be used to turn on/off the warning messages that are699# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES700# this implies that the warnings are on.701#702# Tip: Turn warnings on while writing the documentation.703# The default value is: YES.704WARNINGS = YES706# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate708# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag709# will automatically be disabled.710# The default value is: YES.711WARN_IF_UNDOCUMENTED = NO713# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for715# potential errors in the documentation, such as not documenting some parameters716# in a documented function, or documenting parameters that don't exist or using717# markup commands wrongly.718# The default value is: YES.719WARN_IF_DOC_ERROR = YES721# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that723# are documented, but have no documentation for their parameters or return724# value. If set to NO doxygen will only warn about wrong or incomplete parameter725# documentation, but not about the absence of documentation.726# The default value is: NO.727WARN_NO_PARAMDOC = NO729# The WARN_FORMAT tag determines the format of the warning messages that doxygen731# can produce. The string should contain the $file, $line, and $text tags, which732# will be replaced by the file and line number from which the warning originated733# and the warning text. Optionally the format may contain $version, which will734# be replaced by the version of the file (if it could be obtained via735# FILE_VERSION_FILTER)736# The default value is: $file:$line: $text.737WARN_FORMAT = "$file:$line: $text"739# The WARN_LOGFILE tag can be used to specify a file to which warning and error741# messages should be written. If left blank the output is written to standard742# error (stderr).743WARN_LOGFILE =745#---------------------------------------------------------------------------747# Configuration options related to the input files748#---------------------------------------------------------------------------749# The INPUT tag is used to specify the files and/or directories that contain751# documented source files. You may enter file names like myfile.cpp or752# directories like /usr/src/myproject. Separate the files or directories with753# spaces.754# Note: If this tag is empty the current directory is searched.755INPUT = ./include/caffe \757./src/caffe758# This tag can be used to specify the character encoding of the source files760# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses761# libiconv (or the iconv built into libc) for the transcoding. See the libiconv762# documentation (see: http://www.gnu.org/software/libiconv) for the list of763# possible encodings.764# The default value is: UTF-8.765INPUT_ENCODING = UTF-8767# If the value of the INPUT tag contains directories, you can use the769# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and770# *.h) to filter out the source-files in the directories. If left blank the771# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,772# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,773# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,774# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,775# *.qsf, *.as and *.js.776FILE_PATTERNS =778# The RECURSIVE tag can be used to specify whether or not subdirectories should780# be searched for input files as well.781# The default value is: NO.782RECURSIVE = YES784# The EXCLUDE tag can be used to specify files and/or directories that should be786# excluded from the INPUT source files. This way you can easily exclude a787# subdirectory from a directory tree whose root is specified with the INPUT tag.788#789# Note that relative paths are relative to the directory from which doxygen is790# run.791EXCLUDE = ./src/caffe/test/ \793./include/caffe/test/794# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or796# directories that are symbolic links (a Unix file system feature) are excluded797# from the input.798# The default value is: NO.799EXCLUDE_SYMLINKS = NO801# If the value of the INPUT tag contains directories, you can use the803# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude804# certain files from those directories.805#806# Note that the wildcards are matched against the file with absolute path, so to807# exclude all test directories for example use the pattern */test/*808EXCLUDE_PATTERNS =810# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names812# (namespaces, classes, functions, etc.) that should be excluded from the813# output. The symbol name can be a fully qualified name, a word, or if the814# wildcard * is used, a substring. Examples: ANamespace, AClass,815# AClass::ANamespace, ANamespace::*Test816#817# Note that the wildcards are matched against the file with absolute path, so to818# exclude all test directories use the pattern */test/*819EXCLUDE_SYMBOLS =821# The EXAMPLE_PATH tag can be used to specify one or more files or directories823# that contain example code fragments that are included (see the \include824# command).825EXAMPLE_PATH =827# If the value of the EXAMPLE_PATH tag contains directories, you can use the829# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and830# *.h) to filter out the source-files in the directories. If left blank all831# files are included.832EXAMPLE_PATTERNS =834# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be836# searched for input files to be used with the \include or \dontinclude commands837# irrespective of the value of the RECURSIVE tag.838# The default value is: NO.839EXAMPLE_RECURSIVE = NO841# The IMAGE_PATH tag can be used to specify one or more files or directories843# that contain images that are to be included in the documentation (see the844# \image command).845IMAGE_PATH =847# The INPUT_FILTER tag can be used to specify a program that doxygen should849# invoke to filter for each input file. Doxygen will invoke the filter program850# by executing (via popen()) the command:851#852# <filter> <input-file>853#854# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the855# name of an input file. Doxygen will then use the output that the filter856# program writes to standard output. If FILTER_PATTERNS is specified, this tag857# will be ignored.858#859# Note that the filter must not add or remove lines; it is applied before the860# code is scanned, but not when the output code is generated. If lines are added861# or removed, the anchors will not be placed correctly.862INPUT_FILTER =864# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern866# basis. Doxygen will compare the file name with each pattern and apply the867# filter if there is a match. The filters are a list of the form: pattern=filter868# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how869# filters are used. If the FILTER_PATTERNS tag is empty or if none of the870# patterns match the file name, INPUT_FILTER is applied.871FILTER_PATTERNS =873# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using875# INPUT_FILTER ) will also be used to filter the input files that are used for876# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).877# The default value is: NO.878FILTER_SOURCE_FILES = NO880# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file882# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and883# it is also possible to disable source filtering for a specific pattern using884# *.ext= (so without naming a filter).885# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.886FILTER_SOURCE_PATTERNS =888# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that890# is part of the input, its contents will be placed on the main page891# (index.html). This can be useful if you have a project on for instance GitHub892# and want to reuse the introduction page also for the doxygen output.893USE_MDFILE_AS_MAINPAGE =895#---------------------------------------------------------------------------897# Configuration options related to source browsing898#---------------------------------------------------------------------------899# If the SOURCE_BROWSER tag is set to YES then a list of source files will be901# generated. Documented entities will be cross-referenced with these sources.902#903# Note: To get rid of all source code in the generated output, make sure that904# also VERBATIM_HEADERS is set to NO.905# The default value is: NO.906SOURCE_BROWSER = NO908# Setting the INLINE_SOURCES tag to YES will include the body of functions,910# classes and enums directly into the documentation.911# The default value is: NO.912INLINE_SOURCES = NO914# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any916# special comment blocks from generated source code fragments. Normal C, C++ and917# Fortran comments will always remain visible.918# The default value is: YES.919STRIP_CODE_COMMENTS = YES921# If the REFERENCED_BY_RELATION tag is set to YES then for each documented923# function all documented functions referencing it will be listed.924# The default value is: NO.925REFERENCED_BY_RELATION = NO927# If the REFERENCES_RELATION tag is set to YES then for each documented function929# all documented entities called/used by that function will be listed.930# The default value is: NO.931REFERENCES_RELATION = NO933# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set935# to YES, then the hyperlinks from functions in REFERENCES_RELATION and936# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will937# link to the documentation.938# The default value is: YES.939REFERENCES_LINK_SOURCE = YES941# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the943# source code will show a tooltip with additional information such as prototype,944# brief description and links to the definition and documentation. Since this945# will make the HTML file larger and loading of large files a bit slower, you946# can opt to disable this feature.947# The default value is: YES.948# This tag requires that the tag SOURCE_BROWSER is set to YES.949SOURCE_TOOLTIPS = YES951# If the USE_HTAGS tag is set to YES then the references to source code will953# point to the HTML generated by the htags(1) tool instead of doxygen built-in954# source browser. The htags tool is part of GNU's global source tagging system955# (see http://www.gnu.org/software/global/global.html). You will need version956# 4.8.6 or higher.957#958# To use it do the following:959# - Install the latest version of global960# - Enable SOURCE_BROWSER and USE_HTAGS in the config file961# - Make sure the INPUT points to the root of the source tree962# - Run doxygen as normal963#964# Doxygen will invoke htags (and that will in turn invoke gtags), so these965# tools must be available from the command line (i.e. in the search path).966#967# The result: instead of the source browser generated by doxygen, the links to968# source code will now point to the output of htags.969# The default value is: NO.970# This tag requires that the tag SOURCE_BROWSER is set to YES.971USE_HTAGS = NO973# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a975# verbatim copy of the header file for each class for which an include is976# specified. Set to NO to disable this.977# See also: Section \class.978# The default value is: YES.979VERBATIM_HEADERS = YES981#---------------------------------------------------------------------------983# Configuration options related to the alphabetical class index984#---------------------------------------------------------------------------985# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all987# compounds will be generated. Enable this if the project contains a lot of988# classes, structs, unions or interfaces.989# The default value is: YES.990ALPHABETICAL_INDEX = YES992# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in994# which the alphabetical index list will be split.995# Minimum value: 1, maximum value: 20, default value: 5.996# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.997COLS_IN_ALPHA_INDEX = 5999# In case all classes in a project start with a common prefix, all classes will1001# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag1002# can be used to specify a prefix (or a list of prefixes) that should be ignored1003# while generating the index headers.1004# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.1005IGNORE_PREFIX =1007#---------------------------------------------------------------------------1009# Configuration options related to the HTML output1010#---------------------------------------------------------------------------1011# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output1013# The default value is: YES.1014GENERATE_HTML = YES1016# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a1018# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1019# it.1020# The default directory is: html.1021# This tag requires that the tag GENERATE_HTML is set to YES.1022HTML_OUTPUT = html1024# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each1026# generated HTML page (for example: .htm, .php, .asp).1027# The default value is: .html.1028# This tag requires that the tag GENERATE_HTML is set to YES.1029HTML_FILE_EXTENSION = .html1031# The HTML_HEADER tag can be used to specify a user-defined HTML header file for1033# each generated HTML page. If the tag is left blank doxygen will generate a1034# standard header.1035#1036# To get valid HTML the header file that includes any scripts and style sheets1037# that doxygen needs, which is dependent on the configuration options used (e.g.1038# the setting GENERATE_TREEVIEW). It is highly recommended to start with a1039# default header using1040# doxygen -w html new_header.html new_footer.html new_stylesheet.css1041# YourConfigFile1042# and then modify the file new_header.html. See also section "Doxygen usage"1043# for information on how to generate the default header that doxygen normally1044# uses.1045# Note: The header is subject to change so you typically have to regenerate the1046# default header when upgrading to a newer version of doxygen. For a description1047# of the possible markers and block names see the documentation.1048# This tag requires that the tag GENERATE_HTML is set to YES.1049HTML_HEADER =1051# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each1053# generated HTML page. If the tag is left blank doxygen will generate a standard1054# footer. See HTML_HEADER for more information on how to generate a default1055# footer and what special commands can be used inside the footer. See also1056# section "Doxygen usage" for information on how to generate the default footer1057# that doxygen normally uses.1058# This tag requires that the tag GENERATE_HTML is set to YES.1059HTML_FOOTER =1061# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style1063# sheet that is used by each HTML page. It can be used to fine-tune the look of1064# the HTML output. If left blank doxygen will generate a default style sheet.1065# See also section "Doxygen usage" for information on how to generate the style1066# sheet that doxygen normally uses.1067# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as1068# it is more robust and this tag (HTML_STYLESHEET) will in the future become1069# obsolete.1070# This tag requires that the tag GENERATE_HTML is set to YES.1071HTML_STYLESHEET =1073# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined1075# cascading style sheets that are included after the standard style sheets1076# created by doxygen. Using this option one can overrule certain style aspects.1077# This is preferred over using HTML_STYLESHEET since it does not replace the1078# standard style sheet and is therefor more robust against future updates.1079# Doxygen will copy the style sheet files to the output directory.1080# Note: The order of the extra stylesheet files is of importance (e.g. the last1081# stylesheet in the list overrules the setting of the previous ones in the1082# list). For an example see the documentation.1083# This tag requires that the tag GENERATE_HTML is set to YES.1084HTML_EXTRA_STYLESHEET =1086# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or1088# other source files which should be copied to the HTML output directory. Note1089# that these files will be copied to the base HTML output directory. Use the1090# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these1091# files. In the HTML_STYLESHEET file, use the file name only. Also note that the1092# files will be copied as-is; there are no commands or markers available.1093# This tag requires that the tag GENERATE_HTML is set to YES.1094HTML_EXTRA_FILES =1096# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen1098# will adjust the colors in the stylesheet and background images according to1099# this color. Hue is specified as an angle on a colorwheel, see1100# http://en.wikipedia.org/wiki/Hue for more information. For instance the value1101# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3001102# purple, and 360 is red again.1103# Minimum value: 0, maximum value: 359, default value: 220.1104# This tag requires that the tag GENERATE_HTML is set to YES.1105HTML_COLORSTYLE_HUE = 2201107# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors1109# in the HTML output. For a value of 0 the output will use grayscales only. A1110# value of 255 will produce the most vivid colors.1111# Minimum value: 0, maximum value: 255, default value: 100.1112# This tag requires that the tag GENERATE_HTML is set to YES.1113HTML_COLORSTYLE_SAT = 1001115# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the1117# luminance component of the colors in the HTML output. Values below 1001118# gradually make the output lighter, whereas values above 100 make the output1119# darker. The value divided by 100 is the actual gamma applied, so 80 represents1120# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not1121# change the gamma.1122# Minimum value: 40, maximum value: 240, default value: 80.1123# This tag requires that the tag GENERATE_HTML is set to YES.1124HTML_COLORSTYLE_GAMMA = 801126# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1128# page will contain the date and time when the page was generated. Setting this1129# to NO can help when comparing the output of multiple runs.1130# The default value is: YES.1131# This tag requires that the tag GENERATE_HTML is set to YES.1132HTML_TIMESTAMP = YES1134# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1136# documentation will contain sections that can be hidden and shown after the1137# page has loaded.1138# The default value is: NO.1139# This tag requires that the tag GENERATE_HTML is set to YES.1140HTML_DYNAMIC_SECTIONS = NO1142# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries1144# shown in the various tree structured indices initially; the user can expand1145# and collapse entries dynamically later on. Doxygen will expand the tree to1146# such a level that at most the specified number of entries are visible (unless1147# a fully collapsed tree already exceeds this amount). So setting the number of1148# entries 1 will produce a full collapsed tree by default. 0 is a special value1149# representing an infinite number of entries and will result in a full expanded1150# tree by default.1151# Minimum value: 0, maximum value: 9999, default value: 100.1152# This tag requires that the tag GENERATE_HTML is set to YES.1153HTML_INDEX_NUM_ENTRIES = 1001155# If the GENERATE_DOCSET tag is set to YES, additional index files will be1157# generated that can be used as input for Apple's Xcode 3 integrated development1158# environment (see: http://developer.apple.com/tools/xcode/), introduced with1159# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a1160# Makefile in the HTML output directory. Running make will produce the docset in1161# that directory and running make install will install the docset in1162# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at1163# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1164# for more information.1165# The default value is: NO.1166# This tag requires that the tag GENERATE_HTML is set to YES.1167GENERATE_DOCSET = NO1169# This tag determines the name of the docset feed. A documentation feed provides1171# an umbrella under which multiple documentation sets from a single provider1172# (such as a company or product suite) can be grouped.1173# The default value is: Doxygen generated docs.1174# This tag requires that the tag GENERATE_DOCSET is set to YES.1175DOCSET_FEEDNAME = "Doxygen generated docs"1177# This tag specifies a string that should uniquely identify the documentation1179# set bundle. This should be a reverse domain-name style string, e.g.1180# com.mycompany.MyDocSet. Doxygen will append .docset to the name.1181# The default value is: org.doxygen.Project.1182# This tag requires that the tag GENERATE_DOCSET is set to YES.1183DOCSET_BUNDLE_ID = org.doxygen.Project1185# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify1187# the documentation publisher. This should be a reverse domain-name style1188# string, e.g. com.mycompany.MyDocSet.documentation.1189# The default value is: org.doxygen.Publisher.1190# This tag requires that the tag GENERATE_DOCSET is set to YES.1191DOCSET_PUBLISHER_ID = org.doxygen.Publisher1193# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.1195# The default value is: Publisher.1196# This tag requires that the tag GENERATE_DOCSET is set to YES.1197DOCSET_PUBLISHER_NAME = Publisher1199# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three1201# additional HTML index files: index.hhp, index.hhc, and index.hhk. The1202# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop1203# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on1204# Windows.1205#1206# The HTML Help Workshop contains a compiler that can convert all HTML output1207# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML1208# files are now used as the Windows 98 help format, and will replace the old1209# Windows help format (.hlp) on all Windows platforms in the future. Compressed1210# HTML files also contain an index, a table of contents, and you can search for1211# words in the documentation. The HTML workshop also contains a viewer for1212# compressed HTML files.1213# The default value is: NO.1214# This tag requires that the tag GENERATE_HTML is set to YES.1215GENERATE_HTMLHELP = NO1217# The CHM_FILE tag can be used to specify the file name of the resulting .chm1219# file. You can add a path in front of the file if the result should not be1220# written to the html output directory.1221# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1222CHM_FILE =1224# The HHC_LOCATION tag can be used to specify the location (absolute path1226# including file name) of the HTML help compiler ( hhc.exe). If non-empty1227# doxygen will try to run the HTML help compiler on the generated index.hhp.1228# The file has to be specified with full path.1229# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1230HHC_LOCATION =1232# The GENERATE_CHI flag controls if a separate .chi index file is generated (1234# YES) or that it should be included in the master .chm file ( NO).1235# The default value is: NO.1236# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1237GENERATE_CHI = NO1239# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)1241# and project file content.1242# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1243CHM_INDEX_ENCODING =1245# The BINARY_TOC flag controls whether a binary table of contents is generated (1247# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it1248# enables the Previous and Next buttons.1249# The default value is: NO.1250# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1251BINARY_TOC = NO1253# The TOC_EXPAND flag can be set to YES to add extra items for group members to1255# the table of contents of the HTML help documentation and to the tree view.1256# The default value is: NO.1257# This tag requires that the tag GENERATE_HTMLHELP is set to YES.1258TOC_EXPAND = NO1260# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1262# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that1263# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help1264# (.qch) of the generated HTML documentation.1265# The default value is: NO.1266# This tag requires that the tag GENERATE_HTML is set to YES.1267GENERATE_QHP = NO1269# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify1271# the file name of the resulting .qch file. The path specified is relative to1272# the HTML output folder.1273# This tag requires that the tag GENERATE_QHP is set to YES.1274QCH_FILE =1276# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help1278# Project output. For more information please see Qt Help Project / Namespace1279# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).1280# The default value is: org.doxygen.Project.1281# This tag requires that the tag GENERATE_QHP is set to YES.1282QHP_NAMESPACE = org.doxygen.Project1284# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt1286# Help Project output. For more information please see Qt Help Project / Virtual1287# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-1288# folders).1289# The default value is: doc.1290# This tag requires that the tag GENERATE_QHP is set to YES.1291QHP_VIRTUAL_FOLDER = doc1293# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom1295# filter to add. For more information please see Qt Help Project / Custom1296# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1297# filters).1298# This tag requires that the tag GENERATE_QHP is set to YES.1299QHP_CUST_FILTER_NAME =1301# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the1303# custom filter to add. For more information please see Qt Help Project / Custom1304# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-1305# filters).1306# This tag requires that the tag GENERATE_QHP is set to YES.1307QHP_CUST_FILTER_ATTRS =1309# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1311# project's filter section matches. Qt Help Project / Filter Attributes (see:1312# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).1313# This tag requires that the tag GENERATE_QHP is set to YES.1314QHP_SECT_FILTER_ATTRS =1316# The QHG_LOCATION tag can be used to specify the location of Qt's1318# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the1319# generated .qhp file.1320# This tag requires that the tag GENERATE_QHP is set to YES.1321QHG_LOCATION =1323# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be1325# generated, together with the HTML files, they form an Eclipse help plugin. To1326# install this plugin and make it available under the help contents menu in1327# Eclipse, the contents of the directory containing the HTML and XML files needs1328# to be copied into the plugins directory of eclipse. The name of the directory1329# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.1330# After copying Eclipse needs to be restarted before the help appears.1331# The default value is: NO.1332# This tag requires that the tag GENERATE_HTML is set to YES.1333GENERATE_ECLIPSEHELP = NO1335# A unique identifier for the Eclipse help plugin. When installing the plugin1337# the directory name containing the HTML and XML files should also have this1338# name. Each documentation set should have its own identifier.1339# The default value is: org.doxygen.Project.1340# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.1341ECLIPSE_DOC_ID = org.doxygen.Project1343# If you want full control over the layout of the generated HTML pages it might1345# be necessary to disable the index and replace it with your own. The1346# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top1347# of each HTML page. A value of NO enables the index and the value YES disables1348# it. Since the tabs in the index contain the same information as the navigation1349# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.1350# The default value is: NO.1351# This tag requires that the tag GENERATE_HTML is set to YES.1352DISABLE_INDEX = NO1354# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1356# structure should be generated to display hierarchical information. If the tag1357# value is set to YES, a side panel will be generated containing a tree-like1358# index structure (just like the one that is generated for HTML Help). For this1359# to work a browser that supports JavaScript, DHTML, CSS and frames is required1360# (i.e. any modern browser). Windows users are probably better off using the1361# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can1362# further fine-tune the look of the index. As an example, the default style1363# sheet generated by doxygen has an example that shows how to put an image at1364# the root of the tree instead of the PROJECT_NAME. Since the tree basically has1365# the same information as the tab index, you could consider setting1366# DISABLE_INDEX to YES when enabling this option.1367# The default value is: NO.1368# This tag requires that the tag GENERATE_HTML is set to YES.1369GENERATE_TREEVIEW = NO1371# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that1373# doxygen will group on one line in the generated HTML documentation.1374#1375# Note that a value of 0 will completely suppress the enum values from appearing1376# in the overview section.1377# Minimum value: 0, maximum value: 20, default value: 4.1378# This tag requires that the tag GENERATE_HTML is set to YES.1379ENUM_VALUES_PER_LINE = 41381# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used1383# to set the initial width (in pixels) of the frame in which the tree is shown.1384# Minimum value: 0, maximum value: 1500, default value: 250.1385# This tag requires that the tag GENERATE_HTML is set to YES.1386TREEVIEW_WIDTH = 2501388# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to1390# external symbols imported via tag files in a separate window.1391# The default value is: NO.1392# This tag requires that the tag GENERATE_HTML is set to YES.1393EXT_LINKS_IN_WINDOW = NO1395# Use this tag to change the font size of LaTeX formulas included as images in1397# the HTML documentation. When you change the font size after a successful1398# doxygen run you need to manually remove any form_*.png images from the HTML1399# output directory to force them to be regenerated.1400# Minimum value: 8, maximum value: 50, default value: 10.1401# This tag requires that the tag GENERATE_HTML is set to YES.1402FORMULA_FONTSIZE = 101404# Use the FORMULA_TRANPARENT tag to determine whether or not the images1406# generated for formulas are transparent PNGs. Transparent PNGs are not1407# supported properly for IE 6.0, but are supported on all modern browsers.1408#1409# Note that when changing this option you need to delete any form_*.png files in1410# the HTML output directory before the changes have effect.1411# The default value is: YES.1412# This tag requires that the tag GENERATE_HTML is set to YES.1413FORMULA_TRANSPARENT = YES1415# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see1417# http://www.mathjax.org) which uses client side Javascript for the rendering1418# instead of using prerendered bitmaps. Use this if you do not have LaTeX1419# installed or if you want to formulas look prettier in the HTML output. When1420# enabled you may also need to install MathJax separately and configure the path1421# to it using the MATHJAX_RELPATH option.1422# The default value is: NO.1423# This tag requires that the tag GENERATE_HTML is set to YES.1424USE_MATHJAX = NO1426# When MathJax is enabled you can set the default output format to be used for1428# the MathJax output. See the MathJax site (see:1429# http://docs.mathjax.org/en/latest/output.html) for more details.1430# Possible values are: HTML-CSS (which is slower, but has the best1431# compatibility), NativeMML (i.e. MathML) and SVG.1432# The default value is: HTML-CSS.1433# This tag requires that the tag USE_MATHJAX is set to YES.1434MATHJAX_FORMAT = HTML-CSS1436# When MathJax is enabled you need to specify the location relative to the HTML1438# output directory using the MATHJAX_RELPATH option. The destination directory1439# should contain the MathJax.js script. For instance, if the mathjax directory1440# is located at the same level as the HTML output directory, then1441# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax1442# Content Delivery Network so you can quickly see the result without installing1443# MathJax. However, it is strongly recommended to install a local copy of1444# MathJax from http://www.mathjax.org before deployment.1445# The default value is: http://cdn.mathjax.org/mathjax/latest.1446# This tag requires that the tag USE_MATHJAX is set to YES.1447MATHJAX_RELPATH = http://www.mathjax.org/mathjax1449# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax1451# extension names that should be enabled during MathJax rendering. For example1452# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols1453# This tag requires that the tag USE_MATHJAX is set to YES.1454MATHJAX_EXTENSIONS =1456# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces1458# of code that will be used on startup of the MathJax code. See the MathJax site1459# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an1460# example see the documentation.1461# This tag requires that the tag USE_MATHJAX is set to YES.1462MATHJAX_CODEFILE =1464# When the SEARCHENGINE tag is enabled doxygen will generate a search box for1466# the HTML output. The underlying search engine uses javascript and DHTML and1467# should work on any modern browser. Note that when using HTML help1468# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)1469# there is already a search function so this one should typically be disabled.1470# For large projects the javascript based search engine can be slow, then1471# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to1472# search using the keyboard; to jump to the search box use <access key> + S1473# (what the <access key> is depends on the OS and browser, but it is typically1474# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down1475# key> to jump into the search results window, the results can be navigated1476# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel1477# the search. The filter options can be selected when the cursor is inside the1478# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>1479# to select a filter and <Enter> or <escape> to activate or cancel the filter1480# option.1481# The default value is: YES.1482# This tag requires that the tag GENERATE_HTML is set to YES.1483SEARCHENGINE = YES1485# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1487# implemented using a web server instead of a web client using Javascript. There1488# are two flavors of web server based searching depending on the EXTERNAL_SEARCH1489# setting. When disabled, doxygen will generate a PHP script for searching and1490# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing1491# and searching needs to be provided by external tools. See the section1492# "External Indexing and Searching" for details.1493# The default value is: NO.1494# This tag requires that the tag SEARCHENGINE is set to YES.1495SERVER_BASED_SEARCH = NO1497# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP1499# script for searching. Instead the search results are written to an XML file1500# which needs to be processed by an external indexer. Doxygen will invoke an1501# external search engine pointed to by the SEARCHENGINE_URL option to obtain the1502# search results.1503#1504# Doxygen ships with an example indexer ( doxyindexer) and search engine1505# (doxysearch.cgi) which are based on the open source search engine library1506# Xapian (see: http://xapian.org/).1507#1508# See the section "External Indexing and Searching" for details.1509# The default value is: NO.1510# This tag requires that the tag SEARCHENGINE is set to YES.1511EXTERNAL_SEARCH = NO1513# The SEARCHENGINE_URL should point to a search engine hosted by a web server1515# which will return the search results when EXTERNAL_SEARCH is enabled.1516#1517# Doxygen ships with an example indexer ( doxyindexer) and search engine1518# (doxysearch.cgi) which are based on the open source search engine library1519# Xapian (see: http://xapian.org/). See the section "External Indexing and1520# Searching" for details.1521# This tag requires that the tag SEARCHENGINE is set to YES.1522SEARCHENGINE_URL =1524# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1526# search data is written to a file for indexing by an external tool. With the1527# SEARCHDATA_FILE tag the name of this file can be specified.1528# The default file is: searchdata.xml.1529# This tag requires that the tag SEARCHENGINE is set to YES.1530SEARCHDATA_FILE = searchdata.xml1532# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the1534# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1535# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1536# projects and redirect the results back to the right project.1537# This tag requires that the tag SEARCHENGINE is set to YES.1538EXTERNAL_SEARCH_ID =1540# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1542# projects other than the one defined by this configuration file, but that are1543# all added to the same external search index. Each project needs to have a1544# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of1545# to a relative location where the documentation can be found. The format is:1546# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...1547# This tag requires that the tag SEARCHENGINE is set to YES.1548EXTRA_SEARCH_MAPPINGS =1550#---------------------------------------------------------------------------1552# Configuration options related to the LaTeX output1553#---------------------------------------------------------------------------1554# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.1556# The default value is: YES.1557GENERATE_LATEX = YES1559# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a1561# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1562# it.1563# The default directory is: latex.1564# This tag requires that the tag GENERATE_LATEX is set to YES.1565LATEX_OUTPUT = latex1567# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1569# invoked.1570#1571# Note that when enabling USE_PDFLATEX this option is only used for generating1572# bitmaps for formulas in the HTML output, but not in the Makefile that is1573# written to the output directory.1574# The default file is: latex.1575# This tag requires that the tag GENERATE_LATEX is set to YES.1576LATEX_CMD_NAME = latex1578# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate1580# index for LaTeX.1581# The default file is: makeindex.1582# This tag requires that the tag GENERATE_LATEX is set to YES.1583MAKEINDEX_CMD_NAME = makeindex1585# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX1587# documents. This may be useful for small projects and may help to save some1588# trees in general.1589# The default value is: NO.1590# This tag requires that the tag GENERATE_LATEX is set to YES.1591COMPACT_LATEX = NO1593# The PAPER_TYPE tag can be used to set the paper type that is used by the1595# printer.1596# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x1597# 14 inches) and executive (7.25 x 10.5 inches).1598# The default value is: a4.1599# This tag requires that the tag GENERATE_LATEX is set to YES.1600PAPER_TYPE = a41602# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names1604# that should be included in the LaTeX output. To get the times font for1605# instance you can specify1606# EXTRA_PACKAGES=times1607# If left blank no extra packages will be included.1608# This tag requires that the tag GENERATE_LATEX is set to YES.1609EXTRA_PACKAGES = amsmath \1611amsfonts \1612xr1613# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the1615# generated LaTeX document. The header should contain everything until the first1616# chapter. If it is left blank doxygen will generate a standard header. See1617# section "Doxygen usage" for information on how to let doxygen write the1618# default header to a separate file.1619#1620# Note: Only use a user-defined header if you know what you are doing! The1621# following commands have a special meaning inside the header: $title,1622# $datetime, $date, $doxygenversion, $projectname, $projectnumber,1623# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,1624# for the replacement values of the other commands the user is refered to1625# HTML_HEADER.1626# This tag requires that the tag GENERATE_LATEX is set to YES.1627LATEX_HEADER =1629# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the1631# generated LaTeX document. The footer should contain everything after the last1632# chapter. If it is left blank doxygen will generate a standard footer. See1633# LATEX_HEADER for more information on how to generate a default footer and what1634# special commands can be used inside the footer.1635#1636# Note: Only use a user-defined footer if you know what you are doing!1637# This tag requires that the tag GENERATE_LATEX is set to YES.1638LATEX_FOOTER =1640# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or1642# other source files which should be copied to the LATEX_OUTPUT output1643# directory. Note that the files will be copied as-is; there are no commands or1644# markers available.1645# This tag requires that the tag GENERATE_LATEX is set to YES.1646LATEX_EXTRA_FILES =1648# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is1650# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will1651# contain links (just like the HTML output) instead of page references. This1652# makes the output suitable for online browsing using a PDF viewer.1653# The default value is: YES.1654# This tag requires that the tag GENERATE_LATEX is set to YES.1655PDF_HYPERLINKS = YES1657# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate1659# the PDF file directly from the LaTeX files. Set this option to YES to get a1660# higher quality PDF documentation.1661# The default value is: YES.1662# This tag requires that the tag GENERATE_LATEX is set to YES.1663USE_PDFLATEX = YES1665# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode1667# command to the generated LaTeX files. This will instruct LaTeX to keep running1668# if errors occur, instead of asking the user for help. This option is also used1669# when generating formulas in HTML.1670# The default value is: NO.1671# This tag requires that the tag GENERATE_LATEX is set to YES.1672LATEX_BATCHMODE = NO1674# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the1676# index chapters (such as File Index, Compound Index, etc.) in the output.1677# The default value is: NO.1678# This tag requires that the tag GENERATE_LATEX is set to YES.1679LATEX_HIDE_INDICES = NO1681# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source1683# code with syntax highlighting in the LaTeX output.1684#1685# Note that which sources are shown also depends on other settings such as1686# SOURCE_BROWSER.1687# The default value is: NO.1688# This tag requires that the tag GENERATE_LATEX is set to YES.1689LATEX_SOURCE_CODE = NO1691# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1693# bibliography, e.g. plainnat, or ieeetr. See1694# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.1695# The default value is: plain.1696# This tag requires that the tag GENERATE_LATEX is set to YES.1697LATEX_BIB_STYLE = plain1699#---------------------------------------------------------------------------1701# Configuration options related to the RTF output1702#---------------------------------------------------------------------------1703# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The1705# RTF output is optimized for Word 97 and may not look too pretty with other RTF1706# readers/editors.1707# The default value is: NO.1708GENERATE_RTF = NO1710# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a1712# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1713# it.1714# The default directory is: rtf.1715# This tag requires that the tag GENERATE_RTF is set to YES.1716RTF_OUTPUT = rtf1718# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF1720# documents. This may be useful for small projects and may help to save some1721# trees in general.1722# The default value is: NO.1723# This tag requires that the tag GENERATE_RTF is set to YES.1724COMPACT_RTF = NO1726# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will1728# contain hyperlink fields. The RTF file will contain links (just like the HTML1729# output) instead of page references. This makes the output suitable for online1730# browsing using Word or some other Word compatible readers that support those1731# fields.1732#1733# Note: WordPad (write) and others do not support links.1734# The default value is: NO.1735# This tag requires that the tag GENERATE_RTF is set to YES.1736RTF_HYPERLINKS = NO1738# Load stylesheet definitions from file. Syntax is similar to doxygen's config1740# file, i.e. a series of assignments. You only have to provide replacements,1741# missing definitions are set to their default value.1742#1743# See also section "Doxygen usage" for information on how to generate the1744# default style sheet that doxygen normally uses.1745# This tag requires that the tag GENERATE_RTF is set to YES.1746RTF_STYLESHEET_FILE =1748# Set optional variables used in the generation of an RTF document. Syntax is1750# similar to doxygen's config file. A template extensions file can be generated1751# using doxygen -e rtf extensionFile.1752# This tag requires that the tag GENERATE_RTF is set to YES.1753RTF_EXTENSIONS_FILE =1755#---------------------------------------------------------------------------1757# Configuration options related to the man page output1758#---------------------------------------------------------------------------1759# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for1761# classes and files.1762# The default value is: NO.1763GENERATE_MAN = NO1765# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a1767# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1768# it. A directory man3 will be created inside the directory specified by1769# MAN_OUTPUT.1770# The default directory is: man.1771# This tag requires that the tag GENERATE_MAN is set to YES.1772MAN_OUTPUT = man1774# The MAN_EXTENSION tag determines the extension that is added to the generated1776# man pages. In case the manual section does not start with a number, the number1777# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is1778# optional.1779# The default value is: .3.1780# This tag requires that the tag GENERATE_MAN is set to YES.1781MAN_EXTENSION = .31783# The MAN_SUBDIR tag determines the name of the directory created within1785# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by1786# MAN_EXTENSION with the initial . removed.1787# This tag requires that the tag GENERATE_MAN is set to YES.1788MAN_SUBDIR =1790# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it1792# will generate one additional man file for each entity documented in the real1793# man page(s). These additional files only source the real man page, but without1794# them the man command would be unable to find the correct page.1795# The default value is: NO.1796# This tag requires that the tag GENERATE_MAN is set to YES.1797MAN_LINKS = NO1799#---------------------------------------------------------------------------1801# Configuration options related to the XML output1802#---------------------------------------------------------------------------1803# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that1805# captures the structure of the code including all documentation.1806# The default value is: NO.1807GENERATE_XML = NO1809# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a1811# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of1812# it.1813# The default directory is: xml.1814# This tag requires that the tag GENERATE_XML is set to YES.1815XML_OUTPUT = xml1817# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program1819# listings (including syntax highlighting and cross-referencing information) to1820# the XML output. Note that enabling this will significantly increase the size1821# of the XML output.1822# The default value is: YES.1823# This tag requires that the tag GENERATE_XML is set to YES.1824XML_PROGRAMLISTING = YES1826#---------------------------------------------------------------------------1828# Configuration options related to the DOCBOOK output1829#---------------------------------------------------------------------------1830# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files1832# that can be used to generate PDF.1833# The default value is: NO.1834GENERATE_DOCBOOK = NO1836# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.1838# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in1839# front of it.1840# The default directory is: docbook.1841# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1842DOCBOOK_OUTPUT = docbook1844# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the1846# program listings (including syntax highlighting and cross-referencing1847# information) to the DOCBOOK output. Note that enabling this will significantly1848# increase the size of the DOCBOOK output.1849# The default value is: NO.1850# This tag requires that the tag GENERATE_DOCBOOK is set to YES.1851DOCBOOK_PROGRAMLISTING = NO1853#---------------------------------------------------------------------------1855# Configuration options for the AutoGen Definitions output1856#---------------------------------------------------------------------------1857# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen1859# Definitions (see http://autogen.sf.net) file that captures the structure of1860# the code including all documentation. Note that this feature is still1861# experimental and incomplete at the moment.1862# The default value is: NO.1863GENERATE_AUTOGEN_DEF = NO1865#---------------------------------------------------------------------------1867# Configuration options related to the Perl module output1868#---------------------------------------------------------------------------1869# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module1871# file that captures the structure of the code including all documentation.1872#1873# Note that this feature is still experimental and incomplete at the moment.1874# The default value is: NO.1875GENERATE_PERLMOD = NO1877# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary1879# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI1880# output from the Perl module output.1881# The default value is: NO.1882# This tag requires that the tag GENERATE_PERLMOD is set to YES.1883PERLMOD_LATEX = NO1885# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely1887# formatted so it can be parsed by a human reader. This is useful if you want to1888# understand what is going on. On the other hand, if this tag is set to NO the1889# size of the Perl module output will be much smaller and Perl will parse it1890# just the same.1891# The default value is: YES.1892# This tag requires that the tag GENERATE_PERLMOD is set to YES.1893PERLMOD_PRETTY = YES1895# The names of the make variables in the generated doxyrules.make file are1897# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful1898# so different doxyrules.make files included by the same Makefile don't1899# overwrite each other's variables.1900# This tag requires that the tag GENERATE_PERLMOD is set to YES.1901PERLMOD_MAKEVAR_PREFIX =1903#---------------------------------------------------------------------------1905# Configuration options related to the preprocessor1906#---------------------------------------------------------------------------1907# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all1909# C-preprocessor directives found in the sources and include files.1910# The default value is: YES.1911ENABLE_PREPROCESSING = YES1913# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names1915# in the source code. If set to NO only conditional compilation will be1916# performed. Macro expansion can be done in a controlled way by setting1917# EXPAND_ONLY_PREDEF to YES.1918# The default value is: NO.1919# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1920MACRO_EXPANSION = NO1922# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then1924# the macro expansion is limited to the macros specified with the PREDEFINED and1925# EXPAND_AS_DEFINED tags.1926# The default value is: NO.1927# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1928EXPAND_ONLY_PREDEF = NO1930# If the SEARCH_INCLUDES tag is set to YES the includes files in the1932# INCLUDE_PATH will be searched if a #include is found.1933# The default value is: YES.1934# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1935SEARCH_INCLUDES = YES1937# The INCLUDE_PATH tag can be used to specify one or more directories that1939# contain include files that are not input files but should be processed by the1940# preprocessor.1941# This tag requires that the tag SEARCH_INCLUDES is set to YES.1942INCLUDE_PATH =1944# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1946# patterns (like *.h and *.hpp) to filter out the header-files in the1947# directories. If left blank, the patterns specified with FILE_PATTERNS will be1948# used.1949# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1950INCLUDE_FILE_PATTERNS =1952# The PREDEFINED tag can be used to specify one or more macro names that are1954# defined before the preprocessor is started (similar to the -D option of e.g.1955# gcc). The argument of the tag is a list of macros of the form: name or1956# name=definition (no spaces). If the definition and the "=" are omitted, "=1"1957# is assumed. To prevent a macro definition from being undefined via #undef or1958# recursively expanded use the := operator instead of the = operator.1959# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1960PREDEFINED =1962# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this1964# tag can be used to specify a list of macro names that should be expanded. The1965# macro definition that is found in the sources will be used. Use the PREDEFINED1966# tag if you want to use a different macro definition that overrules the1967# definition found in the source code.1968# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1969EXPAND_AS_DEFINED =1971# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will1973# remove all references to function-like macros that are alone on a line, have1974# an all uppercase name, and do not end with a semicolon. Such function macros1975# are typically used for boiler-plate code, and will confuse the parser if not1976# removed.1977# The default value is: YES.1978# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.1979SKIP_FUNCTION_MACROS = YES1981#---------------------------------------------------------------------------1983# Configuration options related to external references1984#---------------------------------------------------------------------------1985# The TAGFILES tag can be used to specify one or more tag files. For each tag1987# file the location of the external documentation should be added. The format of1988# a tag file without this location is as follows:1989# TAGFILES = file1 file2 ...1990# Adding location for the tag files is done as follows:1991# TAGFILES = file1=loc1 "file2 = loc2" ...1992# where loc1 and loc2 can be relative or absolute paths or URLs. See the1993# section "Linking to external documentation" for more information about the use1994# of tag files.1995# Note: Each tag file must have a unique name (where the name does NOT include1996# the path). If a tag file is not located in the directory in which doxygen is1997# run, you must also specify the path to the tagfile here.1998TAGFILES =2000# When a file name is specified after GENERATE_TAGFILE, doxygen will create a2002# tag file that is based on the input files it reads. See section "Linking to2003# external documentation" for more information about the usage of tag files.2004GENERATE_TAGFILE =2006# If the ALLEXTERNALS tag is set to YES all external class will be listed in the2008# class index. If set to NO only the inherited external classes will be listed.2009# The default value is: NO.2010ALLEXTERNALS = NO2012# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in2014# the modules index. If set to NO, only the current project's groups will be2015# listed.2016# The default value is: YES.2017EXTERNAL_GROUPS = YES2019# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in2021# the related pages index. If set to NO, only the current project's pages will2022# be listed.2023# The default value is: YES.2024EXTERNAL_PAGES = YES2026# The PERL_PATH should be the absolute path and name of the perl script2028# interpreter (i.e. the result of 'which perl').2029# The default file (with absolute path) is: /usr/bin/perl.2030PERL_PATH = /usr/bin/perl2032#---------------------------------------------------------------------------2034# Configuration options related to the dot tool2035#---------------------------------------------------------------------------2036# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram2038# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to2039# NO turns the diagrams off. Note that this option also works with HAVE_DOT2040# disabled, but it is recommended to install and use dot, since it yields more2041# powerful graphs.2042# The default value is: YES.2043CLASS_DIAGRAMS = YES2045# You can define message sequence charts within doxygen comments using the \msc2047# command. Doxygen will then run the mscgen tool (see:2048# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the2049# documentation. The MSCGEN_PATH tag allows you to specify the directory where2050# the mscgen tool resides. If left empty the tool is assumed to be found in the2051# default search path.2052MSCGEN_PATH =2054# You can include diagrams made with dia in doxygen documentation. Doxygen will2056# then run dia to produce the diagram and insert it in the documentation. The2057# DIA_PATH tag allows you to specify the directory where the dia binary resides.2058# If left empty dia is assumed to be found in the default search path.2059DIA_PATH =2061# If set to YES, the inheritance and collaboration graphs will hide inheritance2063# and usage relations if the target is undocumented or is not a class.2064# The default value is: YES.2065HIDE_UNDOC_RELATIONS = YES2067# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is2069# available from the path. This tool is part of Graphviz (see:2070# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent2071# Bell Labs. The other options in this section have no effect if this option is2072# set to NO2073# The default value is: NO.2074HAVE_DOT = NO2076# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed2078# to run in parallel. When set to 0 doxygen will base this on the number of2079# processors available in the system. You can set it explicitly to a value2080# larger than 0 to get control over the balance between CPU load and processing2081# speed.2082# Minimum value: 0, maximum value: 32, default value: 0.2083# This tag requires that the tag HAVE_DOT is set to YES.2084DOT_NUM_THREADS = 02086# When you want a differently looking font in the dot files that doxygen2088# generates you can specify the font name using DOT_FONTNAME. You need to make2089# sure dot is able to find the font, which can be done by putting it in a2090# standard location or by setting the DOTFONTPATH environment variable or by2091# setting DOT_FONTPATH to the directory containing the font.2092# The default value is: Helvetica.2093# This tag requires that the tag HAVE_DOT is set to YES.2094DOT_FONTNAME = Helvetica2096# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of2098# dot graphs.2099# Minimum value: 4, maximum value: 24, default value: 10.2100# This tag requires that the tag HAVE_DOT is set to YES.2101DOT_FONTSIZE = 102103# By default doxygen will tell dot to use the default font as specified with2105# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set2106# the path where dot can find it using this tag.2107# This tag requires that the tag HAVE_DOT is set to YES.2108DOT_FONTPATH =2110# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for2112# each documented class showing the direct and indirect inheritance relations.2113# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.2114# The default value is: YES.2115# This tag requires that the tag HAVE_DOT is set to YES.2116CLASS_GRAPH = YES2118# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a2120# graph for each documented class showing the direct and indirect implementation2121# dependencies (inheritance, containment, and class references variables) of the2122# class with other documented classes.2123# The default value is: YES.2124# This tag requires that the tag HAVE_DOT is set to YES.2125COLLABORATION_GRAPH = YES2127# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for2129# groups, showing the direct groups dependencies.2130# The default value is: YES.2131# This tag requires that the tag HAVE_DOT is set to YES.2132GROUP_GRAPHS = YES2134# If the UML_LOOK tag is set to YES doxygen will generate inheritance and2136# collaboration diagrams in a style similar to the OMG's Unified Modeling2137# Language.2138# The default value is: NO.2139# This tag requires that the tag HAVE_DOT is set to YES.2140UML_LOOK = NO2142# If the UML_LOOK tag is enabled, the fields and methods are shown inside the2144# class node. If there are many fields or methods and many nodes the graph may2145# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the2146# number of items for each type to make the size more manageable. Set this to 02147# for no limit. Note that the threshold may be exceeded by 50% before the limit2148# is enforced. So when you set the threshold to 10, up to 15 fields may appear,2149# but if the number exceeds 15, the total amount of fields shown is limited to2150# 10.2151# Minimum value: 0, maximum value: 100, default value: 10.2152# This tag requires that the tag HAVE_DOT is set to YES.2153UML_LIMIT_NUM_FIELDS = 102155# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and2157# collaboration graphs will show the relations between templates and their2158# instances.2159# The default value is: NO.2160# This tag requires that the tag HAVE_DOT is set to YES.2161TEMPLATE_RELATIONS = NO2163# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to2165# YES then doxygen will generate a graph for each documented file showing the2166# direct and indirect include dependencies of the file with other documented2167# files.2168# The default value is: YES.2169# This tag requires that the tag HAVE_DOT is set to YES.2170INCLUDE_GRAPH = YES2172# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are2174# set to YES then doxygen will generate a graph for each documented file showing2175# the direct and indirect include dependencies of the file with other documented2176# files.2177# The default value is: YES.2178# This tag requires that the tag HAVE_DOT is set to YES.2179INCLUDED_BY_GRAPH = YES2181# If the CALL_GRAPH tag is set to YES then doxygen will generate a call2183# dependency graph for every global function or class method.2184#2185# Note that enabling this option will significantly increase the time of a run.2186# So in most cases it will be better to enable call graphs for selected2187# functions only using the \callgraph command.2188# The default value is: NO.2189# This tag requires that the tag HAVE_DOT is set to YES.2190CALL_GRAPH = NO2192# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller2194# dependency graph for every global function or class method.2195#2196# Note that enabling this option will significantly increase the time of a run.2197# So in most cases it will be better to enable caller graphs for selected2198# functions only using the \callergraph command.2199# The default value is: NO.2200# This tag requires that the tag HAVE_DOT is set to YES.2201CALLER_GRAPH = NO2203# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical2205# hierarchy of all classes instead of a textual one.2206# The default value is: YES.2207# This tag requires that the tag HAVE_DOT is set to YES.2208GRAPHICAL_HIERARCHY = YES2210# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the2212# dependencies a directory has on other directories in a graphical way. The2213# dependency relations are determined by the #include relations between the2214# files in the directories.2215# The default value is: YES.2216# This tag requires that the tag HAVE_DOT is set to YES.2217DIRECTORY_GRAPH = YES2219# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images2221# generated by dot.2222# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order2223# to make the SVG files visible in IE 9+ (other browsers do not have this2224# requirement).2225# Possible values are: png, jpg, gif and svg.2226# The default value is: png.2227# This tag requires that the tag HAVE_DOT is set to YES.2228DOT_IMAGE_FORMAT = png2230# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to2232# enable generation of interactive SVG images that allow zooming and panning.2233#2234# Note that this requires a modern browser other than Internet Explorer. Tested2235# and working are Firefox, Chrome, Safari, and Opera.2236# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make2237# the SVG files visible. Older versions of IE do not have SVG support.2238# The default value is: NO.2239# This tag requires that the tag HAVE_DOT is set to YES.2240INTERACTIVE_SVG = NO2242# The DOT_PATH tag can be used to specify the path where the dot tool can be2244# found. If left blank, it is assumed the dot tool can be found in the path.2245# This tag requires that the tag HAVE_DOT is set to YES.2246DOT_PATH =2248# The DOTFILE_DIRS tag can be used to specify one or more directories that2250# contain dot files that are included in the documentation (see the \dotfile2251# command).2252# This tag requires that the tag HAVE_DOT is set to YES.2253DOTFILE_DIRS =2255# The MSCFILE_DIRS tag can be used to specify one or more directories that2257# contain msc files that are included in the documentation (see the \mscfile2258# command).2259MSCFILE_DIRS =2261# The DIAFILE_DIRS tag can be used to specify one or more directories that2263# contain dia files that are included in the documentation (see the \diafile2264# command).2265DIAFILE_DIRS =2267# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the2269# path where java can find the plantuml.jar file. If left blank, it is assumed2270# PlantUML is not used or called during a preprocessing step. Doxygen will2271# generate a warning when it encounters a \startuml command in this case and2272# will not generate output for the diagram.2273# This tag requires that the tag HAVE_DOT is set to YES.2274PLANTUML_JAR_PATH =2276# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes2278# that will be shown in the graph. If the number of nodes in a graph becomes2279# larger than this value, doxygen will truncate the graph, which is visualized2280# by representing a node as a red box. Note that doxygen if the number of direct2281# children of the root node in a graph is already larger than2282# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that2283# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.2284# Minimum value: 0, maximum value: 10000, default value: 50.2285# This tag requires that the tag HAVE_DOT is set to YES.2286DOT_GRAPH_MAX_NODES = 502288# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs2290# generated by dot. A depth value of 3 means that only nodes reachable from the2291# root by following a path via at most 3 edges will be shown. Nodes that lay2292# further from the root node will be omitted. Note that setting this option to 12293# or 2 may greatly reduce the computation time needed for large code bases. Also2294# note that the size of a graph can be further restricted by2295# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.2296# Minimum value: 0, maximum value: 1000, default value: 0.2297# This tag requires that the tag HAVE_DOT is set to YES.2298MAX_DOT_GRAPH_DEPTH = 02300# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent2302# background. This is disabled by default, because dot on Windows does not seem2303# to support this out of the box.2304#2305# Warning: Depending on the platform used, enabling this option may lead to2306# badly anti-aliased labels on the edges of a graph (i.e. they become hard to2307# read).2308# The default value is: NO.2309# This tag requires that the tag HAVE_DOT is set to YES.2310DOT_TRANSPARENT = NO2312# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output2314# files in one run (i.e. multiple -o and -T options on the command line). This2315# makes dot run faster, but since only newer versions of dot (>1.8.10) support2316# this, this feature is disabled by default.2317# The default value is: NO.2318# This tag requires that the tag HAVE_DOT is set to YES.2319DOT_MULTI_TARGETS = YES2321# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page2323# explaining the meaning of the various boxes and arrows in the dot generated2324# graphs.2325# The default value is: YES.2326# This tag requires that the tag HAVE_DOT is set to YES.2327GENERATE_LEGEND = YES2329# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot2331# files that are used to generate the various graphs.2332# The default value is: YES.2333# This tag requires that the tag HAVE_DOT is set to YES.2334DOT_CLEANUP = YES2336