Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

Committer:
switches
Date:
Fri Dec 16 16:27:57 2016 +0000
Revision:
3:1198227e6421
Parent:
0:5c4d7b2438d3
Changed ADC scale for MAX32625 platforms to 1.2V full scale to match MAX32630 platforms

Who changed what in which revision?

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