游戏王对战板,目前code还是空的

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WFKnight 0:9b3d4731edbb 1 # Doxyfile 1.8.13
WFKnight 0:9b3d4731edbb 2
WFKnight 0:9b3d4731edbb 3 # This file describes the settings to be used by the documentation system
WFKnight 0:9b3d4731edbb 4 # doxygen (www.doxygen.org) for a project.
WFKnight 0:9b3d4731edbb 5 #
WFKnight 0:9b3d4731edbb 6 # All text after a double hash (##) is considered a comment and is placed in
WFKnight 0:9b3d4731edbb 7 # front of the TAG it is preceding.
WFKnight 0:9b3d4731edbb 8 #
WFKnight 0:9b3d4731edbb 9 # All text after a single hash (#) is considered a comment and will be ignored.
WFKnight 0:9b3d4731edbb 10 # The format is:
WFKnight 0:9b3d4731edbb 11 # TAG = value [value, ...]
WFKnight 0:9b3d4731edbb 12 # For lists, items can also be appended using:
WFKnight 0:9b3d4731edbb 13 # TAG += value [value, ...]
WFKnight 0:9b3d4731edbb 14 # Values that contain spaces should be placed between quotes (\" \").
WFKnight 0:9b3d4731edbb 15
WFKnight 0:9b3d4731edbb 16 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 17 # Project related configuration options
WFKnight 0:9b3d4731edbb 18 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 19
WFKnight 0:9b3d4731edbb 20 # This tag specifies the encoding used for all characters in the config file
WFKnight 0:9b3d4731edbb 21 # that follow. The default is UTF-8 which is also the encoding used for all text
WFKnight 0:9b3d4731edbb 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
WFKnight 0:9b3d4731edbb 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
WFKnight 0:9b3d4731edbb 24 # for the list of possible encodings.
WFKnight 0:9b3d4731edbb 25 # The default value is: UTF-8.
WFKnight 0:9b3d4731edbb 26
WFKnight 0:9b3d4731edbb 27 DOXYFILE_ENCODING = UTF-8
WFKnight 0:9b3d4731edbb 28
WFKnight 0:9b3d4731edbb 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
WFKnight 0:9b3d4731edbb 30 # double-quotes, unless you are using Doxywizard) that should identify the
WFKnight 0:9b3d4731edbb 31 # project for which the documentation is generated. This name is used in the
WFKnight 0:9b3d4731edbb 32 # title of most generated pages and in a few other places.
WFKnight 0:9b3d4731edbb 33 # The default value is: My Project.
WFKnight 0:9b3d4731edbb 34
WFKnight 0:9b3d4731edbb 35 PROJECT_NAME = "Mbed OS Reference"
WFKnight 0:9b3d4731edbb 36
WFKnight 0:9b3d4731edbb 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
WFKnight 0:9b3d4731edbb 38 # could be handy for archiving the generated documentation or if some version
WFKnight 0:9b3d4731edbb 39 # control system is used.
WFKnight 0:9b3d4731edbb 40
WFKnight 0:9b3d4731edbb 41 PROJECT_NUMBER =
WFKnight 0:9b3d4731edbb 42
WFKnight 0:9b3d4731edbb 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
WFKnight 0:9b3d4731edbb 44 # for a project that appears at the top of each page and should give viewer a
WFKnight 0:9b3d4731edbb 45 # quick idea about the purpose of the project. Keep the description short.
WFKnight 0:9b3d4731edbb 46
WFKnight 0:9b3d4731edbb 47 PROJECT_BRIEF =
WFKnight 0:9b3d4731edbb 48
WFKnight 0:9b3d4731edbb 49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
WFKnight 0:9b3d4731edbb 50 # in the documentation. The maximum height of the logo should not exceed 55
WFKnight 0:9b3d4731edbb 51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
WFKnight 0:9b3d4731edbb 52 # the logo to the output directory.
WFKnight 0:9b3d4731edbb 53
WFKnight 0:9b3d4731edbb 54 PROJECT_LOGO =
WFKnight 0:9b3d4731edbb 55
WFKnight 0:9b3d4731edbb 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
WFKnight 0:9b3d4731edbb 57 # into which the generated documentation will be written. If a relative path is
WFKnight 0:9b3d4731edbb 58 # entered, it will be relative to the location where doxygen was started. If
WFKnight 0:9b3d4731edbb 59 # left blank the current directory will be used.
WFKnight 0:9b3d4731edbb 60
WFKnight 0:9b3d4731edbb 61 OUTPUT_DIRECTORY =
WFKnight 0:9b3d4731edbb 62
WFKnight 0:9b3d4731edbb 63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
WFKnight 0:9b3d4731edbb 64 # directories (in 2 levels) under the output directory of each output format and
WFKnight 0:9b3d4731edbb 65 # will distribute the generated files over these directories. Enabling this
WFKnight 0:9b3d4731edbb 66 # option can be useful when feeding doxygen a huge amount of source files, where
WFKnight 0:9b3d4731edbb 67 # putting all generated files in the same directory would otherwise causes
WFKnight 0:9b3d4731edbb 68 # performance problems for the file system.
WFKnight 0:9b3d4731edbb 69 # The default value is: NO.
WFKnight 0:9b3d4731edbb 70
WFKnight 0:9b3d4731edbb 71 CREATE_SUBDIRS = NO
WFKnight 0:9b3d4731edbb 72
WFKnight 0:9b3d4731edbb 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
WFKnight 0:9b3d4731edbb 74 # characters to appear in the names of generated files. If set to NO, non-ASCII
WFKnight 0:9b3d4731edbb 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
WFKnight 0:9b3d4731edbb 76 # U+3044.
WFKnight 0:9b3d4731edbb 77 # The default value is: NO.
WFKnight 0:9b3d4731edbb 78
WFKnight 0:9b3d4731edbb 79 #ALLOW_UNICODE_NAMES = NO
WFKnight 0:9b3d4731edbb 80
WFKnight 0:9b3d4731edbb 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
WFKnight 0:9b3d4731edbb 82 # documentation generated by doxygen is written. Doxygen will use this
WFKnight 0:9b3d4731edbb 83 # information to generate all constant output in the proper language.
WFKnight 0:9b3d4731edbb 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
WFKnight 0:9b3d4731edbb 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
WFKnight 0:9b3d4731edbb 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
WFKnight 0:9b3d4731edbb 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
WFKnight 0:9b3d4731edbb 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
WFKnight 0:9b3d4731edbb 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
WFKnight 0:9b3d4731edbb 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
WFKnight 0:9b3d4731edbb 91 # Ukrainian and Vietnamese.
WFKnight 0:9b3d4731edbb 92 # The default value is: English.
WFKnight 0:9b3d4731edbb 93
WFKnight 0:9b3d4731edbb 94 OUTPUT_LANGUAGE = English
WFKnight 0:9b3d4731edbb 95
WFKnight 0:9b3d4731edbb 96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
WFKnight 0:9b3d4731edbb 97 # descriptions after the members that are listed in the file and class
WFKnight 0:9b3d4731edbb 98 # documentation (similar to Javadoc). Set to NO to disable this.
WFKnight 0:9b3d4731edbb 99 # The default value is: YES.
WFKnight 0:9b3d4731edbb 100
WFKnight 0:9b3d4731edbb 101 BRIEF_MEMBER_DESC = YES
WFKnight 0:9b3d4731edbb 102
WFKnight 0:9b3d4731edbb 103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
WFKnight 0:9b3d4731edbb 104 # description of a member or function before the detailed description
WFKnight 0:9b3d4731edbb 105 #
WFKnight 0:9b3d4731edbb 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
WFKnight 0:9b3d4731edbb 107 # brief descriptions will be completely suppressed.
WFKnight 0:9b3d4731edbb 108 # The default value is: YES.
WFKnight 0:9b3d4731edbb 109
WFKnight 0:9b3d4731edbb 110 REPEAT_BRIEF = YES
WFKnight 0:9b3d4731edbb 111
WFKnight 0:9b3d4731edbb 112 # This tag implements a quasi-intelligent brief description abbreviator that is
WFKnight 0:9b3d4731edbb 113 # used to form the text in various listings. Each string in this list, if found
WFKnight 0:9b3d4731edbb 114 # as the leading text of the brief description, will be stripped from the text
WFKnight 0:9b3d4731edbb 115 # and the result, after processing the whole list, is used as the annotated
WFKnight 0:9b3d4731edbb 116 # text. Otherwise, the brief description is used as-is. If left blank, the
WFKnight 0:9b3d4731edbb 117 # following values are used ($name is automatically replaced with the name of
WFKnight 0:9b3d4731edbb 118 # the entity):The $name class, The $name widget, The $name file, is, provides,
WFKnight 0:9b3d4731edbb 119 # specifies, contains, represents, a, an and the.
WFKnight 0:9b3d4731edbb 120
WFKnight 0:9b3d4731edbb 121 ABBREVIATE_BRIEF =
WFKnight 0:9b3d4731edbb 122
WFKnight 0:9b3d4731edbb 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
WFKnight 0:9b3d4731edbb 124 # doxygen will generate a detailed section even if there is only a brief
WFKnight 0:9b3d4731edbb 125 # description.
WFKnight 0:9b3d4731edbb 126 # The default value is: NO.
WFKnight 0:9b3d4731edbb 127
WFKnight 0:9b3d4731edbb 128 ALWAYS_DETAILED_SEC = YES
WFKnight 0:9b3d4731edbb 129
WFKnight 0:9b3d4731edbb 130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
WFKnight 0:9b3d4731edbb 131 # inherited members of a class in the documentation of that class as if those
WFKnight 0:9b3d4731edbb 132 # members were ordinary class members. Constructors, destructors and assignment
WFKnight 0:9b3d4731edbb 133 # operators of the base classes will not be shown.
WFKnight 0:9b3d4731edbb 134 # The default value is: NO.
WFKnight 0:9b3d4731edbb 135
WFKnight 0:9b3d4731edbb 136 INLINE_INHERITED_MEMB = YES
WFKnight 0:9b3d4731edbb 137
WFKnight 0:9b3d4731edbb 138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
WFKnight 0:9b3d4731edbb 139 # before files name in the file list and in the header files. If set to NO the
WFKnight 0:9b3d4731edbb 140 # shortest path that makes the file name unique will be used
WFKnight 0:9b3d4731edbb 141 # The default value is: YES.
WFKnight 0:9b3d4731edbb 142
WFKnight 0:9b3d4731edbb 143 FULL_PATH_NAMES = NO
WFKnight 0:9b3d4731edbb 144
WFKnight 0:9b3d4731edbb 145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
WFKnight 0:9b3d4731edbb 146 # Stripping is only done if one of the specified strings matches the left-hand
WFKnight 0:9b3d4731edbb 147 # part of the path. The tag can be used to show relative paths in the file list.
WFKnight 0:9b3d4731edbb 148 # If left blank the directory from which doxygen is run is used as the path to
WFKnight 0:9b3d4731edbb 149 # strip.
WFKnight 0:9b3d4731edbb 150 #
WFKnight 0:9b3d4731edbb 151 # Note that you can specify absolute paths here, but also relative paths, which
WFKnight 0:9b3d4731edbb 152 # will be relative from the directory where doxygen is started.
WFKnight 0:9b3d4731edbb 153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
WFKnight 0:9b3d4731edbb 154
WFKnight 0:9b3d4731edbb 155 STRIP_FROM_PATH =
WFKnight 0:9b3d4731edbb 156
WFKnight 0:9b3d4731edbb 157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
WFKnight 0:9b3d4731edbb 158 # path mentioned in the documentation of a class, which tells the reader which
WFKnight 0:9b3d4731edbb 159 # header file to include in order to use a class. If left blank only the name of
WFKnight 0:9b3d4731edbb 160 # the header file containing the class definition is used. Otherwise one should
WFKnight 0:9b3d4731edbb 161 # specify the list of include paths that are normally passed to the compiler
WFKnight 0:9b3d4731edbb 162 # using the -I flag.
WFKnight 0:9b3d4731edbb 163
WFKnight 0:9b3d4731edbb 164 STRIP_FROM_INC_PATH =
WFKnight 0:9b3d4731edbb 165
WFKnight 0:9b3d4731edbb 166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
WFKnight 0:9b3d4731edbb 167 # less readable) file names. This can be useful is your file systems doesn't
WFKnight 0:9b3d4731edbb 168 # support long names like on DOS, Mac, or CD-ROM.
WFKnight 0:9b3d4731edbb 169 # The default value is: NO.
WFKnight 0:9b3d4731edbb 170
WFKnight 0:9b3d4731edbb 171 SHORT_NAMES = NO
WFKnight 0:9b3d4731edbb 172
WFKnight 0:9b3d4731edbb 173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
WFKnight 0:9b3d4731edbb 174 # first line (until the first dot) of a Javadoc-style comment as the brief
WFKnight 0:9b3d4731edbb 175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
WFKnight 0:9b3d4731edbb 176 # style comments (thus requiring an explicit @brief command for a brief
WFKnight 0:9b3d4731edbb 177 # description.)
WFKnight 0:9b3d4731edbb 178 # The default value is: NO.
WFKnight 0:9b3d4731edbb 179
WFKnight 0:9b3d4731edbb 180 JAVADOC_AUTOBRIEF = YES
WFKnight 0:9b3d4731edbb 181
WFKnight 0:9b3d4731edbb 182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
WFKnight 0:9b3d4731edbb 183 # line (until the first dot) of a Qt-style comment as the brief description. If
WFKnight 0:9b3d4731edbb 184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
WFKnight 0:9b3d4731edbb 185 # requiring an explicit \brief command for a brief description.)
WFKnight 0:9b3d4731edbb 186 # The default value is: NO.
WFKnight 0:9b3d4731edbb 187
WFKnight 0:9b3d4731edbb 188 QT_AUTOBRIEF = NO
WFKnight 0:9b3d4731edbb 189
WFKnight 0:9b3d4731edbb 190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
WFKnight 0:9b3d4731edbb 191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
WFKnight 0:9b3d4731edbb 192 # a brief description. This used to be the default behavior. The new default is
WFKnight 0:9b3d4731edbb 193 # to treat a multi-line C++ comment block as a detailed description. Set this
WFKnight 0:9b3d4731edbb 194 # tag to YES if you prefer the old behavior instead.
WFKnight 0:9b3d4731edbb 195 #
WFKnight 0:9b3d4731edbb 196 # Note that setting this tag to YES also means that rational rose comments are
WFKnight 0:9b3d4731edbb 197 # not recognized any more.
WFKnight 0:9b3d4731edbb 198 # The default value is: NO.
WFKnight 0:9b3d4731edbb 199
WFKnight 0:9b3d4731edbb 200 MULTILINE_CPP_IS_BRIEF = NO
WFKnight 0:9b3d4731edbb 201
WFKnight 0:9b3d4731edbb 202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
WFKnight 0:9b3d4731edbb 203 # documentation from any documented member that it re-implements.
WFKnight 0:9b3d4731edbb 204 # The default value is: YES.
WFKnight 0:9b3d4731edbb 205
WFKnight 0:9b3d4731edbb 206 INHERIT_DOCS = YES
WFKnight 0:9b3d4731edbb 207
WFKnight 0:9b3d4731edbb 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
WFKnight 0:9b3d4731edbb 209 # page for each member. If set to NO, the documentation of a member will be part
WFKnight 0:9b3d4731edbb 210 # of the file/class/namespace that contains it.
WFKnight 0:9b3d4731edbb 211 # The default value is: NO.
WFKnight 0:9b3d4731edbb 212
WFKnight 0:9b3d4731edbb 213 SEPARATE_MEMBER_PAGES = NO
WFKnight 0:9b3d4731edbb 214
WFKnight 0:9b3d4731edbb 215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
WFKnight 0:9b3d4731edbb 216 # uses this value to replace tabs by spaces in code fragments.
WFKnight 0:9b3d4731edbb 217 # Minimum value: 1, maximum value: 16, default value: 4.
WFKnight 0:9b3d4731edbb 218
WFKnight 0:9b3d4731edbb 219 TAB_SIZE = 4
WFKnight 0:9b3d4731edbb 220
WFKnight 0:9b3d4731edbb 221 # This tag can be used to specify a number of aliases that act as commands in
WFKnight 0:9b3d4731edbb 222 # the documentation. An alias has the form:
WFKnight 0:9b3d4731edbb 223 # name=value
WFKnight 0:9b3d4731edbb 224 # For example adding
WFKnight 0:9b3d4731edbb 225 # "sideeffect=@par Side Effects:\n"
WFKnight 0:9b3d4731edbb 226 # will allow you to put the command \sideeffect (or @sideeffect) in the
WFKnight 0:9b3d4731edbb 227 # documentation, which will result in a user-defined paragraph with heading
WFKnight 0:9b3d4731edbb 228 # "Side Effects:". You can put \n's in the value part of an alias to insert
WFKnight 0:9b3d4731edbb 229 # newlines.
WFKnight 0:9b3d4731edbb 230
WFKnight 0:9b3d4731edbb 231 ALIASES =
WFKnight 0:9b3d4731edbb 232
WFKnight 0:9b3d4731edbb 233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
WFKnight 0:9b3d4731edbb 234 # A mapping has the form "name=value". For example adding "class=itcl::class"
WFKnight 0:9b3d4731edbb 235 # will allow you to use the command class in the itcl::class meaning.
WFKnight 0:9b3d4731edbb 236
WFKnight 0:9b3d4731edbb 237 TCL_SUBST =
WFKnight 0:9b3d4731edbb 238
WFKnight 0:9b3d4731edbb 239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
WFKnight 0:9b3d4731edbb 240 # only. Doxygen will then generate output that is more tailored for C. For
WFKnight 0:9b3d4731edbb 241 # instance, some of the names that are used will be different. The list of all
WFKnight 0:9b3d4731edbb 242 # members will be omitted, etc.
WFKnight 0:9b3d4731edbb 243 # The default value is: NO.
WFKnight 0:9b3d4731edbb 244
WFKnight 0:9b3d4731edbb 245 OPTIMIZE_OUTPUT_FOR_C = YES
WFKnight 0:9b3d4731edbb 246
WFKnight 0:9b3d4731edbb 247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
WFKnight 0:9b3d4731edbb 248 # Python sources only. Doxygen will then generate output that is more tailored
WFKnight 0:9b3d4731edbb 249 # for that language. For instance, namespaces will be presented as packages,
WFKnight 0:9b3d4731edbb 250 # qualified scopes will look different, etc.
WFKnight 0:9b3d4731edbb 251 # The default value is: NO.
WFKnight 0:9b3d4731edbb 252
WFKnight 0:9b3d4731edbb 253 OPTIMIZE_OUTPUT_JAVA = NO
WFKnight 0:9b3d4731edbb 254
WFKnight 0:9b3d4731edbb 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
WFKnight 0:9b3d4731edbb 256 # sources. Doxygen will then generate output that is tailored for Fortran.
WFKnight 0:9b3d4731edbb 257 # The default value is: NO.
WFKnight 0:9b3d4731edbb 258
WFKnight 0:9b3d4731edbb 259 OPTIMIZE_FOR_FORTRAN = NO
WFKnight 0:9b3d4731edbb 260
WFKnight 0:9b3d4731edbb 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
WFKnight 0:9b3d4731edbb 262 # sources. Doxygen will then generate output that is tailored for VHDL.
WFKnight 0:9b3d4731edbb 263 # The default value is: NO.
WFKnight 0:9b3d4731edbb 264
WFKnight 0:9b3d4731edbb 265 OPTIMIZE_OUTPUT_VHDL = NO
WFKnight 0:9b3d4731edbb 266
WFKnight 0:9b3d4731edbb 267 # Doxygen selects the parser to use depending on the extension of the files it
WFKnight 0:9b3d4731edbb 268 # parses. With this tag you can assign which parser to use for a given
WFKnight 0:9b3d4731edbb 269 # extension. Doxygen has a built-in mapping, but you can override or extend it
WFKnight 0:9b3d4731edbb 270 # using this tag. The format is ext=language, where ext is a file extension, and
WFKnight 0:9b3d4731edbb 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
WFKnight 0:9b3d4731edbb 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
WFKnight 0:9b3d4731edbb 273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
WFKnight 0:9b3d4731edbb 274 # Fortran. In the later case the parser tries to guess whether the code is fixed
WFKnight 0:9b3d4731edbb 275 # or free formatted code, this is the default for Fortran type files), VHDL. For
WFKnight 0:9b3d4731edbb 276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
WFKnight 0:9b3d4731edbb 277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
WFKnight 0:9b3d4731edbb 278 #
WFKnight 0:9b3d4731edbb 279 # Note: For files without extension you can use no_extension as a placeholder.
WFKnight 0:9b3d4731edbb 280 #
WFKnight 0:9b3d4731edbb 281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
WFKnight 0:9b3d4731edbb 282 # the files are not read by doxygen.
WFKnight 0:9b3d4731edbb 283
WFKnight 0:9b3d4731edbb 284 EXTENSION_MAPPING =
WFKnight 0:9b3d4731edbb 285
WFKnight 0:9b3d4731edbb 286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
WFKnight 0:9b3d4731edbb 287 # according to the Markdown format, which allows for more readable
WFKnight 0:9b3d4731edbb 288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
WFKnight 0:9b3d4731edbb 289 # The output of markdown processing is further processed by doxygen, so you can
WFKnight 0:9b3d4731edbb 290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
WFKnight 0:9b3d4731edbb 291 # case of backward compatibilities issues.
WFKnight 0:9b3d4731edbb 292 # The default value is: YES.
WFKnight 0:9b3d4731edbb 293
WFKnight 0:9b3d4731edbb 294 MARKDOWN_SUPPORT = YES
WFKnight 0:9b3d4731edbb 295
WFKnight 0:9b3d4731edbb 296 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
WFKnight 0:9b3d4731edbb 297 # to that level are automatically included in the table of contents, even if
WFKnight 0:9b3d4731edbb 298 # they do not have an id attribute.
WFKnight 0:9b3d4731edbb 299 # Note: This feature currently applies only to Markdown headings.
WFKnight 0:9b3d4731edbb 300 # Minimum value: 0, maximum value: 99, default value: 0.
WFKnight 0:9b3d4731edbb 301 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
WFKnight 0:9b3d4731edbb 302
WFKnight 0:9b3d4731edbb 303 #TOC_INCLUDE_HEADINGS = 0
WFKnight 0:9b3d4731edbb 304
WFKnight 0:9b3d4731edbb 305 # When enabled doxygen tries to link words that correspond to documented
WFKnight 0:9b3d4731edbb 306 # classes, or namespaces to their corresponding documentation. Such a link can
WFKnight 0:9b3d4731edbb 307 # be prevented in individual cases by putting a % sign in front of the word or
WFKnight 0:9b3d4731edbb 308 # globally by setting AUTOLINK_SUPPORT to NO.
WFKnight 0:9b3d4731edbb 309 # The default value is: YES.
WFKnight 0:9b3d4731edbb 310
WFKnight 0:9b3d4731edbb 311 AUTOLINK_SUPPORT = YES
WFKnight 0:9b3d4731edbb 312
WFKnight 0:9b3d4731edbb 313 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
WFKnight 0:9b3d4731edbb 314 # to include (a tag file for) the STL sources as input, then you should set this
WFKnight 0:9b3d4731edbb 315 # tag to YES in order to let doxygen match functions declarations and
WFKnight 0:9b3d4731edbb 316 # definitions whose arguments contain STL classes (e.g. func(std::string);
WFKnight 0:9b3d4731edbb 317 # versus func(std::string) {}). This also make the inheritance and collaboration
WFKnight 0:9b3d4731edbb 318 # diagrams that involve STL classes more complete and accurate.
WFKnight 0:9b3d4731edbb 319 # The default value is: NO.
WFKnight 0:9b3d4731edbb 320
WFKnight 0:9b3d4731edbb 321 BUILTIN_STL_SUPPORT = NO
WFKnight 0:9b3d4731edbb 322
WFKnight 0:9b3d4731edbb 323 # If you use Microsoft's C++/CLI language, you should set this option to YES to
WFKnight 0:9b3d4731edbb 324 # enable parsing support.
WFKnight 0:9b3d4731edbb 325 # The default value is: NO.
WFKnight 0:9b3d4731edbb 326
WFKnight 0:9b3d4731edbb 327 CPP_CLI_SUPPORT = NO
WFKnight 0:9b3d4731edbb 328
WFKnight 0:9b3d4731edbb 329 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
WFKnight 0:9b3d4731edbb 330 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
WFKnight 0:9b3d4731edbb 331 # will parse them like normal C++ but will assume all classes use public instead
WFKnight 0:9b3d4731edbb 332 # of private inheritance when no explicit protection keyword is present.
WFKnight 0:9b3d4731edbb 333 # The default value is: NO.
WFKnight 0:9b3d4731edbb 334
WFKnight 0:9b3d4731edbb 335 SIP_SUPPORT = NO
WFKnight 0:9b3d4731edbb 336
WFKnight 0:9b3d4731edbb 337 # For Microsoft's IDL there are propget and propput attributes to indicate
WFKnight 0:9b3d4731edbb 338 # getter and setter methods for a property. Setting this option to YES will make
WFKnight 0:9b3d4731edbb 339 # doxygen to replace the get and set methods by a property in the documentation.
WFKnight 0:9b3d4731edbb 340 # This will only work if the methods are indeed getting or setting a simple
WFKnight 0:9b3d4731edbb 341 # type. If this is not the case, or you want to show the methods anyway, you
WFKnight 0:9b3d4731edbb 342 # should set this option to NO.
WFKnight 0:9b3d4731edbb 343 # The default value is: YES.
WFKnight 0:9b3d4731edbb 344
WFKnight 0:9b3d4731edbb 345 IDL_PROPERTY_SUPPORT = YES
WFKnight 0:9b3d4731edbb 346
WFKnight 0:9b3d4731edbb 347 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
WFKnight 0:9b3d4731edbb 348 # tag is set to YES then doxygen will reuse the documentation of the first
WFKnight 0:9b3d4731edbb 349 # member in the group (if any) for the other members of the group. By default
WFKnight 0:9b3d4731edbb 350 # all members of a group must be documented explicitly.
WFKnight 0:9b3d4731edbb 351 # The default value is: NO.
WFKnight 0:9b3d4731edbb 352
WFKnight 0:9b3d4731edbb 353 DISTRIBUTE_GROUP_DOC = NO
WFKnight 0:9b3d4731edbb 354
WFKnight 0:9b3d4731edbb 355 # If one adds a struct or class to a group and this option is enabled, then also
WFKnight 0:9b3d4731edbb 356 # any nested class or struct is added to the same group. By default this option
WFKnight 0:9b3d4731edbb 357 # is disabled and one has to add nested compounds explicitly via \ingroup.
WFKnight 0:9b3d4731edbb 358 # The default value is: NO.
WFKnight 0:9b3d4731edbb 359
WFKnight 0:9b3d4731edbb 360 #GROUP_NESTED_COMPOUNDS = NO
WFKnight 0:9b3d4731edbb 361
WFKnight 0:9b3d4731edbb 362 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
WFKnight 0:9b3d4731edbb 363 # (for instance a group of public functions) to be put as a subgroup of that
WFKnight 0:9b3d4731edbb 364 # type (e.g. under the Public Functions section). Set it to NO to prevent
WFKnight 0:9b3d4731edbb 365 # subgrouping. Alternatively, this can be done per class using the
WFKnight 0:9b3d4731edbb 366 # \nosubgrouping command.
WFKnight 0:9b3d4731edbb 367 # The default value is: YES.
WFKnight 0:9b3d4731edbb 368
WFKnight 0:9b3d4731edbb 369 SUBGROUPING = YES
WFKnight 0:9b3d4731edbb 370
WFKnight 0:9b3d4731edbb 371 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
WFKnight 0:9b3d4731edbb 372 # are shown inside the group in which they are included (e.g. using \ingroup)
WFKnight 0:9b3d4731edbb 373 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
WFKnight 0:9b3d4731edbb 374 # and RTF).
WFKnight 0:9b3d4731edbb 375 #
WFKnight 0:9b3d4731edbb 376 # Note that this feature does not work in combination with
WFKnight 0:9b3d4731edbb 377 # SEPARATE_MEMBER_PAGES.
WFKnight 0:9b3d4731edbb 378 # The default value is: NO.
WFKnight 0:9b3d4731edbb 379
WFKnight 0:9b3d4731edbb 380 INLINE_GROUPED_CLASSES = NO
WFKnight 0:9b3d4731edbb 381
WFKnight 0:9b3d4731edbb 382 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
WFKnight 0:9b3d4731edbb 383 # with only public data fields or simple typedef fields will be shown inline in
WFKnight 0:9b3d4731edbb 384 # the documentation of the scope in which they are defined (i.e. file,
WFKnight 0:9b3d4731edbb 385 # namespace, or group documentation), provided this scope is documented. If set
WFKnight 0:9b3d4731edbb 386 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
WFKnight 0:9b3d4731edbb 387 # Man pages) or section (for LaTeX and RTF).
WFKnight 0:9b3d4731edbb 388 # The default value is: NO.
WFKnight 0:9b3d4731edbb 389
WFKnight 0:9b3d4731edbb 390 INLINE_SIMPLE_STRUCTS = NO
WFKnight 0:9b3d4731edbb 391
WFKnight 0:9b3d4731edbb 392 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
WFKnight 0:9b3d4731edbb 393 # enum is documented as struct, union, or enum with the name of the typedef. So
WFKnight 0:9b3d4731edbb 394 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
WFKnight 0:9b3d4731edbb 395 # with name TypeT. When disabled the typedef will appear as a member of a file,
WFKnight 0:9b3d4731edbb 396 # namespace, or class. And the struct will be named TypeS. This can typically be
WFKnight 0:9b3d4731edbb 397 # useful for C code in case the coding convention dictates that all compound
WFKnight 0:9b3d4731edbb 398 # types are typedef'ed and only the typedef is referenced, never the tag name.
WFKnight 0:9b3d4731edbb 399 # The default value is: NO.
WFKnight 0:9b3d4731edbb 400
WFKnight 0:9b3d4731edbb 401 TYPEDEF_HIDES_STRUCT = NO
WFKnight 0:9b3d4731edbb 402
WFKnight 0:9b3d4731edbb 403 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
WFKnight 0:9b3d4731edbb 404 # cache is used to resolve symbols given their name and scope. Since this can be
WFKnight 0:9b3d4731edbb 405 # an expensive process and often the same symbol appears multiple times in the
WFKnight 0:9b3d4731edbb 406 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
WFKnight 0:9b3d4731edbb 407 # doxygen will become slower. If the cache is too large, memory is wasted. The
WFKnight 0:9b3d4731edbb 408 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
WFKnight 0:9b3d4731edbb 409 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
WFKnight 0:9b3d4731edbb 410 # symbols. At the end of a run doxygen will report the cache usage and suggest
WFKnight 0:9b3d4731edbb 411 # the optimal cache size from a speed point of view.
WFKnight 0:9b3d4731edbb 412 # Minimum value: 0, maximum value: 9, default value: 0.
WFKnight 0:9b3d4731edbb 413
WFKnight 0:9b3d4731edbb 414 LOOKUP_CACHE_SIZE = 0
WFKnight 0:9b3d4731edbb 415
WFKnight 0:9b3d4731edbb 416 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 417 # Build related configuration options
WFKnight 0:9b3d4731edbb 418 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 419
WFKnight 0:9b3d4731edbb 420 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
WFKnight 0:9b3d4731edbb 421 # documentation are documented, even if no documentation was available. Private
WFKnight 0:9b3d4731edbb 422 # class members and static file members will be hidden unless the
WFKnight 0:9b3d4731edbb 423 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
WFKnight 0:9b3d4731edbb 424 # Note: This will also disable the warnings about undocumented members that are
WFKnight 0:9b3d4731edbb 425 # normally produced when WARNINGS is set to YES.
WFKnight 0:9b3d4731edbb 426 # The default value is: NO.
WFKnight 0:9b3d4731edbb 427
WFKnight 0:9b3d4731edbb 428 EXTRACT_ALL = NO
WFKnight 0:9b3d4731edbb 429
WFKnight 0:9b3d4731edbb 430 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
WFKnight 0:9b3d4731edbb 431 # be included in the documentation.
WFKnight 0:9b3d4731edbb 432 # The default value is: NO.
WFKnight 0:9b3d4731edbb 433
WFKnight 0:9b3d4731edbb 434 EXTRACT_PRIVATE = NO
WFKnight 0:9b3d4731edbb 435
WFKnight 0:9b3d4731edbb 436 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
WFKnight 0:9b3d4731edbb 437 # scope will be included in the documentation.
WFKnight 0:9b3d4731edbb 438 # The default value is: NO.
WFKnight 0:9b3d4731edbb 439
WFKnight 0:9b3d4731edbb 440 EXTRACT_PACKAGE = NO
WFKnight 0:9b3d4731edbb 441
WFKnight 0:9b3d4731edbb 442 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
WFKnight 0:9b3d4731edbb 443 # included in the documentation.
WFKnight 0:9b3d4731edbb 444 # The default value is: NO.
WFKnight 0:9b3d4731edbb 445
WFKnight 0:9b3d4731edbb 446 EXTRACT_STATIC = YES
WFKnight 0:9b3d4731edbb 447
WFKnight 0:9b3d4731edbb 448 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
WFKnight 0:9b3d4731edbb 449 # locally in source files will be included in the documentation. If set to NO,
WFKnight 0:9b3d4731edbb 450 # only classes defined in header files are included. Does not have any effect
WFKnight 0:9b3d4731edbb 451 # for Java sources.
WFKnight 0:9b3d4731edbb 452 # The default value is: YES.
WFKnight 0:9b3d4731edbb 453
WFKnight 0:9b3d4731edbb 454 EXTRACT_LOCAL_CLASSES = NO
WFKnight 0:9b3d4731edbb 455
WFKnight 0:9b3d4731edbb 456 # This flag is only useful for Objective-C code. If set to YES, local methods,
WFKnight 0:9b3d4731edbb 457 # which are defined in the implementation section but not in the interface are
WFKnight 0:9b3d4731edbb 458 # included in the documentation. If set to NO, only methods in the interface are
WFKnight 0:9b3d4731edbb 459 # included.
WFKnight 0:9b3d4731edbb 460 # The default value is: NO.
WFKnight 0:9b3d4731edbb 461
WFKnight 0:9b3d4731edbb 462 EXTRACT_LOCAL_METHODS = NO
WFKnight 0:9b3d4731edbb 463
WFKnight 0:9b3d4731edbb 464 # If this flag is set to YES, the members of anonymous namespaces will be
WFKnight 0:9b3d4731edbb 465 # extracted and appear in the documentation as a namespace called
WFKnight 0:9b3d4731edbb 466 # 'anonymous_namespace{file}', where file will be replaced with the base name of
WFKnight 0:9b3d4731edbb 467 # the file that contains the anonymous namespace. By default anonymous namespace
WFKnight 0:9b3d4731edbb 468 # are hidden.
WFKnight 0:9b3d4731edbb 469 # The default value is: NO.
WFKnight 0:9b3d4731edbb 470
WFKnight 0:9b3d4731edbb 471 EXTRACT_ANON_NSPACES = YES
WFKnight 0:9b3d4731edbb 472
WFKnight 0:9b3d4731edbb 473 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
WFKnight 0:9b3d4731edbb 474 # undocumented members inside documented classes or files. If set to NO these
WFKnight 0:9b3d4731edbb 475 # members will be included in the various overviews, but no documentation
WFKnight 0:9b3d4731edbb 476 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
WFKnight 0:9b3d4731edbb 477 # The default value is: NO.
WFKnight 0:9b3d4731edbb 478
WFKnight 0:9b3d4731edbb 479 HIDE_UNDOC_MEMBERS = YES
WFKnight 0:9b3d4731edbb 480
WFKnight 0:9b3d4731edbb 481 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
WFKnight 0:9b3d4731edbb 482 # undocumented classes that are normally visible in the class hierarchy. If set
WFKnight 0:9b3d4731edbb 483 # to NO, these classes will be included in the various overviews. This option
WFKnight 0:9b3d4731edbb 484 # has no effect if EXTRACT_ALL is enabled.
WFKnight 0:9b3d4731edbb 485 # The default value is: NO.
WFKnight 0:9b3d4731edbb 486
WFKnight 0:9b3d4731edbb 487 HIDE_UNDOC_CLASSES = YES
WFKnight 0:9b3d4731edbb 488
WFKnight 0:9b3d4731edbb 489 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
WFKnight 0:9b3d4731edbb 490 # (class|struct|union) declarations. If set to NO, these declarations will be
WFKnight 0:9b3d4731edbb 491 # included in the documentation.
WFKnight 0:9b3d4731edbb 492 # The default value is: NO.
WFKnight 0:9b3d4731edbb 493
WFKnight 0:9b3d4731edbb 494 HIDE_FRIEND_COMPOUNDS = NO
WFKnight 0:9b3d4731edbb 495
WFKnight 0:9b3d4731edbb 496 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
WFKnight 0:9b3d4731edbb 497 # documentation blocks found inside the body of a function. If set to NO, these
WFKnight 0:9b3d4731edbb 498 # blocks will be appended to the function's detailed documentation block.
WFKnight 0:9b3d4731edbb 499 # The default value is: NO.
WFKnight 0:9b3d4731edbb 500
WFKnight 0:9b3d4731edbb 501 HIDE_IN_BODY_DOCS = NO
WFKnight 0:9b3d4731edbb 502
WFKnight 0:9b3d4731edbb 503 # The INTERNAL_DOCS tag determines if documentation that is typed after a
WFKnight 0:9b3d4731edbb 504 # \internal command is included. If the tag is set to NO then the documentation
WFKnight 0:9b3d4731edbb 505 # will be excluded. Set it to YES to include the internal documentation.
WFKnight 0:9b3d4731edbb 506 # The default value is: NO.
WFKnight 0:9b3d4731edbb 507
WFKnight 0:9b3d4731edbb 508 INTERNAL_DOCS = NO
WFKnight 0:9b3d4731edbb 509
WFKnight 0:9b3d4731edbb 510 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
WFKnight 0:9b3d4731edbb 511 # names in lower-case letters. If set to YES, upper-case letters are also
WFKnight 0:9b3d4731edbb 512 # allowed. This is useful if you have classes or files whose names only differ
WFKnight 0:9b3d4731edbb 513 # in case and if your file system supports case sensitive file names. Windows
WFKnight 0:9b3d4731edbb 514 # and Mac users are advised to set this option to NO.
WFKnight 0:9b3d4731edbb 515 # The default value is: system dependent.
WFKnight 0:9b3d4731edbb 516
WFKnight 0:9b3d4731edbb 517 CASE_SENSE_NAMES = YES
WFKnight 0:9b3d4731edbb 518
WFKnight 0:9b3d4731edbb 519 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
WFKnight 0:9b3d4731edbb 520 # their full class and namespace scopes in the documentation. If set to YES, the
WFKnight 0:9b3d4731edbb 521 # scope will be hidden.
WFKnight 0:9b3d4731edbb 522 # The default value is: NO.
WFKnight 0:9b3d4731edbb 523
WFKnight 0:9b3d4731edbb 524 HIDE_SCOPE_NAMES = YES
WFKnight 0:9b3d4731edbb 525
WFKnight 0:9b3d4731edbb 526 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
WFKnight 0:9b3d4731edbb 527 # append additional text to a page's title, such as Class Reference. If set to
WFKnight 0:9b3d4731edbb 528 # YES the compound reference will be hidden.
WFKnight 0:9b3d4731edbb 529 # The default value is: NO.
WFKnight 0:9b3d4731edbb 530
WFKnight 0:9b3d4731edbb 531 #HIDE_COMPOUND_REFERENCE= NO
WFKnight 0:9b3d4731edbb 532
WFKnight 0:9b3d4731edbb 533 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
WFKnight 0:9b3d4731edbb 534 # the files that are included by a file in the documentation of that file.
WFKnight 0:9b3d4731edbb 535 # The default value is: YES.
WFKnight 0:9b3d4731edbb 536
WFKnight 0:9b3d4731edbb 537 SHOW_INCLUDE_FILES = YES
WFKnight 0:9b3d4731edbb 538
WFKnight 0:9b3d4731edbb 539 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
WFKnight 0:9b3d4731edbb 540 # grouped member an include statement to the documentation, telling the reader
WFKnight 0:9b3d4731edbb 541 # which file to include in order to use the member.
WFKnight 0:9b3d4731edbb 542 # The default value is: NO.
WFKnight 0:9b3d4731edbb 543
WFKnight 0:9b3d4731edbb 544 SHOW_GROUPED_MEMB_INC = NO
WFKnight 0:9b3d4731edbb 545
WFKnight 0:9b3d4731edbb 546 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
WFKnight 0:9b3d4731edbb 547 # files with double quotes in the documentation rather than with sharp brackets.
WFKnight 0:9b3d4731edbb 548 # The default value is: NO.
WFKnight 0:9b3d4731edbb 549
WFKnight 0:9b3d4731edbb 550 FORCE_LOCAL_INCLUDES = NO
WFKnight 0:9b3d4731edbb 551
WFKnight 0:9b3d4731edbb 552 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
WFKnight 0:9b3d4731edbb 553 # documentation for inline members.
WFKnight 0:9b3d4731edbb 554 # The default value is: YES.
WFKnight 0:9b3d4731edbb 555
WFKnight 0:9b3d4731edbb 556 INLINE_INFO = NO
WFKnight 0:9b3d4731edbb 557
WFKnight 0:9b3d4731edbb 558 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
WFKnight 0:9b3d4731edbb 559 # (detailed) documentation of file and class members alphabetically by member
WFKnight 0:9b3d4731edbb 560 # name. If set to NO, the members will appear in declaration order.
WFKnight 0:9b3d4731edbb 561 # The default value is: YES.
WFKnight 0:9b3d4731edbb 562
WFKnight 0:9b3d4731edbb 563 SORT_MEMBER_DOCS = YES
WFKnight 0:9b3d4731edbb 564
WFKnight 0:9b3d4731edbb 565 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
WFKnight 0:9b3d4731edbb 566 # descriptions of file, namespace and class members alphabetically by member
WFKnight 0:9b3d4731edbb 567 # name. If set to NO, the members will appear in declaration order. Note that
WFKnight 0:9b3d4731edbb 568 # this will also influence the order of the classes in the class list.
WFKnight 0:9b3d4731edbb 569 # The default value is: NO.
WFKnight 0:9b3d4731edbb 570
WFKnight 0:9b3d4731edbb 571 SORT_BRIEF_DOCS = NO
WFKnight 0:9b3d4731edbb 572
WFKnight 0:9b3d4731edbb 573 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
WFKnight 0:9b3d4731edbb 574 # (brief and detailed) documentation of class members so that constructors and
WFKnight 0:9b3d4731edbb 575 # destructors are listed first. If set to NO the constructors will appear in the
WFKnight 0:9b3d4731edbb 576 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
WFKnight 0:9b3d4731edbb 577 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
WFKnight 0:9b3d4731edbb 578 # member documentation.
WFKnight 0:9b3d4731edbb 579 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
WFKnight 0:9b3d4731edbb 580 # detailed member documentation.
WFKnight 0:9b3d4731edbb 581 # The default value is: NO.
WFKnight 0:9b3d4731edbb 582
WFKnight 0:9b3d4731edbb 583 SORT_MEMBERS_CTORS_1ST = NO
WFKnight 0:9b3d4731edbb 584
WFKnight 0:9b3d4731edbb 585 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
WFKnight 0:9b3d4731edbb 586 # of group names into alphabetical order. If set to NO the group names will
WFKnight 0:9b3d4731edbb 587 # appear in their defined order.
WFKnight 0:9b3d4731edbb 588 # The default value is: NO.
WFKnight 0:9b3d4731edbb 589
WFKnight 0:9b3d4731edbb 590 SORT_GROUP_NAMES = NO
WFKnight 0:9b3d4731edbb 591
WFKnight 0:9b3d4731edbb 592 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
WFKnight 0:9b3d4731edbb 593 # fully-qualified names, including namespaces. If set to NO, the class list will
WFKnight 0:9b3d4731edbb 594 # be sorted only by class name, not including the namespace part.
WFKnight 0:9b3d4731edbb 595 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
WFKnight 0:9b3d4731edbb 596 # Note: This option applies only to the class list, not to the alphabetical
WFKnight 0:9b3d4731edbb 597 # list.
WFKnight 0:9b3d4731edbb 598 # The default value is: NO.
WFKnight 0:9b3d4731edbb 599
WFKnight 0:9b3d4731edbb 600 SORT_BY_SCOPE_NAME = NO
WFKnight 0:9b3d4731edbb 601
WFKnight 0:9b3d4731edbb 602 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
WFKnight 0:9b3d4731edbb 603 # type resolution of all parameters of a function it will reject a match between
WFKnight 0:9b3d4731edbb 604 # the prototype and the implementation of a member function even if there is
WFKnight 0:9b3d4731edbb 605 # only one candidate or it is obvious which candidate to choose by doing a
WFKnight 0:9b3d4731edbb 606 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
WFKnight 0:9b3d4731edbb 607 # accept a match between prototype and implementation in such cases.
WFKnight 0:9b3d4731edbb 608 # The default value is: NO.
WFKnight 0:9b3d4731edbb 609
WFKnight 0:9b3d4731edbb 610 STRICT_PROTO_MATCHING = NO
WFKnight 0:9b3d4731edbb 611
WFKnight 0:9b3d4731edbb 612 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
WFKnight 0:9b3d4731edbb 613 # list. This list is created by putting \todo commands in the documentation.
WFKnight 0:9b3d4731edbb 614 # The default value is: YES.
WFKnight 0:9b3d4731edbb 615
WFKnight 0:9b3d4731edbb 616 GENERATE_TODOLIST = NO
WFKnight 0:9b3d4731edbb 617
WFKnight 0:9b3d4731edbb 618 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
WFKnight 0:9b3d4731edbb 619 # list. This list is created by putting \test commands in the documentation.
WFKnight 0:9b3d4731edbb 620 # The default value is: YES.
WFKnight 0:9b3d4731edbb 621
WFKnight 0:9b3d4731edbb 622 GENERATE_TESTLIST = NO
WFKnight 0:9b3d4731edbb 623
WFKnight 0:9b3d4731edbb 624 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
WFKnight 0:9b3d4731edbb 625 # list. This list is created by putting \bug commands in the documentation.
WFKnight 0:9b3d4731edbb 626 # The default value is: YES.
WFKnight 0:9b3d4731edbb 627
WFKnight 0:9b3d4731edbb 628 GENERATE_BUGLIST = NO
WFKnight 0:9b3d4731edbb 629
WFKnight 0:9b3d4731edbb 630 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
WFKnight 0:9b3d4731edbb 631 # the deprecated list. This list is created by putting \deprecated commands in
WFKnight 0:9b3d4731edbb 632 # the documentation.
WFKnight 0:9b3d4731edbb 633 # The default value is: YES.
WFKnight 0:9b3d4731edbb 634
WFKnight 0:9b3d4731edbb 635 GENERATE_DEPRECATEDLIST= YES
WFKnight 0:9b3d4731edbb 636
WFKnight 0:9b3d4731edbb 637 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
WFKnight 0:9b3d4731edbb 638 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
WFKnight 0:9b3d4731edbb 639 # ... \endcond blocks.
WFKnight 0:9b3d4731edbb 640
WFKnight 0:9b3d4731edbb 641 ENABLED_SECTIONS =
WFKnight 0:9b3d4731edbb 642
WFKnight 0:9b3d4731edbb 643 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
WFKnight 0:9b3d4731edbb 644 # initial value of a variable or macro / define can have for it to appear in the
WFKnight 0:9b3d4731edbb 645 # documentation. If the initializer consists of more lines than specified here
WFKnight 0:9b3d4731edbb 646 # it will be hidden. Use a value of 0 to hide initializers completely. The
WFKnight 0:9b3d4731edbb 647 # appearance of the value of individual variables and macros / defines can be
WFKnight 0:9b3d4731edbb 648 # controlled using \showinitializer or \hideinitializer command in the
WFKnight 0:9b3d4731edbb 649 # documentation regardless of this setting.
WFKnight 0:9b3d4731edbb 650 # Minimum value: 0, maximum value: 10000, default value: 30.
WFKnight 0:9b3d4731edbb 651
WFKnight 0:9b3d4731edbb 652 MAX_INITIALIZER_LINES = 30
WFKnight 0:9b3d4731edbb 653
WFKnight 0:9b3d4731edbb 654 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
WFKnight 0:9b3d4731edbb 655 # the bottom of the documentation of classes and structs. If set to YES, the
WFKnight 0:9b3d4731edbb 656 # list will mention the files that were used to generate the documentation.
WFKnight 0:9b3d4731edbb 657 # The default value is: YES.
WFKnight 0:9b3d4731edbb 658
WFKnight 0:9b3d4731edbb 659 SHOW_USED_FILES = NO
WFKnight 0:9b3d4731edbb 660
WFKnight 0:9b3d4731edbb 661 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
WFKnight 0:9b3d4731edbb 662 # will remove the Files entry from the Quick Index and from the Folder Tree View
WFKnight 0:9b3d4731edbb 663 # (if specified).
WFKnight 0:9b3d4731edbb 664 # The default value is: YES.
WFKnight 0:9b3d4731edbb 665
WFKnight 0:9b3d4731edbb 666 SHOW_FILES = YES
WFKnight 0:9b3d4731edbb 667
WFKnight 0:9b3d4731edbb 668 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
WFKnight 0:9b3d4731edbb 669 # page. This will remove the Namespaces entry from the Quick Index and from the
WFKnight 0:9b3d4731edbb 670 # Folder Tree View (if specified).
WFKnight 0:9b3d4731edbb 671 # The default value is: YES.
WFKnight 0:9b3d4731edbb 672
WFKnight 0:9b3d4731edbb 673 SHOW_NAMESPACES = YES
WFKnight 0:9b3d4731edbb 674
WFKnight 0:9b3d4731edbb 675 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
WFKnight 0:9b3d4731edbb 676 # doxygen should invoke to get the current version for each file (typically from
WFKnight 0:9b3d4731edbb 677 # the version control system). Doxygen will invoke the program by executing (via
WFKnight 0:9b3d4731edbb 678 # popen()) the command command input-file, where command is the value of the
WFKnight 0:9b3d4731edbb 679 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
WFKnight 0:9b3d4731edbb 680 # by doxygen. Whatever the program writes to standard output is used as the file
WFKnight 0:9b3d4731edbb 681 # version. For an example see the documentation.
WFKnight 0:9b3d4731edbb 682
WFKnight 0:9b3d4731edbb 683 FILE_VERSION_FILTER =
WFKnight 0:9b3d4731edbb 684
WFKnight 0:9b3d4731edbb 685 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
WFKnight 0:9b3d4731edbb 686 # by doxygen. The layout file controls the global structure of the generated
WFKnight 0:9b3d4731edbb 687 # output files in an output format independent way. To create the layout file
WFKnight 0:9b3d4731edbb 688 # that represents doxygen's defaults, run doxygen with the -l option. You can
WFKnight 0:9b3d4731edbb 689 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
WFKnight 0:9b3d4731edbb 690 # will be used as the name of the layout file.
WFKnight 0:9b3d4731edbb 691 #
WFKnight 0:9b3d4731edbb 692 # Note that if you run doxygen from a directory containing a file called
WFKnight 0:9b3d4731edbb 693 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
WFKnight 0:9b3d4731edbb 694 # tag is left empty.
WFKnight 0:9b3d4731edbb 695
WFKnight 0:9b3d4731edbb 696 LAYOUT_FILE =
WFKnight 0:9b3d4731edbb 697
WFKnight 0:9b3d4731edbb 698 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
WFKnight 0:9b3d4731edbb 699 # the reference definitions. This must be a list of .bib files. The .bib
WFKnight 0:9b3d4731edbb 700 # extension is automatically appended if omitted. This requires the bibtex tool
WFKnight 0:9b3d4731edbb 701 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
WFKnight 0:9b3d4731edbb 702 # For LaTeX the style of the bibliography can be controlled using
WFKnight 0:9b3d4731edbb 703 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
WFKnight 0:9b3d4731edbb 704 # search path. See also \cite for info how to create references.
WFKnight 0:9b3d4731edbb 705
WFKnight 0:9b3d4731edbb 706 CITE_BIB_FILES =
WFKnight 0:9b3d4731edbb 707
WFKnight 0:9b3d4731edbb 708 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 709 # Configuration options related to warning and progress messages
WFKnight 0:9b3d4731edbb 710 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 711
WFKnight 0:9b3d4731edbb 712 # The QUIET tag can be used to turn on/off the messages that are generated to
WFKnight 0:9b3d4731edbb 713 # standard output by doxygen. If QUIET is set to YES this implies that the
WFKnight 0:9b3d4731edbb 714 # messages are off.
WFKnight 0:9b3d4731edbb 715 # The default value is: NO.
WFKnight 0:9b3d4731edbb 716
WFKnight 0:9b3d4731edbb 717 QUIET = YES
WFKnight 0:9b3d4731edbb 718
WFKnight 0:9b3d4731edbb 719 # The WARNINGS tag can be used to turn on/off the warning messages that are
WFKnight 0:9b3d4731edbb 720 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
WFKnight 0:9b3d4731edbb 721 # this implies that the warnings are on.
WFKnight 0:9b3d4731edbb 722 #
WFKnight 0:9b3d4731edbb 723 # Tip: Turn warnings on while writing the documentation.
WFKnight 0:9b3d4731edbb 724 # The default value is: YES.
WFKnight 0:9b3d4731edbb 725
WFKnight 0:9b3d4731edbb 726 WARNINGS = YES
WFKnight 0:9b3d4731edbb 727
WFKnight 0:9b3d4731edbb 728 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
WFKnight 0:9b3d4731edbb 729 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
WFKnight 0:9b3d4731edbb 730 # will automatically be disabled.
WFKnight 0:9b3d4731edbb 731 # The default value is: YES.
WFKnight 0:9b3d4731edbb 732
WFKnight 0:9b3d4731edbb 733 WARN_IF_UNDOCUMENTED = YES
WFKnight 0:9b3d4731edbb 734
WFKnight 0:9b3d4731edbb 735 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
WFKnight 0:9b3d4731edbb 736 # potential errors in the documentation, such as not documenting some parameters
WFKnight 0:9b3d4731edbb 737 # in a documented function, or documenting parameters that don't exist or using
WFKnight 0:9b3d4731edbb 738 # markup commands wrongly.
WFKnight 0:9b3d4731edbb 739 # The default value is: YES.
WFKnight 0:9b3d4731edbb 740
WFKnight 0:9b3d4731edbb 741 WARN_IF_DOC_ERROR = YES
WFKnight 0:9b3d4731edbb 742
WFKnight 0:9b3d4731edbb 743 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
WFKnight 0:9b3d4731edbb 744 # are documented, but have no documentation for their parameters or return
WFKnight 0:9b3d4731edbb 745 # value. If set to NO, doxygen will only warn about wrong or incomplete
WFKnight 0:9b3d4731edbb 746 # parameter documentation, but not about the absence of documentation.
WFKnight 0:9b3d4731edbb 747 # The default value is: NO.
WFKnight 0:9b3d4731edbb 748
WFKnight 0:9b3d4731edbb 749 WARN_NO_PARAMDOC = NO
WFKnight 0:9b3d4731edbb 750
WFKnight 0:9b3d4731edbb 751 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
WFKnight 0:9b3d4731edbb 752 # a warning is encountered.
WFKnight 0:9b3d4731edbb 753 # The default value is: NO.
WFKnight 0:9b3d4731edbb 754
WFKnight 0:9b3d4731edbb 755 #WARN_AS_ERROR = NO
WFKnight 0:9b3d4731edbb 756
WFKnight 0:9b3d4731edbb 757 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
WFKnight 0:9b3d4731edbb 758 # can produce. The string should contain the $file, $line, and $text tags, which
WFKnight 0:9b3d4731edbb 759 # will be replaced by the file and line number from which the warning originated
WFKnight 0:9b3d4731edbb 760 # and the warning text. Optionally the format may contain $version, which will
WFKnight 0:9b3d4731edbb 761 # be replaced by the version of the file (if it could be obtained via
WFKnight 0:9b3d4731edbb 762 # FILE_VERSION_FILTER)
WFKnight 0:9b3d4731edbb 763 # The default value is: $file:$line: $text.
WFKnight 0:9b3d4731edbb 764
WFKnight 0:9b3d4731edbb 765 WARN_FORMAT = "$file:$line: $text"
WFKnight 0:9b3d4731edbb 766
WFKnight 0:9b3d4731edbb 767 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
WFKnight 0:9b3d4731edbb 768 # messages should be written. If left blank the output is written to standard
WFKnight 0:9b3d4731edbb 769 # error (stderr).
WFKnight 0:9b3d4731edbb 770
WFKnight 0:9b3d4731edbb 771 WARN_LOGFILE =
WFKnight 0:9b3d4731edbb 772
WFKnight 0:9b3d4731edbb 773 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 774 # Configuration options related to the input files
WFKnight 0:9b3d4731edbb 775 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 776
WFKnight 0:9b3d4731edbb 777 # The INPUT tag is used to specify the files and/or directories that contain
WFKnight 0:9b3d4731edbb 778 # documented source files. You may enter file names like myfile.cpp or
WFKnight 0:9b3d4731edbb 779 # directories like /usr/src/myproject. Separate the files or directories with
WFKnight 0:9b3d4731edbb 780 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
WFKnight 0:9b3d4731edbb 781 # Note: If this tag is empty the current directory is searched.
WFKnight 0:9b3d4731edbb 782
WFKnight 0:9b3d4731edbb 783 INPUT = .
WFKnight 0:9b3d4731edbb 784
WFKnight 0:9b3d4731edbb 785 # This tag can be used to specify the character encoding of the source files
WFKnight 0:9b3d4731edbb 786 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
WFKnight 0:9b3d4731edbb 787 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
WFKnight 0:9b3d4731edbb 788 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
WFKnight 0:9b3d4731edbb 789 # possible encodings.
WFKnight 0:9b3d4731edbb 790 # The default value is: UTF-8.
WFKnight 0:9b3d4731edbb 791
WFKnight 0:9b3d4731edbb 792 INPUT_ENCODING = UTF-8
WFKnight 0:9b3d4731edbb 793
WFKnight 0:9b3d4731edbb 794 # If the value of the INPUT tag contains directories, you can use the
WFKnight 0:9b3d4731edbb 795 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
WFKnight 0:9b3d4731edbb 796 # *.h) to filter out the source-files in the directories.
WFKnight 0:9b3d4731edbb 797 #
WFKnight 0:9b3d4731edbb 798 # Note that for custom extensions or not directly supported extensions you also
WFKnight 0:9b3d4731edbb 799 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
WFKnight 0:9b3d4731edbb 800 # read by doxygen.
WFKnight 0:9b3d4731edbb 801 #
WFKnight 0:9b3d4731edbb 802 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
WFKnight 0:9b3d4731edbb 803 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
WFKnight 0:9b3d4731edbb 804 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
WFKnight 0:9b3d4731edbb 805 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
WFKnight 0:9b3d4731edbb 806 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
WFKnight 0:9b3d4731edbb 807
WFKnight 0:9b3d4731edbb 808 FILE_PATTERNS = *.h
WFKnight 0:9b3d4731edbb 809
WFKnight 0:9b3d4731edbb 810 # The RECURSIVE tag can be used to specify whether or not subdirectories should
WFKnight 0:9b3d4731edbb 811 # be searched for input files as well.
WFKnight 0:9b3d4731edbb 812 # The default value is: NO.
WFKnight 0:9b3d4731edbb 813
WFKnight 0:9b3d4731edbb 814 RECURSIVE = YES
WFKnight 0:9b3d4731edbb 815
WFKnight 0:9b3d4731edbb 816 # The EXCLUDE tag can be used to specify files and/or directories that should be
WFKnight 0:9b3d4731edbb 817 # excluded from the INPUT source files. This way you can easily exclude a
WFKnight 0:9b3d4731edbb 818 # subdirectory from a directory tree whose root is specified with the INPUT tag.
WFKnight 0:9b3d4731edbb 819 #
WFKnight 0:9b3d4731edbb 820 # Note that relative paths are relative to the directory from which doxygen is
WFKnight 0:9b3d4731edbb 821 # run.
WFKnight 0:9b3d4731edbb 822
WFKnight 0:9b3d4731edbb 823 EXCLUDE =
WFKnight 0:9b3d4731edbb 824
WFKnight 0:9b3d4731edbb 825 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
WFKnight 0:9b3d4731edbb 826 # directories that are symbolic links (a Unix file system feature) are excluded
WFKnight 0:9b3d4731edbb 827 # from the input.
WFKnight 0:9b3d4731edbb 828 # The default value is: NO.
WFKnight 0:9b3d4731edbb 829
WFKnight 0:9b3d4731edbb 830 EXCLUDE_SYMLINKS = YES
WFKnight 0:9b3d4731edbb 831
WFKnight 0:9b3d4731edbb 832 # If the value of the INPUT tag contains directories, you can use the
WFKnight 0:9b3d4731edbb 833 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
WFKnight 0:9b3d4731edbb 834 # certain files from those directories.
WFKnight 0:9b3d4731edbb 835 #
WFKnight 0:9b3d4731edbb 836 # Note that the wildcards are matched against the file with absolute path, so to
WFKnight 0:9b3d4731edbb 837 # exclude all test directories for example use the pattern */test/*
WFKnight 0:9b3d4731edbb 838
WFKnight 0:9b3d4731edbb 839 EXCLUDE_PATTERNS = */tools/* \
WFKnight 0:9b3d4731edbb 840 */targets/* \
WFKnight 0:9b3d4731edbb 841 */BUILD/* \
WFKnight 0:9b3d4731edbb 842 */rtos/TARGET_CORTEX/rtx* \
WFKnight 0:9b3d4731edbb 843 */cmsis/* \
WFKnight 0:9b3d4731edbb 844 */features/cryptocell/* \
WFKnight 0:9b3d4731edbb 845 */features/mbedtls/* \
WFKnight 0:9b3d4731edbb 846 */features/storage/* \
WFKnight 0:9b3d4731edbb 847 */features/unsupported/* \
WFKnight 0:9b3d4731edbb 848 */features/FEATURE_LWIP/* \
WFKnight 0:9b3d4731edbb 849 */features/FEATURE_UVISOR/* \
WFKnight 0:9b3d4731edbb 850 */features/nanostack/sal-stack-nanostack/* \
WFKnight 0:9b3d4731edbb 851 */features/nanostack/coap-service/* \
WFKnight 0:9b3d4731edbb 852 */mbed-trace/* \
WFKnight 0:9b3d4731edbb 853 */mbed-coap/* \
WFKnight 0:9b3d4731edbb 854 */nanostack-libservice/* \
WFKnight 0:9b3d4731edbb 855 */mbed-client-randlib/* \
WFKnight 0:9b3d4731edbb 856 */nanostack/sal-stack-nanostack-eventloop/* \
WFKnight 0:9b3d4731edbb 857 */ble/generic/* \
WFKnight 0:9b3d4731edbb 858 */ble/pal/*
WFKnight 0:9b3d4731edbb 859
WFKnight 0:9b3d4731edbb 860 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
WFKnight 0:9b3d4731edbb 861 # (namespaces, classes, functions, etc.) that should be excluded from the
WFKnight 0:9b3d4731edbb 862 # output. The symbol name can be a fully qualified name, a word, or if the
WFKnight 0:9b3d4731edbb 863 # wildcard * is used, a substring. Examples: ANamespace, AClass,
WFKnight 0:9b3d4731edbb 864 # AClass::ANamespace, ANamespace::*Test
WFKnight 0:9b3d4731edbb 865 #
WFKnight 0:9b3d4731edbb 866 # Note that the wildcards are matched against the file with absolute path, so to
WFKnight 0:9b3d4731edbb 867 # exclude all test directories use the pattern */test/*
WFKnight 0:9b3d4731edbb 868
WFKnight 0:9b3d4731edbb 869 EXCLUDE_SYMBOLS =
WFKnight 0:9b3d4731edbb 870
WFKnight 0:9b3d4731edbb 871 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
WFKnight 0:9b3d4731edbb 872 # that contain example code fragments that are included (see the \include
WFKnight 0:9b3d4731edbb 873 # command).
WFKnight 0:9b3d4731edbb 874
WFKnight 0:9b3d4731edbb 875 EXAMPLE_PATH =
WFKnight 0:9b3d4731edbb 876
WFKnight 0:9b3d4731edbb 877 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
WFKnight 0:9b3d4731edbb 878 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
WFKnight 0:9b3d4731edbb 879 # *.h) to filter out the source-files in the directories. If left blank all
WFKnight 0:9b3d4731edbb 880 # files are included.
WFKnight 0:9b3d4731edbb 881
WFKnight 0:9b3d4731edbb 882 EXAMPLE_PATTERNS =
WFKnight 0:9b3d4731edbb 883
WFKnight 0:9b3d4731edbb 884 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
WFKnight 0:9b3d4731edbb 885 # searched for input files to be used with the \include or \dontinclude commands
WFKnight 0:9b3d4731edbb 886 # irrespective of the value of the RECURSIVE tag.
WFKnight 0:9b3d4731edbb 887 # The default value is: NO.
WFKnight 0:9b3d4731edbb 888
WFKnight 0:9b3d4731edbb 889 EXAMPLE_RECURSIVE = NO
WFKnight 0:9b3d4731edbb 890
WFKnight 0:9b3d4731edbb 891 # The IMAGE_PATH tag can be used to specify one or more files or directories
WFKnight 0:9b3d4731edbb 892 # that contain images that are to be included in the documentation (see the
WFKnight 0:9b3d4731edbb 893 # \image command).
WFKnight 0:9b3d4731edbb 894
WFKnight 0:9b3d4731edbb 895 IMAGE_PATH =
WFKnight 0:9b3d4731edbb 896
WFKnight 0:9b3d4731edbb 897 # The INPUT_FILTER tag can be used to specify a program that doxygen should
WFKnight 0:9b3d4731edbb 898 # invoke to filter for each input file. Doxygen will invoke the filter program
WFKnight 0:9b3d4731edbb 899 # by executing (via popen()) the command:
WFKnight 0:9b3d4731edbb 900 #
WFKnight 0:9b3d4731edbb 901 # <filter> <input-file>
WFKnight 0:9b3d4731edbb 902 #
WFKnight 0:9b3d4731edbb 903 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
WFKnight 0:9b3d4731edbb 904 # name of an input file. Doxygen will then use the output that the filter
WFKnight 0:9b3d4731edbb 905 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
WFKnight 0:9b3d4731edbb 906 # will be ignored.
WFKnight 0:9b3d4731edbb 907 #
WFKnight 0:9b3d4731edbb 908 # Note that the filter must not add or remove lines; it is applied before the
WFKnight 0:9b3d4731edbb 909 # code is scanned, but not when the output code is generated. If lines are added
WFKnight 0:9b3d4731edbb 910 # or removed, the anchors will not be placed correctly.
WFKnight 0:9b3d4731edbb 911 #
WFKnight 0:9b3d4731edbb 912 # Note that for custom extensions or not directly supported extensions you also
WFKnight 0:9b3d4731edbb 913 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
WFKnight 0:9b3d4731edbb 914 # properly processed by doxygen.
WFKnight 0:9b3d4731edbb 915
WFKnight 0:9b3d4731edbb 916 INPUT_FILTER =
WFKnight 0:9b3d4731edbb 917
WFKnight 0:9b3d4731edbb 918 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
WFKnight 0:9b3d4731edbb 919 # basis. Doxygen will compare the file name with each pattern and apply the
WFKnight 0:9b3d4731edbb 920 # filter if there is a match. The filters are a list of the form: pattern=filter
WFKnight 0:9b3d4731edbb 921 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
WFKnight 0:9b3d4731edbb 922 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
WFKnight 0:9b3d4731edbb 923 # patterns match the file name, INPUT_FILTER is applied.
WFKnight 0:9b3d4731edbb 924 #
WFKnight 0:9b3d4731edbb 925 # Note that for custom extensions or not directly supported extensions you also
WFKnight 0:9b3d4731edbb 926 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
WFKnight 0:9b3d4731edbb 927 # properly processed by doxygen.
WFKnight 0:9b3d4731edbb 928
WFKnight 0:9b3d4731edbb 929 FILTER_PATTERNS =
WFKnight 0:9b3d4731edbb 930
WFKnight 0:9b3d4731edbb 931 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
WFKnight 0:9b3d4731edbb 932 # INPUT_FILTER) will also be used to filter the input files that are used for
WFKnight 0:9b3d4731edbb 933 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
WFKnight 0:9b3d4731edbb 934 # The default value is: NO.
WFKnight 0:9b3d4731edbb 935
WFKnight 0:9b3d4731edbb 936 FILTER_SOURCE_FILES = NO
WFKnight 0:9b3d4731edbb 937
WFKnight 0:9b3d4731edbb 938 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
WFKnight 0:9b3d4731edbb 939 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
WFKnight 0:9b3d4731edbb 940 # it is also possible to disable source filtering for a specific pattern using
WFKnight 0:9b3d4731edbb 941 # *.ext= (so without naming a filter).
WFKnight 0:9b3d4731edbb 942 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
WFKnight 0:9b3d4731edbb 943
WFKnight 0:9b3d4731edbb 944 FILTER_SOURCE_PATTERNS =
WFKnight 0:9b3d4731edbb 945
WFKnight 0:9b3d4731edbb 946 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
WFKnight 0:9b3d4731edbb 947 # is part of the input, its contents will be placed on the main page
WFKnight 0:9b3d4731edbb 948 # (index.html). This can be useful if you have a project on for instance GitHub
WFKnight 0:9b3d4731edbb 949 # and want to reuse the introduction page also for the doxygen output.
WFKnight 0:9b3d4731edbb 950
WFKnight 0:9b3d4731edbb 951 USE_MDFILE_AS_MAINPAGE =
WFKnight 0:9b3d4731edbb 952
WFKnight 0:9b3d4731edbb 953 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 954 # Configuration options related to source browsing
WFKnight 0:9b3d4731edbb 955 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 956
WFKnight 0:9b3d4731edbb 957 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
WFKnight 0:9b3d4731edbb 958 # generated. Documented entities will be cross-referenced with these sources.
WFKnight 0:9b3d4731edbb 959 #
WFKnight 0:9b3d4731edbb 960 # Note: To get rid of all source code in the generated output, make sure that
WFKnight 0:9b3d4731edbb 961 # also VERBATIM_HEADERS is set to NO.
WFKnight 0:9b3d4731edbb 962 # The default value is: NO.
WFKnight 0:9b3d4731edbb 963
WFKnight 0:9b3d4731edbb 964 SOURCE_BROWSER = YES
WFKnight 0:9b3d4731edbb 965
WFKnight 0:9b3d4731edbb 966 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
WFKnight 0:9b3d4731edbb 967 # classes and enums directly into the documentation.
WFKnight 0:9b3d4731edbb 968 # The default value is: NO.
WFKnight 0:9b3d4731edbb 969
WFKnight 0:9b3d4731edbb 970 INLINE_SOURCES = NO
WFKnight 0:9b3d4731edbb 971
WFKnight 0:9b3d4731edbb 972 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
WFKnight 0:9b3d4731edbb 973 # special comment blocks from generated source code fragments. Normal C, C++ and
WFKnight 0:9b3d4731edbb 974 # Fortran comments will always remain visible.
WFKnight 0:9b3d4731edbb 975 # The default value is: YES.
WFKnight 0:9b3d4731edbb 976
WFKnight 0:9b3d4731edbb 977 STRIP_CODE_COMMENTS = NO
WFKnight 0:9b3d4731edbb 978
WFKnight 0:9b3d4731edbb 979 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
WFKnight 0:9b3d4731edbb 980 # function all documented functions referencing it will be listed.
WFKnight 0:9b3d4731edbb 981 # The default value is: NO.
WFKnight 0:9b3d4731edbb 982
WFKnight 0:9b3d4731edbb 983 REFERENCED_BY_RELATION = NO
WFKnight 0:9b3d4731edbb 984
WFKnight 0:9b3d4731edbb 985 # If the REFERENCES_RELATION tag is set to YES then for each documented function
WFKnight 0:9b3d4731edbb 986 # all documented entities called/used by that function will be listed.
WFKnight 0:9b3d4731edbb 987 # The default value is: NO.
WFKnight 0:9b3d4731edbb 988
WFKnight 0:9b3d4731edbb 989 REFERENCES_RELATION = NO
WFKnight 0:9b3d4731edbb 990
WFKnight 0:9b3d4731edbb 991 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
WFKnight 0:9b3d4731edbb 992 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
WFKnight 0:9b3d4731edbb 993 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
WFKnight 0:9b3d4731edbb 994 # link to the documentation.
WFKnight 0:9b3d4731edbb 995 # The default value is: YES.
WFKnight 0:9b3d4731edbb 996
WFKnight 0:9b3d4731edbb 997 REFERENCES_LINK_SOURCE = NO
WFKnight 0:9b3d4731edbb 998
WFKnight 0:9b3d4731edbb 999 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
WFKnight 0:9b3d4731edbb 1000 # source code will show a tooltip with additional information such as prototype,
WFKnight 0:9b3d4731edbb 1001 # brief description and links to the definition and documentation. Since this
WFKnight 0:9b3d4731edbb 1002 # will make the HTML file larger and loading of large files a bit slower, you
WFKnight 0:9b3d4731edbb 1003 # can opt to disable this feature.
WFKnight 0:9b3d4731edbb 1004 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1005 # This tag requires that the tag SOURCE_BROWSER is set to YES.
WFKnight 0:9b3d4731edbb 1006
WFKnight 0:9b3d4731edbb 1007 SOURCE_TOOLTIPS = YES
WFKnight 0:9b3d4731edbb 1008
WFKnight 0:9b3d4731edbb 1009 # If the USE_HTAGS tag is set to YES then the references to source code will
WFKnight 0:9b3d4731edbb 1010 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
WFKnight 0:9b3d4731edbb 1011 # source browser. The htags tool is part of GNU's global source tagging system
WFKnight 0:9b3d4731edbb 1012 # (see http://www.gnu.org/software/global/global.html). You will need version
WFKnight 0:9b3d4731edbb 1013 # 4.8.6 or higher.
WFKnight 0:9b3d4731edbb 1014 #
WFKnight 0:9b3d4731edbb 1015 # To use it do the following:
WFKnight 0:9b3d4731edbb 1016 # - Install the latest version of global
WFKnight 0:9b3d4731edbb 1017 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
WFKnight 0:9b3d4731edbb 1018 # - Make sure the INPUT points to the root of the source tree
WFKnight 0:9b3d4731edbb 1019 # - Run doxygen as normal
WFKnight 0:9b3d4731edbb 1020 #
WFKnight 0:9b3d4731edbb 1021 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
WFKnight 0:9b3d4731edbb 1022 # tools must be available from the command line (i.e. in the search path).
WFKnight 0:9b3d4731edbb 1023 #
WFKnight 0:9b3d4731edbb 1024 # The result: instead of the source browser generated by doxygen, the links to
WFKnight 0:9b3d4731edbb 1025 # source code will now point to the output of htags.
WFKnight 0:9b3d4731edbb 1026 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1027 # This tag requires that the tag SOURCE_BROWSER is set to YES.
WFKnight 0:9b3d4731edbb 1028
WFKnight 0:9b3d4731edbb 1029 USE_HTAGS = NO
WFKnight 0:9b3d4731edbb 1030
WFKnight 0:9b3d4731edbb 1031 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
WFKnight 0:9b3d4731edbb 1032 # verbatim copy of the header file for each class for which an include is
WFKnight 0:9b3d4731edbb 1033 # specified. Set to NO to disable this.
WFKnight 0:9b3d4731edbb 1034 # See also: Section \class.
WFKnight 0:9b3d4731edbb 1035 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1036
WFKnight 0:9b3d4731edbb 1037 VERBATIM_HEADERS = YES
WFKnight 0:9b3d4731edbb 1038
WFKnight 0:9b3d4731edbb 1039 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
WFKnight 0:9b3d4731edbb 1040 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
WFKnight 0:9b3d4731edbb 1041 # cost of reduced performance. This can be particularly helpful with template
WFKnight 0:9b3d4731edbb 1042 # rich C++ code for which doxygen's built-in parser lacks the necessary type
WFKnight 0:9b3d4731edbb 1043 # information.
WFKnight 0:9b3d4731edbb 1044 # Note: The availability of this option depends on whether or not doxygen was
WFKnight 0:9b3d4731edbb 1045 # generated with the -Duse-libclang=ON option for CMake.
WFKnight 0:9b3d4731edbb 1046 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1047
WFKnight 0:9b3d4731edbb 1048 #CLANG_ASSISTED_PARSING = NO
WFKnight 0:9b3d4731edbb 1049
WFKnight 0:9b3d4731edbb 1050 # If clang assisted parsing is enabled you can provide the compiler with command
WFKnight 0:9b3d4731edbb 1051 # line options that you would normally use when invoking the compiler. Note that
WFKnight 0:9b3d4731edbb 1052 # the include paths will already be set by doxygen for the files and directories
WFKnight 0:9b3d4731edbb 1053 # specified with INPUT and INCLUDE_PATH.
WFKnight 0:9b3d4731edbb 1054 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
WFKnight 0:9b3d4731edbb 1055
WFKnight 0:9b3d4731edbb 1056 #CLANG_OPTIONS =
WFKnight 0:9b3d4731edbb 1057
WFKnight 0:9b3d4731edbb 1058 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1059 # Configuration options related to the alphabetical class index
WFKnight 0:9b3d4731edbb 1060 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1061
WFKnight 0:9b3d4731edbb 1062 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
WFKnight 0:9b3d4731edbb 1063 # compounds will be generated. Enable this if the project contains a lot of
WFKnight 0:9b3d4731edbb 1064 # classes, structs, unions or interfaces.
WFKnight 0:9b3d4731edbb 1065 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1066
WFKnight 0:9b3d4731edbb 1067 ALPHABETICAL_INDEX = NO
WFKnight 0:9b3d4731edbb 1068
WFKnight 0:9b3d4731edbb 1069 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
WFKnight 0:9b3d4731edbb 1070 # which the alphabetical index list will be split.
WFKnight 0:9b3d4731edbb 1071 # Minimum value: 1, maximum value: 20, default value: 5.
WFKnight 0:9b3d4731edbb 1072 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
WFKnight 0:9b3d4731edbb 1073
WFKnight 0:9b3d4731edbb 1074 COLS_IN_ALPHA_INDEX = 5
WFKnight 0:9b3d4731edbb 1075
WFKnight 0:9b3d4731edbb 1076 # In case all classes in a project start with a common prefix, all classes will
WFKnight 0:9b3d4731edbb 1077 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
WFKnight 0:9b3d4731edbb 1078 # can be used to specify a prefix (or a list of prefixes) that should be ignored
WFKnight 0:9b3d4731edbb 1079 # while generating the index headers.
WFKnight 0:9b3d4731edbb 1080 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
WFKnight 0:9b3d4731edbb 1081
WFKnight 0:9b3d4731edbb 1082 IGNORE_PREFIX =
WFKnight 0:9b3d4731edbb 1083
WFKnight 0:9b3d4731edbb 1084 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1085 # Configuration options related to the HTML output
WFKnight 0:9b3d4731edbb 1086 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1087
WFKnight 0:9b3d4731edbb 1088 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
WFKnight 0:9b3d4731edbb 1089 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1090
WFKnight 0:9b3d4731edbb 1091 GENERATE_HTML = YES
WFKnight 0:9b3d4731edbb 1092
WFKnight 0:9b3d4731edbb 1093 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
WFKnight 0:9b3d4731edbb 1094 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
WFKnight 0:9b3d4731edbb 1095 # it.
WFKnight 0:9b3d4731edbb 1096 # The default directory is: html.
WFKnight 0:9b3d4731edbb 1097 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1098
WFKnight 0:9b3d4731edbb 1099 HTML_OUTPUT = BUILD/html
WFKnight 0:9b3d4731edbb 1100
WFKnight 0:9b3d4731edbb 1101 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
WFKnight 0:9b3d4731edbb 1102 # generated HTML page (for example: .htm, .php, .asp).
WFKnight 0:9b3d4731edbb 1103 # The default value is: .html.
WFKnight 0:9b3d4731edbb 1104 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1105
WFKnight 0:9b3d4731edbb 1106 HTML_FILE_EXTENSION = .html
WFKnight 0:9b3d4731edbb 1107
WFKnight 0:9b3d4731edbb 1108 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
WFKnight 0:9b3d4731edbb 1109 # each generated HTML page. If the tag is left blank doxygen will generate a
WFKnight 0:9b3d4731edbb 1110 # standard header.
WFKnight 0:9b3d4731edbb 1111 #
WFKnight 0:9b3d4731edbb 1112 # To get valid HTML the header file that includes any scripts and style sheets
WFKnight 0:9b3d4731edbb 1113 # that doxygen needs, which is dependent on the configuration options used (e.g.
WFKnight 0:9b3d4731edbb 1114 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
WFKnight 0:9b3d4731edbb 1115 # default header using
WFKnight 0:9b3d4731edbb 1116 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
WFKnight 0:9b3d4731edbb 1117 # YourConfigFile
WFKnight 0:9b3d4731edbb 1118 # and then modify the file new_header.html. See also section "Doxygen usage"
WFKnight 0:9b3d4731edbb 1119 # for information on how to generate the default header that doxygen normally
WFKnight 0:9b3d4731edbb 1120 # uses.
WFKnight 0:9b3d4731edbb 1121 # Note: The header is subject to change so you typically have to regenerate the
WFKnight 0:9b3d4731edbb 1122 # default header when upgrading to a newer version of doxygen. For a description
WFKnight 0:9b3d4731edbb 1123 # of the possible markers and block names see the documentation.
WFKnight 0:9b3d4731edbb 1124 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1125
WFKnight 0:9b3d4731edbb 1126 HTML_HEADER =
WFKnight 0:9b3d4731edbb 1127
WFKnight 0:9b3d4731edbb 1128 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
WFKnight 0:9b3d4731edbb 1129 # generated HTML page. If the tag is left blank doxygen will generate a standard
WFKnight 0:9b3d4731edbb 1130 # footer. See HTML_HEADER for more information on how to generate a default
WFKnight 0:9b3d4731edbb 1131 # footer and what special commands can be used inside the footer. See also
WFKnight 0:9b3d4731edbb 1132 # section "Doxygen usage" for information on how to generate the default footer
WFKnight 0:9b3d4731edbb 1133 # that doxygen normally uses.
WFKnight 0:9b3d4731edbb 1134 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1135
WFKnight 0:9b3d4731edbb 1136 HTML_FOOTER =
WFKnight 0:9b3d4731edbb 1137
WFKnight 0:9b3d4731edbb 1138 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
WFKnight 0:9b3d4731edbb 1139 # sheet that is used by each HTML page. It can be used to fine-tune the look of
WFKnight 0:9b3d4731edbb 1140 # the HTML output. If left blank doxygen will generate a default style sheet.
WFKnight 0:9b3d4731edbb 1141 # See also section "Doxygen usage" for information on how to generate the style
WFKnight 0:9b3d4731edbb 1142 # sheet that doxygen normally uses.
WFKnight 0:9b3d4731edbb 1143 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
WFKnight 0:9b3d4731edbb 1144 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
WFKnight 0:9b3d4731edbb 1145 # obsolete.
WFKnight 0:9b3d4731edbb 1146 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1147
WFKnight 0:9b3d4731edbb 1148 HTML_STYLESHEET =
WFKnight 0:9b3d4731edbb 1149
WFKnight 0:9b3d4731edbb 1150 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
WFKnight 0:9b3d4731edbb 1151 # cascading style sheets that are included after the standard style sheets
WFKnight 0:9b3d4731edbb 1152 # created by doxygen. Using this option one can overrule certain style aspects.
WFKnight 0:9b3d4731edbb 1153 # This is preferred over using HTML_STYLESHEET since it does not replace the
WFKnight 0:9b3d4731edbb 1154 # standard style sheet and is therefore more robust against future updates.
WFKnight 0:9b3d4731edbb 1155 # Doxygen will copy the style sheet files to the output directory.
WFKnight 0:9b3d4731edbb 1156 # Note: The order of the extra style sheet files is of importance (e.g. the last
WFKnight 0:9b3d4731edbb 1157 # style sheet in the list overrules the setting of the previous ones in the
WFKnight 0:9b3d4731edbb 1158 # list). For an example see the documentation.
WFKnight 0:9b3d4731edbb 1159 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1160
WFKnight 0:9b3d4731edbb 1161 HTML_EXTRA_STYLESHEET =
WFKnight 0:9b3d4731edbb 1162
WFKnight 0:9b3d4731edbb 1163 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
WFKnight 0:9b3d4731edbb 1164 # other source files which should be copied to the HTML output directory. Note
WFKnight 0:9b3d4731edbb 1165 # that these files will be copied to the base HTML output directory. Use the
WFKnight 0:9b3d4731edbb 1166 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
WFKnight 0:9b3d4731edbb 1167 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
WFKnight 0:9b3d4731edbb 1168 # files will be copied as-is; there are no commands or markers available.
WFKnight 0:9b3d4731edbb 1169 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1170
WFKnight 0:9b3d4731edbb 1171 HTML_EXTRA_FILES =
WFKnight 0:9b3d4731edbb 1172
WFKnight 0:9b3d4731edbb 1173 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
WFKnight 0:9b3d4731edbb 1174 # will adjust the colors in the style sheet and background images according to
WFKnight 0:9b3d4731edbb 1175 # this color. Hue is specified as an angle on a colorwheel, see
WFKnight 0:9b3d4731edbb 1176 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
WFKnight 0:9b3d4731edbb 1177 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
WFKnight 0:9b3d4731edbb 1178 # purple, and 360 is red again.
WFKnight 0:9b3d4731edbb 1179 # Minimum value: 0, maximum value: 359, default value: 220.
WFKnight 0:9b3d4731edbb 1180 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1181
WFKnight 0:9b3d4731edbb 1182 HTML_COLORSTYLE_HUE = 220
WFKnight 0:9b3d4731edbb 1183
WFKnight 0:9b3d4731edbb 1184 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
WFKnight 0:9b3d4731edbb 1185 # in the HTML output. For a value of 0 the output will use grayscales only. A
WFKnight 0:9b3d4731edbb 1186 # value of 255 will produce the most vivid colors.
WFKnight 0:9b3d4731edbb 1187 # Minimum value: 0, maximum value: 255, default value: 100.
WFKnight 0:9b3d4731edbb 1188 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1189
WFKnight 0:9b3d4731edbb 1190 HTML_COLORSTYLE_SAT = 100
WFKnight 0:9b3d4731edbb 1191
WFKnight 0:9b3d4731edbb 1192 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
WFKnight 0:9b3d4731edbb 1193 # luminance component of the colors in the HTML output. Values below 100
WFKnight 0:9b3d4731edbb 1194 # gradually make the output lighter, whereas values above 100 make the output
WFKnight 0:9b3d4731edbb 1195 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
WFKnight 0:9b3d4731edbb 1196 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
WFKnight 0:9b3d4731edbb 1197 # change the gamma.
WFKnight 0:9b3d4731edbb 1198 # Minimum value: 40, maximum value: 240, default value: 80.
WFKnight 0:9b3d4731edbb 1199 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1200
WFKnight 0:9b3d4731edbb 1201 HTML_COLORSTYLE_GAMMA = 80
WFKnight 0:9b3d4731edbb 1202
WFKnight 0:9b3d4731edbb 1203 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
WFKnight 0:9b3d4731edbb 1204 # page will contain the date and time when the page was generated. Setting this
WFKnight 0:9b3d4731edbb 1205 # to YES can help to show when doxygen was last run and thus if the
WFKnight 0:9b3d4731edbb 1206 # documentation is up to date.
WFKnight 0:9b3d4731edbb 1207 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1208 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1209
WFKnight 0:9b3d4731edbb 1210 HTML_TIMESTAMP = NO
WFKnight 0:9b3d4731edbb 1211
WFKnight 0:9b3d4731edbb 1212 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
WFKnight 0:9b3d4731edbb 1213 # documentation will contain sections that can be hidden and shown after the
WFKnight 0:9b3d4731edbb 1214 # page has loaded.
WFKnight 0:9b3d4731edbb 1215 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1216 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1217
WFKnight 0:9b3d4731edbb 1218 HTML_DYNAMIC_SECTIONS = NO
WFKnight 0:9b3d4731edbb 1219
WFKnight 0:9b3d4731edbb 1220 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
WFKnight 0:9b3d4731edbb 1221 # shown in the various tree structured indices initially; the user can expand
WFKnight 0:9b3d4731edbb 1222 # and collapse entries dynamically later on. Doxygen will expand the tree to
WFKnight 0:9b3d4731edbb 1223 # such a level that at most the specified number of entries are visible (unless
WFKnight 0:9b3d4731edbb 1224 # a fully collapsed tree already exceeds this amount). So setting the number of
WFKnight 0:9b3d4731edbb 1225 # entries 1 will produce a full collapsed tree by default. 0 is a special value
WFKnight 0:9b3d4731edbb 1226 # representing an infinite number of entries and will result in a full expanded
WFKnight 0:9b3d4731edbb 1227 # tree by default.
WFKnight 0:9b3d4731edbb 1228 # Minimum value: 0, maximum value: 9999, default value: 100.
WFKnight 0:9b3d4731edbb 1229 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1230
WFKnight 0:9b3d4731edbb 1231 HTML_INDEX_NUM_ENTRIES = 100
WFKnight 0:9b3d4731edbb 1232
WFKnight 0:9b3d4731edbb 1233 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
WFKnight 0:9b3d4731edbb 1234 # generated that can be used as input for Apple's Xcode 3 integrated development
WFKnight 0:9b3d4731edbb 1235 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
WFKnight 0:9b3d4731edbb 1236 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
WFKnight 0:9b3d4731edbb 1237 # Makefile in the HTML output directory. Running make will produce the docset in
WFKnight 0:9b3d4731edbb 1238 # that directory and running make install will install the docset in
WFKnight 0:9b3d4731edbb 1239 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
WFKnight 0:9b3d4731edbb 1240 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
WFKnight 0:9b3d4731edbb 1241 # for more information.
WFKnight 0:9b3d4731edbb 1242 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1243 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1244
WFKnight 0:9b3d4731edbb 1245 GENERATE_DOCSET = NO
WFKnight 0:9b3d4731edbb 1246
WFKnight 0:9b3d4731edbb 1247 # This tag determines the name of the docset feed. A documentation feed provides
WFKnight 0:9b3d4731edbb 1248 # an umbrella under which multiple documentation sets from a single provider
WFKnight 0:9b3d4731edbb 1249 # (such as a company or product suite) can be grouped.
WFKnight 0:9b3d4731edbb 1250 # The default value is: Doxygen generated docs.
WFKnight 0:9b3d4731edbb 1251 # This tag requires that the tag GENERATE_DOCSET is set to YES.
WFKnight 0:9b3d4731edbb 1252
WFKnight 0:9b3d4731edbb 1253 DOCSET_FEEDNAME = "Doxygen generated docs"
WFKnight 0:9b3d4731edbb 1254
WFKnight 0:9b3d4731edbb 1255 # This tag specifies a string that should uniquely identify the documentation
WFKnight 0:9b3d4731edbb 1256 # set bundle. This should be a reverse domain-name style string, e.g.
WFKnight 0:9b3d4731edbb 1257 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
WFKnight 0:9b3d4731edbb 1258 # The default value is: org.doxygen.Project.
WFKnight 0:9b3d4731edbb 1259 # This tag requires that the tag GENERATE_DOCSET is set to YES.
WFKnight 0:9b3d4731edbb 1260
WFKnight 0:9b3d4731edbb 1261 DOCSET_BUNDLE_ID = org.doxygen.Project
WFKnight 0:9b3d4731edbb 1262
WFKnight 0:9b3d4731edbb 1263 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
WFKnight 0:9b3d4731edbb 1264 # the documentation publisher. This should be a reverse domain-name style
WFKnight 0:9b3d4731edbb 1265 # string, e.g. com.mycompany.MyDocSet.documentation.
WFKnight 0:9b3d4731edbb 1266 # The default value is: org.doxygen.Publisher.
WFKnight 0:9b3d4731edbb 1267 # This tag requires that the tag GENERATE_DOCSET is set to YES.
WFKnight 0:9b3d4731edbb 1268
WFKnight 0:9b3d4731edbb 1269 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
WFKnight 0:9b3d4731edbb 1270
WFKnight 0:9b3d4731edbb 1271 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
WFKnight 0:9b3d4731edbb 1272 # The default value is: Publisher.
WFKnight 0:9b3d4731edbb 1273 # This tag requires that the tag GENERATE_DOCSET is set to YES.
WFKnight 0:9b3d4731edbb 1274
WFKnight 0:9b3d4731edbb 1275 DOCSET_PUBLISHER_NAME = Publisher
WFKnight 0:9b3d4731edbb 1276
WFKnight 0:9b3d4731edbb 1277 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
WFKnight 0:9b3d4731edbb 1278 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
WFKnight 0:9b3d4731edbb 1279 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
WFKnight 0:9b3d4731edbb 1280 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
WFKnight 0:9b3d4731edbb 1281 # Windows.
WFKnight 0:9b3d4731edbb 1282 #
WFKnight 0:9b3d4731edbb 1283 # The HTML Help Workshop contains a compiler that can convert all HTML output
WFKnight 0:9b3d4731edbb 1284 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
WFKnight 0:9b3d4731edbb 1285 # files are now used as the Windows 98 help format, and will replace the old
WFKnight 0:9b3d4731edbb 1286 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
WFKnight 0:9b3d4731edbb 1287 # HTML files also contain an index, a table of contents, and you can search for
WFKnight 0:9b3d4731edbb 1288 # words in the documentation. The HTML workshop also contains a viewer for
WFKnight 0:9b3d4731edbb 1289 # compressed HTML files.
WFKnight 0:9b3d4731edbb 1290 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1291 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1292
WFKnight 0:9b3d4731edbb 1293 GENERATE_HTMLHELP = NO
WFKnight 0:9b3d4731edbb 1294
WFKnight 0:9b3d4731edbb 1295 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
WFKnight 0:9b3d4731edbb 1296 # file. You can add a path in front of the file if the result should not be
WFKnight 0:9b3d4731edbb 1297 # written to the html output directory.
WFKnight 0:9b3d4731edbb 1298 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
WFKnight 0:9b3d4731edbb 1299
WFKnight 0:9b3d4731edbb 1300 CHM_FILE =
WFKnight 0:9b3d4731edbb 1301
WFKnight 0:9b3d4731edbb 1302 # The HHC_LOCATION tag can be used to specify the location (absolute path
WFKnight 0:9b3d4731edbb 1303 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
WFKnight 0:9b3d4731edbb 1304 # doxygen will try to run the HTML help compiler on the generated index.hhp.
WFKnight 0:9b3d4731edbb 1305 # The file has to be specified with full path.
WFKnight 0:9b3d4731edbb 1306 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
WFKnight 0:9b3d4731edbb 1307
WFKnight 0:9b3d4731edbb 1308 HHC_LOCATION =
WFKnight 0:9b3d4731edbb 1309
WFKnight 0:9b3d4731edbb 1310 # The GENERATE_CHI flag controls if a separate .chi index file is generated
WFKnight 0:9b3d4731edbb 1311 # (YES) or that it should be included in the master .chm file (NO).
WFKnight 0:9b3d4731edbb 1312 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1313 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
WFKnight 0:9b3d4731edbb 1314
WFKnight 0:9b3d4731edbb 1315 GENERATE_CHI = NO
WFKnight 0:9b3d4731edbb 1316
WFKnight 0:9b3d4731edbb 1317 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
WFKnight 0:9b3d4731edbb 1318 # and project file content.
WFKnight 0:9b3d4731edbb 1319 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
WFKnight 0:9b3d4731edbb 1320
WFKnight 0:9b3d4731edbb 1321 CHM_INDEX_ENCODING =
WFKnight 0:9b3d4731edbb 1322
WFKnight 0:9b3d4731edbb 1323 # The BINARY_TOC flag controls whether a binary table of contents is generated
WFKnight 0:9b3d4731edbb 1324 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
WFKnight 0:9b3d4731edbb 1325 # enables the Previous and Next buttons.
WFKnight 0:9b3d4731edbb 1326 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1327 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
WFKnight 0:9b3d4731edbb 1328
WFKnight 0:9b3d4731edbb 1329 BINARY_TOC = NO
WFKnight 0:9b3d4731edbb 1330
WFKnight 0:9b3d4731edbb 1331 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
WFKnight 0:9b3d4731edbb 1332 # the table of contents of the HTML help documentation and to the tree view.
WFKnight 0:9b3d4731edbb 1333 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1334 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
WFKnight 0:9b3d4731edbb 1335
WFKnight 0:9b3d4731edbb 1336 TOC_EXPAND = NO
WFKnight 0:9b3d4731edbb 1337
WFKnight 0:9b3d4731edbb 1338 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
WFKnight 0:9b3d4731edbb 1339 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
WFKnight 0:9b3d4731edbb 1340 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
WFKnight 0:9b3d4731edbb 1341 # (.qch) of the generated HTML documentation.
WFKnight 0:9b3d4731edbb 1342 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1343 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1344
WFKnight 0:9b3d4731edbb 1345 GENERATE_QHP = NO
WFKnight 0:9b3d4731edbb 1346
WFKnight 0:9b3d4731edbb 1347 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
WFKnight 0:9b3d4731edbb 1348 # the file name of the resulting .qch file. The path specified is relative to
WFKnight 0:9b3d4731edbb 1349 # the HTML output folder.
WFKnight 0:9b3d4731edbb 1350 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1351
WFKnight 0:9b3d4731edbb 1352 QCH_FILE =
WFKnight 0:9b3d4731edbb 1353
WFKnight 0:9b3d4731edbb 1354 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
WFKnight 0:9b3d4731edbb 1355 # Project output. For more information please see Qt Help Project / Namespace
WFKnight 0:9b3d4731edbb 1356 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
WFKnight 0:9b3d4731edbb 1357 # The default value is: org.doxygen.Project.
WFKnight 0:9b3d4731edbb 1358 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1359
WFKnight 0:9b3d4731edbb 1360 QHP_NAMESPACE = org.doxygen.Project
WFKnight 0:9b3d4731edbb 1361
WFKnight 0:9b3d4731edbb 1362 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
WFKnight 0:9b3d4731edbb 1363 # Help Project output. For more information please see Qt Help Project / Virtual
WFKnight 0:9b3d4731edbb 1364 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
WFKnight 0:9b3d4731edbb 1365 # folders).
WFKnight 0:9b3d4731edbb 1366 # The default value is: doc.
WFKnight 0:9b3d4731edbb 1367 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1368
WFKnight 0:9b3d4731edbb 1369 QHP_VIRTUAL_FOLDER = doc
WFKnight 0:9b3d4731edbb 1370
WFKnight 0:9b3d4731edbb 1371 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
WFKnight 0:9b3d4731edbb 1372 # filter to add. For more information please see Qt Help Project / Custom
WFKnight 0:9b3d4731edbb 1373 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
WFKnight 0:9b3d4731edbb 1374 # filters).
WFKnight 0:9b3d4731edbb 1375 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1376
WFKnight 0:9b3d4731edbb 1377 QHP_CUST_FILTER_NAME =
WFKnight 0:9b3d4731edbb 1378
WFKnight 0:9b3d4731edbb 1379 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
WFKnight 0:9b3d4731edbb 1380 # custom filter to add. For more information please see Qt Help Project / Custom
WFKnight 0:9b3d4731edbb 1381 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
WFKnight 0:9b3d4731edbb 1382 # filters).
WFKnight 0:9b3d4731edbb 1383 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1384
WFKnight 0:9b3d4731edbb 1385 QHP_CUST_FILTER_ATTRS =
WFKnight 0:9b3d4731edbb 1386
WFKnight 0:9b3d4731edbb 1387 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
WFKnight 0:9b3d4731edbb 1388 # project's filter section matches. Qt Help Project / Filter Attributes (see:
WFKnight 0:9b3d4731edbb 1389 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
WFKnight 0:9b3d4731edbb 1390 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1391
WFKnight 0:9b3d4731edbb 1392 QHP_SECT_FILTER_ATTRS =
WFKnight 0:9b3d4731edbb 1393
WFKnight 0:9b3d4731edbb 1394 # The QHG_LOCATION tag can be used to specify the location of Qt's
WFKnight 0:9b3d4731edbb 1395 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
WFKnight 0:9b3d4731edbb 1396 # generated .qhp file.
WFKnight 0:9b3d4731edbb 1397 # This tag requires that the tag GENERATE_QHP is set to YES.
WFKnight 0:9b3d4731edbb 1398
WFKnight 0:9b3d4731edbb 1399 QHG_LOCATION =
WFKnight 0:9b3d4731edbb 1400
WFKnight 0:9b3d4731edbb 1401 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
WFKnight 0:9b3d4731edbb 1402 # generated, together with the HTML files, they form an Eclipse help plugin. To
WFKnight 0:9b3d4731edbb 1403 # install this plugin and make it available under the help contents menu in
WFKnight 0:9b3d4731edbb 1404 # Eclipse, the contents of the directory containing the HTML and XML files needs
WFKnight 0:9b3d4731edbb 1405 # to be copied into the plugins directory of eclipse. The name of the directory
WFKnight 0:9b3d4731edbb 1406 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
WFKnight 0:9b3d4731edbb 1407 # After copying Eclipse needs to be restarted before the help appears.
WFKnight 0:9b3d4731edbb 1408 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1409 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1410
WFKnight 0:9b3d4731edbb 1411 GENERATE_ECLIPSEHELP = NO
WFKnight 0:9b3d4731edbb 1412
WFKnight 0:9b3d4731edbb 1413 # A unique identifier for the Eclipse help plugin. When installing the plugin
WFKnight 0:9b3d4731edbb 1414 # the directory name containing the HTML and XML files should also have this
WFKnight 0:9b3d4731edbb 1415 # name. Each documentation set should have its own identifier.
WFKnight 0:9b3d4731edbb 1416 # The default value is: org.doxygen.Project.
WFKnight 0:9b3d4731edbb 1417 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
WFKnight 0:9b3d4731edbb 1418
WFKnight 0:9b3d4731edbb 1419 ECLIPSE_DOC_ID = org.doxygen.Project
WFKnight 0:9b3d4731edbb 1420
WFKnight 0:9b3d4731edbb 1421 # If you want full control over the layout of the generated HTML pages it might
WFKnight 0:9b3d4731edbb 1422 # be necessary to disable the index and replace it with your own. The
WFKnight 0:9b3d4731edbb 1423 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
WFKnight 0:9b3d4731edbb 1424 # of each HTML page. A value of NO enables the index and the value YES disables
WFKnight 0:9b3d4731edbb 1425 # it. Since the tabs in the index contain the same information as the navigation
WFKnight 0:9b3d4731edbb 1426 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
WFKnight 0:9b3d4731edbb 1427 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1428 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1429
WFKnight 0:9b3d4731edbb 1430 DISABLE_INDEX = YES
WFKnight 0:9b3d4731edbb 1431
WFKnight 0:9b3d4731edbb 1432 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
WFKnight 0:9b3d4731edbb 1433 # structure should be generated to display hierarchical information. If the tag
WFKnight 0:9b3d4731edbb 1434 # value is set to YES, a side panel will be generated containing a tree-like
WFKnight 0:9b3d4731edbb 1435 # index structure (just like the one that is generated for HTML Help). For this
WFKnight 0:9b3d4731edbb 1436 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
WFKnight 0:9b3d4731edbb 1437 # (i.e. any modern browser). Windows users are probably better off using the
WFKnight 0:9b3d4731edbb 1438 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
WFKnight 0:9b3d4731edbb 1439 # further fine-tune the look of the index. As an example, the default style
WFKnight 0:9b3d4731edbb 1440 # sheet generated by doxygen has an example that shows how to put an image at
WFKnight 0:9b3d4731edbb 1441 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
WFKnight 0:9b3d4731edbb 1442 # the same information as the tab index, you could consider setting
WFKnight 0:9b3d4731edbb 1443 # DISABLE_INDEX to YES when enabling this option.
WFKnight 0:9b3d4731edbb 1444 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1445 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1446
WFKnight 0:9b3d4731edbb 1447 GENERATE_TREEVIEW = NO
WFKnight 0:9b3d4731edbb 1448
WFKnight 0:9b3d4731edbb 1449 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
WFKnight 0:9b3d4731edbb 1450 # doxygen will group on one line in the generated HTML documentation.
WFKnight 0:9b3d4731edbb 1451 #
WFKnight 0:9b3d4731edbb 1452 # Note that a value of 0 will completely suppress the enum values from appearing
WFKnight 0:9b3d4731edbb 1453 # in the overview section.
WFKnight 0:9b3d4731edbb 1454 # Minimum value: 0, maximum value: 20, default value: 4.
WFKnight 0:9b3d4731edbb 1455 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1456
WFKnight 0:9b3d4731edbb 1457 ENUM_VALUES_PER_LINE = 4
WFKnight 0:9b3d4731edbb 1458
WFKnight 0:9b3d4731edbb 1459 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
WFKnight 0:9b3d4731edbb 1460 # to set the initial width (in pixels) of the frame in which the tree is shown.
WFKnight 0:9b3d4731edbb 1461 # Minimum value: 0, maximum value: 1500, default value: 250.
WFKnight 0:9b3d4731edbb 1462 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1463
WFKnight 0:9b3d4731edbb 1464 TREEVIEW_WIDTH = 250
WFKnight 0:9b3d4731edbb 1465
WFKnight 0:9b3d4731edbb 1466 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
WFKnight 0:9b3d4731edbb 1467 # external symbols imported via tag files in a separate window.
WFKnight 0:9b3d4731edbb 1468 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1469 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1470
WFKnight 0:9b3d4731edbb 1471 EXT_LINKS_IN_WINDOW = NO
WFKnight 0:9b3d4731edbb 1472
WFKnight 0:9b3d4731edbb 1473 # Use this tag to change the font size of LaTeX formulas included as images in
WFKnight 0:9b3d4731edbb 1474 # the HTML documentation. When you change the font size after a successful
WFKnight 0:9b3d4731edbb 1475 # doxygen run you need to manually remove any form_*.png images from the HTML
WFKnight 0:9b3d4731edbb 1476 # output directory to force them to be regenerated.
WFKnight 0:9b3d4731edbb 1477 # Minimum value: 8, maximum value: 50, default value: 10.
WFKnight 0:9b3d4731edbb 1478 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1479
WFKnight 0:9b3d4731edbb 1480 FORMULA_FONTSIZE = 10
WFKnight 0:9b3d4731edbb 1481
WFKnight 0:9b3d4731edbb 1482 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
WFKnight 0:9b3d4731edbb 1483 # generated for formulas are transparent PNGs. Transparent PNGs are not
WFKnight 0:9b3d4731edbb 1484 # supported properly for IE 6.0, but are supported on all modern browsers.
WFKnight 0:9b3d4731edbb 1485 #
WFKnight 0:9b3d4731edbb 1486 # Note that when changing this option you need to delete any form_*.png files in
WFKnight 0:9b3d4731edbb 1487 # the HTML output directory before the changes have effect.
WFKnight 0:9b3d4731edbb 1488 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1489 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1490
WFKnight 0:9b3d4731edbb 1491 FORMULA_TRANSPARENT = YES
WFKnight 0:9b3d4731edbb 1492
WFKnight 0:9b3d4731edbb 1493 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
WFKnight 0:9b3d4731edbb 1494 # http://www.mathjax.org) which uses client side Javascript for the rendering
WFKnight 0:9b3d4731edbb 1495 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
WFKnight 0:9b3d4731edbb 1496 # installed or if you want to formulas look prettier in the HTML output. When
WFKnight 0:9b3d4731edbb 1497 # enabled you may also need to install MathJax separately and configure the path
WFKnight 0:9b3d4731edbb 1498 # to it using the MATHJAX_RELPATH option.
WFKnight 0:9b3d4731edbb 1499 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1500 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1501
WFKnight 0:9b3d4731edbb 1502 USE_MATHJAX = NO
WFKnight 0:9b3d4731edbb 1503
WFKnight 0:9b3d4731edbb 1504 # When MathJax is enabled you can set the default output format to be used for
WFKnight 0:9b3d4731edbb 1505 # the MathJax output. See the MathJax site (see:
WFKnight 0:9b3d4731edbb 1506 # http://docs.mathjax.org/en/latest/output.html) for more details.
WFKnight 0:9b3d4731edbb 1507 # Possible values are: HTML-CSS (which is slower, but has the best
WFKnight 0:9b3d4731edbb 1508 # compatibility), NativeMML (i.e. MathML) and SVG.
WFKnight 0:9b3d4731edbb 1509 # The default value is: HTML-CSS.
WFKnight 0:9b3d4731edbb 1510 # This tag requires that the tag USE_MATHJAX is set to YES.
WFKnight 0:9b3d4731edbb 1511
WFKnight 0:9b3d4731edbb 1512 MATHJAX_FORMAT = HTML-CSS
WFKnight 0:9b3d4731edbb 1513
WFKnight 0:9b3d4731edbb 1514 # When MathJax is enabled you need to specify the location relative to the HTML
WFKnight 0:9b3d4731edbb 1515 # output directory using the MATHJAX_RELPATH option. The destination directory
WFKnight 0:9b3d4731edbb 1516 # should contain the MathJax.js script. For instance, if the mathjax directory
WFKnight 0:9b3d4731edbb 1517 # is located at the same level as the HTML output directory, then
WFKnight 0:9b3d4731edbb 1518 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
WFKnight 0:9b3d4731edbb 1519 # Content Delivery Network so you can quickly see the result without installing
WFKnight 0:9b3d4731edbb 1520 # MathJax. However, it is strongly recommended to install a local copy of
WFKnight 0:9b3d4731edbb 1521 # MathJax from http://www.mathjax.org before deployment.
WFKnight 0:9b3d4731edbb 1522 # The default value is: http://cdn.mathjax.org/mathjax/latest.
WFKnight 0:9b3d4731edbb 1523 # This tag requires that the tag USE_MATHJAX is set to YES.
WFKnight 0:9b3d4731edbb 1524
WFKnight 0:9b3d4731edbb 1525 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
WFKnight 0:9b3d4731edbb 1526
WFKnight 0:9b3d4731edbb 1527 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
WFKnight 0:9b3d4731edbb 1528 # extension names that should be enabled during MathJax rendering. For example
WFKnight 0:9b3d4731edbb 1529 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
WFKnight 0:9b3d4731edbb 1530 # This tag requires that the tag USE_MATHJAX is set to YES.
WFKnight 0:9b3d4731edbb 1531
WFKnight 0:9b3d4731edbb 1532 MATHJAX_EXTENSIONS =
WFKnight 0:9b3d4731edbb 1533
WFKnight 0:9b3d4731edbb 1534 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
WFKnight 0:9b3d4731edbb 1535 # of code that will be used on startup of the MathJax code. See the MathJax site
WFKnight 0:9b3d4731edbb 1536 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
WFKnight 0:9b3d4731edbb 1537 # example see the documentation.
WFKnight 0:9b3d4731edbb 1538 # This tag requires that the tag USE_MATHJAX is set to YES.
WFKnight 0:9b3d4731edbb 1539
WFKnight 0:9b3d4731edbb 1540 MATHJAX_CODEFILE =
WFKnight 0:9b3d4731edbb 1541
WFKnight 0:9b3d4731edbb 1542 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
WFKnight 0:9b3d4731edbb 1543 # the HTML output. The underlying search engine uses javascript and DHTML and
WFKnight 0:9b3d4731edbb 1544 # should work on any modern browser. Note that when using HTML help
WFKnight 0:9b3d4731edbb 1545 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
WFKnight 0:9b3d4731edbb 1546 # there is already a search function so this one should typically be disabled.
WFKnight 0:9b3d4731edbb 1547 # For large projects the javascript based search engine can be slow, then
WFKnight 0:9b3d4731edbb 1548 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
WFKnight 0:9b3d4731edbb 1549 # search using the keyboard; to jump to the search box use <access key> + S
WFKnight 0:9b3d4731edbb 1550 # (what the <access key> is depends on the OS and browser, but it is typically
WFKnight 0:9b3d4731edbb 1551 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
WFKnight 0:9b3d4731edbb 1552 # key> to jump into the search results window, the results can be navigated
WFKnight 0:9b3d4731edbb 1553 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
WFKnight 0:9b3d4731edbb 1554 # the search. The filter options can be selected when the cursor is inside the
WFKnight 0:9b3d4731edbb 1555 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
WFKnight 0:9b3d4731edbb 1556 # to select a filter and <Enter> or <escape> to activate or cancel the filter
WFKnight 0:9b3d4731edbb 1557 # option.
WFKnight 0:9b3d4731edbb 1558 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1559 # This tag requires that the tag GENERATE_HTML is set to YES.
WFKnight 0:9b3d4731edbb 1560
WFKnight 0:9b3d4731edbb 1561 SEARCHENGINE = NO
WFKnight 0:9b3d4731edbb 1562
WFKnight 0:9b3d4731edbb 1563 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
WFKnight 0:9b3d4731edbb 1564 # implemented using a web server instead of a web client using Javascript. There
WFKnight 0:9b3d4731edbb 1565 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
WFKnight 0:9b3d4731edbb 1566 # setting. When disabled, doxygen will generate a PHP script for searching and
WFKnight 0:9b3d4731edbb 1567 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
WFKnight 0:9b3d4731edbb 1568 # and searching needs to be provided by external tools. See the section
WFKnight 0:9b3d4731edbb 1569 # "External Indexing and Searching" for details.
WFKnight 0:9b3d4731edbb 1570 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1571 # This tag requires that the tag SEARCHENGINE is set to YES.
WFKnight 0:9b3d4731edbb 1572
WFKnight 0:9b3d4731edbb 1573 SERVER_BASED_SEARCH = NO
WFKnight 0:9b3d4731edbb 1574
WFKnight 0:9b3d4731edbb 1575 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
WFKnight 0:9b3d4731edbb 1576 # script for searching. Instead the search results are written to an XML file
WFKnight 0:9b3d4731edbb 1577 # which needs to be processed by an external indexer. Doxygen will invoke an
WFKnight 0:9b3d4731edbb 1578 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
WFKnight 0:9b3d4731edbb 1579 # search results.
WFKnight 0:9b3d4731edbb 1580 #
WFKnight 0:9b3d4731edbb 1581 # Doxygen ships with an example indexer (doxyindexer) and search engine
WFKnight 0:9b3d4731edbb 1582 # (doxysearch.cgi) which are based on the open source search engine library
WFKnight 0:9b3d4731edbb 1583 # Xapian (see: http://xapian.org/).
WFKnight 0:9b3d4731edbb 1584 #
WFKnight 0:9b3d4731edbb 1585 # See the section "External Indexing and Searching" for details.
WFKnight 0:9b3d4731edbb 1586 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1587 # This tag requires that the tag SEARCHENGINE is set to YES.
WFKnight 0:9b3d4731edbb 1588
WFKnight 0:9b3d4731edbb 1589 EXTERNAL_SEARCH = NO
WFKnight 0:9b3d4731edbb 1590
WFKnight 0:9b3d4731edbb 1591 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
WFKnight 0:9b3d4731edbb 1592 # which will return the search results when EXTERNAL_SEARCH is enabled.
WFKnight 0:9b3d4731edbb 1593 #
WFKnight 0:9b3d4731edbb 1594 # Doxygen ships with an example indexer (doxyindexer) and search engine
WFKnight 0:9b3d4731edbb 1595 # (doxysearch.cgi) which are based on the open source search engine library
WFKnight 0:9b3d4731edbb 1596 # Xapian (see: http://xapian.org/). See the section "External Indexing and
WFKnight 0:9b3d4731edbb 1597 # Searching" for details.
WFKnight 0:9b3d4731edbb 1598 # This tag requires that the tag SEARCHENGINE is set to YES.
WFKnight 0:9b3d4731edbb 1599
WFKnight 0:9b3d4731edbb 1600 SEARCHENGINE_URL =
WFKnight 0:9b3d4731edbb 1601
WFKnight 0:9b3d4731edbb 1602 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
WFKnight 0:9b3d4731edbb 1603 # search data is written to a file for indexing by an external tool. With the
WFKnight 0:9b3d4731edbb 1604 # SEARCHDATA_FILE tag the name of this file can be specified.
WFKnight 0:9b3d4731edbb 1605 # The default file is: searchdata.xml.
WFKnight 0:9b3d4731edbb 1606 # This tag requires that the tag SEARCHENGINE is set to YES.
WFKnight 0:9b3d4731edbb 1607
WFKnight 0:9b3d4731edbb 1608 SEARCHDATA_FILE = searchdata.xml
WFKnight 0:9b3d4731edbb 1609
WFKnight 0:9b3d4731edbb 1610 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
WFKnight 0:9b3d4731edbb 1611 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
WFKnight 0:9b3d4731edbb 1612 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
WFKnight 0:9b3d4731edbb 1613 # projects and redirect the results back to the right project.
WFKnight 0:9b3d4731edbb 1614 # This tag requires that the tag SEARCHENGINE is set to YES.
WFKnight 0:9b3d4731edbb 1615
WFKnight 0:9b3d4731edbb 1616 EXTERNAL_SEARCH_ID =
WFKnight 0:9b3d4731edbb 1617
WFKnight 0:9b3d4731edbb 1618 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
WFKnight 0:9b3d4731edbb 1619 # projects other than the one defined by this configuration file, but that are
WFKnight 0:9b3d4731edbb 1620 # all added to the same external search index. Each project needs to have a
WFKnight 0:9b3d4731edbb 1621 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
WFKnight 0:9b3d4731edbb 1622 # to a relative location where the documentation can be found. The format is:
WFKnight 0:9b3d4731edbb 1623 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
WFKnight 0:9b3d4731edbb 1624 # This tag requires that the tag SEARCHENGINE is set to YES.
WFKnight 0:9b3d4731edbb 1625
WFKnight 0:9b3d4731edbb 1626 EXTRA_SEARCH_MAPPINGS =
WFKnight 0:9b3d4731edbb 1627
WFKnight 0:9b3d4731edbb 1628 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1629 # Configuration options related to the LaTeX output
WFKnight 0:9b3d4731edbb 1630 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1631
WFKnight 0:9b3d4731edbb 1632 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
WFKnight 0:9b3d4731edbb 1633 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1634
WFKnight 0:9b3d4731edbb 1635 GENERATE_LATEX = NO
WFKnight 0:9b3d4731edbb 1636
WFKnight 0:9b3d4731edbb 1637 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
WFKnight 0:9b3d4731edbb 1638 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
WFKnight 0:9b3d4731edbb 1639 # it.
WFKnight 0:9b3d4731edbb 1640 # The default directory is: latex.
WFKnight 0:9b3d4731edbb 1641 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1642
WFKnight 0:9b3d4731edbb 1643 LATEX_OUTPUT = latex
WFKnight 0:9b3d4731edbb 1644
WFKnight 0:9b3d4731edbb 1645 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
WFKnight 0:9b3d4731edbb 1646 # invoked.
WFKnight 0:9b3d4731edbb 1647 #
WFKnight 0:9b3d4731edbb 1648 # Note that when enabling USE_PDFLATEX this option is only used for generating
WFKnight 0:9b3d4731edbb 1649 # bitmaps for formulas in the HTML output, but not in the Makefile that is
WFKnight 0:9b3d4731edbb 1650 # written to the output directory.
WFKnight 0:9b3d4731edbb 1651 # The default file is: latex.
WFKnight 0:9b3d4731edbb 1652 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1653
WFKnight 0:9b3d4731edbb 1654 LATEX_CMD_NAME = latex
WFKnight 0:9b3d4731edbb 1655
WFKnight 0:9b3d4731edbb 1656 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
WFKnight 0:9b3d4731edbb 1657 # index for LaTeX.
WFKnight 0:9b3d4731edbb 1658 # The default file is: makeindex.
WFKnight 0:9b3d4731edbb 1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1660
WFKnight 0:9b3d4731edbb 1661 MAKEINDEX_CMD_NAME = makeindex
WFKnight 0:9b3d4731edbb 1662
WFKnight 0:9b3d4731edbb 1663 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
WFKnight 0:9b3d4731edbb 1664 # documents. This may be useful for small projects and may help to save some
WFKnight 0:9b3d4731edbb 1665 # trees in general.
WFKnight 0:9b3d4731edbb 1666 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1667 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1668
WFKnight 0:9b3d4731edbb 1669 COMPACT_LATEX = NO
WFKnight 0:9b3d4731edbb 1670
WFKnight 0:9b3d4731edbb 1671 # The PAPER_TYPE tag can be used to set the paper type that is used by the
WFKnight 0:9b3d4731edbb 1672 # printer.
WFKnight 0:9b3d4731edbb 1673 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
WFKnight 0:9b3d4731edbb 1674 # 14 inches) and executive (7.25 x 10.5 inches).
WFKnight 0:9b3d4731edbb 1675 # The default value is: a4.
WFKnight 0:9b3d4731edbb 1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1677
WFKnight 0:9b3d4731edbb 1678 PAPER_TYPE = a4wide
WFKnight 0:9b3d4731edbb 1679
WFKnight 0:9b3d4731edbb 1680 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
WFKnight 0:9b3d4731edbb 1681 # that should be included in the LaTeX output. The package can be specified just
WFKnight 0:9b3d4731edbb 1682 # by its name or with the correct syntax as to be used with the LaTeX
WFKnight 0:9b3d4731edbb 1683 # \usepackage command. To get the times font for instance you can specify :
WFKnight 0:9b3d4731edbb 1684 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
WFKnight 0:9b3d4731edbb 1685 # To use the option intlimits with the amsmath package you can specify:
WFKnight 0:9b3d4731edbb 1686 # EXTRA_PACKAGES=[intlimits]{amsmath}
WFKnight 0:9b3d4731edbb 1687 # If left blank no extra packages will be included.
WFKnight 0:9b3d4731edbb 1688 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1689
WFKnight 0:9b3d4731edbb 1690 EXTRA_PACKAGES =
WFKnight 0:9b3d4731edbb 1691
WFKnight 0:9b3d4731edbb 1692 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
WFKnight 0:9b3d4731edbb 1693 # generated LaTeX document. The header should contain everything until the first
WFKnight 0:9b3d4731edbb 1694 # chapter. If it is left blank doxygen will generate a standard header. See
WFKnight 0:9b3d4731edbb 1695 # section "Doxygen usage" for information on how to let doxygen write the
WFKnight 0:9b3d4731edbb 1696 # default header to a separate file.
WFKnight 0:9b3d4731edbb 1697 #
WFKnight 0:9b3d4731edbb 1698 # Note: Only use a user-defined header if you know what you are doing! The
WFKnight 0:9b3d4731edbb 1699 # following commands have a special meaning inside the header: $title,
WFKnight 0:9b3d4731edbb 1700 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
WFKnight 0:9b3d4731edbb 1701 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
WFKnight 0:9b3d4731edbb 1702 # string, for the replacement values of the other commands the user is referred
WFKnight 0:9b3d4731edbb 1703 # to HTML_HEADER.
WFKnight 0:9b3d4731edbb 1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1705
WFKnight 0:9b3d4731edbb 1706 LATEX_HEADER =
WFKnight 0:9b3d4731edbb 1707
WFKnight 0:9b3d4731edbb 1708 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
WFKnight 0:9b3d4731edbb 1709 # generated LaTeX document. The footer should contain everything after the last
WFKnight 0:9b3d4731edbb 1710 # chapter. If it is left blank doxygen will generate a standard footer. See
WFKnight 0:9b3d4731edbb 1711 # LATEX_HEADER for more information on how to generate a default footer and what
WFKnight 0:9b3d4731edbb 1712 # special commands can be used inside the footer.
WFKnight 0:9b3d4731edbb 1713 #
WFKnight 0:9b3d4731edbb 1714 # Note: Only use a user-defined footer if you know what you are doing!
WFKnight 0:9b3d4731edbb 1715 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1716
WFKnight 0:9b3d4731edbb 1717 LATEX_FOOTER =
WFKnight 0:9b3d4731edbb 1718
WFKnight 0:9b3d4731edbb 1719 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
WFKnight 0:9b3d4731edbb 1720 # LaTeX style sheets that are included after the standard style sheets created
WFKnight 0:9b3d4731edbb 1721 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
WFKnight 0:9b3d4731edbb 1722 # will copy the style sheet files to the output directory.
WFKnight 0:9b3d4731edbb 1723 # Note: The order of the extra style sheet files is of importance (e.g. the last
WFKnight 0:9b3d4731edbb 1724 # style sheet in the list overrules the setting of the previous ones in the
WFKnight 0:9b3d4731edbb 1725 # list).
WFKnight 0:9b3d4731edbb 1726 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1727
WFKnight 0:9b3d4731edbb 1728 #LATEX_EXTRA_STYLESHEET =
WFKnight 0:9b3d4731edbb 1729
WFKnight 0:9b3d4731edbb 1730 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
WFKnight 0:9b3d4731edbb 1731 # other source files which should be copied to the LATEX_OUTPUT output
WFKnight 0:9b3d4731edbb 1732 # directory. Note that the files will be copied as-is; there are no commands or
WFKnight 0:9b3d4731edbb 1733 # markers available.
WFKnight 0:9b3d4731edbb 1734 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1735
WFKnight 0:9b3d4731edbb 1736 LATEX_EXTRA_FILES =
WFKnight 0:9b3d4731edbb 1737
WFKnight 0:9b3d4731edbb 1738 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
WFKnight 0:9b3d4731edbb 1739 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
WFKnight 0:9b3d4731edbb 1740 # contain links (just like the HTML output) instead of page references. This
WFKnight 0:9b3d4731edbb 1741 # makes the output suitable for online browsing using a PDF viewer.
WFKnight 0:9b3d4731edbb 1742 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1743 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1744
WFKnight 0:9b3d4731edbb 1745 PDF_HYPERLINKS = YES
WFKnight 0:9b3d4731edbb 1746
WFKnight 0:9b3d4731edbb 1747 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
WFKnight 0:9b3d4731edbb 1748 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
WFKnight 0:9b3d4731edbb 1749 # higher quality PDF documentation.
WFKnight 0:9b3d4731edbb 1750 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1751 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1752
WFKnight 0:9b3d4731edbb 1753 USE_PDFLATEX = YES
WFKnight 0:9b3d4731edbb 1754
WFKnight 0:9b3d4731edbb 1755 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
WFKnight 0:9b3d4731edbb 1756 # command to the generated LaTeX files. This will instruct LaTeX to keep running
WFKnight 0:9b3d4731edbb 1757 # if errors occur, instead of asking the user for help. This option is also used
WFKnight 0:9b3d4731edbb 1758 # when generating formulas in HTML.
WFKnight 0:9b3d4731edbb 1759 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1760 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1761
WFKnight 0:9b3d4731edbb 1762 LATEX_BATCHMODE = NO
WFKnight 0:9b3d4731edbb 1763
WFKnight 0:9b3d4731edbb 1764 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
WFKnight 0:9b3d4731edbb 1765 # index chapters (such as File Index, Compound Index, etc.) in the output.
WFKnight 0:9b3d4731edbb 1766 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1767 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1768
WFKnight 0:9b3d4731edbb 1769 LATEX_HIDE_INDICES = NO
WFKnight 0:9b3d4731edbb 1770
WFKnight 0:9b3d4731edbb 1771 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
WFKnight 0:9b3d4731edbb 1772 # code with syntax highlighting in the LaTeX output.
WFKnight 0:9b3d4731edbb 1773 #
WFKnight 0:9b3d4731edbb 1774 # Note that which sources are shown also depends on other settings such as
WFKnight 0:9b3d4731edbb 1775 # SOURCE_BROWSER.
WFKnight 0:9b3d4731edbb 1776 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1777 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1778
WFKnight 0:9b3d4731edbb 1779 LATEX_SOURCE_CODE = NO
WFKnight 0:9b3d4731edbb 1780
WFKnight 0:9b3d4731edbb 1781 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
WFKnight 0:9b3d4731edbb 1782 # bibliography, e.g. plainnat, or ieeetr. See
WFKnight 0:9b3d4731edbb 1783 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
WFKnight 0:9b3d4731edbb 1784 # The default value is: plain.
WFKnight 0:9b3d4731edbb 1785 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1786
WFKnight 0:9b3d4731edbb 1787 LATEX_BIB_STYLE = plain
WFKnight 0:9b3d4731edbb 1788
WFKnight 0:9b3d4731edbb 1789 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
WFKnight 0:9b3d4731edbb 1790 # page will contain the date and time when the page was generated. Setting this
WFKnight 0:9b3d4731edbb 1791 # to NO can help when comparing the output of multiple runs.
WFKnight 0:9b3d4731edbb 1792 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1793 # This tag requires that the tag GENERATE_LATEX is set to YES.
WFKnight 0:9b3d4731edbb 1794
WFKnight 0:9b3d4731edbb 1795 #LATEX_TIMESTAMP = NO
WFKnight 0:9b3d4731edbb 1796
WFKnight 0:9b3d4731edbb 1797 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1798 # Configuration options related to the RTF output
WFKnight 0:9b3d4731edbb 1799 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1800
WFKnight 0:9b3d4731edbb 1801 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
WFKnight 0:9b3d4731edbb 1802 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
WFKnight 0:9b3d4731edbb 1803 # readers/editors.
WFKnight 0:9b3d4731edbb 1804 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1805
WFKnight 0:9b3d4731edbb 1806 GENERATE_RTF = NO
WFKnight 0:9b3d4731edbb 1807
WFKnight 0:9b3d4731edbb 1808 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
WFKnight 0:9b3d4731edbb 1809 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
WFKnight 0:9b3d4731edbb 1810 # it.
WFKnight 0:9b3d4731edbb 1811 # The default directory is: rtf.
WFKnight 0:9b3d4731edbb 1812 # This tag requires that the tag GENERATE_RTF is set to YES.
WFKnight 0:9b3d4731edbb 1813
WFKnight 0:9b3d4731edbb 1814 RTF_OUTPUT = rtf
WFKnight 0:9b3d4731edbb 1815
WFKnight 0:9b3d4731edbb 1816 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
WFKnight 0:9b3d4731edbb 1817 # documents. This may be useful for small projects and may help to save some
WFKnight 0:9b3d4731edbb 1818 # trees in general.
WFKnight 0:9b3d4731edbb 1819 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1820 # This tag requires that the tag GENERATE_RTF is set to YES.
WFKnight 0:9b3d4731edbb 1821
WFKnight 0:9b3d4731edbb 1822 COMPACT_RTF = NO
WFKnight 0:9b3d4731edbb 1823
WFKnight 0:9b3d4731edbb 1824 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
WFKnight 0:9b3d4731edbb 1825 # contain hyperlink fields. The RTF file will contain links (just like the HTML
WFKnight 0:9b3d4731edbb 1826 # output) instead of page references. This makes the output suitable for online
WFKnight 0:9b3d4731edbb 1827 # browsing using Word or some other Word compatible readers that support those
WFKnight 0:9b3d4731edbb 1828 # fields.
WFKnight 0:9b3d4731edbb 1829 #
WFKnight 0:9b3d4731edbb 1830 # Note: WordPad (write) and others do not support links.
WFKnight 0:9b3d4731edbb 1831 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1832 # This tag requires that the tag GENERATE_RTF is set to YES.
WFKnight 0:9b3d4731edbb 1833
WFKnight 0:9b3d4731edbb 1834 RTF_HYPERLINKS = NO
WFKnight 0:9b3d4731edbb 1835
WFKnight 0:9b3d4731edbb 1836 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
WFKnight 0:9b3d4731edbb 1837 # file, i.e. a series of assignments. You only have to provide replacements,
WFKnight 0:9b3d4731edbb 1838 # missing definitions are set to their default value.
WFKnight 0:9b3d4731edbb 1839 #
WFKnight 0:9b3d4731edbb 1840 # See also section "Doxygen usage" for information on how to generate the
WFKnight 0:9b3d4731edbb 1841 # default style sheet that doxygen normally uses.
WFKnight 0:9b3d4731edbb 1842 # This tag requires that the tag GENERATE_RTF is set to YES.
WFKnight 0:9b3d4731edbb 1843
WFKnight 0:9b3d4731edbb 1844 RTF_STYLESHEET_FILE =
WFKnight 0:9b3d4731edbb 1845
WFKnight 0:9b3d4731edbb 1846 # Set optional variables used in the generation of an RTF document. Syntax is
WFKnight 0:9b3d4731edbb 1847 # similar to doxygen's config file. A template extensions file can be generated
WFKnight 0:9b3d4731edbb 1848 # using doxygen -e rtf extensionFile.
WFKnight 0:9b3d4731edbb 1849 # This tag requires that the tag GENERATE_RTF is set to YES.
WFKnight 0:9b3d4731edbb 1850
WFKnight 0:9b3d4731edbb 1851 RTF_EXTENSIONS_FILE =
WFKnight 0:9b3d4731edbb 1852
WFKnight 0:9b3d4731edbb 1853 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
WFKnight 0:9b3d4731edbb 1854 # with syntax highlighting in the RTF output.
WFKnight 0:9b3d4731edbb 1855 #
WFKnight 0:9b3d4731edbb 1856 # Note that which sources are shown also depends on other settings such as
WFKnight 0:9b3d4731edbb 1857 # SOURCE_BROWSER.
WFKnight 0:9b3d4731edbb 1858 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1859 # This tag requires that the tag GENERATE_RTF is set to YES.
WFKnight 0:9b3d4731edbb 1860
WFKnight 0:9b3d4731edbb 1861 #RTF_SOURCE_CODE = NO
WFKnight 0:9b3d4731edbb 1862
WFKnight 0:9b3d4731edbb 1863 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1864 # Configuration options related to the man page output
WFKnight 0:9b3d4731edbb 1865 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1866
WFKnight 0:9b3d4731edbb 1867 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
WFKnight 0:9b3d4731edbb 1868 # classes and files.
WFKnight 0:9b3d4731edbb 1869 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1870
WFKnight 0:9b3d4731edbb 1871 GENERATE_MAN = NO
WFKnight 0:9b3d4731edbb 1872
WFKnight 0:9b3d4731edbb 1873 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
WFKnight 0:9b3d4731edbb 1874 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
WFKnight 0:9b3d4731edbb 1875 # it. A directory man3 will be created inside the directory specified by
WFKnight 0:9b3d4731edbb 1876 # MAN_OUTPUT.
WFKnight 0:9b3d4731edbb 1877 # The default directory is: man.
WFKnight 0:9b3d4731edbb 1878 # This tag requires that the tag GENERATE_MAN is set to YES.
WFKnight 0:9b3d4731edbb 1879
WFKnight 0:9b3d4731edbb 1880 MAN_OUTPUT = man
WFKnight 0:9b3d4731edbb 1881
WFKnight 0:9b3d4731edbb 1882 # The MAN_EXTENSION tag determines the extension that is added to the generated
WFKnight 0:9b3d4731edbb 1883 # man pages. In case the manual section does not start with a number, the number
WFKnight 0:9b3d4731edbb 1884 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
WFKnight 0:9b3d4731edbb 1885 # optional.
WFKnight 0:9b3d4731edbb 1886 # The default value is: .3.
WFKnight 0:9b3d4731edbb 1887 # This tag requires that the tag GENERATE_MAN is set to YES.
WFKnight 0:9b3d4731edbb 1888
WFKnight 0:9b3d4731edbb 1889 MAN_EXTENSION = .3
WFKnight 0:9b3d4731edbb 1890
WFKnight 0:9b3d4731edbb 1891 # The MAN_SUBDIR tag determines the name of the directory created within
WFKnight 0:9b3d4731edbb 1892 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
WFKnight 0:9b3d4731edbb 1893 # MAN_EXTENSION with the initial . removed.
WFKnight 0:9b3d4731edbb 1894 # This tag requires that the tag GENERATE_MAN is set to YES.
WFKnight 0:9b3d4731edbb 1895
WFKnight 0:9b3d4731edbb 1896 #MAN_SUBDIR =
WFKnight 0:9b3d4731edbb 1897
WFKnight 0:9b3d4731edbb 1898 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
WFKnight 0:9b3d4731edbb 1899 # will generate one additional man file for each entity documented in the real
WFKnight 0:9b3d4731edbb 1900 # man page(s). These additional files only source the real man page, but without
WFKnight 0:9b3d4731edbb 1901 # them the man command would be unable to find the correct page.
WFKnight 0:9b3d4731edbb 1902 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1903 # This tag requires that the tag GENERATE_MAN is set to YES.
WFKnight 0:9b3d4731edbb 1904
WFKnight 0:9b3d4731edbb 1905 MAN_LINKS = NO
WFKnight 0:9b3d4731edbb 1906
WFKnight 0:9b3d4731edbb 1907 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1908 # Configuration options related to the XML output
WFKnight 0:9b3d4731edbb 1909 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1910
WFKnight 0:9b3d4731edbb 1911 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
WFKnight 0:9b3d4731edbb 1912 # captures the structure of the code including all documentation.
WFKnight 0:9b3d4731edbb 1913 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1914
WFKnight 0:9b3d4731edbb 1915 GENERATE_XML = YES
WFKnight 0:9b3d4731edbb 1916
WFKnight 0:9b3d4731edbb 1917 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
WFKnight 0:9b3d4731edbb 1918 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
WFKnight 0:9b3d4731edbb 1919 # it.
WFKnight 0:9b3d4731edbb 1920 # The default directory is: xml.
WFKnight 0:9b3d4731edbb 1921 # This tag requires that the tag GENERATE_XML is set to YES.
WFKnight 0:9b3d4731edbb 1922
WFKnight 0:9b3d4731edbb 1923 XML_OUTPUT = BUILD/xml
WFKnight 0:9b3d4731edbb 1924
WFKnight 0:9b3d4731edbb 1925 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
WFKnight 0:9b3d4731edbb 1926 # listings (including syntax highlighting and cross-referencing information) to
WFKnight 0:9b3d4731edbb 1927 # the XML output. Note that enabling this will significantly increase the size
WFKnight 0:9b3d4731edbb 1928 # of the XML output.
WFKnight 0:9b3d4731edbb 1929 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1930 # This tag requires that the tag GENERATE_XML is set to YES.
WFKnight 0:9b3d4731edbb 1931
WFKnight 0:9b3d4731edbb 1932 XML_PROGRAMLISTING = YES
WFKnight 0:9b3d4731edbb 1933
WFKnight 0:9b3d4731edbb 1934 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1935 # Configuration options related to the DOCBOOK output
WFKnight 0:9b3d4731edbb 1936 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1937
WFKnight 0:9b3d4731edbb 1938 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
WFKnight 0:9b3d4731edbb 1939 # that can be used to generate PDF.
WFKnight 0:9b3d4731edbb 1940 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1941
WFKnight 0:9b3d4731edbb 1942 GENERATE_DOCBOOK = NO
WFKnight 0:9b3d4731edbb 1943
WFKnight 0:9b3d4731edbb 1944 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
WFKnight 0:9b3d4731edbb 1945 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
WFKnight 0:9b3d4731edbb 1946 # front of it.
WFKnight 0:9b3d4731edbb 1947 # The default directory is: docbook.
WFKnight 0:9b3d4731edbb 1948 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
WFKnight 0:9b3d4731edbb 1949
WFKnight 0:9b3d4731edbb 1950 DOCBOOK_OUTPUT = docbook
WFKnight 0:9b3d4731edbb 1951
WFKnight 0:9b3d4731edbb 1952 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
WFKnight 0:9b3d4731edbb 1953 # program listings (including syntax highlighting and cross-referencing
WFKnight 0:9b3d4731edbb 1954 # information) to the DOCBOOK output. Note that enabling this will significantly
WFKnight 0:9b3d4731edbb 1955 # increase the size of the DOCBOOK output.
WFKnight 0:9b3d4731edbb 1956 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1957 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
WFKnight 0:9b3d4731edbb 1958
WFKnight 0:9b3d4731edbb 1959 #DOCBOOK_PROGRAMLISTING = NO
WFKnight 0:9b3d4731edbb 1960
WFKnight 0:9b3d4731edbb 1961 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1962 # Configuration options for the AutoGen Definitions output
WFKnight 0:9b3d4731edbb 1963 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1964
WFKnight 0:9b3d4731edbb 1965 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
WFKnight 0:9b3d4731edbb 1966 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
WFKnight 0:9b3d4731edbb 1967 # structure of the code including all documentation. Note that this feature is
WFKnight 0:9b3d4731edbb 1968 # still experimental and incomplete at the moment.
WFKnight 0:9b3d4731edbb 1969 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1970
WFKnight 0:9b3d4731edbb 1971 GENERATE_AUTOGEN_DEF = NO
WFKnight 0:9b3d4731edbb 1972
WFKnight 0:9b3d4731edbb 1973 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1974 # Configuration options related to the Perl module output
WFKnight 0:9b3d4731edbb 1975 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 1976
WFKnight 0:9b3d4731edbb 1977 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
WFKnight 0:9b3d4731edbb 1978 # file that captures the structure of the code including all documentation.
WFKnight 0:9b3d4731edbb 1979 #
WFKnight 0:9b3d4731edbb 1980 # Note that this feature is still experimental and incomplete at the moment.
WFKnight 0:9b3d4731edbb 1981 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1982
WFKnight 0:9b3d4731edbb 1983 GENERATE_PERLMOD = NO
WFKnight 0:9b3d4731edbb 1984
WFKnight 0:9b3d4731edbb 1985 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
WFKnight 0:9b3d4731edbb 1986 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
WFKnight 0:9b3d4731edbb 1987 # output from the Perl module output.
WFKnight 0:9b3d4731edbb 1988 # The default value is: NO.
WFKnight 0:9b3d4731edbb 1989 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
WFKnight 0:9b3d4731edbb 1990
WFKnight 0:9b3d4731edbb 1991 PERLMOD_LATEX = NO
WFKnight 0:9b3d4731edbb 1992
WFKnight 0:9b3d4731edbb 1993 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
WFKnight 0:9b3d4731edbb 1994 # formatted so it can be parsed by a human reader. This is useful if you want to
WFKnight 0:9b3d4731edbb 1995 # understand what is going on. On the other hand, if this tag is set to NO, the
WFKnight 0:9b3d4731edbb 1996 # size of the Perl module output will be much smaller and Perl will parse it
WFKnight 0:9b3d4731edbb 1997 # just the same.
WFKnight 0:9b3d4731edbb 1998 # The default value is: YES.
WFKnight 0:9b3d4731edbb 1999 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
WFKnight 0:9b3d4731edbb 2000
WFKnight 0:9b3d4731edbb 2001 PERLMOD_PRETTY = YES
WFKnight 0:9b3d4731edbb 2002
WFKnight 0:9b3d4731edbb 2003 # The names of the make variables in the generated doxyrules.make file are
WFKnight 0:9b3d4731edbb 2004 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
WFKnight 0:9b3d4731edbb 2005 # so different doxyrules.make files included by the same Makefile don't
WFKnight 0:9b3d4731edbb 2006 # overwrite each other's variables.
WFKnight 0:9b3d4731edbb 2007 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
WFKnight 0:9b3d4731edbb 2008
WFKnight 0:9b3d4731edbb 2009 PERLMOD_MAKEVAR_PREFIX =
WFKnight 0:9b3d4731edbb 2010
WFKnight 0:9b3d4731edbb 2011 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 2012 # Configuration options related to the preprocessor
WFKnight 0:9b3d4731edbb 2013 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 2014
WFKnight 0:9b3d4731edbb 2015 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
WFKnight 0:9b3d4731edbb 2016 # C-preprocessor directives found in the sources and include files.
WFKnight 0:9b3d4731edbb 2017 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2018
WFKnight 0:9b3d4731edbb 2019 ENABLE_PREPROCESSING = YES
WFKnight 0:9b3d4731edbb 2020
WFKnight 0:9b3d4731edbb 2021 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
WFKnight 0:9b3d4731edbb 2022 # in the source code. If set to NO, only conditional compilation will be
WFKnight 0:9b3d4731edbb 2023 # performed. Macro expansion can be done in a controlled way by setting
WFKnight 0:9b3d4731edbb 2024 # EXPAND_ONLY_PREDEF to YES.
WFKnight 0:9b3d4731edbb 2025 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2026 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2027
WFKnight 0:9b3d4731edbb 2028 MACRO_EXPANSION = YES
WFKnight 0:9b3d4731edbb 2029
WFKnight 0:9b3d4731edbb 2030 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
WFKnight 0:9b3d4731edbb 2031 # the macro expansion is limited to the macros specified with the PREDEFINED and
WFKnight 0:9b3d4731edbb 2032 # EXPAND_AS_DEFINED tags.
WFKnight 0:9b3d4731edbb 2033 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2034 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2035
WFKnight 0:9b3d4731edbb 2036 EXPAND_ONLY_PREDEF = NO
WFKnight 0:9b3d4731edbb 2037
WFKnight 0:9b3d4731edbb 2038 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
WFKnight 0:9b3d4731edbb 2039 # INCLUDE_PATH will be searched if a #include is found.
WFKnight 0:9b3d4731edbb 2040 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2041 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2042
WFKnight 0:9b3d4731edbb 2043 SEARCH_INCLUDES = YES
WFKnight 0:9b3d4731edbb 2044
WFKnight 0:9b3d4731edbb 2045 # The INCLUDE_PATH tag can be used to specify one or more directories that
WFKnight 0:9b3d4731edbb 2046 # contain include files that are not input files but should be processed by the
WFKnight 0:9b3d4731edbb 2047 # preprocessor.
WFKnight 0:9b3d4731edbb 2048 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
WFKnight 0:9b3d4731edbb 2049
WFKnight 0:9b3d4731edbb 2050 INCLUDE_PATH =
WFKnight 0:9b3d4731edbb 2051
WFKnight 0:9b3d4731edbb 2052 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
WFKnight 0:9b3d4731edbb 2053 # patterns (like *.h and *.hpp) to filter out the header-files in the
WFKnight 0:9b3d4731edbb 2054 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
WFKnight 0:9b3d4731edbb 2055 # used.
WFKnight 0:9b3d4731edbb 2056 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2057
WFKnight 0:9b3d4731edbb 2058 INCLUDE_FILE_PATTERNS =
WFKnight 0:9b3d4731edbb 2059
WFKnight 0:9b3d4731edbb 2060 # The PREDEFINED tag can be used to specify one or more macro names that are
WFKnight 0:9b3d4731edbb 2061 # defined before the preprocessor is started (similar to the -D option of e.g.
WFKnight 0:9b3d4731edbb 2062 # gcc). The argument of the tag is a list of macros of the form: name or
WFKnight 0:9b3d4731edbb 2063 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
WFKnight 0:9b3d4731edbb 2064 # is assumed. To prevent a macro definition from being undefined via #undef or
WFKnight 0:9b3d4731edbb 2065 # recursively expanded use the := operator instead of the = operator.
WFKnight 0:9b3d4731edbb 2066 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2067
WFKnight 0:9b3d4731edbb 2068 PREDEFINED = DOXYGEN_ONLY \
WFKnight 0:9b3d4731edbb 2069 DEVICE_ANALOGIN \
WFKnight 0:9b3d4731edbb 2070 DEVICE_ANALOGOUT \
WFKnight 0:9b3d4731edbb 2071 DEVICE_CAN \
WFKnight 0:9b3d4731edbb 2072 DEVICE_CRC \
WFKnight 0:9b3d4731edbb 2073 DEVICE_ETHERNET \
WFKnight 0:9b3d4731edbb 2074 DEVICE_EMAC \
WFKnight 0:9b3d4731edbb 2075 DEVICE_ETH \
WFKnight 0:9b3d4731edbb 2076 DEVICE_FLASH \
WFKnight 0:9b3d4731edbb 2077 DEVICE_I2C \
WFKnight 0:9b3d4731edbb 2078 DEVICE_I2CSLAVE \
WFKnight 0:9b3d4731edbb 2079 DEVICE_I2C_ASYNCH \
WFKnight 0:9b3d4731edbb 2080 DEVICE_INTERRUPTIN \
WFKnight 0:9b3d4731edbb 2081 DEVICE_ITM \
WFKnight 0:9b3d4731edbb 2082 DEVICE_LPTICKER \
WFKnight 0:9b3d4731edbb 2083 DEVICE_PORTIN \
WFKnight 0:9b3d4731edbb 2084 DEVICE_PORTINOUT \
WFKnight 0:9b3d4731edbb 2085 DEVICE_PORTOUT \
WFKnight 0:9b3d4731edbb 2086 DEVICE_PWMOUT \
WFKnight 0:9b3d4731edbb 2087 DEVICE_RTC \
WFKnight 0:9b3d4731edbb 2088 DEVICE_TRNG \
WFKnight 0:9b3d4731edbb 2089 DEVICE_SERIAL \
WFKnight 0:9b3d4731edbb 2090 DEVICE_SERIAL_ASYNCH \
WFKnight 0:9b3d4731edbb 2091 DEVICE_SERIAL_FC \
WFKnight 0:9b3d4731edbb 2092 DEVICE_SLEEP \
WFKnight 0:9b3d4731edbb 2093 DEVICE_SPI \
WFKnight 0:9b3d4731edbb 2094 DEVICE_SPI_ASYNCH \
WFKnight 0:9b3d4731edbb 2095 DEVICE_SPISLAVE \
WFKnight 0:9b3d4731edbb 2096 DEVICE_STORAGE \
WFKnight 0:9b3d4731edbb 2097 "MBED_DEPRECATED_SINCE(d, m)=" \
WFKnight 0:9b3d4731edbb 2098 "MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=" \
WFKnight 0:9b3d4731edbb 2099 "MBED_DEPRECATED(s)="
WFKnight 0:9b3d4731edbb 2100
WFKnight 0:9b3d4731edbb 2101 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
WFKnight 0:9b3d4731edbb 2102 # tag can be used to specify a list of macro names that should be expanded. The
WFKnight 0:9b3d4731edbb 2103 # macro definition that is found in the sources will be used. Use the PREDEFINED
WFKnight 0:9b3d4731edbb 2104 # tag if you want to use a different macro definition that overrules the
WFKnight 0:9b3d4731edbb 2105 # definition found in the source code.
WFKnight 0:9b3d4731edbb 2106 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2107
WFKnight 0:9b3d4731edbb 2108 EXPAND_AS_DEFINED =
WFKnight 0:9b3d4731edbb 2109
WFKnight 0:9b3d4731edbb 2110 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
WFKnight 0:9b3d4731edbb 2111 # remove all references to function-like macros that are alone on a line, have
WFKnight 0:9b3d4731edbb 2112 # an all uppercase name, and do not end with a semicolon. Such function macros
WFKnight 0:9b3d4731edbb 2113 # are typically used for boiler-plate code, and will confuse the parser if not
WFKnight 0:9b3d4731edbb 2114 # removed.
WFKnight 0:9b3d4731edbb 2115 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2116 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
WFKnight 0:9b3d4731edbb 2117
WFKnight 0:9b3d4731edbb 2118 SKIP_FUNCTION_MACROS = NO
WFKnight 0:9b3d4731edbb 2119
WFKnight 0:9b3d4731edbb 2120 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 2121 # Configuration options related to external references
WFKnight 0:9b3d4731edbb 2122 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 2123
WFKnight 0:9b3d4731edbb 2124 # The TAGFILES tag can be used to specify one or more tag files. For each tag
WFKnight 0:9b3d4731edbb 2125 # file the location of the external documentation should be added. The format of
WFKnight 0:9b3d4731edbb 2126 # a tag file without this location is as follows:
WFKnight 0:9b3d4731edbb 2127 # TAGFILES = file1 file2 ...
WFKnight 0:9b3d4731edbb 2128 # Adding location for the tag files is done as follows:
WFKnight 0:9b3d4731edbb 2129 # TAGFILES = file1=loc1 "file2 = loc2" ...
WFKnight 0:9b3d4731edbb 2130 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
WFKnight 0:9b3d4731edbb 2131 # section "Linking to external documentation" for more information about the use
WFKnight 0:9b3d4731edbb 2132 # of tag files.
WFKnight 0:9b3d4731edbb 2133 # Note: Each tag file must have a unique name (where the name does NOT include
WFKnight 0:9b3d4731edbb 2134 # the path). If a tag file is not located in the directory in which doxygen is
WFKnight 0:9b3d4731edbb 2135 # run, you must also specify the path to the tagfile here.
WFKnight 0:9b3d4731edbb 2136
WFKnight 0:9b3d4731edbb 2137 TAGFILES =
WFKnight 0:9b3d4731edbb 2138
WFKnight 0:9b3d4731edbb 2139 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
WFKnight 0:9b3d4731edbb 2140 # tag file that is based on the input files it reads. See section "Linking to
WFKnight 0:9b3d4731edbb 2141 # external documentation" for more information about the usage of tag files.
WFKnight 0:9b3d4731edbb 2142
WFKnight 0:9b3d4731edbb 2143 GENERATE_TAGFILE =
WFKnight 0:9b3d4731edbb 2144
WFKnight 0:9b3d4731edbb 2145 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
WFKnight 0:9b3d4731edbb 2146 # the class index. If set to NO, only the inherited external classes will be
WFKnight 0:9b3d4731edbb 2147 # listed.
WFKnight 0:9b3d4731edbb 2148 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2149
WFKnight 0:9b3d4731edbb 2150 ALLEXTERNALS = NO
WFKnight 0:9b3d4731edbb 2151
WFKnight 0:9b3d4731edbb 2152 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
WFKnight 0:9b3d4731edbb 2153 # in the modules index. If set to NO, only the current project's groups will be
WFKnight 0:9b3d4731edbb 2154 # listed.
WFKnight 0:9b3d4731edbb 2155 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2156
WFKnight 0:9b3d4731edbb 2157 EXTERNAL_GROUPS = YES
WFKnight 0:9b3d4731edbb 2158
WFKnight 0:9b3d4731edbb 2159 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
WFKnight 0:9b3d4731edbb 2160 # the related pages index. If set to NO, only the current project's pages will
WFKnight 0:9b3d4731edbb 2161 # be listed.
WFKnight 0:9b3d4731edbb 2162 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2163
WFKnight 0:9b3d4731edbb 2164 EXTERNAL_PAGES = YES
WFKnight 0:9b3d4731edbb 2165
WFKnight 0:9b3d4731edbb 2166 # The PERL_PATH should be the absolute path and name of the perl script
WFKnight 0:9b3d4731edbb 2167 # interpreter (i.e. the result of 'which perl').
WFKnight 0:9b3d4731edbb 2168 # The default file (with absolute path) is: /usr/bin/perl.
WFKnight 0:9b3d4731edbb 2169
WFKnight 0:9b3d4731edbb 2170 PERL_PATH = /usr/bin/perl
WFKnight 0:9b3d4731edbb 2171
WFKnight 0:9b3d4731edbb 2172 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 2173 # Configuration options related to the dot tool
WFKnight 0:9b3d4731edbb 2174 #---------------------------------------------------------------------------
WFKnight 0:9b3d4731edbb 2175
WFKnight 0:9b3d4731edbb 2176 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
WFKnight 0:9b3d4731edbb 2177 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
WFKnight 0:9b3d4731edbb 2178 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
WFKnight 0:9b3d4731edbb 2179 # disabled, but it is recommended to install and use dot, since it yields more
WFKnight 0:9b3d4731edbb 2180 # powerful graphs.
WFKnight 0:9b3d4731edbb 2181 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2182
WFKnight 0:9b3d4731edbb 2183 CLASS_DIAGRAMS = NO
WFKnight 0:9b3d4731edbb 2184
WFKnight 0:9b3d4731edbb 2185 # You can define message sequence charts within doxygen comments using the \msc
WFKnight 0:9b3d4731edbb 2186 # command. Doxygen will then run the mscgen tool (see:
WFKnight 0:9b3d4731edbb 2187 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
WFKnight 0:9b3d4731edbb 2188 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
WFKnight 0:9b3d4731edbb 2189 # the mscgen tool resides. If left empty the tool is assumed to be found in the
WFKnight 0:9b3d4731edbb 2190 # default search path.
WFKnight 0:9b3d4731edbb 2191
WFKnight 0:9b3d4731edbb 2192 MSCGEN_PATH =
WFKnight 0:9b3d4731edbb 2193
WFKnight 0:9b3d4731edbb 2194 # You can include diagrams made with dia in doxygen documentation. Doxygen will
WFKnight 0:9b3d4731edbb 2195 # then run dia to produce the diagram and insert it in the documentation. The
WFKnight 0:9b3d4731edbb 2196 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
WFKnight 0:9b3d4731edbb 2197 # If left empty dia is assumed to be found in the default search path.
WFKnight 0:9b3d4731edbb 2198
WFKnight 0:9b3d4731edbb 2199 DIA_PATH =
WFKnight 0:9b3d4731edbb 2200
WFKnight 0:9b3d4731edbb 2201 # If set to YES the inheritance and collaboration graphs will hide inheritance
WFKnight 0:9b3d4731edbb 2202 # and usage relations if the target is undocumented or is not a class.
WFKnight 0:9b3d4731edbb 2203 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2204
WFKnight 0:9b3d4731edbb 2205 HIDE_UNDOC_RELATIONS = YES
WFKnight 0:9b3d4731edbb 2206
WFKnight 0:9b3d4731edbb 2207 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
WFKnight 0:9b3d4731edbb 2208 # available from the path. This tool is part of Graphviz (see:
WFKnight 0:9b3d4731edbb 2209 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
WFKnight 0:9b3d4731edbb 2210 # Bell Labs. The other options in this section have no effect if this option is
WFKnight 0:9b3d4731edbb 2211 # set to NO
WFKnight 0:9b3d4731edbb 2212 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2213
WFKnight 0:9b3d4731edbb 2214 HAVE_DOT = NO
WFKnight 0:9b3d4731edbb 2215
WFKnight 0:9b3d4731edbb 2216 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
WFKnight 0:9b3d4731edbb 2217 # to run in parallel. When set to 0 doxygen will base this on the number of
WFKnight 0:9b3d4731edbb 2218 # processors available in the system. You can set it explicitly to a value
WFKnight 0:9b3d4731edbb 2219 # larger than 0 to get control over the balance between CPU load and processing
WFKnight 0:9b3d4731edbb 2220 # speed.
WFKnight 0:9b3d4731edbb 2221 # Minimum value: 0, maximum value: 32, default value: 0.
WFKnight 0:9b3d4731edbb 2222 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2223
WFKnight 0:9b3d4731edbb 2224 DOT_NUM_THREADS = 0
WFKnight 0:9b3d4731edbb 2225
WFKnight 0:9b3d4731edbb 2226 # When you want a differently looking font in the dot files that doxygen
WFKnight 0:9b3d4731edbb 2227 # generates you can specify the font name using DOT_FONTNAME. You need to make
WFKnight 0:9b3d4731edbb 2228 # sure dot is able to find the font, which can be done by putting it in a
WFKnight 0:9b3d4731edbb 2229 # standard location or by setting the DOTFONTPATH environment variable or by
WFKnight 0:9b3d4731edbb 2230 # setting DOT_FONTPATH to the directory containing the font.
WFKnight 0:9b3d4731edbb 2231 # The default value is: Helvetica.
WFKnight 0:9b3d4731edbb 2232 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2233
WFKnight 0:9b3d4731edbb 2234 DOT_FONTNAME = Helvetica
WFKnight 0:9b3d4731edbb 2235
WFKnight 0:9b3d4731edbb 2236 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
WFKnight 0:9b3d4731edbb 2237 # dot graphs.
WFKnight 0:9b3d4731edbb 2238 # Minimum value: 4, maximum value: 24, default value: 10.
WFKnight 0:9b3d4731edbb 2239 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2240
WFKnight 0:9b3d4731edbb 2241 DOT_FONTSIZE = 10
WFKnight 0:9b3d4731edbb 2242
WFKnight 0:9b3d4731edbb 2243 # By default doxygen will tell dot to use the default font as specified with
WFKnight 0:9b3d4731edbb 2244 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
WFKnight 0:9b3d4731edbb 2245 # the path where dot can find it using this tag.
WFKnight 0:9b3d4731edbb 2246 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2247
WFKnight 0:9b3d4731edbb 2248 DOT_FONTPATH =
WFKnight 0:9b3d4731edbb 2249
WFKnight 0:9b3d4731edbb 2250 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
WFKnight 0:9b3d4731edbb 2251 # each documented class showing the direct and indirect inheritance relations.
WFKnight 0:9b3d4731edbb 2252 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
WFKnight 0:9b3d4731edbb 2253 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2254 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2255
WFKnight 0:9b3d4731edbb 2256 CLASS_GRAPH = YES
WFKnight 0:9b3d4731edbb 2257
WFKnight 0:9b3d4731edbb 2258 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
WFKnight 0:9b3d4731edbb 2259 # graph for each documented class showing the direct and indirect implementation
WFKnight 0:9b3d4731edbb 2260 # dependencies (inheritance, containment, and class references variables) of the
WFKnight 0:9b3d4731edbb 2261 # class with other documented classes.
WFKnight 0:9b3d4731edbb 2262 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2263 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2264
WFKnight 0:9b3d4731edbb 2265 COLLABORATION_GRAPH = YES
WFKnight 0:9b3d4731edbb 2266
WFKnight 0:9b3d4731edbb 2267 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
WFKnight 0:9b3d4731edbb 2268 # groups, showing the direct groups dependencies.
WFKnight 0:9b3d4731edbb 2269 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2270 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2271
WFKnight 0:9b3d4731edbb 2272 GROUP_GRAPHS = YES
WFKnight 0:9b3d4731edbb 2273
WFKnight 0:9b3d4731edbb 2274 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
WFKnight 0:9b3d4731edbb 2275 # collaboration diagrams in a style similar to the OMG's Unified Modeling
WFKnight 0:9b3d4731edbb 2276 # Language.
WFKnight 0:9b3d4731edbb 2277 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2278 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2279
WFKnight 0:9b3d4731edbb 2280 UML_LOOK = NO
WFKnight 0:9b3d4731edbb 2281
WFKnight 0:9b3d4731edbb 2282 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
WFKnight 0:9b3d4731edbb 2283 # class node. If there are many fields or methods and many nodes the graph may
WFKnight 0:9b3d4731edbb 2284 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
WFKnight 0:9b3d4731edbb 2285 # number of items for each type to make the size more manageable. Set this to 0
WFKnight 0:9b3d4731edbb 2286 # for no limit. Note that the threshold may be exceeded by 50% before the limit
WFKnight 0:9b3d4731edbb 2287 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
WFKnight 0:9b3d4731edbb 2288 # but if the number exceeds 15, the total amount of fields shown is limited to
WFKnight 0:9b3d4731edbb 2289 # 10.
WFKnight 0:9b3d4731edbb 2290 # Minimum value: 0, maximum value: 100, default value: 10.
WFKnight 0:9b3d4731edbb 2291 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2292
WFKnight 0:9b3d4731edbb 2293 UML_LIMIT_NUM_FIELDS = 10
WFKnight 0:9b3d4731edbb 2294
WFKnight 0:9b3d4731edbb 2295 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
WFKnight 0:9b3d4731edbb 2296 # collaboration graphs will show the relations between templates and their
WFKnight 0:9b3d4731edbb 2297 # instances.
WFKnight 0:9b3d4731edbb 2298 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2299 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2300
WFKnight 0:9b3d4731edbb 2301 TEMPLATE_RELATIONS = NO
WFKnight 0:9b3d4731edbb 2302
WFKnight 0:9b3d4731edbb 2303 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
WFKnight 0:9b3d4731edbb 2304 # YES then doxygen will generate a graph for each documented file showing the
WFKnight 0:9b3d4731edbb 2305 # direct and indirect include dependencies of the file with other documented
WFKnight 0:9b3d4731edbb 2306 # files.
WFKnight 0:9b3d4731edbb 2307 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2308 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2309
WFKnight 0:9b3d4731edbb 2310 INCLUDE_GRAPH = YES
WFKnight 0:9b3d4731edbb 2311
WFKnight 0:9b3d4731edbb 2312 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
WFKnight 0:9b3d4731edbb 2313 # set to YES then doxygen will generate a graph for each documented file showing
WFKnight 0:9b3d4731edbb 2314 # the direct and indirect include dependencies of the file with other documented
WFKnight 0:9b3d4731edbb 2315 # files.
WFKnight 0:9b3d4731edbb 2316 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2317 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2318
WFKnight 0:9b3d4731edbb 2319 INCLUDED_BY_GRAPH = YES
WFKnight 0:9b3d4731edbb 2320
WFKnight 0:9b3d4731edbb 2321 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
WFKnight 0:9b3d4731edbb 2322 # dependency graph for every global function or class method.
WFKnight 0:9b3d4731edbb 2323 #
WFKnight 0:9b3d4731edbb 2324 # Note that enabling this option will significantly increase the time of a run.
WFKnight 0:9b3d4731edbb 2325 # So in most cases it will be better to enable call graphs for selected
WFKnight 0:9b3d4731edbb 2326 # functions only using the \callgraph command. Disabling a call graph can be
WFKnight 0:9b3d4731edbb 2327 # accomplished by means of the command \hidecallgraph.
WFKnight 0:9b3d4731edbb 2328 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2329 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2330
WFKnight 0:9b3d4731edbb 2331 CALL_GRAPH = NO
WFKnight 0:9b3d4731edbb 2332
WFKnight 0:9b3d4731edbb 2333 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
WFKnight 0:9b3d4731edbb 2334 # dependency graph for every global function or class method.
WFKnight 0:9b3d4731edbb 2335 #
WFKnight 0:9b3d4731edbb 2336 # Note that enabling this option will significantly increase the time of a run.
WFKnight 0:9b3d4731edbb 2337 # So in most cases it will be better to enable caller graphs for selected
WFKnight 0:9b3d4731edbb 2338 # functions only using the \callergraph command. Disabling a caller graph can be
WFKnight 0:9b3d4731edbb 2339 # accomplished by means of the command \hidecallergraph.
WFKnight 0:9b3d4731edbb 2340 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2341 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2342
WFKnight 0:9b3d4731edbb 2343 CALLER_GRAPH = NO
WFKnight 0:9b3d4731edbb 2344
WFKnight 0:9b3d4731edbb 2345 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
WFKnight 0:9b3d4731edbb 2346 # hierarchy of all classes instead of a textual one.
WFKnight 0:9b3d4731edbb 2347 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2348 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2349
WFKnight 0:9b3d4731edbb 2350 GRAPHICAL_HIERARCHY = YES
WFKnight 0:9b3d4731edbb 2351
WFKnight 0:9b3d4731edbb 2352 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
WFKnight 0:9b3d4731edbb 2353 # dependencies a directory has on other directories in a graphical way. The
WFKnight 0:9b3d4731edbb 2354 # dependency relations are determined by the #include relations between the
WFKnight 0:9b3d4731edbb 2355 # files in the directories.
WFKnight 0:9b3d4731edbb 2356 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2357 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2358
WFKnight 0:9b3d4731edbb 2359 DIRECTORY_GRAPH = YES
WFKnight 0:9b3d4731edbb 2360
WFKnight 0:9b3d4731edbb 2361 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
WFKnight 0:9b3d4731edbb 2362 # generated by dot. For an explanation of the image formats see the section
WFKnight 0:9b3d4731edbb 2363 # output formats in the documentation of the dot tool (Graphviz (see:
WFKnight 0:9b3d4731edbb 2364 # http://www.graphviz.org/)).
WFKnight 0:9b3d4731edbb 2365 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
WFKnight 0:9b3d4731edbb 2366 # to make the SVG files visible in IE 9+ (other browsers do not have this
WFKnight 0:9b3d4731edbb 2367 # requirement).
WFKnight 0:9b3d4731edbb 2368 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
WFKnight 0:9b3d4731edbb 2369 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
WFKnight 0:9b3d4731edbb 2370 # png:gdiplus:gdiplus.
WFKnight 0:9b3d4731edbb 2371 # The default value is: png.
WFKnight 0:9b3d4731edbb 2372 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2373
WFKnight 0:9b3d4731edbb 2374 DOT_IMAGE_FORMAT = png
WFKnight 0:9b3d4731edbb 2375
WFKnight 0:9b3d4731edbb 2376 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
WFKnight 0:9b3d4731edbb 2377 # enable generation of interactive SVG images that allow zooming and panning.
WFKnight 0:9b3d4731edbb 2378 #
WFKnight 0:9b3d4731edbb 2379 # Note that this requires a modern browser other than Internet Explorer. Tested
WFKnight 0:9b3d4731edbb 2380 # and working are Firefox, Chrome, Safari, and Opera.
WFKnight 0:9b3d4731edbb 2381 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
WFKnight 0:9b3d4731edbb 2382 # the SVG files visible. Older versions of IE do not have SVG support.
WFKnight 0:9b3d4731edbb 2383 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2384 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2385
WFKnight 0:9b3d4731edbb 2386 INTERACTIVE_SVG = NO
WFKnight 0:9b3d4731edbb 2387
WFKnight 0:9b3d4731edbb 2388 # The DOT_PATH tag can be used to specify the path where the dot tool can be
WFKnight 0:9b3d4731edbb 2389 # found. If left blank, it is assumed the dot tool can be found in the path.
WFKnight 0:9b3d4731edbb 2390 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2391
WFKnight 0:9b3d4731edbb 2392 DOT_PATH =
WFKnight 0:9b3d4731edbb 2393
WFKnight 0:9b3d4731edbb 2394 # The DOTFILE_DIRS tag can be used to specify one or more directories that
WFKnight 0:9b3d4731edbb 2395 # contain dot files that are included in the documentation (see the \dotfile
WFKnight 0:9b3d4731edbb 2396 # command).
WFKnight 0:9b3d4731edbb 2397 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2398
WFKnight 0:9b3d4731edbb 2399 DOTFILE_DIRS =
WFKnight 0:9b3d4731edbb 2400
WFKnight 0:9b3d4731edbb 2401 # The MSCFILE_DIRS tag can be used to specify one or more directories that
WFKnight 0:9b3d4731edbb 2402 # contain msc files that are included in the documentation (see the \mscfile
WFKnight 0:9b3d4731edbb 2403 # command).
WFKnight 0:9b3d4731edbb 2404
WFKnight 0:9b3d4731edbb 2405 MSCFILE_DIRS =
WFKnight 0:9b3d4731edbb 2406
WFKnight 0:9b3d4731edbb 2407 # The DIAFILE_DIRS tag can be used to specify one or more directories that
WFKnight 0:9b3d4731edbb 2408 # contain dia files that are included in the documentation (see the \diafile
WFKnight 0:9b3d4731edbb 2409 # command).
WFKnight 0:9b3d4731edbb 2410
WFKnight 0:9b3d4731edbb 2411 DIAFILE_DIRS =
WFKnight 0:9b3d4731edbb 2412
WFKnight 0:9b3d4731edbb 2413 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
WFKnight 0:9b3d4731edbb 2414 # path where java can find the plantuml.jar file. If left blank, it is assumed
WFKnight 0:9b3d4731edbb 2415 # PlantUML is not used or called during a preprocessing step. Doxygen will
WFKnight 0:9b3d4731edbb 2416 # generate a warning when it encounters a \startuml command in this case and
WFKnight 0:9b3d4731edbb 2417 # will not generate output for the diagram.
WFKnight 0:9b3d4731edbb 2418
WFKnight 0:9b3d4731edbb 2419 #PLANTUML_JAR_PATH =
WFKnight 0:9b3d4731edbb 2420
WFKnight 0:9b3d4731edbb 2421 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
WFKnight 0:9b3d4731edbb 2422 # configuration file for plantuml.
WFKnight 0:9b3d4731edbb 2423
WFKnight 0:9b3d4731edbb 2424 #PLANTUML_CFG_FILE =
WFKnight 0:9b3d4731edbb 2425
WFKnight 0:9b3d4731edbb 2426 # When using plantuml, the specified paths are searched for files specified by
WFKnight 0:9b3d4731edbb 2427 # the !include statement in a plantuml block.
WFKnight 0:9b3d4731edbb 2428
WFKnight 0:9b3d4731edbb 2429 #PLANTUML_INCLUDE_PATH =
WFKnight 0:9b3d4731edbb 2430
WFKnight 0:9b3d4731edbb 2431 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
WFKnight 0:9b3d4731edbb 2432 # that will be shown in the graph. If the number of nodes in a graph becomes
WFKnight 0:9b3d4731edbb 2433 # larger than this value, doxygen will truncate the graph, which is visualized
WFKnight 0:9b3d4731edbb 2434 # by representing a node as a red box. Note that doxygen if the number of direct
WFKnight 0:9b3d4731edbb 2435 # children of the root node in a graph is already larger than
WFKnight 0:9b3d4731edbb 2436 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
WFKnight 0:9b3d4731edbb 2437 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
WFKnight 0:9b3d4731edbb 2438 # Minimum value: 0, maximum value: 10000, default value: 50.
WFKnight 0:9b3d4731edbb 2439 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2440
WFKnight 0:9b3d4731edbb 2441 DOT_GRAPH_MAX_NODES = 50
WFKnight 0:9b3d4731edbb 2442
WFKnight 0:9b3d4731edbb 2443 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
WFKnight 0:9b3d4731edbb 2444 # generated by dot. A depth value of 3 means that only nodes reachable from the
WFKnight 0:9b3d4731edbb 2445 # root by following a path via at most 3 edges will be shown. Nodes that lay
WFKnight 0:9b3d4731edbb 2446 # further from the root node will be omitted. Note that setting this option to 1
WFKnight 0:9b3d4731edbb 2447 # or 2 may greatly reduce the computation time needed for large code bases. Also
WFKnight 0:9b3d4731edbb 2448 # note that the size of a graph can be further restricted by
WFKnight 0:9b3d4731edbb 2449 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
WFKnight 0:9b3d4731edbb 2450 # Minimum value: 0, maximum value: 1000, default value: 0.
WFKnight 0:9b3d4731edbb 2451 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2452
WFKnight 0:9b3d4731edbb 2453 MAX_DOT_GRAPH_DEPTH = 0
WFKnight 0:9b3d4731edbb 2454
WFKnight 0:9b3d4731edbb 2455 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
WFKnight 0:9b3d4731edbb 2456 # background. This is disabled by default, because dot on Windows does not seem
WFKnight 0:9b3d4731edbb 2457 # to support this out of the box.
WFKnight 0:9b3d4731edbb 2458 #
WFKnight 0:9b3d4731edbb 2459 # Warning: Depending on the platform used, enabling this option may lead to
WFKnight 0:9b3d4731edbb 2460 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
WFKnight 0:9b3d4731edbb 2461 # read).
WFKnight 0:9b3d4731edbb 2462 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2463 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2464
WFKnight 0:9b3d4731edbb 2465 DOT_TRANSPARENT = NO
WFKnight 0:9b3d4731edbb 2466
WFKnight 0:9b3d4731edbb 2467 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
WFKnight 0:9b3d4731edbb 2468 # files in one run (i.e. multiple -o and -T options on the command line). This
WFKnight 0:9b3d4731edbb 2469 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
WFKnight 0:9b3d4731edbb 2470 # this, this feature is disabled by default.
WFKnight 0:9b3d4731edbb 2471 # The default value is: NO.
WFKnight 0:9b3d4731edbb 2472 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2473
WFKnight 0:9b3d4731edbb 2474 DOT_MULTI_TARGETS = YES
WFKnight 0:9b3d4731edbb 2475
WFKnight 0:9b3d4731edbb 2476 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
WFKnight 0:9b3d4731edbb 2477 # explaining the meaning of the various boxes and arrows in the dot generated
WFKnight 0:9b3d4731edbb 2478 # graphs.
WFKnight 0:9b3d4731edbb 2479 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2480 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2481
WFKnight 0:9b3d4731edbb 2482 GENERATE_LEGEND = YES
WFKnight 0:9b3d4731edbb 2483
WFKnight 0:9b3d4731edbb 2484 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
WFKnight 0:9b3d4731edbb 2485 # files that are used to generate the various graphs.
WFKnight 0:9b3d4731edbb 2486 # The default value is: YES.
WFKnight 0:9b3d4731edbb 2487 # This tag requires that the tag HAVE_DOT is set to YES.
WFKnight 0:9b3d4731edbb 2488
WFKnight 0:9b3d4731edbb 2489 DOT_CLEANUP = YES