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