Greg Steiert / pegasus_dev

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.

Dependents:   blinky_max32630fthr

features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/Doxyfile@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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