annotate 3rdparty/vmime/Doxyfile.in @ 0:a4671277546c tip

created the repository for the thymian project
author ferencd
date Tue, 17 Aug 2021 11:19:54 +0200
parents
children
rev   line source
ferencd@0 1 #
ferencd@0 2 # Doxygen settings for VMime
ferencd@0 3 #
ferencd@0 4 # All text after a hash (#) is considered a comment and will be ignored
ferencd@0 5 # The format is:
ferencd@0 6 # TAG = value [value, ...]
ferencd@0 7 # For lists items can also be appended using:
ferencd@0 8 # TAG += value [value, ...]
ferencd@0 9 # Values that contain spaces should be placed between quotes (" ")
ferencd@0 10 #
ferencd@0 11
ferencd@0 12 #---------------------------------------------------------------------------
ferencd@0 13 # General configuration options
ferencd@0 14 #---------------------------------------------------------------------------
ferencd@0 15
ferencd@0 16 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
ferencd@0 17 # by quotes) that should identify the project.
ferencd@0 18
ferencd@0 19 PROJECT_NAME = VMime
ferencd@0 20
ferencd@0 21 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
ferencd@0 22 # This could be handy for archiving the generated documentation or
ferencd@0 23 # if some version control system is used.
ferencd@0 24
ferencd@0 25 PROJECT_NUMBER =
ferencd@0 26
ferencd@0 27 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
ferencd@0 28 # base path where the generated documentation will be put.
ferencd@0 29 # If a relative path is entered, it will be relative to the location
ferencd@0 30 # where doxygen was started. If left blank the current directory will be used.
ferencd@0 31
ferencd@0 32 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc/
ferencd@0 33
ferencd@0 34 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
ferencd@0 35 # documentation generated by doxygen is written. Doxygen will use this
ferencd@0 36 # information to generate all constant output in the proper language.
ferencd@0 37 # The default language is English, other supported languages are:
ferencd@0 38 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
ferencd@0 39 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
ferencd@0 40 # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
ferencd@0 41 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
ferencd@0 42
ferencd@0 43 OUTPUT_LANGUAGE = English
ferencd@0 44
ferencd@0 45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
ferencd@0 46 # documentation are documented, even if no documentation was available.
ferencd@0 47 # Private class members and static file members will be hidden unless
ferencd@0 48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
ferencd@0 49
ferencd@0 50 EXTRACT_ALL = YES
ferencd@0 51
ferencd@0 52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
ferencd@0 53 # will be included in the documentation.
ferencd@0 54
ferencd@0 55 EXTRACT_PRIVATE = NO
ferencd@0 56
ferencd@0 57 # If the EXTRACT_STATIC tag is set to YES all static members of a file
ferencd@0 58 # will be included in the documentation.
ferencd@0 59
ferencd@0 60 EXTRACT_STATIC = NO
ferencd@0 61
ferencd@0 62 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
ferencd@0 63 # defined locally in source files will be included in the documentation.
ferencd@0 64 # If set to NO only classes defined in header files are included.
ferencd@0 65
ferencd@0 66 EXTRACT_LOCAL_CLASSES = NO
ferencd@0 67
ferencd@0 68 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
ferencd@0 69 # undocumented members of documented classes, files or namespaces.
ferencd@0 70 # If set to NO (the default) these members will be included in the
ferencd@0 71 # various overviews, but no documentation section is generated.
ferencd@0 72 # This option has no effect if EXTRACT_ALL is enabled.
ferencd@0 73
ferencd@0 74 HIDE_UNDOC_MEMBERS = NO
ferencd@0 75
ferencd@0 76 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
ferencd@0 77 # undocumented classes that are normally visible in the class hierarchy.
ferencd@0 78 # If set to NO (the default) these class will be included in the various
ferencd@0 79 # overviews. This option has no effect if EXTRACT_ALL is enabled.
ferencd@0 80
ferencd@0 81 HIDE_UNDOC_CLASSES = NO
ferencd@0 82
ferencd@0 83 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
ferencd@0 84 # friend (class|struct|union) declarations.
ferencd@0 85 # If set to NO (the default) these declarations will be included in the
ferencd@0 86 # documentation.
ferencd@0 87
ferencd@0 88 HIDE_FRIEND_COMPOUNDS = YES
ferencd@0 89
ferencd@0 90 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
ferencd@0 91 # documentation blocks found inside the body of a function.
ferencd@0 92 # If set to NO (the default) these blocks will be appended to the
ferencd@0 93 # function's detailed documentation block.
ferencd@0 94
ferencd@0 95 #HIDE_IN_BODY_DOCS = NO
ferencd@0 96
ferencd@0 97 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
ferencd@0 98 # include brief member descriptions after the members that are listed in
ferencd@0 99 # the file and class documentation (similar to JavaDoc).
ferencd@0 100 # Set to NO to disable this.
ferencd@0 101
ferencd@0 102 BRIEF_MEMBER_DESC = NO
ferencd@0 103
ferencd@0 104 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
ferencd@0 105 # the brief description of a member or function before the detailed description.
ferencd@0 106 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
ferencd@0 107 # brief descriptions will be completely suppressed.
ferencd@0 108
ferencd@0 109 REPEAT_BRIEF = YES
ferencd@0 110
ferencd@0 111 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
ferencd@0 112 # Doxygen will generate a detailed section even if there is only a brief
ferencd@0 113 # description.
ferencd@0 114
ferencd@0 115 ALWAYS_DETAILED_SEC = NO
ferencd@0 116
ferencd@0 117 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
ferencd@0 118 # members of a class in the documentation of that class as if those members were
ferencd@0 119 # ordinary class members. Constructors, destructors and assignment operators of
ferencd@0 120 # the base classes will not be shown.
ferencd@0 121
ferencd@0 122 INLINE_INHERITED_MEMB = NO
ferencd@0 123
ferencd@0 124 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
ferencd@0 125 # path before files name in the file list and in the header files. If set
ferencd@0 126 # to NO the shortest path that makes the file name unique will be used.
ferencd@0 127
ferencd@0 128 FULL_PATH_NAMES = NO
ferencd@0 129
ferencd@0 130 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
ferencd@0 131 # can be used to strip a user defined part of the path. Stripping is
ferencd@0 132 # only done if one of the specified strings matches the left-hand part of
ferencd@0 133 # the path. It is allowed to use relative paths in the argument list.
ferencd@0 134
ferencd@0 135 STRIP_FROM_PATH =
ferencd@0 136
ferencd@0 137 # The INTERNAL_DOCS tag determines if documentation
ferencd@0 138 # that is typed after a \internal command is included. If the tag is set
ferencd@0 139 # to NO (the default) then the documentation will be excluded.
ferencd@0 140 # Set it to YES to include the internal documentation.
ferencd@0 141
ferencd@0 142 INTERNAL_DOCS = NO
ferencd@0 143
ferencd@0 144 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
ferencd@0 145 # file names in lower case letters. If set to YES upper case letters are also
ferencd@0 146 # allowed. This is useful if you have classes or files whose names only differ
ferencd@0 147 # in case and if your file system supports case sensitive file names. Windows
ferencd@0 148 # users are adviced to set this option to NO.
ferencd@0 149
ferencd@0 150 CASE_SENSE_NAMES = YES
ferencd@0 151
ferencd@0 152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
ferencd@0 153 # (but less readable) file names. This can be useful is your file systems
ferencd@0 154 # doesn't support long names like on DOS, Mac, or CD-ROM.
ferencd@0 155
ferencd@0 156 SHORT_NAMES = NO
ferencd@0 157
ferencd@0 158 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
ferencd@0 159 # will show members with their full class and namespace scopes in the
ferencd@0 160 # documentation. If set to YES the scope will be hidden.
ferencd@0 161
ferencd@0 162 HIDE_SCOPE_NAMES = YES
ferencd@0 163
ferencd@0 164 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
ferencd@0 165 # will generate a verbatim copy of the header file for each class for
ferencd@0 166 # which an include is specified. Set to NO to disable this.
ferencd@0 167
ferencd@0 168 VERBATIM_HEADERS = NO
ferencd@0 169
ferencd@0 170 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
ferencd@0 171 # will put list of the files that are included by a file in the documentation
ferencd@0 172 # of that file.
ferencd@0 173
ferencd@0 174 SHOW_INCLUDE_FILES = NO
ferencd@0 175
ferencd@0 176 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
ferencd@0 177 # will interpret the first line (until the first dot) of a JavaDoc-style
ferencd@0 178 # comment as the brief description. If set to NO, the JavaDoc
ferencd@0 179 # comments will behave just like the Qt-style comments (thus requiring an
ferencd@0 180 # explict @brief command for a brief description.
ferencd@0 181
ferencd@0 182 JAVADOC_AUTOBRIEF = YES
ferencd@0 183
ferencd@0 184 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
ferencd@0 185 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
ferencd@0 186 # comments) as a brief description. This used to be the default behaviour.
ferencd@0 187 # The new default is to treat a multi-line C++ comment block as a detailed
ferencd@0 188 # description. Set this tag to YES if you prefer the old behaviour instead.
ferencd@0 189
ferencd@0 190 MULTILINE_CPP_IS_BRIEF = NO
ferencd@0 191
ferencd@0 192 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
ferencd@0 193 # will output the detailed description near the top, like JavaDoc.
ferencd@0 194 # If set to NO, the detailed description appears after the member
ferencd@0 195 # documentation.
ferencd@0 196
ferencd@0 197 DETAILS_AT_TOP = NO
ferencd@0 198
ferencd@0 199 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
ferencd@0 200 # member inherits the documentation from any documented member that it
ferencd@0 201 # reimplements.
ferencd@0 202
ferencd@0 203 INHERIT_DOCS = YES
ferencd@0 204
ferencd@0 205 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
ferencd@0 206 # is inserted in the documentation for inline members.
ferencd@0 207
ferencd@0 208 INLINE_INFO = NO
ferencd@0 209
ferencd@0 210 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
ferencd@0 211 # will sort the (detailed) documentation of file and class members
ferencd@0 212 # alphabetically by member name. If set to NO the members will appear in
ferencd@0 213 # declaration order.
ferencd@0 214
ferencd@0 215 SORT_MEMBER_DOCS = YES
ferencd@0 216
ferencd@0 217 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
ferencd@0 218 # tag is set to YES, then doxygen will reuse the documentation of the first
ferencd@0 219 # member in the group (if any) for the other members of the group. By default
ferencd@0 220 # all members of a group must be documented explicitly.
ferencd@0 221
ferencd@0 222 DISTRIBUTE_GROUP_DOC = NO
ferencd@0 223
ferencd@0 224 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
ferencd@0 225 # Doxygen uses this value to replace tabs by spaces in code fragments.
ferencd@0 226
ferencd@0 227 TAB_SIZE = 4
ferencd@0 228
ferencd@0 229 # The GENERATE_TODOLIST tag can be used to enable (YES) or
ferencd@0 230 # disable (NO) the todo list. This list is created by putting \todo
ferencd@0 231 # commands in the documentation.
ferencd@0 232
ferencd@0 233 GENERATE_TODOLIST = YES
ferencd@0 234
ferencd@0 235 # The GENERATE_TESTLIST tag can be used to enable (YES) or
ferencd@0 236 # disable (NO) the test list. This list is created by putting \test
ferencd@0 237 # commands in the documentation.
ferencd@0 238
ferencd@0 239 GENERATE_TESTLIST = YES
ferencd@0 240
ferencd@0 241 # The GENERATE_BUGLIST tag can be used to enable (YES) or
ferencd@0 242 # disable (NO) the bug list. This list is created by putting \bug
ferencd@0 243 # commands in the documentation.
ferencd@0 244
ferencd@0 245 GENERATE_BUGLIST = YES
ferencd@0 246
ferencd@0 247 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
ferencd@0 248 # disable (NO) the deprecated list. This list is created by putting
ferencd@0 249 # \deprecated commands in the documentation.
ferencd@0 250
ferencd@0 251 GENERATE_DEPRECATEDLIST= YES
ferencd@0 252
ferencd@0 253 # This tag can be used to specify a number of aliases that acts
ferencd@0 254 # as commands in the documentation. An alias has the form "name=value".
ferencd@0 255 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
ferencd@0 256 # put the command \sideeffect (or @sideeffect) in the documentation, which
ferencd@0 257 # will result in a user defined paragraph with heading "Side Effects:".
ferencd@0 258 # You can put \n's in the value part of an alias to insert newlines.
ferencd@0 259
ferencd@0 260 ALIASES =
ferencd@0 261
ferencd@0 262 # The ENABLED_SECTIONS tag can be used to enable conditional
ferencd@0 263 # documentation sections, marked by \if sectionname ... \endif.
ferencd@0 264
ferencd@0 265 ENABLED_SECTIONS =
ferencd@0 266
ferencd@0 267 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
ferencd@0 268 # the initial value of a variable or define consist of for it to appear in
ferencd@0 269 # the documentation. If the initializer consists of more lines than specified
ferencd@0 270 # here it will be hidden. Use a value of 0 to hide initializers completely.
ferencd@0 271 # The appearance of the initializer of individual variables and defines in the
ferencd@0 272 # documentation can be controlled using \showinitializer or \hideinitializer
ferencd@0 273 # command in the documentation regardless of this setting.
ferencd@0 274
ferencd@0 275 MAX_INITIALIZER_LINES = 30
ferencd@0 276
ferencd@0 277 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
ferencd@0 278 # only. Doxygen will then generate output that is more tailored for C.
ferencd@0 279 # For instance some of the names that are used will be different. The list
ferencd@0 280 # of all members will be omitted, etc.
ferencd@0 281
ferencd@0 282 OPTIMIZE_OUTPUT_FOR_C = NO
ferencd@0 283
ferencd@0 284 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
ferencd@0 285 # only. Doxygen will then generate output that is more tailored for Java.
ferencd@0 286 # For instance namespaces will be presented as packages, qualified scopes
ferencd@0 287 # will look different, etc.
ferencd@0 288
ferencd@0 289 OPTIMIZE_OUTPUT_JAVA = NO
ferencd@0 290
ferencd@0 291 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
ferencd@0 292 # at the bottom of the documentation of classes and structs. If set to YES the
ferencd@0 293 # list will mention the files that were used to generate the documentation.
ferencd@0 294
ferencd@0 295 SHOW_USED_FILES = YES
ferencd@0 296
ferencd@0 297 #---------------------------------------------------------------------------
ferencd@0 298 # configuration options related to warning and progress messages
ferencd@0 299 #---------------------------------------------------------------------------
ferencd@0 300
ferencd@0 301 # The QUIET tag can be used to turn on/off the messages that are generated
ferencd@0 302 # by doxygen. Possible values are YES and NO. If left blank NO is used.
ferencd@0 303
ferencd@0 304 QUIET = YES
ferencd@0 305
ferencd@0 306 # The WARNINGS tag can be used to turn on/off the warning messages that are
ferencd@0 307 # generated by doxygen. Possible values are YES and NO. If left blank
ferencd@0 308 # NO is used.
ferencd@0 309
ferencd@0 310 WARNINGS = YES
ferencd@0 311
ferencd@0 312 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
ferencd@0 313 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
ferencd@0 314 # automatically be disabled.
ferencd@0 315
ferencd@0 316 WARN_IF_UNDOCUMENTED = YES
ferencd@0 317
ferencd@0 318 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
ferencd@0 319 # potential errors in the documentation, such as not documenting some
ferencd@0 320 # parameters in a documented function, or documenting parameters that
ferencd@0 321 # don't exist or using markup commands wrongly.
ferencd@0 322
ferencd@0 323 #WARN_IF_DOC_ERROR = YES
ferencd@0 324
ferencd@0 325 # The WARN_FORMAT tag determines the format of the warning messages that
ferencd@0 326 # doxygen can produce. The string should contain the $file, $line, and $text
ferencd@0 327 # tags, which will be replaced by the file and line number from which the
ferencd@0 328 # warning originated and the warning text.
ferencd@0 329
ferencd@0 330 WARN_FORMAT = "$file:$line: $text"
ferencd@0 331
ferencd@0 332 # The WARN_LOGFILE tag can be used to specify a file to which warning
ferencd@0 333 # and error messages should be written. If left blank the output is written
ferencd@0 334 # to stderr.
ferencd@0 335
ferencd@0 336 WARN_LOGFILE =
ferencd@0 337
ferencd@0 338 #---------------------------------------------------------------------------
ferencd@0 339 # configuration options related to the input files
ferencd@0 340 #---------------------------------------------------------------------------
ferencd@0 341
ferencd@0 342 # The INPUT tag can be used to specify the files and/or directories that contain
ferencd@0 343 # documented source files. You may enter file names like "myfile.cpp" or
ferencd@0 344 # directories like "/usr/src/myproject". Separate the files or directories
ferencd@0 345 # with spaces.
ferencd@0 346
ferencd@0 347 INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/vmime/
ferencd@0 348
ferencd@0 349 # If the value of the INPUT tag contains directories, you can use the
ferencd@0 350 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
ferencd@0 351 # and *.h) to filter out the source-files in the directories. If left
ferencd@0 352 # blank the following patterns are tested:
ferencd@0 353 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
ferencd@0 354 # *.h++ *.idl *.odl
ferencd@0 355
ferencd@0 356 FILE_PATTERNS =
ferencd@0 357
ferencd@0 358 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
ferencd@0 359 # should be searched for input files as well. Possible values are YES and NO.
ferencd@0 360 # If left blank NO is used.
ferencd@0 361
ferencd@0 362 RECURSIVE = YES
ferencd@0 363
ferencd@0 364 # The EXCLUDE tag can be used to specify files and/or directories that should
ferencd@0 365 # excluded from the INPUT source files. This way you can easily exclude a
ferencd@0 366 # subdirectory from a directory tree whose root is specified with the INPUT tag.
ferencd@0 367
ferencd@0 368 EXCLUDE =
ferencd@0 369
ferencd@0 370 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
ferencd@0 371 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
ferencd@0 372
ferencd@0 373 EXCLUDE_SYMLINKS = NO
ferencd@0 374
ferencd@0 375 # If the value of the INPUT tag contains directories, you can use the
ferencd@0 376 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
ferencd@0 377 # certain files from those directories.
ferencd@0 378
ferencd@0 379 EXCLUDE_PATTERNS = */config.hpp */IMAPTag* */IMAPParser* */IMAPUtils* */IMAPConnection* */md5* */smartPtr* */authHelper* */maildirUtils*
ferencd@0 380
ferencd@0 381 # The EXAMPLE_PATH tag can be used to specify one or more files or
ferencd@0 382 # directories that contain example code fragments that are included (see
ferencd@0 383 # the \include command).
ferencd@0 384
ferencd@0 385 EXAMPLE_PATH =
ferencd@0 386
ferencd@0 387 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
ferencd@0 388 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
ferencd@0 389 # and *.h) to filter out the source-files in the directories. If left
ferencd@0 390 # blank all files are included.
ferencd@0 391
ferencd@0 392 EXAMPLE_PATTERNS =
ferencd@0 393
ferencd@0 394 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
ferencd@0 395 # searched for input files to be used with the \include or \dontinclude
ferencd@0 396 # commands irrespective of the value of the RECURSIVE tag.
ferencd@0 397 # Possible values are YES and NO. If left blank NO is used.
ferencd@0 398
ferencd@0 399 EXAMPLE_RECURSIVE = NO
ferencd@0 400
ferencd@0 401 # The IMAGE_PATH tag can be used to specify one or more files or
ferencd@0 402 # directories that contain image that are included in the documentation (see
ferencd@0 403 # the \image command).
ferencd@0 404
ferencd@0 405 IMAGE_PATH =
ferencd@0 406
ferencd@0 407 # The INPUT_FILTER tag can be used to specify a program that doxygen should
ferencd@0 408 # invoke to filter for each input file. Doxygen will invoke the filter program
ferencd@0 409 # by executing (via popen()) the command <filter> <input-file>, where <filter>
ferencd@0 410 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
ferencd@0 411 # input file. Doxygen will then use the output that the filter program writes
ferencd@0 412 # to standard output.
ferencd@0 413
ferencd@0 414 INPUT_FILTER =
ferencd@0 415
ferencd@0 416 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
ferencd@0 417 # INPUT_FILTER) will be used to filter the input files when producing source
ferencd@0 418 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
ferencd@0 419
ferencd@0 420 FILTER_SOURCE_FILES = NO
ferencd@0 421
ferencd@0 422 #---------------------------------------------------------------------------
ferencd@0 423 # configuration options related to source browsing
ferencd@0 424 #---------------------------------------------------------------------------
ferencd@0 425
ferencd@0 426 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
ferencd@0 427 # be generated. Documented entities will be cross-referenced with these sources.
ferencd@0 428
ferencd@0 429 SOURCE_BROWSER = NO
ferencd@0 430 # YES --> sources visibles
ferencd@0 431
ferencd@0 432 # Setting the INLINE_SOURCES tag to YES will include the body
ferencd@0 433 # of functions and classes directly in the documentation.
ferencd@0 434
ferencd@0 435 INLINE_SOURCES = NO
ferencd@0 436
ferencd@0 437 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
ferencd@0 438 # doxygen to hide any special comment blocks from generated source code
ferencd@0 439 # fragments. Normal C and C++ comments will always remain visible.
ferencd@0 440
ferencd@0 441 STRIP_CODE_COMMENTS = YES
ferencd@0 442
ferencd@0 443 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
ferencd@0 444 # then for each documented function all documented
ferencd@0 445 # functions referencing it will be listed.
ferencd@0 446
ferencd@0 447 REFERENCED_BY_RELATION = YES
ferencd@0 448
ferencd@0 449 # If the REFERENCES_RELATION tag is set to YES (the default)
ferencd@0 450 # then for each documented function all documented entities
ferencd@0 451 # called/used by that function will be listed.
ferencd@0 452
ferencd@0 453 REFERENCES_RELATION = YES
ferencd@0 454
ferencd@0 455 #---------------------------------------------------------------------------
ferencd@0 456 # configuration options related to the alphabetical class index
ferencd@0 457 #---------------------------------------------------------------------------
ferencd@0 458
ferencd@0 459 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
ferencd@0 460 # of all compounds will be generated. Enable this if the project
ferencd@0 461 # contains a lot of classes, structs, unions or interfaces.
ferencd@0 462
ferencd@0 463 ALPHABETICAL_INDEX = YES
ferencd@0 464
ferencd@0 465 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
ferencd@0 466 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
ferencd@0 467 # in which this list will be split (can be a number in the range [1..20])
ferencd@0 468
ferencd@0 469 COLS_IN_ALPHA_INDEX = 1
ferencd@0 470
ferencd@0 471 # In case all classes in a project start with a common prefix, all
ferencd@0 472 # classes will be put under the same header in the alphabetical index.
ferencd@0 473 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
ferencd@0 474 # should be ignored while generating the index headers.
ferencd@0 475
ferencd@0 476 IGNORE_PREFIX =
ferencd@0 477
ferencd@0 478 #---------------------------------------------------------------------------
ferencd@0 479 # configuration options related to the HTML output
ferencd@0 480 #---------------------------------------------------------------------------
ferencd@0 481
ferencd@0 482 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
ferencd@0 483 # generate HTML output.
ferencd@0 484
ferencd@0 485 GENERATE_HTML = YES
ferencd@0 486
ferencd@0 487 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
ferencd@0 488 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
ferencd@0 489 # put in front of it. If left blank `html' will be used as the default path.
ferencd@0 490
ferencd@0 491 HTML_OUTPUT = html
ferencd@0 492
ferencd@0 493 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
ferencd@0 494 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
ferencd@0 495 # doxygen will generate files with .html extension.
ferencd@0 496
ferencd@0 497 HTML_FILE_EXTENSION = .html
ferencd@0 498
ferencd@0 499 # The HTML_HEADER tag can be used to specify a personal HTML header for
ferencd@0 500 # each generated HTML page. If it is left blank doxygen will generate a
ferencd@0 501 # standard header.
ferencd@0 502
ferencd@0 503 HTML_HEADER =
ferencd@0 504
ferencd@0 505 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
ferencd@0 506 # each generated HTML page. If it is left blank doxygen will generate a
ferencd@0 507 # standard footer.
ferencd@0 508
ferencd@0 509 HTML_FOOTER =
ferencd@0 510
ferencd@0 511 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
ferencd@0 512 # style sheet that is used by each HTML page. It can be used to
ferencd@0 513 # fine-tune the look of the HTML output. If the tag is left blank doxygen
ferencd@0 514 # will generate a default style sheet
ferencd@0 515
ferencd@0 516 HTML_STYLESHEET =
ferencd@0 517
ferencd@0 518 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
ferencd@0 519 # files or namespaces will be aligned in HTML using tables. If set to
ferencd@0 520 # NO a bullet list will be used.
ferencd@0 521
ferencd@0 522 HTML_ALIGN_MEMBERS = YES
ferencd@0 523
ferencd@0 524 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
ferencd@0 525 # will be generated that can be used as input for tools like the
ferencd@0 526 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
ferencd@0 527 # of the generated HTML documentation.
ferencd@0 528
ferencd@0 529 GENERATE_HTMLHELP = NO
ferencd@0 530
ferencd@0 531 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
ferencd@0 532 # be used to specify the file name of the resulting .chm file. You
ferencd@0 533 # can add a path in front of the file if the result should not be
ferencd@0 534 # written to the html output dir.
ferencd@0 535
ferencd@0 536 CHM_FILE =
ferencd@0 537
ferencd@0 538 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
ferencd@0 539 # be used to specify the location (absolute path including file name) of
ferencd@0 540 # the HTML help compiler (hhc.exe). If non empty doxygen will try to run
ferencd@0 541 # the html help compiler on the generated index.hhp.
ferencd@0 542
ferencd@0 543 HHC_LOCATION =
ferencd@0 544
ferencd@0 545 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
ferencd@0 546 # controls if a separate .chi index file is generated (YES) or that
ferencd@0 547 # it should be included in the master .chm file (NO).
ferencd@0 548
ferencd@0 549 GENERATE_CHI = NO
ferencd@0 550
ferencd@0 551 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
ferencd@0 552 # controls whether a binary table of contents is generated (YES) or a
ferencd@0 553 # normal table of contents (NO) in the .chm file.
ferencd@0 554
ferencd@0 555 BINARY_TOC = NO
ferencd@0 556
ferencd@0 557 # The TOC_EXPAND flag can be set to YES to add extra items for group members
ferencd@0 558 # to the contents of the Html help documentation and to the tree view.
ferencd@0 559
ferencd@0 560 TOC_EXPAND = NO
ferencd@0 561
ferencd@0 562 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
ferencd@0 563 # top of each HTML page. The value NO (the default) enables the index and
ferencd@0 564 # the value YES disables it.
ferencd@0 565
ferencd@0 566 DISABLE_INDEX = NO
ferencd@0 567
ferencd@0 568 # This tag can be used to set the number of enum values (range [1..20])
ferencd@0 569 # that doxygen will group on one line in the generated HTML documentation.
ferencd@0 570
ferencd@0 571 ENUM_VALUES_PER_LINE = 4
ferencd@0 572
ferencd@0 573 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
ferencd@0 574 # generated containing a tree-like index structure (just like the one that
ferencd@0 575 # is generated for HTML Help). For this to work a browser that supports
ferencd@0 576 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
ferencd@0 577 # or Internet explorer 4.0+). Note that for large projects the tree generation
ferencd@0 578 # can take a very long time. In such cases it is better to disable this feature.
ferencd@0 579 # Windows users are probably better off using the HTML help feature.
ferencd@0 580
ferencd@0 581 GENERATE_TREEVIEW = YES
ferencd@0 582
ferencd@0 583 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
ferencd@0 584 # used to set the initial width (in pixels) of the frame in which the tree
ferencd@0 585 # is shown.
ferencd@0 586
ferencd@0 587 TREEVIEW_WIDTH = 300
ferencd@0 588
ferencd@0 589 #---------------------------------------------------------------------------
ferencd@0 590 # configuration options related to the LaTeX output
ferencd@0 591 #---------------------------------------------------------------------------
ferencd@0 592
ferencd@0 593 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
ferencd@0 594 # generate Latex output.
ferencd@0 595
ferencd@0 596 GENERATE_LATEX = NO
ferencd@0 597
ferencd@0 598 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
ferencd@0 599 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
ferencd@0 600 # put in front of it. If left blank `latex' will be used as the default path.
ferencd@0 601
ferencd@0 602 LATEX_OUTPUT = latex
ferencd@0 603
ferencd@0 604 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
ferencd@0 605 # invoked. If left blank `latex' will be used as the default command name.
ferencd@0 606
ferencd@0 607 LATEX_CMD_NAME = latex
ferencd@0 608
ferencd@0 609 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
ferencd@0 610 # generate index for LaTeX. If left blank `makeindex' will be used as the
ferencd@0 611 # default command name.
ferencd@0 612
ferencd@0 613 MAKEINDEX_CMD_NAME = makeindex
ferencd@0 614
ferencd@0 615 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
ferencd@0 616 # LaTeX documents. This may be useful for small projects and may help to
ferencd@0 617 # save some trees in general.
ferencd@0 618
ferencd@0 619 COMPACT_LATEX = NO
ferencd@0 620
ferencd@0 621 # The PAPER_TYPE tag can be used to set the paper type that is used
ferencd@0 622 # by the printer. Possible values are: a4, a4wide, letter, legal and
ferencd@0 623 # executive. If left blank a4wide will be used.
ferencd@0 624
ferencd@0 625 PAPER_TYPE = a4wide
ferencd@0 626
ferencd@0 627 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
ferencd@0 628 # packages that should be included in the LaTeX output.
ferencd@0 629
ferencd@0 630 EXTRA_PACKAGES =
ferencd@0 631
ferencd@0 632 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
ferencd@0 633 # the generated latex document. The header should contain everything until
ferencd@0 634 # the first chapter. If it is left blank doxygen will generate a
ferencd@0 635 # standard header. Notice: only use this tag if you know what you are doing!
ferencd@0 636
ferencd@0 637 LATEX_HEADER =
ferencd@0 638
ferencd@0 639 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
ferencd@0 640 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
ferencd@0 641 # contain links (just like the HTML output) instead of page references
ferencd@0 642 # This makes the output suitable for online browsing using a pdf viewer.
ferencd@0 643
ferencd@0 644 PDF_HYPERLINKS = NO
ferencd@0 645
ferencd@0 646 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
ferencd@0 647 # plain latex in the generated Makefile. Set this option to YES to get a
ferencd@0 648 # higher quality PDF documentation.
ferencd@0 649
ferencd@0 650 USE_PDFLATEX = NO
ferencd@0 651
ferencd@0 652 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
ferencd@0 653 # command to the generated LaTeX files. This will instruct LaTeX to keep
ferencd@0 654 # running if errors occur, instead of asking the user for help.
ferencd@0 655 # This option is also used when generating formulas in HTML.
ferencd@0 656
ferencd@0 657 LATEX_BATCHMODE = NO
ferencd@0 658
ferencd@0 659 #---------------------------------------------------------------------------
ferencd@0 660 # configuration options related to the RTF output
ferencd@0 661 #---------------------------------------------------------------------------
ferencd@0 662
ferencd@0 663 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
ferencd@0 664 # The RTF output is optimised for Word 97 and may not look very pretty with
ferencd@0 665 # other RTF readers or editors.
ferencd@0 666
ferencd@0 667 GENERATE_RTF = NO
ferencd@0 668
ferencd@0 669 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
ferencd@0 670 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
ferencd@0 671 # put in front of it. If left blank `rtf' will be used as the default path.
ferencd@0 672
ferencd@0 673 RTF_OUTPUT = rtf
ferencd@0 674
ferencd@0 675 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
ferencd@0 676 # RTF documents. This may be useful for small projects and may help to
ferencd@0 677 # save some trees in general.
ferencd@0 678
ferencd@0 679 COMPACT_RTF = NO
ferencd@0 680
ferencd@0 681 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
ferencd@0 682 # will contain hyperlink fields. The RTF file will
ferencd@0 683 # contain links (just like the HTML output) instead of page references.
ferencd@0 684 # This makes the output suitable for online browsing using WORD or other
ferencd@0 685 # programs which support those fields.
ferencd@0 686 # Note: wordpad (write) and others do not support links.
ferencd@0 687
ferencd@0 688 RTF_HYPERLINKS = NO
ferencd@0 689
ferencd@0 690 # Load stylesheet definitions from file. Syntax is similar to doxygen's
ferencd@0 691 # config file, i.e. a series of assigments. You only have to provide
ferencd@0 692 # replacements, missing definitions are set to their default value.
ferencd@0 693
ferencd@0 694 RTF_STYLESHEET_FILE =
ferencd@0 695
ferencd@0 696 # Set optional variables used in the generation of an rtf document.
ferencd@0 697 # Syntax is similar to doxygen's config file.
ferencd@0 698
ferencd@0 699 RTF_EXTENSIONS_FILE =
ferencd@0 700
ferencd@0 701 #---------------------------------------------------------------------------
ferencd@0 702 # configuration options related to the man page output
ferencd@0 703 #---------------------------------------------------------------------------
ferencd@0 704
ferencd@0 705 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
ferencd@0 706 # generate man pages
ferencd@0 707
ferencd@0 708 GENERATE_MAN = NO
ferencd@0 709
ferencd@0 710 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
ferencd@0 711 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
ferencd@0 712 # put in front of it. If left blank `man' will be used as the default path.
ferencd@0 713
ferencd@0 714 MAN_OUTPUT = man
ferencd@0 715
ferencd@0 716 # The MAN_EXTENSION tag determines the extension that is added to
ferencd@0 717 # the generated man pages (default is the subroutine's section .3)
ferencd@0 718
ferencd@0 719 MAN_EXTENSION = .3
ferencd@0 720
ferencd@0 721 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
ferencd@0 722 # then it will generate one additional man file for each entity
ferencd@0 723 # documented in the real man page(s). These additional files
ferencd@0 724 # only source the real man page, but without them the man command
ferencd@0 725 # would be unable to find the correct page. The default is NO.
ferencd@0 726
ferencd@0 727 MAN_LINKS = NO
ferencd@0 728
ferencd@0 729 #---------------------------------------------------------------------------
ferencd@0 730 # configuration options related to the XML output
ferencd@0 731 #---------------------------------------------------------------------------
ferencd@0 732
ferencd@0 733 # If the GENERATE_XML tag is set to YES Doxygen will
ferencd@0 734 # generate an XML file that captures the structure of
ferencd@0 735 # the code including all documentation. Note that this
ferencd@0 736 # feature is still experimental and incomplete at the
ferencd@0 737 # moment.
ferencd@0 738
ferencd@0 739 GENERATE_XML = NO
ferencd@0 740
ferencd@0 741 # The XML_SCHEMA tag can be used to specify an XML schema,
ferencd@0 742 # which can be used by a validating XML parser to check the
ferencd@0 743 # syntax of the XML files.
ferencd@0 744
ferencd@0 745 XML_SCHEMA =
ferencd@0 746
ferencd@0 747 # The XML_DTD tag can be used to specify an XML DTD,
ferencd@0 748 # which can be used by a validating XML parser to check the
ferencd@0 749 # syntax of the XML files.
ferencd@0 750
ferencd@0 751 XML_DTD =
ferencd@0 752
ferencd@0 753 #---------------------------------------------------------------------------
ferencd@0 754 # configuration options for the AutoGen Definitions output
ferencd@0 755 #---------------------------------------------------------------------------
ferencd@0 756
ferencd@0 757 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
ferencd@0 758 # generate an AutoGen Definitions (see autogen.sf.net) file
ferencd@0 759 # that captures the structure of the code including all
ferencd@0 760 # documentation. Note that this feature is still experimental
ferencd@0 761 # and incomplete at the moment.
ferencd@0 762
ferencd@0 763 GENERATE_AUTOGEN_DEF = NO
ferencd@0 764
ferencd@0 765 #---------------------------------------------------------------------------
ferencd@0 766 # configuration options related to the Perl module output
ferencd@0 767 #---------------------------------------------------------------------------
ferencd@0 768
ferencd@0 769 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
ferencd@0 770 # generate a Perl module file that captures the structure of
ferencd@0 771 # the code including all documentation. Note that this
ferencd@0 772 # feature is still experimental and incomplete at the
ferencd@0 773 # moment.
ferencd@0 774
ferencd@0 775 #GENERATE_PERLMOD = NO
ferencd@0 776
ferencd@0 777 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
ferencd@0 778 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
ferencd@0 779 # to generate PDF and DVI output from the Perl module output.
ferencd@0 780
ferencd@0 781 #PERLMOD_LATEX = NO
ferencd@0 782
ferencd@0 783 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
ferencd@0 784 # nicely formatted so it can be parsed by a human reader. This is useful
ferencd@0 785 # if you want to understand what is going on. On the other hand, if this
ferencd@0 786 # tag is set to NO the size of the Perl module output will be much smaller
ferencd@0 787 # and Perl will parse it just the same.
ferencd@0 788
ferencd@0 789 #PERLMOD_PRETTY = YES
ferencd@0 790
ferencd@0 791 # The names of the make variables in the generated doxyrules.make file
ferencd@0 792 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
ferencd@0 793 # This is useful so different doxyrules.make files included by the same
ferencd@0 794 # Makefile don't overwrite each other's variables.
ferencd@0 795
ferencd@0 796 #PERLMOD_MAKEVAR_PREFIX =
ferencd@0 797
ferencd@0 798 #---------------------------------------------------------------------------
ferencd@0 799 # Configuration options related to the preprocessor
ferencd@0 800 #---------------------------------------------------------------------------
ferencd@0 801
ferencd@0 802 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
ferencd@0 803 # evaluate all C-preprocessor directives found in the sources and include
ferencd@0 804 # files.
ferencd@0 805
ferencd@0 806 ENABLE_PREPROCESSING = YES
ferencd@0 807
ferencd@0 808 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
ferencd@0 809 # names in the source code. If set to NO (the default) only conditional
ferencd@0 810 # compilation will be performed. Macro expansion can be done in a controlled
ferencd@0 811 # way by setting EXPAND_ONLY_PREDEF to YES.
ferencd@0 812
ferencd@0 813 MACRO_EXPANSION = YES
ferencd@0 814
ferencd@0 815 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
ferencd@0 816 # then the macro expansion is limited to the macros specified with the
ferencd@0 817 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
ferencd@0 818
ferencd@0 819 EXPAND_ONLY_PREDEF = NO
ferencd@0 820
ferencd@0 821 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
ferencd@0 822 # in the INCLUDE_PATH (see below) will be search if a #include is found.
ferencd@0 823
ferencd@0 824 SEARCH_INCLUDES = YES
ferencd@0 825
ferencd@0 826 # The INCLUDE_PATH tag can be used to specify one or more directories that
ferencd@0 827 # contain include files that are not input files but should be processed by
ferencd@0 828 # the preprocessor.
ferencd@0 829
ferencd@0 830 INCLUDE_PATH =
ferencd@0 831
ferencd@0 832 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
ferencd@0 833 # patterns (like *.h and *.hpp) to filter out the header-files in the
ferencd@0 834 # directories. If left blank, the patterns specified with FILE_PATTERNS will
ferencd@0 835 # be used.
ferencd@0 836
ferencd@0 837 INCLUDE_FILE_PATTERNS =
ferencd@0 838
ferencd@0 839 # The PREDEFINED tag can be used to specify one or more macro names that
ferencd@0 840 # are defined before the preprocessor is started (similar to the -D option of
ferencd@0 841 # gcc). The argument of the tag is a list of macros of the form: name
ferencd@0 842 # or name=definition (no spaces). If the definition and the = are
ferencd@0 843 # omitted =1 is assumed.
ferencd@0 844
ferencd@0 845 PREDEFINED = VMIME_BUILDING_DOC VMIME_HAVE_SASL_SUPPORT VMIME_HAVE_TLS_SUPPORT VMIME_HAVE_FILESYSTEM_FEATURES VMIME_HAVE_MESSAGING_FEATURES VMIME_HAVE_MESSAGING_PROTO_POP3 VMIME_HAVE_MESSAGING_PROTO_SMTP VMIME_HAVE_MESSAGING_PROTO_IMAP VMIME_HAVE_MESSAGING_PROTO_MAILDIR VMIME_HAVE_MESSAGING_PROTO_SENDMAIL
ferencd@0 846
ferencd@0 847 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
ferencd@0 848 # this tag can be used to specify a list of macro names that should be expanded.
ferencd@0 849 # The macro definition that is found in the sources will be used.
ferencd@0 850 # Use the PREDEFINED tag if you want to use a different macro definition.
ferencd@0 851
ferencd@0 852 EXPAND_AS_DEFINED =
ferencd@0 853
ferencd@0 854 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
ferencd@0 855 # doxygen's preprocessor will remove all function-like macros that are alone
ferencd@0 856 # on a line, have an all uppercase name, and do not end with a semicolon. Such
ferencd@0 857 # function macros are typically used for boiler-plate code, and will confuse the
ferencd@0 858 # parser if not removed.
ferencd@0 859
ferencd@0 860 SKIP_FUNCTION_MACROS = YES
ferencd@0 861
ferencd@0 862 #---------------------------------------------------------------------------
ferencd@0 863 # Configuration::addtions related to external references
ferencd@0 864 #---------------------------------------------------------------------------
ferencd@0 865
ferencd@0 866 # The TAGFILES tag can be used to specify one or more tagfiles.
ferencd@0 867
ferencd@0 868 TAGFILES =
ferencd@0 869
ferencd@0 870 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
ferencd@0 871 # a tag file that is based on the input files it reads.
ferencd@0 872
ferencd@0 873 GENERATE_TAGFILE =
ferencd@0 874
ferencd@0 875 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
ferencd@0 876 # in the class index. If set to NO only the inherited external classes
ferencd@0 877 # will be listed.
ferencd@0 878
ferencd@0 879 ALLEXTERNALS = NO
ferencd@0 880
ferencd@0 881 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
ferencd@0 882 # in the modules index. If set to NO, only the current project's groups will
ferencd@0 883 # be listed.
ferencd@0 884
ferencd@0 885 EXTERNAL_GROUPS = YES
ferencd@0 886
ferencd@0 887 # The PERL_PATH should be the absolute path and name of the perl script
ferencd@0 888 # interpreter (i.e. the result of `which perl').
ferencd@0 889
ferencd@0 890 PERL_PATH = /usr/bin/perl
ferencd@0 891
ferencd@0 892 #---------------------------------------------------------------------------
ferencd@0 893 # Configuration options related to the dot tool
ferencd@0 894 #---------------------------------------------------------------------------
ferencd@0 895
ferencd@0 896 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
ferencd@0 897 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
ferencd@0 898 # super classes. Setting the tag to NO turns the diagrams off. Note that this
ferencd@0 899 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
ferencd@0 900 # recommended to install and use dot, since it yield more powerful graphs.
ferencd@0 901
ferencd@0 902 CLASS_DIAGRAMS = YES
ferencd@0 903
ferencd@0 904 # If set to YES, the inheritance and collaboration graphs will hide
ferencd@0 905 # inheritance and usage relations if the target is undocumented
ferencd@0 906 # or is not a class.
ferencd@0 907
ferencd@0 908 HIDE_UNDOC_RELATIONS = YES
ferencd@0 909
ferencd@0 910 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
ferencd@0 911 # available from the path. This tool is part of Graphviz, a graph visualization
ferencd@0 912 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
ferencd@0 913 # have no effect if this option is set to NO (the default)
ferencd@0 914
ferencd@0 915 HAVE_DOT = YES
ferencd@0 916
ferencd@0 917 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
ferencd@0 918 # will generate a graph for each documented class showing the direct and
ferencd@0 919 # indirect inheritance relations. Setting this tag to YES will force the
ferencd@0 920 # the CLASS_DIAGRAMS tag to NO.
ferencd@0 921
ferencd@0 922 CLASS_GRAPH = YES
ferencd@0 923
ferencd@0 924 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
ferencd@0 925 # will generate a graph for each documented class showing the direct and
ferencd@0 926 # indirect implementation dependencies (inheritance, containment, and
ferencd@0 927 # class references variables) of the class with other documented classes.
ferencd@0 928
ferencd@0 929 COLLABORATION_GRAPH = YES
ferencd@0 930
ferencd@0 931 # If set to YES, the inheritance and collaboration graphs will show the
ferencd@0 932 # relations between templates and their instances.
ferencd@0 933
ferencd@0 934 TEMPLATE_RELATIONS = YES
ferencd@0 935
ferencd@0 936 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
ferencd@0 937 # tags are set to YES then doxygen will generate a graph for each documented
ferencd@0 938 # file showing the direct and indirect include dependencies of the file with
ferencd@0 939 # other documented files.
ferencd@0 940
ferencd@0 941 INCLUDE_GRAPH = YES
ferencd@0 942
ferencd@0 943 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
ferencd@0 944 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
ferencd@0 945 # documented header file showing the documented files that directly or
ferencd@0 946 # indirectly include this file.
ferencd@0 947
ferencd@0 948 INCLUDED_BY_GRAPH = YES
ferencd@0 949
ferencd@0 950 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
ferencd@0 951 # will graphical hierarchy of all classes instead of a textual one.
ferencd@0 952
ferencd@0 953 GRAPHICAL_HIERARCHY = YES
ferencd@0 954
ferencd@0 955 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
ferencd@0 956 # generated by dot. Possible values are png, jpg, or gif
ferencd@0 957 # If left blank png will be used.
ferencd@0 958
ferencd@0 959 DOT_IMAGE_FORMAT = png
ferencd@0 960
ferencd@0 961 # The tag DOT_PATH can be used to specify the path where the dot tool can be
ferencd@0 962 # found. If left blank, it is assumed the dot tool can be found on the path.
ferencd@0 963
ferencd@0 964 DOT_PATH =
ferencd@0 965
ferencd@0 966 # The DOTFILE_DIRS tag can be used to specify one or more directories that
ferencd@0 967 # contain dot files that are included in the documentation (see the
ferencd@0 968 # \dotfile command).
ferencd@0 969
ferencd@0 970 DOTFILE_DIRS =
ferencd@0 971
ferencd@0 972 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
ferencd@0 973 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
ferencd@0 974 # this value, doxygen will try to truncate the graph, so that it fits within
ferencd@0 975 # the specified constraint. Beware that most browsers cannot cope with very
ferencd@0 976 # large images.
ferencd@0 977
ferencd@0 978 MAX_DOT_GRAPH_WIDTH = 1024
ferencd@0 979
ferencd@0 980 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
ferencd@0 981 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
ferencd@0 982 # this value, doxygen will try to truncate the graph, so that it fits within
ferencd@0 983 # the specified constraint. Beware that most browsers cannot cope with very
ferencd@0 984 # large images.
ferencd@0 985
ferencd@0 986 MAX_DOT_GRAPH_HEIGHT = 1024
ferencd@0 987
ferencd@0 988 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
ferencd@0 989 # generate a legend page explaining the meaning of the various boxes and
ferencd@0 990 # arrows in the dot generated graphs.
ferencd@0 991
ferencd@0 992 GENERATE_LEGEND = YES
ferencd@0 993
ferencd@0 994 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
ferencd@0 995 # remove the intermedate dot files that are used to generate
ferencd@0 996 # the various graphs.
ferencd@0 997
ferencd@0 998 DOT_CLEANUP = YES
ferencd@0 999
ferencd@0 1000 #---------------------------------------------------------------------------
ferencd@0 1001 # Configuration::addtions related to the search engine
ferencd@0 1002 #---------------------------------------------------------------------------
ferencd@0 1003
ferencd@0 1004 # The SEARCHENGINE tag specifies whether or not a search engine should be
ferencd@0 1005 # used. If set to NO the values of all tags below this one will be ignored.
ferencd@0 1006
ferencd@0 1007 SEARCHENGINE = NO
ferencd@0 1008
ferencd@0 1009 # The CGI_NAME tag should be the name of the CGI script that
ferencd@0 1010 # starts the search engine (doxysearch) with the correct parameters.
ferencd@0 1011 # A script with this name will be generated by doxygen.
ferencd@0 1012
ferencd@0 1013 #CGI_NAME = search.cgi
ferencd@0 1014
ferencd@0 1015 # The CGI_URL tag should be the absolute URL to the directory where the
ferencd@0 1016 # cgi binaries are located. See the documentation of your http daemon for
ferencd@0 1017 # details.
ferencd@0 1018
ferencd@0 1019 #CGI_URL =
ferencd@0 1020
ferencd@0 1021 # The DOC_URL tag should be the absolute URL to the directory where the
ferencd@0 1022 # documentation is located. If left blank the absolute path to the
ferencd@0 1023 # documentation, with file:// prepended to it, will be used.
ferencd@0 1024
ferencd@0 1025 #DOC_URL =
ferencd@0 1026
ferencd@0 1027 # The DOC_ABSPATH tag should be the absolute path to the directory where the
ferencd@0 1028 # documentation is located. If left blank the directory on the local machine
ferencd@0 1029 # will be used.
ferencd@0 1030
ferencd@0 1031 #DOC_ABSPATH =
ferencd@0 1032
ferencd@0 1033 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
ferencd@0 1034 # is installed.
ferencd@0 1035
ferencd@0 1036 #BIN_ABSPATH = /usr/local/bin/
ferencd@0 1037
ferencd@0 1038 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
ferencd@0 1039 # documentation generated for other projects. This allows doxysearch to search
ferencd@0 1040 # the documentation for these projects as well.
ferencd@0 1041
ferencd@0 1042 #EXT_DOC_PATHS =
ferencd@0 1043