Kev Mann / mbed-dev-OS5_10_4

Important changes to repositories hosted on mbed.com

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

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

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

features/nanostack/sal-stack-nanostack/Doxyfile@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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