Nicolas Borla / Mbed OS ROME2_Robot_Firmware

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/doxyfile_options@0:4beb2ea291ec, 2020-03-16 (annotated)

Committer:
boro
Date:
Mon Mar 16 13:12:31 2020 +0000
Revision:
0:4beb2ea291ec
a

Who changed what in which revision?

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