Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/Doxyfile@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

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