This is an example of BLE GATT Client, which receives broadcast data from BLE_Server_BME280 ( a GATT server) , then transfers values up to mbed Device Connector (cloud).

Please refer details about BLEClient_mbedDevConn below. https://github.com/soramame21/BLEClient_mbedDevConn

The location of required BLE GATT server, BLE_Server_BME280, is at here. https://developer.mbed.org/users/edamame22/code/BLE_Server_BME280/

Committer:
edamame22
Date:
Thu Apr 13 04:48:11 2017 +0000
Revision:
0:29983394c6b6
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
edamame22 0:29983394c6b6 1 # Doxyfile 1.8.2
edamame22 0:29983394c6b6 2
edamame22 0:29983394c6b6 3 # This file describes the settings to be used by the documentation system
edamame22 0:29983394c6b6 4 # doxygen (www.doxygen.org) for a project
edamame22 0:29983394c6b6 5 #
edamame22 0:29983394c6b6 6 # All text after a hash (#) is considered a comment and will be ignored
edamame22 0:29983394c6b6 7 # The format is:
edamame22 0:29983394c6b6 8 # TAG = value [value, ...]
edamame22 0:29983394c6b6 9 # For lists items can also be appended using:
edamame22 0:29983394c6b6 10 # TAG += value [value, ...]
edamame22 0:29983394c6b6 11 # Values that contain spaces should be placed between quotes (" ")
edamame22 0:29983394c6b6 12
edamame22 0:29983394c6b6 13 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 14 # Project related configuration options
edamame22 0:29983394c6b6 15 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 16
edamame22 0:29983394c6b6 17 # This tag specifies the encoding used for all characters in the config file
edamame22 0:29983394c6b6 18 # that follow. The default is UTF-8 which is also the encoding used for all
edamame22 0:29983394c6b6 19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
edamame22 0:29983394c6b6 20 # iconv built into libc) for the transcoding. See
edamame22 0:29983394c6b6 21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
edamame22 0:29983394c6b6 22
edamame22 0:29983394c6b6 23 DOXYFILE_ENCODING = UTF-8
edamame22 0:29983394c6b6 24
edamame22 0:29983394c6b6 25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
edamame22 0:29983394c6b6 26 # identify the project. Note that if you do not use Doxywizard you need
edamame22 0:29983394c6b6 27 # to put quotes around the project name if it contains spaces.
edamame22 0:29983394c6b6 28
edamame22 0:29983394c6b6 29 PROJECT_NAME = mbed-client
edamame22 0:29983394c6b6 30
edamame22 0:29983394c6b6 31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
edamame22 0:29983394c6b6 32 # This could be handy for archiving the generated documentation or
edamame22 0:29983394c6b6 33 # if some version control system is used.
edamame22 0:29983394c6b6 34
edamame22 0:29983394c6b6 35 PROJECT_NUMBER =
edamame22 0:29983394c6b6 36
edamame22 0:29983394c6b6 37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
edamame22 0:29983394c6b6 38 # for a project that appears at the top of each page and should give viewer
edamame22 0:29983394c6b6 39 # a quick idea about the purpose of the project. Keep the description short.
edamame22 0:29983394c6b6 40
edamame22 0:29983394c6b6 41 PROJECT_BRIEF = "mbed Client C++ library"
edamame22 0:29983394c6b6 42
edamame22 0:29983394c6b6 43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
edamame22 0:29983394c6b6 44 # included in the documentation. The maximum height of the logo should not
edamame22 0:29983394c6b6 45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
edamame22 0:29983394c6b6 46 # Doxygen will copy the logo to the output directory.
edamame22 0:29983394c6b6 47
edamame22 0:29983394c6b6 48 PROJECT_LOGO =
edamame22 0:29983394c6b6 49
edamame22 0:29983394c6b6 50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
edamame22 0:29983394c6b6 51 # base path where the generated documentation will be put.
edamame22 0:29983394c6b6 52 # If a relative path is entered, it will be relative to the location
edamame22 0:29983394c6b6 53 # where doxygen was started. If left blank the current directory will be used.
edamame22 0:29983394c6b6 54
edamame22 0:29983394c6b6 55 OUTPUT_DIRECTORY = ../docs
edamame22 0:29983394c6b6 56
edamame22 0:29983394c6b6 57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
edamame22 0:29983394c6b6 58 # 4096 sub-directories (in 2 levels) under the output directory of each output
edamame22 0:29983394c6b6 59 # format and will distribute the generated files over these directories.
edamame22 0:29983394c6b6 60 # Enabling this option can be useful when feeding doxygen a huge amount of
edamame22 0:29983394c6b6 61 # source files, where putting all generated files in the same directory would
edamame22 0:29983394c6b6 62 # otherwise cause performance problems for the file system.
edamame22 0:29983394c6b6 63
edamame22 0:29983394c6b6 64 CREATE_SUBDIRS = NO
edamame22 0:29983394c6b6 65
edamame22 0:29983394c6b6 66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
edamame22 0:29983394c6b6 67 # documentation generated by doxygen is written. Doxygen will use this
edamame22 0:29983394c6b6 68 # information to generate all constant output in the proper language.
edamame22 0:29983394c6b6 69 # The default language is English, other supported languages are:
edamame22 0:29983394c6b6 70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
edamame22 0:29983394c6b6 71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
edamame22 0:29983394c6b6 72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
edamame22 0:29983394c6b6 73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
edamame22 0:29983394c6b6 74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
edamame22 0:29983394c6b6 75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
edamame22 0:29983394c6b6 76
edamame22 0:29983394c6b6 77 OUTPUT_LANGUAGE = English
edamame22 0:29983394c6b6 78
edamame22 0:29983394c6b6 79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 80 # include brief member descriptions after the members that are listed in
edamame22 0:29983394c6b6 81 # the file and class documentation (similar to JavaDoc).
edamame22 0:29983394c6b6 82 # Set to NO to disable this.
edamame22 0:29983394c6b6 83
edamame22 0:29983394c6b6 84 BRIEF_MEMBER_DESC = YES
edamame22 0:29983394c6b6 85
edamame22 0:29983394c6b6 86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
edamame22 0:29983394c6b6 87 # the brief description of a member or function before the detailed description.
edamame22 0:29983394c6b6 88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
edamame22 0:29983394c6b6 89 # brief descriptions will be completely suppressed.
edamame22 0:29983394c6b6 90
edamame22 0:29983394c6b6 91 REPEAT_BRIEF = YES
edamame22 0:29983394c6b6 92
edamame22 0:29983394c6b6 93 # This tag implements a quasi-intelligent brief description abbreviator
edamame22 0:29983394c6b6 94 # that is used to form the text in various listings. Each string
edamame22 0:29983394c6b6 95 # in this list, if found as the leading text of the brief description, will be
edamame22 0:29983394c6b6 96 # stripped from the text and the result after processing the whole list, is
edamame22 0:29983394c6b6 97 # used as the annotated text. Otherwise, the brief description is used as-is.
edamame22 0:29983394c6b6 98 # If left blank, the following values are used ("$name" is automatically
edamame22 0:29983394c6b6 99 # replaced with the name of the entity): "The $name class" "The $name widget"
edamame22 0:29983394c6b6 100 # "The $name file" "is" "provides" "specifies" "contains"
edamame22 0:29983394c6b6 101 # "represents" "a" "an" "the"
edamame22 0:29983394c6b6 102
edamame22 0:29983394c6b6 103 ABBREVIATE_BRIEF = "The $name class" \
edamame22 0:29983394c6b6 104 "The $name widget" \
edamame22 0:29983394c6b6 105 "The $name file" \
edamame22 0:29983394c6b6 106 is \
edamame22 0:29983394c6b6 107 provides \
edamame22 0:29983394c6b6 108 specifies \
edamame22 0:29983394c6b6 109 contains \
edamame22 0:29983394c6b6 110 represents \
edamame22 0:29983394c6b6 111 a \
edamame22 0:29983394c6b6 112 an \
edamame22 0:29983394c6b6 113 the
edamame22 0:29983394c6b6 114
edamame22 0:29983394c6b6 115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
edamame22 0:29983394c6b6 116 # Doxygen will generate a detailed section even if there is only a brief
edamame22 0:29983394c6b6 117 # description.
edamame22 0:29983394c6b6 118
edamame22 0:29983394c6b6 119 ALWAYS_DETAILED_SEC = NO
edamame22 0:29983394c6b6 120
edamame22 0:29983394c6b6 121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
edamame22 0:29983394c6b6 122 # inherited members of a class in the documentation of that class as if those
edamame22 0:29983394c6b6 123 # members were ordinary class members. Constructors, destructors and assignment
edamame22 0:29983394c6b6 124 # operators of the base classes will not be shown.
edamame22 0:29983394c6b6 125
edamame22 0:29983394c6b6 126 INLINE_INHERITED_MEMB = NO
edamame22 0:29983394c6b6 127
edamame22 0:29983394c6b6 128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
edamame22 0:29983394c6b6 129 # path before files name in the file list and in the header files. If set
edamame22 0:29983394c6b6 130 # to NO the shortest path that makes the file name unique will be used.
edamame22 0:29983394c6b6 131
edamame22 0:29983394c6b6 132 FULL_PATH_NAMES = NO
edamame22 0:29983394c6b6 133
edamame22 0:29983394c6b6 134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
edamame22 0:29983394c6b6 135 # can be used to strip a user-defined part of the path. Stripping is
edamame22 0:29983394c6b6 136 # only done if one of the specified strings matches the left-hand part of
edamame22 0:29983394c6b6 137 # the path. The tag can be used to show relative paths in the file list.
edamame22 0:29983394c6b6 138 # If left blank the directory from which doxygen is run is used as the
edamame22 0:29983394c6b6 139 # path to strip. Note that you specify absolute paths here, but also
edamame22 0:29983394c6b6 140 # relative paths, which will be relative from the directory where doxygen is
edamame22 0:29983394c6b6 141 # started.
edamame22 0:29983394c6b6 142
edamame22 0:29983394c6b6 143 STRIP_FROM_PATH =
edamame22 0:29983394c6b6 144
edamame22 0:29983394c6b6 145 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
edamame22 0:29983394c6b6 146 # the path mentioned in the documentation of a class, which tells
edamame22 0:29983394c6b6 147 # the reader which header file to include in order to use a class.
edamame22 0:29983394c6b6 148 # If left blank only the name of the header file containing the class
edamame22 0:29983394c6b6 149 # definition is used. Otherwise one should specify the include paths that
edamame22 0:29983394c6b6 150 # are normally passed to the compiler using the -I flag.
edamame22 0:29983394c6b6 151
edamame22 0:29983394c6b6 152 STRIP_FROM_INC_PATH =
edamame22 0:29983394c6b6 153
edamame22 0:29983394c6b6 154 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
edamame22 0:29983394c6b6 155 # (but less readable) file names. This can be useful if your file system
edamame22 0:29983394c6b6 156 # doesn't support long names like on DOS, Mac, or CD-ROM.
edamame22 0:29983394c6b6 157
edamame22 0:29983394c6b6 158 SHORT_NAMES = NO
edamame22 0:29983394c6b6 159
edamame22 0:29983394c6b6 160 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
edamame22 0:29983394c6b6 161 # will interpret the first line (until the first dot) of a JavaDoc-style
edamame22 0:29983394c6b6 162 # comment as the brief description. If set to NO, the JavaDoc
edamame22 0:29983394c6b6 163 # comments will behave just like regular Qt-style comments
edamame22 0:29983394c6b6 164 # (thus requiring an explicit @brief command for a brief description.)
edamame22 0:29983394c6b6 165
edamame22 0:29983394c6b6 166 JAVADOC_AUTOBRIEF = NO
edamame22 0:29983394c6b6 167
edamame22 0:29983394c6b6 168 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
edamame22 0:29983394c6b6 169 # interpret the first line (until the first dot) of a Qt-style
edamame22 0:29983394c6b6 170 # comment as the brief description. If set to NO, the comments
edamame22 0:29983394c6b6 171 # will behave just like regular Qt-style comments (thus requiring
edamame22 0:29983394c6b6 172 # an explicit \brief command for a brief description.)
edamame22 0:29983394c6b6 173
edamame22 0:29983394c6b6 174 QT_AUTOBRIEF = NO
edamame22 0:29983394c6b6 175
edamame22 0:29983394c6b6 176 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
edamame22 0:29983394c6b6 177 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
edamame22 0:29983394c6b6 178 # comments) as a brief description. This used to be the default behaviour.
edamame22 0:29983394c6b6 179 # The new default is to treat a multi-line C++ comment block as a detailed
edamame22 0:29983394c6b6 180 # description. Set this tag to YES if you prefer the old behaviour instead.
edamame22 0:29983394c6b6 181
edamame22 0:29983394c6b6 182 MULTILINE_CPP_IS_BRIEF = NO
edamame22 0:29983394c6b6 183
edamame22 0:29983394c6b6 184 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
edamame22 0:29983394c6b6 185 # member inherits the documentation from any documented member that it
edamame22 0:29983394c6b6 186 # re-implements.
edamame22 0:29983394c6b6 187
edamame22 0:29983394c6b6 188 INHERIT_DOCS = YES
edamame22 0:29983394c6b6 189
edamame22 0:29983394c6b6 190 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
edamame22 0:29983394c6b6 191 # a new page for each member. If set to NO, the documentation of a member will
edamame22 0:29983394c6b6 192 # be part of the file/class/namespace that contains it.
edamame22 0:29983394c6b6 193
edamame22 0:29983394c6b6 194 SEPARATE_MEMBER_PAGES = NO
edamame22 0:29983394c6b6 195
edamame22 0:29983394c6b6 196 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
edamame22 0:29983394c6b6 197 # Doxygen uses this value to replace tabs by spaces in code fragments.
edamame22 0:29983394c6b6 198
edamame22 0:29983394c6b6 199 TAB_SIZE = 16
edamame22 0:29983394c6b6 200
edamame22 0:29983394c6b6 201 # This tag can be used to specify a number of aliases that acts
edamame22 0:29983394c6b6 202 # as commands in the documentation. An alias has the form "name=value".
edamame22 0:29983394c6b6 203 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
edamame22 0:29983394c6b6 204 # put the command \sideeffect (or @sideeffect) in the documentation, which
edamame22 0:29983394c6b6 205 # will result in a user-defined paragraph with heading "Side Effects:".
edamame22 0:29983394c6b6 206 # You can put \n's in the value part of an alias to insert newlines.
edamame22 0:29983394c6b6 207
edamame22 0:29983394c6b6 208 ALIASES =
edamame22 0:29983394c6b6 209
edamame22 0:29983394c6b6 210 # This tag can be used to specify a number of word-keyword mappings (TCL only).
edamame22 0:29983394c6b6 211 # A mapping has the form "name=value". For example adding
edamame22 0:29983394c6b6 212 # "class=itcl::class" will allow you to use the command class in the
edamame22 0:29983394c6b6 213 # itcl::class meaning.
edamame22 0:29983394c6b6 214
edamame22 0:29983394c6b6 215 TCL_SUBST =
edamame22 0:29983394c6b6 216
edamame22 0:29983394c6b6 217 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
edamame22 0:29983394c6b6 218 # sources only. Doxygen will then generate output that is more tailored for C.
edamame22 0:29983394c6b6 219 # For instance, some of the names that are used will be different. The list
edamame22 0:29983394c6b6 220 # of all members will be omitted, etc.
edamame22 0:29983394c6b6 221
edamame22 0:29983394c6b6 222 OPTIMIZE_OUTPUT_FOR_C = YES
edamame22 0:29983394c6b6 223
edamame22 0:29983394c6b6 224 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
edamame22 0:29983394c6b6 225 # sources only. Doxygen will then generate output that is more tailored for
edamame22 0:29983394c6b6 226 # Java. For instance, namespaces will be presented as packages, qualified
edamame22 0:29983394c6b6 227 # scopes will look different, etc.
edamame22 0:29983394c6b6 228
edamame22 0:29983394c6b6 229 OPTIMIZE_OUTPUT_JAVA = NO
edamame22 0:29983394c6b6 230
edamame22 0:29983394c6b6 231 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
edamame22 0:29983394c6b6 232 # sources only. Doxygen will then generate output that is more tailored for
edamame22 0:29983394c6b6 233 # Fortran.
edamame22 0:29983394c6b6 234
edamame22 0:29983394c6b6 235 OPTIMIZE_FOR_FORTRAN = NO
edamame22 0:29983394c6b6 236
edamame22 0:29983394c6b6 237 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
edamame22 0:29983394c6b6 238 # sources. Doxygen will then generate output that is tailored for
edamame22 0:29983394c6b6 239 # VHDL.
edamame22 0:29983394c6b6 240
edamame22 0:29983394c6b6 241 OPTIMIZE_OUTPUT_VHDL = NO
edamame22 0:29983394c6b6 242
edamame22 0:29983394c6b6 243 # Doxygen selects the parser to use depending on the extension of the files it
edamame22 0:29983394c6b6 244 # parses. With this tag you can assign which parser to use for a given
edamame22 0:29983394c6b6 245 # extension. Doxygen has a built-in mapping, but you can override or extend it
edamame22 0:29983394c6b6 246 # using this tag. The format is ext=language, where ext is a file extension,
edamame22 0:29983394c6b6 247 # and language is one of the parsers supported by doxygen: IDL, Java,
edamame22 0:29983394c6b6 248 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
edamame22 0:29983394c6b6 249 # C++. For instance to make doxygen treat .inc files as Fortran files (default
edamame22 0:29983394c6b6 250 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
edamame22 0:29983394c6b6 251 # that for custom extensions you also need to set FILE_PATTERNS otherwise the
edamame22 0:29983394c6b6 252 # files are not read by doxygen.
edamame22 0:29983394c6b6 253
edamame22 0:29983394c6b6 254 EXTENSION_MAPPING =
edamame22 0:29983394c6b6 255
edamame22 0:29983394c6b6 256 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
edamame22 0:29983394c6b6 257 # comments according to the Markdown format, which allows for more readable
edamame22 0:29983394c6b6 258 # documentation. See http://daringfireball.net/projects/markdown/ for details.
edamame22 0:29983394c6b6 259 # The output of markdown processing is further processed by doxygen, so you
edamame22 0:29983394c6b6 260 # can mix doxygen, HTML, and XML commands with Markdown formatting.
edamame22 0:29983394c6b6 261 # Disable only in case of backward compatibilities issues.
edamame22 0:29983394c6b6 262
edamame22 0:29983394c6b6 263 MARKDOWN_SUPPORT = YES
edamame22 0:29983394c6b6 264
edamame22 0:29983394c6b6 265 # When enabled doxygen tries to link words that correspond to documented classes,
edamame22 0:29983394c6b6 266 # or namespaces to their corresponding documentation. Such a link can be
edamame22 0:29983394c6b6 267 # prevented in individual cases by by putting a % sign in front of the word or
edamame22 0:29983394c6b6 268 # globally by setting AUTOLINK_SUPPORT to NO.
edamame22 0:29983394c6b6 269
edamame22 0:29983394c6b6 270 AUTOLINK_SUPPORT = YES
edamame22 0:29983394c6b6 271
edamame22 0:29983394c6b6 272 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
edamame22 0:29983394c6b6 273 # to include (a tag file for) the STL sources as input, then you should
edamame22 0:29983394c6b6 274 # set this tag to YES in order to let doxygen match functions declarations and
edamame22 0:29983394c6b6 275 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
edamame22 0:29983394c6b6 276 # func(std::string) {}). This also makes the inheritance and collaboration
edamame22 0:29983394c6b6 277 # diagrams that involve STL classes more complete and accurate.
edamame22 0:29983394c6b6 278
edamame22 0:29983394c6b6 279 BUILTIN_STL_SUPPORT = NO
edamame22 0:29983394c6b6 280
edamame22 0:29983394c6b6 281 # If you use Microsoft's C++/CLI language, you should set this option to YES to
edamame22 0:29983394c6b6 282 # enable parsing support.
edamame22 0:29983394c6b6 283
edamame22 0:29983394c6b6 284 CPP_CLI_SUPPORT = NO
edamame22 0:29983394c6b6 285
edamame22 0:29983394c6b6 286 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
edamame22 0:29983394c6b6 287 # Doxygen will parse them like normal C++ but will assume all classes use public
edamame22 0:29983394c6b6 288 # instead of private inheritance when no explicit protection keyword is present.
edamame22 0:29983394c6b6 289
edamame22 0:29983394c6b6 290 SIP_SUPPORT = NO
edamame22 0:29983394c6b6 291
edamame22 0:29983394c6b6 292 # For Microsoft's IDL there are propget and propput attributes to indicate
edamame22 0:29983394c6b6 293 # getter and setter methods for a property. Setting this option to YES (the
edamame22 0:29983394c6b6 294 # default) will make doxygen replace the get and set methods by a property in
edamame22 0:29983394c6b6 295 # the documentation. This will only work if the methods are indeed getting or
edamame22 0:29983394c6b6 296 # setting a simple type. If this is not the case, or you want to show the
edamame22 0:29983394c6b6 297 # methods anyway, you should set this option to NO.
edamame22 0:29983394c6b6 298
edamame22 0:29983394c6b6 299 IDL_PROPERTY_SUPPORT = YES
edamame22 0:29983394c6b6 300
edamame22 0:29983394c6b6 301 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
edamame22 0:29983394c6b6 302 # tag is set to YES, then doxygen will reuse the documentation of the first
edamame22 0:29983394c6b6 303 # member in the group (if any) for the other members of the group. By default
edamame22 0:29983394c6b6 304 # all members of a group must be documented explicitly.
edamame22 0:29983394c6b6 305
edamame22 0:29983394c6b6 306 DISTRIBUTE_GROUP_DOC = NO
edamame22 0:29983394c6b6 307
edamame22 0:29983394c6b6 308 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
edamame22 0:29983394c6b6 309 # the same type (for instance a group of public functions) to be put as a
edamame22 0:29983394c6b6 310 # subgroup of that type (e.g. under the Public Functions section). Set it to
edamame22 0:29983394c6b6 311 # NO to prevent subgrouping. Alternatively, this can be done per class using
edamame22 0:29983394c6b6 312 # the \nosubgrouping command.
edamame22 0:29983394c6b6 313
edamame22 0:29983394c6b6 314 SUBGROUPING = YES
edamame22 0:29983394c6b6 315
edamame22 0:29983394c6b6 316 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
edamame22 0:29983394c6b6 317 # unions are shown inside the group in which they are included (e.g. using
edamame22 0:29983394c6b6 318 # @ingroup) instead of on a separate page (for HTML and Man pages) or
edamame22 0:29983394c6b6 319 # section (for LaTeX and RTF).
edamame22 0:29983394c6b6 320
edamame22 0:29983394c6b6 321 INLINE_GROUPED_CLASSES = NO
edamame22 0:29983394c6b6 322
edamame22 0:29983394c6b6 323 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
edamame22 0:29983394c6b6 324 # unions with only public data fields will be shown inline in the documentation
edamame22 0:29983394c6b6 325 # of the scope in which they are defined (i.e. file, namespace, or group
edamame22 0:29983394c6b6 326 # documentation), provided this scope is documented. If set to NO (the default),
edamame22 0:29983394c6b6 327 # structs, classes, and unions are shown on a separate page (for HTML and Man
edamame22 0:29983394c6b6 328 # pages) or section (for LaTeX and RTF).
edamame22 0:29983394c6b6 329
edamame22 0:29983394c6b6 330 INLINE_SIMPLE_STRUCTS = NO
edamame22 0:29983394c6b6 331
edamame22 0:29983394c6b6 332 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
edamame22 0:29983394c6b6 333 # is documented as struct, union, or enum with the name of the typedef. So
edamame22 0:29983394c6b6 334 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
edamame22 0:29983394c6b6 335 # with name TypeT. When disabled the typedef will appear as a member of a file,
edamame22 0:29983394c6b6 336 # namespace, or class. And the struct will be named TypeS. This can typically
edamame22 0:29983394c6b6 337 # be useful for C code in case the coding convention dictates that all compound
edamame22 0:29983394c6b6 338 # types are typedef'ed and only the typedef is referenced, never the tag name.
edamame22 0:29983394c6b6 339
edamame22 0:29983394c6b6 340 TYPEDEF_HIDES_STRUCT = NO
edamame22 0:29983394c6b6 341
edamame22 0:29983394c6b6 342 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
edamame22 0:29983394c6b6 343 # determine which symbols to keep in memory and which to flush to disk.
edamame22 0:29983394c6b6 344 # When the cache is full, less often used symbols will be written to disk.
edamame22 0:29983394c6b6 345 # For small to medium size projects (<1000 input files) the default value is
edamame22 0:29983394c6b6 346 # probably good enough. For larger projects a too small cache size can cause
edamame22 0:29983394c6b6 347 # doxygen to be busy swapping symbols to and from disk most of the time
edamame22 0:29983394c6b6 348 # causing a significant performance penalty.
edamame22 0:29983394c6b6 349 # If the system has enough physical memory increasing the cache will improve the
edamame22 0:29983394c6b6 350 # performance by keeping more symbols in memory. Note that the value works on
edamame22 0:29983394c6b6 351 # a logarithmic scale so increasing the size by one will roughly double the
edamame22 0:29983394c6b6 352 # memory usage. The cache size is given by this formula:
edamame22 0:29983394c6b6 353 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
edamame22 0:29983394c6b6 354 # corresponding to a cache size of 2^16 = 65536 symbols.
edamame22 0:29983394c6b6 355
edamame22 0:29983394c6b6 356 SYMBOL_CACHE_SIZE = 0
edamame22 0:29983394c6b6 357
edamame22 0:29983394c6b6 358 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
edamame22 0:29983394c6b6 359 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
edamame22 0:29983394c6b6 360 # their name and scope. Since this can be an expensive process and often the
edamame22 0:29983394c6b6 361 # same symbol appear multiple times in the code, doxygen keeps a cache of
edamame22 0:29983394c6b6 362 # pre-resolved symbols. If the cache is too small doxygen will become slower.
edamame22 0:29983394c6b6 363 # If the cache is too large, memory is wasted. The cache size is given by this
edamame22 0:29983394c6b6 364 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
edamame22 0:29983394c6b6 365 # corresponding to a cache size of 2^16 = 65536 symbols.
edamame22 0:29983394c6b6 366
edamame22 0:29983394c6b6 367 LOOKUP_CACHE_SIZE = 0
edamame22 0:29983394c6b6 368
edamame22 0:29983394c6b6 369 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 370 # Build related configuration options
edamame22 0:29983394c6b6 371 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 372
edamame22 0:29983394c6b6 373 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
edamame22 0:29983394c6b6 374 # documentation are documented, even if no documentation was available.
edamame22 0:29983394c6b6 375 # Private class members and static file members will be hidden unless
edamame22 0:29983394c6b6 376 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
edamame22 0:29983394c6b6 377
edamame22 0:29983394c6b6 378 EXTRACT_ALL = NO
edamame22 0:29983394c6b6 379
edamame22 0:29983394c6b6 380 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
edamame22 0:29983394c6b6 381 # will be included in the documentation.
edamame22 0:29983394c6b6 382
edamame22 0:29983394c6b6 383 EXTRACT_PRIVATE = NO
edamame22 0:29983394c6b6 384
edamame22 0:29983394c6b6 385 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
edamame22 0:29983394c6b6 386 # scope will be included in the documentation.
edamame22 0:29983394c6b6 387
edamame22 0:29983394c6b6 388 EXTRACT_PACKAGE = NO
edamame22 0:29983394c6b6 389
edamame22 0:29983394c6b6 390 # If the EXTRACT_STATIC tag is set to YES all static members of a file
edamame22 0:29983394c6b6 391 # will be included in the documentation.
edamame22 0:29983394c6b6 392
edamame22 0:29983394c6b6 393 EXTRACT_STATIC = NO
edamame22 0:29983394c6b6 394
edamame22 0:29983394c6b6 395 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
edamame22 0:29983394c6b6 396 # defined locally in source files will be included in the documentation.
edamame22 0:29983394c6b6 397 # If set to NO only classes defined in header files are included.
edamame22 0:29983394c6b6 398
edamame22 0:29983394c6b6 399 EXTRACT_LOCAL_CLASSES = NO
edamame22 0:29983394c6b6 400
edamame22 0:29983394c6b6 401 # This flag is only useful for Objective-C code. When set to YES local
edamame22 0:29983394c6b6 402 # methods, which are defined in the implementation section but not in
edamame22 0:29983394c6b6 403 # the interface are included in the documentation.
edamame22 0:29983394c6b6 404 # If set to NO (the default) only methods in the interface are included.
edamame22 0:29983394c6b6 405
edamame22 0:29983394c6b6 406 EXTRACT_LOCAL_METHODS = NO
edamame22 0:29983394c6b6 407
edamame22 0:29983394c6b6 408 # If this flag is set to YES, the members of anonymous namespaces will be
edamame22 0:29983394c6b6 409 # extracted and appear in the documentation as a namespace called
edamame22 0:29983394c6b6 410 # 'anonymous_namespace{file}', where file will be replaced with the base
edamame22 0:29983394c6b6 411 # name of the file that contains the anonymous namespace. By default
edamame22 0:29983394c6b6 412 # anonymous namespaces are hidden.
edamame22 0:29983394c6b6 413
edamame22 0:29983394c6b6 414 EXTRACT_ANON_NSPACES = NO
edamame22 0:29983394c6b6 415
edamame22 0:29983394c6b6 416 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
edamame22 0:29983394c6b6 417 # undocumented members of documented classes, files or namespaces.
edamame22 0:29983394c6b6 418 # If set to NO (the default) these members will be included in the
edamame22 0:29983394c6b6 419 # various overviews, but no documentation section is generated.
edamame22 0:29983394c6b6 420 # This option has no effect if EXTRACT_ALL is enabled.
edamame22 0:29983394c6b6 421
edamame22 0:29983394c6b6 422 HIDE_UNDOC_MEMBERS = YES
edamame22 0:29983394c6b6 423
edamame22 0:29983394c6b6 424 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
edamame22 0:29983394c6b6 425 # undocumented classes that are normally visible in the class hierarchy.
edamame22 0:29983394c6b6 426 # If set to NO (the default) these classes will be included in the various
edamame22 0:29983394c6b6 427 # overviews. This option has no effect if EXTRACT_ALL is enabled.
edamame22 0:29983394c6b6 428
edamame22 0:29983394c6b6 429 HIDE_UNDOC_CLASSES = YES
edamame22 0:29983394c6b6 430
edamame22 0:29983394c6b6 431 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
edamame22 0:29983394c6b6 432 # friend (class|struct|union) declarations.
edamame22 0:29983394c6b6 433 # If set to NO (the default) these declarations will be included in the
edamame22 0:29983394c6b6 434 # documentation.
edamame22 0:29983394c6b6 435
edamame22 0:29983394c6b6 436 HIDE_FRIEND_COMPOUNDS = YES
edamame22 0:29983394c6b6 437
edamame22 0:29983394c6b6 438 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
edamame22 0:29983394c6b6 439 # documentation blocks found inside the body of a function.
edamame22 0:29983394c6b6 440 # If set to NO (the default) these blocks will be appended to the
edamame22 0:29983394c6b6 441 # function's detailed documentation block.
edamame22 0:29983394c6b6 442
edamame22 0:29983394c6b6 443 HIDE_IN_BODY_DOCS = YES
edamame22 0:29983394c6b6 444
edamame22 0:29983394c6b6 445 # The INTERNAL_DOCS tag determines if documentation
edamame22 0:29983394c6b6 446 # that is typed after a \internal command is included. If the tag is set
edamame22 0:29983394c6b6 447 # to NO (the default) then the documentation will be excluded.
edamame22 0:29983394c6b6 448 # Set it to YES to include the internal documentation.
edamame22 0:29983394c6b6 449
edamame22 0:29983394c6b6 450 INTERNAL_DOCS = NO
edamame22 0:29983394c6b6 451
edamame22 0:29983394c6b6 452 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
edamame22 0:29983394c6b6 453 # file names in lower-case letters. If set to YES upper-case letters are also
edamame22 0:29983394c6b6 454 # allowed. This is useful if you have classes or files whose names only differ
edamame22 0:29983394c6b6 455 # in case and if your file system supports case sensitive file names. Windows
edamame22 0:29983394c6b6 456 # and Mac users are advised to set this option to NO.
edamame22 0:29983394c6b6 457
edamame22 0:29983394c6b6 458 CASE_SENSE_NAMES = NO
edamame22 0:29983394c6b6 459
edamame22 0:29983394c6b6 460 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
edamame22 0:29983394c6b6 461 # will show members with their full class and namespace scopes in the
edamame22 0:29983394c6b6 462 # documentation. If set to YES the scope will be hidden.
edamame22 0:29983394c6b6 463
edamame22 0:29983394c6b6 464 HIDE_SCOPE_NAMES = YES
edamame22 0:29983394c6b6 465
edamame22 0:29983394c6b6 466 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
edamame22 0:29983394c6b6 467 # will put a list of the files that are included by a file in the documentation
edamame22 0:29983394c6b6 468 # of that file.
edamame22 0:29983394c6b6 469
edamame22 0:29983394c6b6 470 SHOW_INCLUDE_FILES = NO
edamame22 0:29983394c6b6 471
edamame22 0:29983394c6b6 472 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
edamame22 0:29983394c6b6 473 # will list include files with double quotes in the documentation
edamame22 0:29983394c6b6 474 # rather than with sharp brackets.
edamame22 0:29983394c6b6 475
edamame22 0:29983394c6b6 476 FORCE_LOCAL_INCLUDES = NO
edamame22 0:29983394c6b6 477
edamame22 0:29983394c6b6 478 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
edamame22 0:29983394c6b6 479 # is inserted in the documentation for inline members.
edamame22 0:29983394c6b6 480
edamame22 0:29983394c6b6 481 INLINE_INFO = YES
edamame22 0:29983394c6b6 482
edamame22 0:29983394c6b6 483 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
edamame22 0:29983394c6b6 484 # will sort the (detailed) documentation of file and class members
edamame22 0:29983394c6b6 485 # alphabetically by member name. If set to NO the members will appear in
edamame22 0:29983394c6b6 486 # declaration order.
edamame22 0:29983394c6b6 487
edamame22 0:29983394c6b6 488 SORT_MEMBER_DOCS = YES
edamame22 0:29983394c6b6 489
edamame22 0:29983394c6b6 490 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
edamame22 0:29983394c6b6 491 # brief documentation of file, namespace and class members alphabetically
edamame22 0:29983394c6b6 492 # by member name. If set to NO (the default) the members will appear in
edamame22 0:29983394c6b6 493 # declaration order.
edamame22 0:29983394c6b6 494
edamame22 0:29983394c6b6 495 SORT_BRIEF_DOCS = NO
edamame22 0:29983394c6b6 496
edamame22 0:29983394c6b6 497 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
edamame22 0:29983394c6b6 498 # will sort the (brief and detailed) documentation of class members so that
edamame22 0:29983394c6b6 499 # constructors and destructors are listed first. If set to NO (the default)
edamame22 0:29983394c6b6 500 # the constructors will appear in the respective orders defined by
edamame22 0:29983394c6b6 501 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
edamame22 0:29983394c6b6 502 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
edamame22 0:29983394c6b6 503 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
edamame22 0:29983394c6b6 504
edamame22 0:29983394c6b6 505 SORT_MEMBERS_CTORS_1ST = NO
edamame22 0:29983394c6b6 506
edamame22 0:29983394c6b6 507 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
edamame22 0:29983394c6b6 508 # hierarchy of group names into alphabetical order. If set to NO (the default)
edamame22 0:29983394c6b6 509 # the group names will appear in their defined order.
edamame22 0:29983394c6b6 510
edamame22 0:29983394c6b6 511 SORT_GROUP_NAMES = NO
edamame22 0:29983394c6b6 512
edamame22 0:29983394c6b6 513 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
edamame22 0:29983394c6b6 514 # sorted by fully-qualified names, including namespaces. If set to
edamame22 0:29983394c6b6 515 # NO (the default), the class list will be sorted only by class name,
edamame22 0:29983394c6b6 516 # not including the namespace part.
edamame22 0:29983394c6b6 517 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
edamame22 0:29983394c6b6 518 # Note: This option applies only to the class list, not to the
edamame22 0:29983394c6b6 519 # alphabetical list.
edamame22 0:29983394c6b6 520
edamame22 0:29983394c6b6 521 SORT_BY_SCOPE_NAME = NO
edamame22 0:29983394c6b6 522
edamame22 0:29983394c6b6 523 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
edamame22 0:29983394c6b6 524 # do proper type resolution of all parameters of a function it will reject a
edamame22 0:29983394c6b6 525 # match between the prototype and the implementation of a member function even
edamame22 0:29983394c6b6 526 # if there is only one candidate or it is obvious which candidate to choose
edamame22 0:29983394c6b6 527 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
edamame22 0:29983394c6b6 528 # will still accept a match between prototype and implementation in such cases.
edamame22 0:29983394c6b6 529
edamame22 0:29983394c6b6 530 STRICT_PROTO_MATCHING = NO
edamame22 0:29983394c6b6 531
edamame22 0:29983394c6b6 532 # The GENERATE_TODOLIST tag can be used to enable (YES) or
edamame22 0:29983394c6b6 533 # disable (NO) the todo list. This list is created by putting \todo
edamame22 0:29983394c6b6 534 # commands in the documentation.
edamame22 0:29983394c6b6 535
edamame22 0:29983394c6b6 536 GENERATE_TODOLIST = YES
edamame22 0:29983394c6b6 537
edamame22 0:29983394c6b6 538 # The GENERATE_TESTLIST tag can be used to enable (YES) or
edamame22 0:29983394c6b6 539 # disable (NO) the test list. This list is created by putting \test
edamame22 0:29983394c6b6 540 # commands in the documentation.
edamame22 0:29983394c6b6 541
edamame22 0:29983394c6b6 542 GENERATE_TESTLIST = YES
edamame22 0:29983394c6b6 543
edamame22 0:29983394c6b6 544 # The GENERATE_BUGLIST tag can be used to enable (YES) or
edamame22 0:29983394c6b6 545 # disable (NO) the bug list. This list is created by putting \bug
edamame22 0:29983394c6b6 546 # commands in the documentation.
edamame22 0:29983394c6b6 547
edamame22 0:29983394c6b6 548 GENERATE_BUGLIST = YES
edamame22 0:29983394c6b6 549
edamame22 0:29983394c6b6 550 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
edamame22 0:29983394c6b6 551 # disable (NO) the deprecated list. This list is created by putting
edamame22 0:29983394c6b6 552 # \deprecated commands in the documentation.
edamame22 0:29983394c6b6 553
edamame22 0:29983394c6b6 554 GENERATE_DEPRECATEDLIST= YES
edamame22 0:29983394c6b6 555
edamame22 0:29983394c6b6 556 # The ENABLED_SECTIONS tag can be used to enable conditional
edamame22 0:29983394c6b6 557 # documentation sections, marked by \if sectionname ... \endif.
edamame22 0:29983394c6b6 558
edamame22 0:29983394c6b6 559 ENABLED_SECTIONS =
edamame22 0:29983394c6b6 560
edamame22 0:29983394c6b6 561 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
edamame22 0:29983394c6b6 562 # the initial value of a variable or macro consists of for it to appear in
edamame22 0:29983394c6b6 563 # the documentation. If the initializer consists of more lines than specified
edamame22 0:29983394c6b6 564 # here it will be hidden. Use a value of 0 to hide initializers completely.
edamame22 0:29983394c6b6 565 # The appearance of the initializer of individual variables and macros in the
edamame22 0:29983394c6b6 566 # documentation can be controlled using \showinitializer or \hideinitializer
edamame22 0:29983394c6b6 567 # command in the documentation regardless of this setting.
edamame22 0:29983394c6b6 568
edamame22 0:29983394c6b6 569 MAX_INITIALIZER_LINES = 18
edamame22 0:29983394c6b6 570
edamame22 0:29983394c6b6 571 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
edamame22 0:29983394c6b6 572 # at the bottom of the documentation of classes and structs. If set to YES the
edamame22 0:29983394c6b6 573 # list will mention the files that were used to generate the documentation.
edamame22 0:29983394c6b6 574
edamame22 0:29983394c6b6 575 SHOW_USED_FILES = YES
edamame22 0:29983394c6b6 576
edamame22 0:29983394c6b6 577 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
edamame22 0:29983394c6b6 578 # This will remove the Files entry from the Quick Index and from the
edamame22 0:29983394c6b6 579 # Folder Tree View (if specified). The default is YES.
edamame22 0:29983394c6b6 580
edamame22 0:29983394c6b6 581 SHOW_FILES = YES
edamame22 0:29983394c6b6 582
edamame22 0:29983394c6b6 583 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
edamame22 0:29983394c6b6 584 # Namespaces page. This will remove the Namespaces entry from the Quick Index
edamame22 0:29983394c6b6 585 # and from the Folder Tree View (if specified). The default is YES.
edamame22 0:29983394c6b6 586
edamame22 0:29983394c6b6 587 SHOW_NAMESPACES = YES
edamame22 0:29983394c6b6 588
edamame22 0:29983394c6b6 589 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
edamame22 0:29983394c6b6 590 # doxygen should invoke to get the current version for each file (typically from
edamame22 0:29983394c6b6 591 # the version control system). Doxygen will invoke the program by executing (via
edamame22 0:29983394c6b6 592 # popen()) the command <command> <input-file>, where <command> is the value of
edamame22 0:29983394c6b6 593 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
edamame22 0:29983394c6b6 594 # provided by doxygen. Whatever the program writes to standard output
edamame22 0:29983394c6b6 595 # is used as the file version. See the manual for examples.
edamame22 0:29983394c6b6 596
edamame22 0:29983394c6b6 597 FILE_VERSION_FILTER =
edamame22 0:29983394c6b6 598
edamame22 0:29983394c6b6 599 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
edamame22 0:29983394c6b6 600 # by doxygen. The layout file controls the global structure of the generated
edamame22 0:29983394c6b6 601 # output files in an output format independent way. To create the layout file
edamame22 0:29983394c6b6 602 # that represents doxygen's defaults, run doxygen with the -l option.
edamame22 0:29983394c6b6 603 # You can optionally specify a file name after the option, if omitted
edamame22 0:29983394c6b6 604 # DoxygenLayout.xml will be used as the name of the layout file.
edamame22 0:29983394c6b6 605
edamame22 0:29983394c6b6 606 LAYOUT_FILE =
edamame22 0:29983394c6b6 607
edamame22 0:29983394c6b6 608 # The CITE_BIB_FILES tag can be used to specify one or more bib files
edamame22 0:29983394c6b6 609 # containing the references data. This must be a list of .bib files. The
edamame22 0:29983394c6b6 610 # .bib extension is automatically appended if omitted. Using this command
edamame22 0:29983394c6b6 611 # requires the bibtex tool to be installed. See also
edamame22 0:29983394c6b6 612 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
edamame22 0:29983394c6b6 613 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
edamame22 0:29983394c6b6 614 # feature you need bibtex and perl available in the search path.
edamame22 0:29983394c6b6 615
edamame22 0:29983394c6b6 616 CITE_BIB_FILES =
edamame22 0:29983394c6b6 617
edamame22 0:29983394c6b6 618 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 619 # configuration options related to warning and progress messages
edamame22 0:29983394c6b6 620 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 621
edamame22 0:29983394c6b6 622 # The QUIET tag can be used to turn on/off the messages that are generated
edamame22 0:29983394c6b6 623 # by doxygen. Possible values are YES and NO. If left blank NO is used.
edamame22 0:29983394c6b6 624
edamame22 0:29983394c6b6 625 QUIET = NO
edamame22 0:29983394c6b6 626
edamame22 0:29983394c6b6 627 # The WARNINGS tag can be used to turn on/off the warning messages that are
edamame22 0:29983394c6b6 628 # generated by doxygen. Possible values are YES and NO. If left blank
edamame22 0:29983394c6b6 629 # NO is used.
edamame22 0:29983394c6b6 630
edamame22 0:29983394c6b6 631 WARNINGS = YES
edamame22 0:29983394c6b6 632
edamame22 0:29983394c6b6 633 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
edamame22 0:29983394c6b6 634 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
edamame22 0:29983394c6b6 635 # automatically be disabled.
edamame22 0:29983394c6b6 636
edamame22 0:29983394c6b6 637 WARN_IF_UNDOCUMENTED = YES
edamame22 0:29983394c6b6 638
edamame22 0:29983394c6b6 639 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
edamame22 0:29983394c6b6 640 # potential errors in the documentation, such as not documenting some
edamame22 0:29983394c6b6 641 # parameters in a documented function, or documenting parameters that
edamame22 0:29983394c6b6 642 # don't exist or using markup commands wrongly.
edamame22 0:29983394c6b6 643
edamame22 0:29983394c6b6 644 WARN_IF_DOC_ERROR = YES
edamame22 0:29983394c6b6 645
edamame22 0:29983394c6b6 646 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
edamame22 0:29983394c6b6 647 # functions that are documented, but have no documentation for their parameters
edamame22 0:29983394c6b6 648 # or return value. If set to NO (the default) doxygen will only warn about
edamame22 0:29983394c6b6 649 # wrong or incomplete parameter documentation, but not about the absence of
edamame22 0:29983394c6b6 650 # documentation.
edamame22 0:29983394c6b6 651
edamame22 0:29983394c6b6 652 WARN_NO_PARAMDOC = NO
edamame22 0:29983394c6b6 653
edamame22 0:29983394c6b6 654 # The WARN_FORMAT tag determines the format of the warning messages that
edamame22 0:29983394c6b6 655 # doxygen can produce. The string should contain the $file, $line, and $text
edamame22 0:29983394c6b6 656 # tags, which will be replaced by the file and line number from which the
edamame22 0:29983394c6b6 657 # warning originated and the warning text. Optionally the format may contain
edamame22 0:29983394c6b6 658 # $version, which will be replaced by the version of the file (if it could
edamame22 0:29983394c6b6 659 # be obtained via FILE_VERSION_FILTER)
edamame22 0:29983394c6b6 660
edamame22 0:29983394c6b6 661 WARN_FORMAT = "$file:$line: $text"
edamame22 0:29983394c6b6 662
edamame22 0:29983394c6b6 663 # The WARN_LOGFILE tag can be used to specify a file to which warning
edamame22 0:29983394c6b6 664 # and error messages should be written. If left blank the output is written
edamame22 0:29983394c6b6 665 # to stderr.
edamame22 0:29983394c6b6 666
edamame22 0:29983394c6b6 667 WARN_LOGFILE =
edamame22 0:29983394c6b6 668
edamame22 0:29983394c6b6 669 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 670 # configuration options related to the input files
edamame22 0:29983394c6b6 671 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 672
edamame22 0:29983394c6b6 673 # The INPUT tag can be used to specify the files and/or directories that contain
edamame22 0:29983394c6b6 674 # documented source files. You may enter file names like "myfile.cpp" or
edamame22 0:29983394c6b6 675 # directories like "/usr/src/myproject". Separate the files or directories
edamame22 0:29983394c6b6 676 # with spaces.
edamame22 0:29983394c6b6 677
edamame22 0:29983394c6b6 678 INPUT = ../mbed-client
edamame22 0:29983394c6b6 679
edamame22 0:29983394c6b6 680 # This tag can be used to specify the character encoding of the source files
edamame22 0:29983394c6b6 681 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
edamame22 0:29983394c6b6 682 # also the default input encoding. Doxygen uses libiconv (or the iconv built
edamame22 0:29983394c6b6 683 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
edamame22 0:29983394c6b6 684 # the list of possible encodings.
edamame22 0:29983394c6b6 685
edamame22 0:29983394c6b6 686 INPUT_ENCODING = UTF-8
edamame22 0:29983394c6b6 687
edamame22 0:29983394c6b6 688 # If the value of the INPUT tag contains directories, you can use the
edamame22 0:29983394c6b6 689 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
edamame22 0:29983394c6b6 690 # and *.h) to filter out the source-files in the directories. If left
edamame22 0:29983394c6b6 691 # blank the following patterns are tested:
edamame22 0:29983394c6b6 692 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
edamame22 0:29983394c6b6 693 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
edamame22 0:29983394c6b6 694 # *.f90 *.f *.for *.vhd *.vhdl
edamame22 0:29983394c6b6 695
edamame22 0:29983394c6b6 696 FILE_PATTERNS = *.c \
edamame22 0:29983394c6b6 697 *.cc \
edamame22 0:29983394c6b6 698 *.cxx \
edamame22 0:29983394c6b6 699 *.cpp \
edamame22 0:29983394c6b6 700 *.c++ \
edamame22 0:29983394c6b6 701 *.d \
edamame22 0:29983394c6b6 702 *.java \
edamame22 0:29983394c6b6 703 *.ii \
edamame22 0:29983394c6b6 704 *.ixx \
edamame22 0:29983394c6b6 705 *.ipp \
edamame22 0:29983394c6b6 706 *.i++ \
edamame22 0:29983394c6b6 707 *.inl \
edamame22 0:29983394c6b6 708 *.h \
edamame22 0:29983394c6b6 709 *.hh \
edamame22 0:29983394c6b6 710 *.hxx \
edamame22 0:29983394c6b6 711 *.hpp \
edamame22 0:29983394c6b6 712 *.h++ \
edamame22 0:29983394c6b6 713 *.idl \
edamame22 0:29983394c6b6 714 *.odl \
edamame22 0:29983394c6b6 715 *.cs \
edamame22 0:29983394c6b6 716 *.php \
edamame22 0:29983394c6b6 717 *.php3 \
edamame22 0:29983394c6b6 718 *.inc \
edamame22 0:29983394c6b6 719 *.m \
edamame22 0:29983394c6b6 720 *.markdown \
edamame22 0:29983394c6b6 721 *.md \
edamame22 0:29983394c6b6 722 *.mm \
edamame22 0:29983394c6b6 723 *.dox \
edamame22 0:29983394c6b6 724 *.py \
edamame22 0:29983394c6b6 725 *.f90 \
edamame22 0:29983394c6b6 726 *.f \
edamame22 0:29983394c6b6 727 *.for \
edamame22 0:29983394c6b6 728 *.vhd \
edamame22 0:29983394c6b6 729 *.vhdl
edamame22 0:29983394c6b6 730
edamame22 0:29983394c6b6 731 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
edamame22 0:29983394c6b6 732 # should be searched for input files as well. Possible values are YES and NO.
edamame22 0:29983394c6b6 733 # If left blank NO is used.
edamame22 0:29983394c6b6 734
edamame22 0:29983394c6b6 735 RECURSIVE = YES
edamame22 0:29983394c6b6 736
edamame22 0:29983394c6b6 737 # The EXCLUDE tag can be used to specify files and/or directories that should be
edamame22 0:29983394c6b6 738 # excluded from the INPUT source files. This way you can easily exclude a
edamame22 0:29983394c6b6 739 # subdirectory from a directory tree whose root is specified with the INPUT tag.
edamame22 0:29983394c6b6 740 # Note that relative paths are relative to the directory from which doxygen is
edamame22 0:29983394c6b6 741 # run.
edamame22 0:29983394c6b6 742
edamame22 0:29983394c6b6 743 EXCLUDE =
edamame22 0:29983394c6b6 744
edamame22 0:29983394c6b6 745 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
edamame22 0:29983394c6b6 746 # directories that are symbolic links (a Unix file system feature) are excluded
edamame22 0:29983394c6b6 747 # from the input.
edamame22 0:29983394c6b6 748
edamame22 0:29983394c6b6 749 EXCLUDE_SYMLINKS = NO
edamame22 0:29983394c6b6 750
edamame22 0:29983394c6b6 751 # If the value of the INPUT tag contains directories, you can use the
edamame22 0:29983394c6b6 752 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
edamame22 0:29983394c6b6 753 # certain files from those directories. Note that the wildcards are matched
edamame22 0:29983394c6b6 754 # against the file with absolute path, so to exclude all test directories
edamame22 0:29983394c6b6 755 # for example use the pattern */test/*
edamame22 0:29983394c6b6 756
edamame22 0:29983394c6b6 757 EXCLUDE_PATTERNS = */config/*
edamame22 0:29983394c6b6 758 EXCLUDE_PATTERNS += */docs/*
edamame22 0:29983394c6b6 759 EXCLUDE_PATTERNS += */doxygen/*
edamame22 0:29983394c6b6 760 EXCLUDE_PATTERNS += */source/*
edamame22 0:29983394c6b6 761 EXCLUDE_PATTERNS += */test/*
edamame22 0:29983394c6b6 762
edamame22 0:29983394c6b6 763 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
edamame22 0:29983394c6b6 764 # (namespaces, classes, functions, etc.) that should be excluded from the
edamame22 0:29983394c6b6 765 # output. The symbol name can be a fully qualified name, a word, or if the
edamame22 0:29983394c6b6 766 # wildcard * is used, a substring. Examples: ANamespace, AClass,
edamame22 0:29983394c6b6 767 # AClass::ANamespace, ANamespace::*Test
edamame22 0:29983394c6b6 768
edamame22 0:29983394c6b6 769 EXCLUDE_SYMBOLS =
edamame22 0:29983394c6b6 770
edamame22 0:29983394c6b6 771 # The EXAMPLE_PATH tag can be used to specify one or more files or
edamame22 0:29983394c6b6 772 # directories that contain example code fragments that are included (see
edamame22 0:29983394c6b6 773 # the \include command).
edamame22 0:29983394c6b6 774
edamame22 0:29983394c6b6 775 EXAMPLE_PATH =
edamame22 0:29983394c6b6 776
edamame22 0:29983394c6b6 777 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
edamame22 0:29983394c6b6 778 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
edamame22 0:29983394c6b6 779 # and *.h) to filter out the source-files in the directories. If left
edamame22 0:29983394c6b6 780 # blank all files are included.
edamame22 0:29983394c6b6 781
edamame22 0:29983394c6b6 782 EXAMPLE_PATTERNS = *
edamame22 0:29983394c6b6 783
edamame22 0:29983394c6b6 784 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
edamame22 0:29983394c6b6 785 # searched for input files to be used with the \include or \dontinclude
edamame22 0:29983394c6b6 786 # commands irrespective of the value of the RECURSIVE tag.
edamame22 0:29983394c6b6 787 # Possible values are YES and NO. If left blank NO is used.
edamame22 0:29983394c6b6 788
edamame22 0:29983394c6b6 789 EXAMPLE_RECURSIVE = NO
edamame22 0:29983394c6b6 790
edamame22 0:29983394c6b6 791 # The IMAGE_PATH tag can be used to specify one or more files or
edamame22 0:29983394c6b6 792 # directories that contain image that are included in the documentation (see
edamame22 0:29983394c6b6 793 # the \image command).
edamame22 0:29983394c6b6 794
edamame22 0:29983394c6b6 795 IMAGE_PATH =
edamame22 0:29983394c6b6 796
edamame22 0:29983394c6b6 797 # The INPUT_FILTER tag can be used to specify a program that doxygen should
edamame22 0:29983394c6b6 798 # invoke to filter for each input file. Doxygen will invoke the filter program
edamame22 0:29983394c6b6 799 # by executing (via popen()) the command <filter> <input-file>, where <filter>
edamame22 0:29983394c6b6 800 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
edamame22 0:29983394c6b6 801 # input file. Doxygen will then use the output that the filter program writes
edamame22 0:29983394c6b6 802 # to standard output. If FILTER_PATTERNS is specified, this tag will be
edamame22 0:29983394c6b6 803 # ignored.
edamame22 0:29983394c6b6 804
edamame22 0:29983394c6b6 805 INPUT_FILTER =
edamame22 0:29983394c6b6 806
edamame22 0:29983394c6b6 807 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
edamame22 0:29983394c6b6 808 # basis. Doxygen will compare the file name with each pattern and apply the
edamame22 0:29983394c6b6 809 # filter if there is a match. The filters are a list of the form:
edamame22 0:29983394c6b6 810 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
edamame22 0:29983394c6b6 811 # info on how filters are used. If FILTER_PATTERNS is empty or if
edamame22 0:29983394c6b6 812 # non of the patterns match the file name, INPUT_FILTER is applied.
edamame22 0:29983394c6b6 813
edamame22 0:29983394c6b6 814 FILTER_PATTERNS =
edamame22 0:29983394c6b6 815
edamame22 0:29983394c6b6 816 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
edamame22 0:29983394c6b6 817 # INPUT_FILTER) will be used to filter the input files when producing source
edamame22 0:29983394c6b6 818 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
edamame22 0:29983394c6b6 819
edamame22 0:29983394c6b6 820 FILTER_SOURCE_FILES = NO
edamame22 0:29983394c6b6 821
edamame22 0:29983394c6b6 822 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
edamame22 0:29983394c6b6 823 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
edamame22 0:29983394c6b6 824 # and it is also possible to disable source filtering for a specific pattern
edamame22 0:29983394c6b6 825 # using *.ext= (so without naming a filter). This option only has effect when
edamame22 0:29983394c6b6 826 # FILTER_SOURCE_FILES is enabled.
edamame22 0:29983394c6b6 827
edamame22 0:29983394c6b6 828 FILTER_SOURCE_PATTERNS =
edamame22 0:29983394c6b6 829
edamame22 0:29983394c6b6 830 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 831 # configuration options related to source browsing
edamame22 0:29983394c6b6 832 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 833
edamame22 0:29983394c6b6 834 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
edamame22 0:29983394c6b6 835 # be generated. Documented entities will be cross-referenced with these sources.
edamame22 0:29983394c6b6 836 # Note: To get rid of all source code in the generated output, make sure also
edamame22 0:29983394c6b6 837 # VERBATIM_HEADERS is set to NO.
edamame22 0:29983394c6b6 838
edamame22 0:29983394c6b6 839 SOURCE_BROWSER = NO
edamame22 0:29983394c6b6 840
edamame22 0:29983394c6b6 841 # Setting the INLINE_SOURCES tag to YES will include the body
edamame22 0:29983394c6b6 842 # of functions and classes directly in the documentation.
edamame22 0:29983394c6b6 843
edamame22 0:29983394c6b6 844 INLINE_SOURCES = NO
edamame22 0:29983394c6b6 845
edamame22 0:29983394c6b6 846 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
edamame22 0:29983394c6b6 847 # doxygen to hide any special comment blocks from generated source code
edamame22 0:29983394c6b6 848 # fragments. Normal C, C++ and Fortran comments will always remain visible.
edamame22 0:29983394c6b6 849
edamame22 0:29983394c6b6 850 STRIP_CODE_COMMENTS = YES
edamame22 0:29983394c6b6 851
edamame22 0:29983394c6b6 852 # If the REFERENCED_BY_RELATION tag is set to YES
edamame22 0:29983394c6b6 853 # then for each documented function all documented
edamame22 0:29983394c6b6 854 # functions referencing it will be listed.
edamame22 0:29983394c6b6 855
edamame22 0:29983394c6b6 856 REFERENCED_BY_RELATION = NO
edamame22 0:29983394c6b6 857
edamame22 0:29983394c6b6 858 # If the REFERENCES_RELATION tag is set to YES
edamame22 0:29983394c6b6 859 # then for each documented function all documented entities
edamame22 0:29983394c6b6 860 # called/used by that function will be listed.
edamame22 0:29983394c6b6 861
edamame22 0:29983394c6b6 862 REFERENCES_RELATION = NO
edamame22 0:29983394c6b6 863
edamame22 0:29983394c6b6 864 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
edamame22 0:29983394c6b6 865 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
edamame22 0:29983394c6b6 866 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
edamame22 0:29983394c6b6 867 # link to the source code. Otherwise they will link to the documentation.
edamame22 0:29983394c6b6 868
edamame22 0:29983394c6b6 869 REFERENCES_LINK_SOURCE = YES
edamame22 0:29983394c6b6 870
edamame22 0:29983394c6b6 871 # If the USE_HTAGS tag is set to YES then the references to source code
edamame22 0:29983394c6b6 872 # will point to the HTML generated by the htags(1) tool instead of doxygen
edamame22 0:29983394c6b6 873 # built-in source browser. The htags tool is part of GNU's global source
edamame22 0:29983394c6b6 874 # tagging system (see http://www.gnu.org/software/global/global.html). You
edamame22 0:29983394c6b6 875 # will need version 4.8.6 or higher.
edamame22 0:29983394c6b6 876
edamame22 0:29983394c6b6 877 USE_HTAGS = NO
edamame22 0:29983394c6b6 878
edamame22 0:29983394c6b6 879 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
edamame22 0:29983394c6b6 880 # will generate a verbatim copy of the header file for each class for
edamame22 0:29983394c6b6 881 # which an include is specified. Set to NO to disable this.
edamame22 0:29983394c6b6 882
edamame22 0:29983394c6b6 883 VERBATIM_HEADERS = YES
edamame22 0:29983394c6b6 884
edamame22 0:29983394c6b6 885 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 886 # configuration options related to the alphabetical class index
edamame22 0:29983394c6b6 887 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 888
edamame22 0:29983394c6b6 889 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
edamame22 0:29983394c6b6 890 # of all compounds will be generated. Enable this if the project
edamame22 0:29983394c6b6 891 # contains a lot of classes, structs, unions or interfaces.
edamame22 0:29983394c6b6 892
edamame22 0:29983394c6b6 893 ALPHABETICAL_INDEX = YES
edamame22 0:29983394c6b6 894
edamame22 0:29983394c6b6 895 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
edamame22 0:29983394c6b6 896 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
edamame22 0:29983394c6b6 897 # in which this list will be split (can be a number in the range [1..20])
edamame22 0:29983394c6b6 898
edamame22 0:29983394c6b6 899 COLS_IN_ALPHA_INDEX = 5
edamame22 0:29983394c6b6 900
edamame22 0:29983394c6b6 901 # In case all classes in a project start with a common prefix, all
edamame22 0:29983394c6b6 902 # classes will be put under the same header in the alphabetical index.
edamame22 0:29983394c6b6 903 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
edamame22 0:29983394c6b6 904 # should be ignored while generating the index headers.
edamame22 0:29983394c6b6 905
edamame22 0:29983394c6b6 906 IGNORE_PREFIX =
edamame22 0:29983394c6b6 907
edamame22 0:29983394c6b6 908 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 909 # configuration options related to the HTML output
edamame22 0:29983394c6b6 910 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 911
edamame22 0:29983394c6b6 912 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 913 # generate HTML output.
edamame22 0:29983394c6b6 914
edamame22 0:29983394c6b6 915 GENERATE_HTML = YES
edamame22 0:29983394c6b6 916
edamame22 0:29983394c6b6 917 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
edamame22 0:29983394c6b6 918 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
edamame22 0:29983394c6b6 919 # put in front of it. If left blank `html' will be used as the default path.
edamame22 0:29983394c6b6 920
edamame22 0:29983394c6b6 921 HTML_OUTPUT = html
edamame22 0:29983394c6b6 922
edamame22 0:29983394c6b6 923 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
edamame22 0:29983394c6b6 924 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
edamame22 0:29983394c6b6 925 # doxygen will generate files with .html extension.
edamame22 0:29983394c6b6 926
edamame22 0:29983394c6b6 927 HTML_FILE_EXTENSION = .html
edamame22 0:29983394c6b6 928
edamame22 0:29983394c6b6 929 # The HTML_HEADER tag can be used to specify a personal HTML header for
edamame22 0:29983394c6b6 930 # each generated HTML page. If it is left blank doxygen will generate a
edamame22 0:29983394c6b6 931 # standard header. Note that when using a custom header you are responsible
edamame22 0:29983394c6b6 932 # for the proper inclusion of any scripts and style sheets that doxygen
edamame22 0:29983394c6b6 933 # needs, which is dependent on the configuration options used.
edamame22 0:29983394c6b6 934 # It is advised to generate a default header using "doxygen -w html
edamame22 0:29983394c6b6 935 # header.html footer.html stylesheet.css YourConfigFile" and then modify
edamame22 0:29983394c6b6 936 # that header. Note that the header is subject to change so you typically
edamame22 0:29983394c6b6 937 # have to redo this when upgrading to a newer version of doxygen or when
edamame22 0:29983394c6b6 938 # changing the value of configuration settings such as GENERATE_TREEVIEW!
edamame22 0:29983394c6b6 939
edamame22 0:29983394c6b6 940 HTML_HEADER =
edamame22 0:29983394c6b6 941
edamame22 0:29983394c6b6 942 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
edamame22 0:29983394c6b6 943 # each generated HTML page. If it is left blank doxygen will generate a
edamame22 0:29983394c6b6 944 # standard footer.
edamame22 0:29983394c6b6 945
edamame22 0:29983394c6b6 946 HTML_FOOTER =
edamame22 0:29983394c6b6 947
edamame22 0:29983394c6b6 948 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
edamame22 0:29983394c6b6 949 # style sheet that is used by each HTML page. It can be used to
edamame22 0:29983394c6b6 950 # fine-tune the look of the HTML output. If left blank doxygen will
edamame22 0:29983394c6b6 951 # generate a default style sheet. Note that it is recommended to use
edamame22 0:29983394c6b6 952 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
edamame22 0:29983394c6b6 953 # tag will in the future become obsolete.
edamame22 0:29983394c6b6 954
edamame22 0:29983394c6b6 955 HTML_STYLESHEET =
edamame22 0:29983394c6b6 956
edamame22 0:29983394c6b6 957 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
edamame22 0:29983394c6b6 958 # user-defined cascading style sheet that is included after the standard
edamame22 0:29983394c6b6 959 # style sheets created by doxygen. Using this option one can overrule
edamame22 0:29983394c6b6 960 # certain style aspects. This is preferred over using HTML_STYLESHEET
edamame22 0:29983394c6b6 961 # since it does not replace the standard style sheet and is therefor more
edamame22 0:29983394c6b6 962 # robust against future updates. Doxygen will copy the style sheet file to
edamame22 0:29983394c6b6 963 # the output directory.
edamame22 0:29983394c6b6 964
edamame22 0:29983394c6b6 965 HTML_EXTRA_STYLESHEET =
edamame22 0:29983394c6b6 966
edamame22 0:29983394c6b6 967 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
edamame22 0:29983394c6b6 968 # other source files which should be copied to the HTML output directory. Note
edamame22 0:29983394c6b6 969 # that these files will be copied to the base HTML output directory. Use the
edamame22 0:29983394c6b6 970 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
edamame22 0:29983394c6b6 971 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
edamame22 0:29983394c6b6 972 # the files will be copied as-is; there are no commands or markers available.
edamame22 0:29983394c6b6 973
edamame22 0:29983394c6b6 974 HTML_EXTRA_FILES =
edamame22 0:29983394c6b6 975
edamame22 0:29983394c6b6 976 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
edamame22 0:29983394c6b6 977 # Doxygen will adjust the colors in the style sheet and background images
edamame22 0:29983394c6b6 978 # according to this color. Hue is specified as an angle on a colorwheel,
edamame22 0:29983394c6b6 979 # see http://en.wikipedia.org/wiki/Hue for more information.
edamame22 0:29983394c6b6 980 # For instance the value 0 represents red, 60 is yellow, 120 is green,
edamame22 0:29983394c6b6 981 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
edamame22 0:29983394c6b6 982 # The allowed range is 0 to 359.
edamame22 0:29983394c6b6 983
edamame22 0:29983394c6b6 984 HTML_COLORSTYLE_HUE = 220
edamame22 0:29983394c6b6 985
edamame22 0:29983394c6b6 986 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
edamame22 0:29983394c6b6 987 # the colors in the HTML output. For a value of 0 the output will use
edamame22 0:29983394c6b6 988 # grayscales only. A value of 255 will produce the most vivid colors.
edamame22 0:29983394c6b6 989
edamame22 0:29983394c6b6 990 HTML_COLORSTYLE_SAT = 100
edamame22 0:29983394c6b6 991
edamame22 0:29983394c6b6 992 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
edamame22 0:29983394c6b6 993 # the luminance component of the colors in the HTML output. Values below
edamame22 0:29983394c6b6 994 # 100 gradually make the output lighter, whereas values above 100 make
edamame22 0:29983394c6b6 995 # the output darker. The value divided by 100 is the actual gamma applied,
edamame22 0:29983394c6b6 996 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
edamame22 0:29983394c6b6 997 # and 100 does not change the gamma.
edamame22 0:29983394c6b6 998
edamame22 0:29983394c6b6 999 HTML_COLORSTYLE_GAMMA = 80
edamame22 0:29983394c6b6 1000
edamame22 0:29983394c6b6 1001 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
edamame22 0:29983394c6b6 1002 # page will contain the date and time when the page was generated. Setting
edamame22 0:29983394c6b6 1003 # this to NO can help when comparing the output of multiple runs.
edamame22 0:29983394c6b6 1004
edamame22 0:29983394c6b6 1005 HTML_TIMESTAMP = YES
edamame22 0:29983394c6b6 1006
edamame22 0:29983394c6b6 1007 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
edamame22 0:29983394c6b6 1008 # documentation will contain sections that can be hidden and shown after the
edamame22 0:29983394c6b6 1009 # page has loaded.
edamame22 0:29983394c6b6 1010
edamame22 0:29983394c6b6 1011 HTML_DYNAMIC_SECTIONS = NO
edamame22 0:29983394c6b6 1012
edamame22 0:29983394c6b6 1013 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
edamame22 0:29983394c6b6 1014 # entries shown in the various tree structured indices initially; the user
edamame22 0:29983394c6b6 1015 # can expand and collapse entries dynamically later on. Doxygen will expand
edamame22 0:29983394c6b6 1016 # the tree to such a level that at most the specified number of entries are
edamame22 0:29983394c6b6 1017 # visible (unless a fully collapsed tree already exceeds this amount).
edamame22 0:29983394c6b6 1018 # So setting the number of entries 1 will produce a full collapsed tree by
edamame22 0:29983394c6b6 1019 # default. 0 is a special value representing an infinite number of entries
edamame22 0:29983394c6b6 1020 # and will result in a full expanded tree by default.
edamame22 0:29983394c6b6 1021
edamame22 0:29983394c6b6 1022 HTML_INDEX_NUM_ENTRIES = 100
edamame22 0:29983394c6b6 1023
edamame22 0:29983394c6b6 1024 # If the GENERATE_DOCSET tag is set to YES, additional index files
edamame22 0:29983394c6b6 1025 # will be generated that can be used as input for Apple's Xcode 3
edamame22 0:29983394c6b6 1026 # integrated development environment, introduced with OSX 10.5 (Leopard).
edamame22 0:29983394c6b6 1027 # To create a documentation set, doxygen will generate a Makefile in the
edamame22 0:29983394c6b6 1028 # HTML output directory. Running make will produce the docset in that
edamame22 0:29983394c6b6 1029 # directory and running "make install" will install the docset in
edamame22 0:29983394c6b6 1030 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
edamame22 0:29983394c6b6 1031 # it at startup.
edamame22 0:29983394c6b6 1032 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
edamame22 0:29983394c6b6 1033 # for more information.
edamame22 0:29983394c6b6 1034
edamame22 0:29983394c6b6 1035 GENERATE_DOCSET = NO
edamame22 0:29983394c6b6 1036
edamame22 0:29983394c6b6 1037 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
edamame22 0:29983394c6b6 1038 # feed. A documentation feed provides an umbrella under which multiple
edamame22 0:29983394c6b6 1039 # documentation sets from a single provider (such as a company or product suite)
edamame22 0:29983394c6b6 1040 # can be grouped.
edamame22 0:29983394c6b6 1041
edamame22 0:29983394c6b6 1042 DOCSET_FEEDNAME = "Doxygen generated docs"
edamame22 0:29983394c6b6 1043
edamame22 0:29983394c6b6 1044 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
edamame22 0:29983394c6b6 1045 # should uniquely identify the documentation set bundle. This should be a
edamame22 0:29983394c6b6 1046 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
edamame22 0:29983394c6b6 1047 # will append .docset to the name.
edamame22 0:29983394c6b6 1048
edamame22 0:29983394c6b6 1049 DOCSET_BUNDLE_ID = org.doxygen.Project
edamame22 0:29983394c6b6 1050
edamame22 0:29983394c6b6 1051 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
edamame22 0:29983394c6b6 1052 # identify the documentation publisher. This should be a reverse domain-name
edamame22 0:29983394c6b6 1053 # style string, e.g. com.mycompany.MyDocSet.documentation.
edamame22 0:29983394c6b6 1054
edamame22 0:29983394c6b6 1055 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
edamame22 0:29983394c6b6 1056
edamame22 0:29983394c6b6 1057 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
edamame22 0:29983394c6b6 1058
edamame22 0:29983394c6b6 1059 DOCSET_PUBLISHER_NAME = Publisher
edamame22 0:29983394c6b6 1060
edamame22 0:29983394c6b6 1061 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
edamame22 0:29983394c6b6 1062 # will be generated that can be used as input for tools like the
edamame22 0:29983394c6b6 1063 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
edamame22 0:29983394c6b6 1064 # of the generated HTML documentation.
edamame22 0:29983394c6b6 1065
edamame22 0:29983394c6b6 1066 GENERATE_HTMLHELP = NO
edamame22 0:29983394c6b6 1067
edamame22 0:29983394c6b6 1068 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
edamame22 0:29983394c6b6 1069 # be used to specify the file name of the resulting .chm file. You
edamame22 0:29983394c6b6 1070 # can add a path in front of the file if the result should not be
edamame22 0:29983394c6b6 1071 # written to the html output directory.
edamame22 0:29983394c6b6 1072
edamame22 0:29983394c6b6 1073 CHM_FILE =
edamame22 0:29983394c6b6 1074
edamame22 0:29983394c6b6 1075 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
edamame22 0:29983394c6b6 1076 # be used to specify the location (absolute path including file name) of
edamame22 0:29983394c6b6 1077 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
edamame22 0:29983394c6b6 1078 # the HTML help compiler on the generated index.hhp.
edamame22 0:29983394c6b6 1079
edamame22 0:29983394c6b6 1080 HHC_LOCATION =
edamame22 0:29983394c6b6 1081
edamame22 0:29983394c6b6 1082 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
edamame22 0:29983394c6b6 1083 # controls if a separate .chi index file is generated (YES) or that
edamame22 0:29983394c6b6 1084 # it should be included in the master .chm file (NO).
edamame22 0:29983394c6b6 1085
edamame22 0:29983394c6b6 1086 GENERATE_CHI = NO
edamame22 0:29983394c6b6 1087
edamame22 0:29983394c6b6 1088 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
edamame22 0:29983394c6b6 1089 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
edamame22 0:29983394c6b6 1090 # content.
edamame22 0:29983394c6b6 1091
edamame22 0:29983394c6b6 1092 CHM_INDEX_ENCODING =
edamame22 0:29983394c6b6 1093
edamame22 0:29983394c6b6 1094 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
edamame22 0:29983394c6b6 1095 # controls whether a binary table of contents is generated (YES) or a
edamame22 0:29983394c6b6 1096 # normal table of contents (NO) in the .chm file.
edamame22 0:29983394c6b6 1097
edamame22 0:29983394c6b6 1098 BINARY_TOC = NO
edamame22 0:29983394c6b6 1099
edamame22 0:29983394c6b6 1100 # The TOC_EXPAND flag can be set to YES to add extra items for group members
edamame22 0:29983394c6b6 1101 # to the contents of the HTML help documentation and to the tree view.
edamame22 0:29983394c6b6 1102
edamame22 0:29983394c6b6 1103 TOC_EXPAND = NO
edamame22 0:29983394c6b6 1104
edamame22 0:29983394c6b6 1105 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
edamame22 0:29983394c6b6 1106 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
edamame22 0:29983394c6b6 1107 # that can be used as input for Qt's qhelpgenerator to generate a
edamame22 0:29983394c6b6 1108 # Qt Compressed Help (.qch) of the generated HTML documentation.
edamame22 0:29983394c6b6 1109
edamame22 0:29983394c6b6 1110 GENERATE_QHP = NO
edamame22 0:29983394c6b6 1111
edamame22 0:29983394c6b6 1112 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
edamame22 0:29983394c6b6 1113 # be used to specify the file name of the resulting .qch file.
edamame22 0:29983394c6b6 1114 # The path specified is relative to the HTML output folder.
edamame22 0:29983394c6b6 1115
edamame22 0:29983394c6b6 1116 QCH_FILE =
edamame22 0:29983394c6b6 1117
edamame22 0:29983394c6b6 1118 # The QHP_NAMESPACE tag specifies the namespace to use when generating
edamame22 0:29983394c6b6 1119 # Qt Help Project output. For more information please see
edamame22 0:29983394c6b6 1120 # http://doc.trolltech.com/qthelpproject.html#namespace
edamame22 0:29983394c6b6 1121
edamame22 0:29983394c6b6 1122 QHP_NAMESPACE = org.doxygen.Project
edamame22 0:29983394c6b6 1123
edamame22 0:29983394c6b6 1124 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
edamame22 0:29983394c6b6 1125 # Qt Help Project output. For more information please see
edamame22 0:29983394c6b6 1126 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
edamame22 0:29983394c6b6 1127
edamame22 0:29983394c6b6 1128 QHP_VIRTUAL_FOLDER = doc
edamame22 0:29983394c6b6 1129
edamame22 0:29983394c6b6 1130 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
edamame22 0:29983394c6b6 1131 # add. For more information please see
edamame22 0:29983394c6b6 1132 # http://doc.trolltech.com/qthelpproject.html#custom-filters
edamame22 0:29983394c6b6 1133
edamame22 0:29983394c6b6 1134 QHP_CUST_FILTER_NAME =
edamame22 0:29983394c6b6 1135
edamame22 0:29983394c6b6 1136 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
edamame22 0:29983394c6b6 1137 # custom filter to add. For more information please see
edamame22 0:29983394c6b6 1138 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
edamame22 0:29983394c6b6 1139 # Qt Help Project / Custom Filters</a>.
edamame22 0:29983394c6b6 1140
edamame22 0:29983394c6b6 1141 QHP_CUST_FILTER_ATTRS =
edamame22 0:29983394c6b6 1142
edamame22 0:29983394c6b6 1143 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
edamame22 0:29983394c6b6 1144 # project's
edamame22 0:29983394c6b6 1145 # filter section matches.
edamame22 0:29983394c6b6 1146 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
edamame22 0:29983394c6b6 1147 # Qt Help Project / Filter Attributes</a>.
edamame22 0:29983394c6b6 1148
edamame22 0:29983394c6b6 1149 QHP_SECT_FILTER_ATTRS =
edamame22 0:29983394c6b6 1150
edamame22 0:29983394c6b6 1151 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
edamame22 0:29983394c6b6 1152 # be used to specify the location of Qt's qhelpgenerator.
edamame22 0:29983394c6b6 1153 # If non-empty doxygen will try to run qhelpgenerator on the generated
edamame22 0:29983394c6b6 1154 # .qhp file.
edamame22 0:29983394c6b6 1155
edamame22 0:29983394c6b6 1156 QHG_LOCATION =
edamame22 0:29983394c6b6 1157
edamame22 0:29983394c6b6 1158 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
edamame22 0:29983394c6b6 1159 # will be generated, which together with the HTML files, form an Eclipse help
edamame22 0:29983394c6b6 1160 # plugin. To install this plugin and make it available under the help contents
edamame22 0:29983394c6b6 1161 # menu in Eclipse, the contents of the directory containing the HTML and XML
edamame22 0:29983394c6b6 1162 # files needs to be copied into the plugins directory of eclipse. The name of
edamame22 0:29983394c6b6 1163 # the directory within the plugins directory should be the same as
edamame22 0:29983394c6b6 1164 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
edamame22 0:29983394c6b6 1165 # the help appears.
edamame22 0:29983394c6b6 1166
edamame22 0:29983394c6b6 1167 GENERATE_ECLIPSEHELP = NO
edamame22 0:29983394c6b6 1168
edamame22 0:29983394c6b6 1169 # A unique identifier for the eclipse help plugin. When installing the plugin
edamame22 0:29983394c6b6 1170 # the directory name containing the HTML and XML files should also have
edamame22 0:29983394c6b6 1171 # this name.
edamame22 0:29983394c6b6 1172
edamame22 0:29983394c6b6 1173 ECLIPSE_DOC_ID = org.doxygen.Project
edamame22 0:29983394c6b6 1174
edamame22 0:29983394c6b6 1175 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
edamame22 0:29983394c6b6 1176 # at top of each HTML page. The value NO (the default) enables the index and
edamame22 0:29983394c6b6 1177 # the value YES disables it. Since the tabs have the same information as the
edamame22 0:29983394c6b6 1178 # navigation tree you can set this option to NO if you already set
edamame22 0:29983394c6b6 1179 # GENERATE_TREEVIEW to YES.
edamame22 0:29983394c6b6 1180
edamame22 0:29983394c6b6 1181 DISABLE_INDEX = NO
edamame22 0:29983394c6b6 1182
edamame22 0:29983394c6b6 1183 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
edamame22 0:29983394c6b6 1184 # structure should be generated to display hierarchical information.
edamame22 0:29983394c6b6 1185 # If the tag value is set to YES, a side panel will be generated
edamame22 0:29983394c6b6 1186 # containing a tree-like index structure (just like the one that
edamame22 0:29983394c6b6 1187 # is generated for HTML Help). For this to work a browser that supports
edamame22 0:29983394c6b6 1188 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
edamame22 0:29983394c6b6 1189 # Windows users are probably better off using the HTML help feature.
edamame22 0:29983394c6b6 1190 # Since the tree basically has the same information as the tab index you
edamame22 0:29983394c6b6 1191 # could consider to set DISABLE_INDEX to NO when enabling this option.
edamame22 0:29983394c6b6 1192
edamame22 0:29983394c6b6 1193 GENERATE_TREEVIEW = NO
edamame22 0:29983394c6b6 1194
edamame22 0:29983394c6b6 1195 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
edamame22 0:29983394c6b6 1196 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
edamame22 0:29983394c6b6 1197 # documentation. Note that a value of 0 will completely suppress the enum
edamame22 0:29983394c6b6 1198 # values from appearing in the overview section.
edamame22 0:29983394c6b6 1199
edamame22 0:29983394c6b6 1200 ENUM_VALUES_PER_LINE = 4
edamame22 0:29983394c6b6 1201
edamame22 0:29983394c6b6 1202 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
edamame22 0:29983394c6b6 1203 # used to set the initial width (in pixels) of the frame in which the tree
edamame22 0:29983394c6b6 1204 # is shown.
edamame22 0:29983394c6b6 1205
edamame22 0:29983394c6b6 1206 TREEVIEW_WIDTH = 250
edamame22 0:29983394c6b6 1207
edamame22 0:29983394c6b6 1208 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
edamame22 0:29983394c6b6 1209 # links to external symbols imported via tag files in a separate window.
edamame22 0:29983394c6b6 1210
edamame22 0:29983394c6b6 1211 EXT_LINKS_IN_WINDOW = NO
edamame22 0:29983394c6b6 1212
edamame22 0:29983394c6b6 1213 # Use this tag to change the font size of Latex formulas included
edamame22 0:29983394c6b6 1214 # as images in the HTML documentation. The default is 10. Note that
edamame22 0:29983394c6b6 1215 # when you change the font size after a successful doxygen run you need
edamame22 0:29983394c6b6 1216 # to manually remove any form_*.png images from the HTML output directory
edamame22 0:29983394c6b6 1217 # to force them to be regenerated.
edamame22 0:29983394c6b6 1218
edamame22 0:29983394c6b6 1219 FORMULA_FONTSIZE = 10
edamame22 0:29983394c6b6 1220
edamame22 0:29983394c6b6 1221 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
edamame22 0:29983394c6b6 1222 # generated for formulas are transparent PNGs. Transparent PNGs are
edamame22 0:29983394c6b6 1223 # not supported properly for IE 6.0, but are supported on all modern browsers.
edamame22 0:29983394c6b6 1224 # Note that when changing this option you need to delete any form_*.png files
edamame22 0:29983394c6b6 1225 # in the HTML output before the changes have effect.
edamame22 0:29983394c6b6 1226
edamame22 0:29983394c6b6 1227 FORMULA_TRANSPARENT = YES
edamame22 0:29983394c6b6 1228
edamame22 0:29983394c6b6 1229 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
edamame22 0:29983394c6b6 1230 # (see http://www.mathjax.org) which uses client side Javascript for the
edamame22 0:29983394c6b6 1231 # rendering instead of using prerendered bitmaps. Use this if you do not
edamame22 0:29983394c6b6 1232 # have LaTeX installed or if you want to formulas look prettier in the HTML
edamame22 0:29983394c6b6 1233 # output. When enabled you may also need to install MathJax separately and
edamame22 0:29983394c6b6 1234 # configure the path to it using the MATHJAX_RELPATH option.
edamame22 0:29983394c6b6 1235
edamame22 0:29983394c6b6 1236 USE_MATHJAX = NO
edamame22 0:29983394c6b6 1237
edamame22 0:29983394c6b6 1238 # When MathJax is enabled you need to specify the location relative to the
edamame22 0:29983394c6b6 1239 # HTML output directory using the MATHJAX_RELPATH option. The destination
edamame22 0:29983394c6b6 1240 # directory should contain the MathJax.js script. For instance, if the mathjax
edamame22 0:29983394c6b6 1241 # directory is located at the same level as the HTML output directory, then
edamame22 0:29983394c6b6 1242 # MATHJAX_RELPATH should be ../mathjax. The default value points to
edamame22 0:29983394c6b6 1243 # the MathJax Content Delivery Network so you can quickly see the result without
edamame22 0:29983394c6b6 1244 # installing MathJax. However, it is strongly recommended to install a local
edamame22 0:29983394c6b6 1245 # copy of MathJax from http://www.mathjax.org before deployment.
edamame22 0:29983394c6b6 1246
edamame22 0:29983394c6b6 1247 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
edamame22 0:29983394c6b6 1248
edamame22 0:29983394c6b6 1249 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
edamame22 0:29983394c6b6 1250 # names that should be enabled during MathJax rendering.
edamame22 0:29983394c6b6 1251
edamame22 0:29983394c6b6 1252 MATHJAX_EXTENSIONS =
edamame22 0:29983394c6b6 1253
edamame22 0:29983394c6b6 1254 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
edamame22 0:29983394c6b6 1255 # for the HTML output. The underlying search engine uses javascript
edamame22 0:29983394c6b6 1256 # and DHTML and should work on any modern browser. Note that when using
edamame22 0:29983394c6b6 1257 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
edamame22 0:29983394c6b6 1258 # (GENERATE_DOCSET) there is already a search function so this one should
edamame22 0:29983394c6b6 1259 # typically be disabled. For large projects the javascript based search engine
edamame22 0:29983394c6b6 1260 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
edamame22 0:29983394c6b6 1261
edamame22 0:29983394c6b6 1262 SEARCHENGINE = YES
edamame22 0:29983394c6b6 1263
edamame22 0:29983394c6b6 1264 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
edamame22 0:29983394c6b6 1265 # implemented using a PHP enabled web server instead of at the web client
edamame22 0:29983394c6b6 1266 # using Javascript. Doxygen will generate the search PHP script and index
edamame22 0:29983394c6b6 1267 # file to put on the web server. The advantage of the server
edamame22 0:29983394c6b6 1268 # based approach is that it scales better to large projects and allows
edamame22 0:29983394c6b6 1269 # full text search. The disadvantages are that it is more difficult to setup
edamame22 0:29983394c6b6 1270 # and does not have live searching capabilities.
edamame22 0:29983394c6b6 1271
edamame22 0:29983394c6b6 1272 SERVER_BASED_SEARCH = NO
edamame22 0:29983394c6b6 1273
edamame22 0:29983394c6b6 1274 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1275 # configuration options related to the LaTeX output
edamame22 0:29983394c6b6 1276 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1277
edamame22 0:29983394c6b6 1278 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 1279 # generate Latex output.
edamame22 0:29983394c6b6 1280
edamame22 0:29983394c6b6 1281 GENERATE_LATEX = NO
edamame22 0:29983394c6b6 1282
edamame22 0:29983394c6b6 1283 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
edamame22 0:29983394c6b6 1284 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
edamame22 0:29983394c6b6 1285 # put in front of it. If left blank `latex' will be used as the default path.
edamame22 0:29983394c6b6 1286
edamame22 0:29983394c6b6 1287 LATEX_OUTPUT = latex
edamame22 0:29983394c6b6 1288
edamame22 0:29983394c6b6 1289 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
edamame22 0:29983394c6b6 1290 # invoked. If left blank `latex' will be used as the default command name.
edamame22 0:29983394c6b6 1291 # Note that when enabling USE_PDFLATEX this option is only used for
edamame22 0:29983394c6b6 1292 # generating bitmaps for formulas in the HTML output, but not in the
edamame22 0:29983394c6b6 1293 # Makefile that is written to the output directory.
edamame22 0:29983394c6b6 1294
edamame22 0:29983394c6b6 1295 LATEX_CMD_NAME = latex
edamame22 0:29983394c6b6 1296
edamame22 0:29983394c6b6 1297 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
edamame22 0:29983394c6b6 1298 # generate index for LaTeX. If left blank `makeindex' will be used as the
edamame22 0:29983394c6b6 1299 # default command name.
edamame22 0:29983394c6b6 1300
edamame22 0:29983394c6b6 1301 MAKEINDEX_CMD_NAME = makeindex
edamame22 0:29983394c6b6 1302
edamame22 0:29983394c6b6 1303 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
edamame22 0:29983394c6b6 1304 # LaTeX documents. This may be useful for small projects and may help to
edamame22 0:29983394c6b6 1305 # save some trees in general.
edamame22 0:29983394c6b6 1306
edamame22 0:29983394c6b6 1307 COMPACT_LATEX = NO
edamame22 0:29983394c6b6 1308
edamame22 0:29983394c6b6 1309 # The PAPER_TYPE tag can be used to set the paper type that is used
edamame22 0:29983394c6b6 1310 # by the printer. Possible values are: a4, letter, legal and
edamame22 0:29983394c6b6 1311 # executive. If left blank a4wide will be used.
edamame22 0:29983394c6b6 1312
edamame22 0:29983394c6b6 1313 PAPER_TYPE = a4
edamame22 0:29983394c6b6 1314
edamame22 0:29983394c6b6 1315 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
edamame22 0:29983394c6b6 1316 # packages that should be included in the LaTeX output.
edamame22 0:29983394c6b6 1317
edamame22 0:29983394c6b6 1318 EXTRA_PACKAGES =
edamame22 0:29983394c6b6 1319
edamame22 0:29983394c6b6 1320 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
edamame22 0:29983394c6b6 1321 # the generated latex document. The header should contain everything until
edamame22 0:29983394c6b6 1322 # the first chapter. If it is left blank doxygen will generate a
edamame22 0:29983394c6b6 1323 # standard header. Notice: only use this tag if you know what you are doing!
edamame22 0:29983394c6b6 1324
edamame22 0:29983394c6b6 1325 LATEX_HEADER =
edamame22 0:29983394c6b6 1326
edamame22 0:29983394c6b6 1327 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
edamame22 0:29983394c6b6 1328 # the generated latex document. The footer should contain everything after
edamame22 0:29983394c6b6 1329 # the last chapter. If it is left blank doxygen will generate a
edamame22 0:29983394c6b6 1330 # standard footer. Notice: only use this tag if you know what you are doing!
edamame22 0:29983394c6b6 1331
edamame22 0:29983394c6b6 1332 LATEX_FOOTER =
edamame22 0:29983394c6b6 1333
edamame22 0:29983394c6b6 1334 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
edamame22 0:29983394c6b6 1335 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
edamame22 0:29983394c6b6 1336 # contain links (just like the HTML output) instead of page references
edamame22 0:29983394c6b6 1337 # This makes the output suitable for online browsing using a pdf viewer.
edamame22 0:29983394c6b6 1338
edamame22 0:29983394c6b6 1339 PDF_HYPERLINKS = YES
edamame22 0:29983394c6b6 1340
edamame22 0:29983394c6b6 1341 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
edamame22 0:29983394c6b6 1342 # plain latex in the generated Makefile. Set this option to YES to get a
edamame22 0:29983394c6b6 1343 # higher quality PDF documentation.
edamame22 0:29983394c6b6 1344
edamame22 0:29983394c6b6 1345 USE_PDFLATEX = YES
edamame22 0:29983394c6b6 1346
edamame22 0:29983394c6b6 1347 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
edamame22 0:29983394c6b6 1348 # command to the generated LaTeX files. This will instruct LaTeX to keep
edamame22 0:29983394c6b6 1349 # running if errors occur, instead of asking the user for help.
edamame22 0:29983394c6b6 1350 # This option is also used when generating formulas in HTML.
edamame22 0:29983394c6b6 1351
edamame22 0:29983394c6b6 1352 LATEX_BATCHMODE = NO
edamame22 0:29983394c6b6 1353
edamame22 0:29983394c6b6 1354 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
edamame22 0:29983394c6b6 1355 # include the index chapters (such as File Index, Compound Index, etc.)
edamame22 0:29983394c6b6 1356 # in the output.
edamame22 0:29983394c6b6 1357
edamame22 0:29983394c6b6 1358 LATEX_HIDE_INDICES = NO
edamame22 0:29983394c6b6 1359
edamame22 0:29983394c6b6 1360 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
edamame22 0:29983394c6b6 1361 # source code with syntax highlighting in the LaTeX output.
edamame22 0:29983394c6b6 1362 # Note that which sources are shown also depends on other settings
edamame22 0:29983394c6b6 1363 # such as SOURCE_BROWSER.
edamame22 0:29983394c6b6 1364
edamame22 0:29983394c6b6 1365 LATEX_SOURCE_CODE = NO
edamame22 0:29983394c6b6 1366
edamame22 0:29983394c6b6 1367 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
edamame22 0:29983394c6b6 1368 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
edamame22 0:29983394c6b6 1369 # http://en.wikipedia.org/wiki/BibTeX for more info.
edamame22 0:29983394c6b6 1370
edamame22 0:29983394c6b6 1371 LATEX_BIB_STYLE = plain
edamame22 0:29983394c6b6 1372
edamame22 0:29983394c6b6 1373 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1374 # configuration options related to the RTF output
edamame22 0:29983394c6b6 1375 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1376
edamame22 0:29983394c6b6 1377 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
edamame22 0:29983394c6b6 1378 # The RTF output is optimized for Word 97 and may not look very pretty with
edamame22 0:29983394c6b6 1379 # other RTF readers or editors.
edamame22 0:29983394c6b6 1380
edamame22 0:29983394c6b6 1381 GENERATE_RTF = NO
edamame22 0:29983394c6b6 1382
edamame22 0:29983394c6b6 1383 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
edamame22 0:29983394c6b6 1384 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
edamame22 0:29983394c6b6 1385 # put in front of it. If left blank `rtf' will be used as the default path.
edamame22 0:29983394c6b6 1386
edamame22 0:29983394c6b6 1387 RTF_OUTPUT = rtf
edamame22 0:29983394c6b6 1388
edamame22 0:29983394c6b6 1389 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
edamame22 0:29983394c6b6 1390 # RTF documents. This may be useful for small projects and may help to
edamame22 0:29983394c6b6 1391 # save some trees in general.
edamame22 0:29983394c6b6 1392
edamame22 0:29983394c6b6 1393 COMPACT_RTF = NO
edamame22 0:29983394c6b6 1394
edamame22 0:29983394c6b6 1395 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
edamame22 0:29983394c6b6 1396 # will contain hyperlink fields. The RTF file will
edamame22 0:29983394c6b6 1397 # contain links (just like the HTML output) instead of page references.
edamame22 0:29983394c6b6 1398 # This makes the output suitable for online browsing using WORD or other
edamame22 0:29983394c6b6 1399 # programs which support those fields.
edamame22 0:29983394c6b6 1400 # Note: wordpad (write) and others do not support links.
edamame22 0:29983394c6b6 1401
edamame22 0:29983394c6b6 1402 RTF_HYPERLINKS = NO
edamame22 0:29983394c6b6 1403
edamame22 0:29983394c6b6 1404 # Load style sheet definitions from file. Syntax is similar to doxygen's
edamame22 0:29983394c6b6 1405 # config file, i.e. a series of assignments. You only have to provide
edamame22 0:29983394c6b6 1406 # replacements, missing definitions are set to their default value.
edamame22 0:29983394c6b6 1407
edamame22 0:29983394c6b6 1408 RTF_STYLESHEET_FILE =
edamame22 0:29983394c6b6 1409
edamame22 0:29983394c6b6 1410 # Set optional variables used in the generation of an rtf document.
edamame22 0:29983394c6b6 1411 # Syntax is similar to doxygen's config file.
edamame22 0:29983394c6b6 1412
edamame22 0:29983394c6b6 1413 RTF_EXTENSIONS_FILE =
edamame22 0:29983394c6b6 1414
edamame22 0:29983394c6b6 1415 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1416 # configuration options related to the man page output
edamame22 0:29983394c6b6 1417 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1418
edamame22 0:29983394c6b6 1419 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 1420 # generate man pages
edamame22 0:29983394c6b6 1421
edamame22 0:29983394c6b6 1422 GENERATE_MAN = NO
edamame22 0:29983394c6b6 1423
edamame22 0:29983394c6b6 1424 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
edamame22 0:29983394c6b6 1425 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
edamame22 0:29983394c6b6 1426 # put in front of it. If left blank `man' will be used as the default path.
edamame22 0:29983394c6b6 1427
edamame22 0:29983394c6b6 1428 MAN_OUTPUT = man
edamame22 0:29983394c6b6 1429
edamame22 0:29983394c6b6 1430 # The MAN_EXTENSION tag determines the extension that is added to
edamame22 0:29983394c6b6 1431 # the generated man pages (default is the subroutine's section .3)
edamame22 0:29983394c6b6 1432
edamame22 0:29983394c6b6 1433 MAN_EXTENSION = .3
edamame22 0:29983394c6b6 1434
edamame22 0:29983394c6b6 1435 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
edamame22 0:29983394c6b6 1436 # then it will generate one additional man file for each entity
edamame22 0:29983394c6b6 1437 # documented in the real man page(s). These additional files
edamame22 0:29983394c6b6 1438 # only source the real man page, but without them the man command
edamame22 0:29983394c6b6 1439 # would be unable to find the correct page. The default is NO.
edamame22 0:29983394c6b6 1440
edamame22 0:29983394c6b6 1441 MAN_LINKS = NO
edamame22 0:29983394c6b6 1442
edamame22 0:29983394c6b6 1443 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1444 # configuration options related to the XML output
edamame22 0:29983394c6b6 1445 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1446
edamame22 0:29983394c6b6 1447 # If the GENERATE_XML tag is set to YES Doxygen will
edamame22 0:29983394c6b6 1448 # generate an XML file that captures the structure of
edamame22 0:29983394c6b6 1449 # the code including all documentation.
edamame22 0:29983394c6b6 1450
edamame22 0:29983394c6b6 1451 GENERATE_XML = NO
edamame22 0:29983394c6b6 1452
edamame22 0:29983394c6b6 1453 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
edamame22 0:29983394c6b6 1454 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
edamame22 0:29983394c6b6 1455 # put in front of it. If left blank `xml' will be used as the default path.
edamame22 0:29983394c6b6 1456
edamame22 0:29983394c6b6 1457 XML_OUTPUT = xml
edamame22 0:29983394c6b6 1458
edamame22 0:29983394c6b6 1459 # The XML_SCHEMA tag can be used to specify an XML schema,
edamame22 0:29983394c6b6 1460 # which can be used by a validating XML parser to check the
edamame22 0:29983394c6b6 1461 # syntax of the XML files.
edamame22 0:29983394c6b6 1462
edamame22 0:29983394c6b6 1463 XML_SCHEMA =
edamame22 0:29983394c6b6 1464
edamame22 0:29983394c6b6 1465 # The XML_DTD tag can be used to specify an XML DTD,
edamame22 0:29983394c6b6 1466 # which can be used by a validating XML parser to check the
edamame22 0:29983394c6b6 1467 # syntax of the XML files.
edamame22 0:29983394c6b6 1468
edamame22 0:29983394c6b6 1469 XML_DTD =
edamame22 0:29983394c6b6 1470
edamame22 0:29983394c6b6 1471 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
edamame22 0:29983394c6b6 1472 # dump the program listings (including syntax highlighting
edamame22 0:29983394c6b6 1473 # and cross-referencing information) to the XML output. Note that
edamame22 0:29983394c6b6 1474 # enabling this will significantly increase the size of the XML output.
edamame22 0:29983394c6b6 1475
edamame22 0:29983394c6b6 1476 XML_PROGRAMLISTING = YES
edamame22 0:29983394c6b6 1477
edamame22 0:29983394c6b6 1478 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1479 # configuration options for the AutoGen Definitions output
edamame22 0:29983394c6b6 1480 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1481
edamame22 0:29983394c6b6 1482 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
edamame22 0:29983394c6b6 1483 # generate an AutoGen Definitions (see autogen.sf.net) file
edamame22 0:29983394c6b6 1484 # that captures the structure of the code including all
edamame22 0:29983394c6b6 1485 # documentation. Note that this feature is still experimental
edamame22 0:29983394c6b6 1486 # and incomplete at the moment.
edamame22 0:29983394c6b6 1487
edamame22 0:29983394c6b6 1488 GENERATE_AUTOGEN_DEF = NO
edamame22 0:29983394c6b6 1489
edamame22 0:29983394c6b6 1490 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1491 # configuration options related to the Perl module output
edamame22 0:29983394c6b6 1492 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1493
edamame22 0:29983394c6b6 1494 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
edamame22 0:29983394c6b6 1495 # generate a Perl module file that captures the structure of
edamame22 0:29983394c6b6 1496 # the code including all documentation. Note that this
edamame22 0:29983394c6b6 1497 # feature is still experimental and incomplete at the
edamame22 0:29983394c6b6 1498 # moment.
edamame22 0:29983394c6b6 1499
edamame22 0:29983394c6b6 1500 GENERATE_PERLMOD = NO
edamame22 0:29983394c6b6 1501
edamame22 0:29983394c6b6 1502 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
edamame22 0:29983394c6b6 1503 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
edamame22 0:29983394c6b6 1504 # to generate PDF and DVI output from the Perl module output.
edamame22 0:29983394c6b6 1505
edamame22 0:29983394c6b6 1506 PERLMOD_LATEX = NO
edamame22 0:29983394c6b6 1507
edamame22 0:29983394c6b6 1508 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
edamame22 0:29983394c6b6 1509 # nicely formatted so it can be parsed by a human reader. This is useful
edamame22 0:29983394c6b6 1510 # if you want to understand what is going on. On the other hand, if this
edamame22 0:29983394c6b6 1511 # tag is set to NO the size of the Perl module output will be much smaller
edamame22 0:29983394c6b6 1512 # and Perl will parse it just the same.
edamame22 0:29983394c6b6 1513
edamame22 0:29983394c6b6 1514 PERLMOD_PRETTY = YES
edamame22 0:29983394c6b6 1515
edamame22 0:29983394c6b6 1516 # The names of the make variables in the generated doxyrules.make file
edamame22 0:29983394c6b6 1517 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
edamame22 0:29983394c6b6 1518 # This is useful so different doxyrules.make files included by the same
edamame22 0:29983394c6b6 1519 # Makefile don't overwrite each other's variables.
edamame22 0:29983394c6b6 1520
edamame22 0:29983394c6b6 1521 PERLMOD_MAKEVAR_PREFIX =
edamame22 0:29983394c6b6 1522
edamame22 0:29983394c6b6 1523 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1524 # Configuration options related to the preprocessor
edamame22 0:29983394c6b6 1525 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1526
edamame22 0:29983394c6b6 1527 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 1528 # evaluate all C-preprocessor directives found in the sources and include
edamame22 0:29983394c6b6 1529 # files.
edamame22 0:29983394c6b6 1530
edamame22 0:29983394c6b6 1531 ENABLE_PREPROCESSING = YES
edamame22 0:29983394c6b6 1532
edamame22 0:29983394c6b6 1533 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
edamame22 0:29983394c6b6 1534 # names in the source code. If set to NO (the default) only conditional
edamame22 0:29983394c6b6 1535 # compilation will be performed. Macro expansion can be done in a controlled
edamame22 0:29983394c6b6 1536 # way by setting EXPAND_ONLY_PREDEF to YES.
edamame22 0:29983394c6b6 1537
edamame22 0:29983394c6b6 1538 MACRO_EXPANSION = NO
edamame22 0:29983394c6b6 1539
edamame22 0:29983394c6b6 1540 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
edamame22 0:29983394c6b6 1541 # then the macro expansion is limited to the macros specified with the
edamame22 0:29983394c6b6 1542 # PREDEFINED and EXPAND_AS_DEFINED tags.
edamame22 0:29983394c6b6 1543
edamame22 0:29983394c6b6 1544 EXPAND_ONLY_PREDEF = NO
edamame22 0:29983394c6b6 1545
edamame22 0:29983394c6b6 1546 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
edamame22 0:29983394c6b6 1547 # pointed to by INCLUDE_PATH will be searched when a #include is found.
edamame22 0:29983394c6b6 1548
edamame22 0:29983394c6b6 1549 SEARCH_INCLUDES = YES
edamame22 0:29983394c6b6 1550
edamame22 0:29983394c6b6 1551 # The INCLUDE_PATH tag can be used to specify one or more directories that
edamame22 0:29983394c6b6 1552 # contain include files that are not input files but should be processed by
edamame22 0:29983394c6b6 1553 # the preprocessor.
edamame22 0:29983394c6b6 1554
edamame22 0:29983394c6b6 1555 INCLUDE_PATH =
edamame22 0:29983394c6b6 1556
edamame22 0:29983394c6b6 1557 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
edamame22 0:29983394c6b6 1558 # patterns (like *.h and *.hpp) to filter out the header-files in the
edamame22 0:29983394c6b6 1559 # directories. If left blank, the patterns specified with FILE_PATTERNS will
edamame22 0:29983394c6b6 1560 # be used.
edamame22 0:29983394c6b6 1561
edamame22 0:29983394c6b6 1562 INCLUDE_FILE_PATTERNS =
edamame22 0:29983394c6b6 1563
edamame22 0:29983394c6b6 1564 # The PREDEFINED tag can be used to specify one or more macro names that
edamame22 0:29983394c6b6 1565 # are defined before the preprocessor is started (similar to the -D option of
edamame22 0:29983394c6b6 1566 # gcc). The argument of the tag is a list of macros of the form: name
edamame22 0:29983394c6b6 1567 # or name=definition (no spaces). If the definition and the = are
edamame22 0:29983394c6b6 1568 # omitted =1 is assumed. To prevent a macro definition from being
edamame22 0:29983394c6b6 1569 # undefined via #undef or recursively expanded use the := operator
edamame22 0:29983394c6b6 1570 # instead of the = operator.
edamame22 0:29983394c6b6 1571
edamame22 0:29983394c6b6 1572 PREDEFINED =
edamame22 0:29983394c6b6 1573
edamame22 0:29983394c6b6 1574 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
edamame22 0:29983394c6b6 1575 # this tag can be used to specify a list of macro names that should be expanded.
edamame22 0:29983394c6b6 1576 # The macro definition that is found in the sources will be used.
edamame22 0:29983394c6b6 1577 # Use the PREDEFINED tag if you want to use a different macro definition that
edamame22 0:29983394c6b6 1578 # overrules the definition found in the source code.
edamame22 0:29983394c6b6 1579
edamame22 0:29983394c6b6 1580 EXPAND_AS_DEFINED =
edamame22 0:29983394c6b6 1581
edamame22 0:29983394c6b6 1582 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
edamame22 0:29983394c6b6 1583 # doxygen's preprocessor will remove all references to function-like macros
edamame22 0:29983394c6b6 1584 # that are alone on a line, have an all uppercase name, and do not end with a
edamame22 0:29983394c6b6 1585 # semicolon, because these will confuse the parser if not removed.
edamame22 0:29983394c6b6 1586
edamame22 0:29983394c6b6 1587 SKIP_FUNCTION_MACROS = YES
edamame22 0:29983394c6b6 1588
edamame22 0:29983394c6b6 1589 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1590 # Configuration::additions related to external references
edamame22 0:29983394c6b6 1591 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1592
edamame22 0:29983394c6b6 1593 # The TAGFILES option can be used to specify one or more tagfiles. For each
edamame22 0:29983394c6b6 1594 # tag file the location of the external documentation should be added. The
edamame22 0:29983394c6b6 1595 # format of a tag file without this location is as follows:
edamame22 0:29983394c6b6 1596 # TAGFILES = file1 file2 ...
edamame22 0:29983394c6b6 1597 # Adding location for the tag files is done as follows:
edamame22 0:29983394c6b6 1598 # TAGFILES = file1=loc1 "file2 = loc2" ...
edamame22 0:29983394c6b6 1599 # where "loc1" and "loc2" can be relative or absolute paths
edamame22 0:29983394c6b6 1600 # or URLs. Note that each tag file must have a unique name (where the name does
edamame22 0:29983394c6b6 1601 # NOT include the path). If a tag file is not located in the directory in which
edamame22 0:29983394c6b6 1602 # doxygen is run, you must also specify the path to the tagfile here.
edamame22 0:29983394c6b6 1603
edamame22 0:29983394c6b6 1604 TAGFILES =
edamame22 0:29983394c6b6 1605
edamame22 0:29983394c6b6 1606 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
edamame22 0:29983394c6b6 1607 # a tag file that is based on the input files it reads.
edamame22 0:29983394c6b6 1608
edamame22 0:29983394c6b6 1609 GENERATE_TAGFILE =
edamame22 0:29983394c6b6 1610
edamame22 0:29983394c6b6 1611 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
edamame22 0:29983394c6b6 1612 # in the class index. If set to NO only the inherited external classes
edamame22 0:29983394c6b6 1613 # will be listed.
edamame22 0:29983394c6b6 1614
edamame22 0:29983394c6b6 1615 ALLEXTERNALS = NO
edamame22 0:29983394c6b6 1616
edamame22 0:29983394c6b6 1617 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
edamame22 0:29983394c6b6 1618 # in the modules index. If set to NO, only the current project's groups will
edamame22 0:29983394c6b6 1619 # be listed.
edamame22 0:29983394c6b6 1620
edamame22 0:29983394c6b6 1621 EXTERNAL_GROUPS = YES
edamame22 0:29983394c6b6 1622
edamame22 0:29983394c6b6 1623 # The PERL_PATH should be the absolute path and name of the perl script
edamame22 0:29983394c6b6 1624 # interpreter (i.e. the result of `which perl').
edamame22 0:29983394c6b6 1625
edamame22 0:29983394c6b6 1626 PERL_PATH = /usr/bin/perl
edamame22 0:29983394c6b6 1627
edamame22 0:29983394c6b6 1628 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1629 # Configuration options related to the dot tool
edamame22 0:29983394c6b6 1630 #---------------------------------------------------------------------------
edamame22 0:29983394c6b6 1631
edamame22 0:29983394c6b6 1632 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 1633 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
edamame22 0:29983394c6b6 1634 # or super classes. Setting the tag to NO turns the diagrams off. Note that
edamame22 0:29983394c6b6 1635 # this option also works with HAVE_DOT disabled, but it is recommended to
edamame22 0:29983394c6b6 1636 # install and use dot, since it yields more powerful graphs.
edamame22 0:29983394c6b6 1637
edamame22 0:29983394c6b6 1638 CLASS_DIAGRAMS = NO
edamame22 0:29983394c6b6 1639
edamame22 0:29983394c6b6 1640 # You can define message sequence charts within doxygen comments using the \msc
edamame22 0:29983394c6b6 1641 # command. Doxygen will then run the mscgen tool (see
edamame22 0:29983394c6b6 1642 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
edamame22 0:29983394c6b6 1643 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
edamame22 0:29983394c6b6 1644 # the mscgen tool resides. If left empty the tool is assumed to be found in the
edamame22 0:29983394c6b6 1645 # default search path.
edamame22 0:29983394c6b6 1646
edamame22 0:29983394c6b6 1647 MSCGEN_PATH =
edamame22 0:29983394c6b6 1648
edamame22 0:29983394c6b6 1649 # If set to YES, the inheritance and collaboration graphs will hide
edamame22 0:29983394c6b6 1650 # inheritance and usage relations if the target is undocumented
edamame22 0:29983394c6b6 1651 # or is not a class.
edamame22 0:29983394c6b6 1652
edamame22 0:29983394c6b6 1653 HIDE_UNDOC_RELATIONS = YES
edamame22 0:29983394c6b6 1654
edamame22 0:29983394c6b6 1655 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
edamame22 0:29983394c6b6 1656 # available from the path. This tool is part of Graphviz, a graph visualization
edamame22 0:29983394c6b6 1657 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
edamame22 0:29983394c6b6 1658 # have no effect if this option is set to NO (the default)
edamame22 0:29983394c6b6 1659
edamame22 0:29983394c6b6 1660 HAVE_DOT = NO
edamame22 0:29983394c6b6 1661
edamame22 0:29983394c6b6 1662 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
edamame22 0:29983394c6b6 1663 # allowed to run in parallel. When set to 0 (the default) doxygen will
edamame22 0:29983394c6b6 1664 # base this on the number of processors available in the system. You can set it
edamame22 0:29983394c6b6 1665 # explicitly to a value larger than 0 to get control over the balance
edamame22 0:29983394c6b6 1666 # between CPU load and processing speed.
edamame22 0:29983394c6b6 1667
edamame22 0:29983394c6b6 1668 DOT_NUM_THREADS = 0
edamame22 0:29983394c6b6 1669
edamame22 0:29983394c6b6 1670 # By default doxygen will use the Helvetica font for all dot files that
edamame22 0:29983394c6b6 1671 # doxygen generates. When you want a differently looking font you can specify
edamame22 0:29983394c6b6 1672 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
edamame22 0:29983394c6b6 1673 # the font, which can be done by putting it in a standard location or by setting
edamame22 0:29983394c6b6 1674 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
edamame22 0:29983394c6b6 1675 # directory containing the font.
edamame22 0:29983394c6b6 1676
edamame22 0:29983394c6b6 1677 DOT_FONTNAME = Helvetica
edamame22 0:29983394c6b6 1678
edamame22 0:29983394c6b6 1679 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
edamame22 0:29983394c6b6 1680 # The default size is 10pt.
edamame22 0:29983394c6b6 1681
edamame22 0:29983394c6b6 1682 DOT_FONTSIZE = 10
edamame22 0:29983394c6b6 1683
edamame22 0:29983394c6b6 1684 # By default doxygen will tell dot to use the Helvetica font.
edamame22 0:29983394c6b6 1685 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
edamame22 0:29983394c6b6 1686 # set the path where dot can find it.
edamame22 0:29983394c6b6 1687
edamame22 0:29983394c6b6 1688 DOT_FONTPATH =
edamame22 0:29983394c6b6 1689
edamame22 0:29983394c6b6 1690 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
edamame22 0:29983394c6b6 1691 # will generate a graph for each documented class showing the direct and
edamame22 0:29983394c6b6 1692 # indirect inheritance relations. Setting this tag to YES will force the
edamame22 0:29983394c6b6 1693 # CLASS_DIAGRAMS tag to NO.
edamame22 0:29983394c6b6 1694
edamame22 0:29983394c6b6 1695 CLASS_GRAPH = YES
edamame22 0:29983394c6b6 1696
edamame22 0:29983394c6b6 1697 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
edamame22 0:29983394c6b6 1698 # will generate a graph for each documented class showing the direct and
edamame22 0:29983394c6b6 1699 # indirect implementation dependencies (inheritance, containment, and
edamame22 0:29983394c6b6 1700 # class references variables) of the class with other documented classes.
edamame22 0:29983394c6b6 1701
edamame22 0:29983394c6b6 1702 COLLABORATION_GRAPH = YES
edamame22 0:29983394c6b6 1703
edamame22 0:29983394c6b6 1704 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
edamame22 0:29983394c6b6 1705 # will generate a graph for groups, showing the direct groups dependencies
edamame22 0:29983394c6b6 1706
edamame22 0:29983394c6b6 1707 GROUP_GRAPHS = YES
edamame22 0:29983394c6b6 1708
edamame22 0:29983394c6b6 1709 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
edamame22 0:29983394c6b6 1710 # collaboration diagrams in a style similar to the OMG's Unified Modeling
edamame22 0:29983394c6b6 1711 # Language.
edamame22 0:29983394c6b6 1712
edamame22 0:29983394c6b6 1713 UML_LOOK = NO
edamame22 0:29983394c6b6 1714
edamame22 0:29983394c6b6 1715 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
edamame22 0:29983394c6b6 1716 # the class node. If there are many fields or methods and many nodes the
edamame22 0:29983394c6b6 1717 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
edamame22 0:29983394c6b6 1718 # threshold limits the number of items for each type to make the size more
edamame22 0:29983394c6b6 1719 # managable. Set this to 0 for no limit. Note that the threshold may be
edamame22 0:29983394c6b6 1720 # exceeded by 50% before the limit is enforced.
edamame22 0:29983394c6b6 1721
edamame22 0:29983394c6b6 1722 UML_LIMIT_NUM_FIELDS = 10
edamame22 0:29983394c6b6 1723
edamame22 0:29983394c6b6 1724 # If set to YES, the inheritance and collaboration graphs will show the
edamame22 0:29983394c6b6 1725 # relations between templates and their instances.
edamame22 0:29983394c6b6 1726
edamame22 0:29983394c6b6 1727 TEMPLATE_RELATIONS = NO
edamame22 0:29983394c6b6 1728
edamame22 0:29983394c6b6 1729 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
edamame22 0:29983394c6b6 1730 # tags are set to YES then doxygen will generate a graph for each documented
edamame22 0:29983394c6b6 1731 # file showing the direct and indirect include dependencies of the file with
edamame22 0:29983394c6b6 1732 # other documented files.
edamame22 0:29983394c6b6 1733
edamame22 0:29983394c6b6 1734 INCLUDE_GRAPH = YES
edamame22 0:29983394c6b6 1735
edamame22 0:29983394c6b6 1736 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
edamame22 0:29983394c6b6 1737 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
edamame22 0:29983394c6b6 1738 # documented header file showing the documented files that directly or
edamame22 0:29983394c6b6 1739 # indirectly include this file.
edamame22 0:29983394c6b6 1740
edamame22 0:29983394c6b6 1741 INCLUDED_BY_GRAPH = YES
edamame22 0:29983394c6b6 1742
edamame22 0:29983394c6b6 1743 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
edamame22 0:29983394c6b6 1744 # doxygen will generate a call dependency graph for every global function
edamame22 0:29983394c6b6 1745 # or class method. Note that enabling this option will significantly increase
edamame22 0:29983394c6b6 1746 # the time of a run. So in most cases it will be better to enable call graphs
edamame22 0:29983394c6b6 1747 # for selected functions only using the \callgraph command.
edamame22 0:29983394c6b6 1748
edamame22 0:29983394c6b6 1749 CALL_GRAPH = YES
edamame22 0:29983394c6b6 1750
edamame22 0:29983394c6b6 1751 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
edamame22 0:29983394c6b6 1752 # doxygen will generate a caller dependency graph for every global function
edamame22 0:29983394c6b6 1753 # or class method. Note that enabling this option will significantly increase
edamame22 0:29983394c6b6 1754 # the time of a run. So in most cases it will be better to enable caller
edamame22 0:29983394c6b6 1755 # graphs for selected functions only using the \callergraph command.
edamame22 0:29983394c6b6 1756
edamame22 0:29983394c6b6 1757 CALLER_GRAPH = YES
edamame22 0:29983394c6b6 1758
edamame22 0:29983394c6b6 1759 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
edamame22 0:29983394c6b6 1760 # will generate a graphical hierarchy of all classes instead of a textual one.
edamame22 0:29983394c6b6 1761
edamame22 0:29983394c6b6 1762 GRAPHICAL_HIERARCHY = YES
edamame22 0:29983394c6b6 1763
edamame22 0:29983394c6b6 1764 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
edamame22 0:29983394c6b6 1765 # then doxygen will show the dependencies a directory has on other directories
edamame22 0:29983394c6b6 1766 # in a graphical way. The dependency relations are determined by the #include
edamame22 0:29983394c6b6 1767 # relations between the files in the directories.
edamame22 0:29983394c6b6 1768
edamame22 0:29983394c6b6 1769 DIRECTORY_GRAPH = YES
edamame22 0:29983394c6b6 1770
edamame22 0:29983394c6b6 1771 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
edamame22 0:29983394c6b6 1772 # generated by dot. Possible values are svg, png, jpg, or gif.
edamame22 0:29983394c6b6 1773 # If left blank png will be used. If you choose svg you need to set
edamame22 0:29983394c6b6 1774 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
edamame22 0:29983394c6b6 1775 # visible in IE 9+ (other browsers do not have this requirement).
edamame22 0:29983394c6b6 1776
edamame22 0:29983394c6b6 1777 DOT_IMAGE_FORMAT = png
edamame22 0:29983394c6b6 1778
edamame22 0:29983394c6b6 1779 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
edamame22 0:29983394c6b6 1780 # enable generation of interactive SVG images that allow zooming and panning.
edamame22 0:29983394c6b6 1781 # Note that this requires a modern browser other than Internet Explorer.
edamame22 0:29983394c6b6 1782 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
edamame22 0:29983394c6b6 1783 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
edamame22 0:29983394c6b6 1784 # visible. Older versions of IE do not have SVG support.
edamame22 0:29983394c6b6 1785
edamame22 0:29983394c6b6 1786 INTERACTIVE_SVG = NO
edamame22 0:29983394c6b6 1787
edamame22 0:29983394c6b6 1788 # The tag DOT_PATH can be used to specify the path where the dot tool can be
edamame22 0:29983394c6b6 1789 # found. If left blank, it is assumed the dot tool can be found in the path.
edamame22 0:29983394c6b6 1790
edamame22 0:29983394c6b6 1791 DOT_PATH =
edamame22 0:29983394c6b6 1792
edamame22 0:29983394c6b6 1793 # The DOTFILE_DIRS tag can be used to specify one or more directories that
edamame22 0:29983394c6b6 1794 # contain dot files that are included in the documentation (see the
edamame22 0:29983394c6b6 1795 # \dotfile command).
edamame22 0:29983394c6b6 1796
edamame22 0:29983394c6b6 1797 DOTFILE_DIRS =
edamame22 0:29983394c6b6 1798
edamame22 0:29983394c6b6 1799 # The MSCFILE_DIRS tag can be used to specify one or more directories that
edamame22 0:29983394c6b6 1800 # contain msc files that are included in the documentation (see the
edamame22 0:29983394c6b6 1801 # \mscfile command).
edamame22 0:29983394c6b6 1802
edamame22 0:29983394c6b6 1803 MSCFILE_DIRS =
edamame22 0:29983394c6b6 1804
edamame22 0:29983394c6b6 1805 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
edamame22 0:29983394c6b6 1806 # nodes that will be shown in the graph. If the number of nodes in a graph
edamame22 0:29983394c6b6 1807 # becomes larger than this value, doxygen will truncate the graph, which is
edamame22 0:29983394c6b6 1808 # visualized by representing a node as a red box. Note that doxygen if the
edamame22 0:29983394c6b6 1809 # number of direct children of the root node in a graph is already larger than
edamame22 0:29983394c6b6 1810 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
edamame22 0:29983394c6b6 1811 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
edamame22 0:29983394c6b6 1812
edamame22 0:29983394c6b6 1813 DOT_GRAPH_MAX_NODES = 44
edamame22 0:29983394c6b6 1814
edamame22 0:29983394c6b6 1815 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
edamame22 0:29983394c6b6 1816 # graphs generated by dot. A depth value of 3 means that only nodes reachable
edamame22 0:29983394c6b6 1817 # from the root by following a path via at most 3 edges will be shown. Nodes
edamame22 0:29983394c6b6 1818 # that lay further from the root node will be omitted. Note that setting this
edamame22 0:29983394c6b6 1819 # option to 1 or 2 may greatly reduce the computation time needed for large
edamame22 0:29983394c6b6 1820 # code bases. Also note that the size of a graph can be further restricted by
edamame22 0:29983394c6b6 1821 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
edamame22 0:29983394c6b6 1822
edamame22 0:29983394c6b6 1823 MAX_DOT_GRAPH_DEPTH = 0
edamame22 0:29983394c6b6 1824
edamame22 0:29983394c6b6 1825 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
edamame22 0:29983394c6b6 1826 # background. This is disabled by default, because dot on Windows does not
edamame22 0:29983394c6b6 1827 # seem to support this out of the box. Warning: Depending on the platform used,
edamame22 0:29983394c6b6 1828 # enabling this option may lead to badly anti-aliased labels on the edges of
edamame22 0:29983394c6b6 1829 # a graph (i.e. they become hard to read).
edamame22 0:29983394c6b6 1830
edamame22 0:29983394c6b6 1831 DOT_TRANSPARENT = NO
edamame22 0:29983394c6b6 1832
edamame22 0:29983394c6b6 1833 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
edamame22 0:29983394c6b6 1834 # files in one run (i.e. multiple -o and -T options on the command line). This
edamame22 0:29983394c6b6 1835 # makes dot run faster, but since only newer versions of dot (>1.8.10)
edamame22 0:29983394c6b6 1836 # support this, this feature is disabled by default.
edamame22 0:29983394c6b6 1837
edamame22 0:29983394c6b6 1838 DOT_MULTI_TARGETS = NO
edamame22 0:29983394c6b6 1839
edamame22 0:29983394c6b6 1840 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 1841 # generate a legend page explaining the meaning of the various boxes and
edamame22 0:29983394c6b6 1842 # arrows in the dot generated graphs.
edamame22 0:29983394c6b6 1843
edamame22 0:29983394c6b6 1844 GENERATE_LEGEND = YES
edamame22 0:29983394c6b6 1845
edamame22 0:29983394c6b6 1846 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
edamame22 0:29983394c6b6 1847 # remove the intermediate dot files that are used to generate
edamame22 0:29983394c6b6 1848 # the various graphs.
edamame22 0:29983394c6b6 1849
edamame22 0:29983394c6b6 1850 DOT_CLEANUP = YES