Doxyfile.in

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