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 # Spanish, Russian, Croatian, Polish, and Portuguese.
  40
  41 OUTPUT_LANGUAGE        = English
  42
  43 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  44 # documentation are documented, even if no documentation was available.
  45 # Private class members and static file members will be hidden unless
  46 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  47
  48 EXTRACT_ALL            = YES
  49
  50 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  51 # will be included in the documentation.
  52
  53 EXTRACT_PRIVATE        = NO
  54
  55 # If the EXTRACT_STATIC tag is set to YES all static members of a file
  56 # will be included in the documentation.
  57
  58 EXTRACT_STATIC         = YES
  59
  60 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  61 # undocumented members of documented classes, files or namespaces.
  62 # If set to NO (the default) these members will be included in the
  63 # various overviews, but no documentation section is generated.
  64 # This option has no effect if EXTRACT_ALL is enabled.
  65
  66 HIDE_UNDOC_MEMBERS     = NO
  67
  68 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  69 # undocumented classes that are normally visible in the class hierarchy.
  70 # If set to NO (the default) these class will be included in the various
  71 # overviews. This option has no effect if EXTRACT_ALL is enabled.
  72
  73 HIDE_UNDOC_CLASSES     = NO
  74
  75 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  76 # include brief member descriptions after the members that are listed in
  77 # the file and class documentation (similar to JavaDoc).
  78 # Set to NO to disable this.
  79
  80 BRIEF_MEMBER_DESC      = YES
  81
  82 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  83 # the brief description of a member or function before the detailed description.
  84 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  85 # brief descriptions will be completely suppressed.
  86
  87 REPEAT_BRIEF           = YES
  88
  89 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  90 # Doxygen will generate a detailed section even if there is only a brief
  91 # description.
  92
  93 ALWAYS_DETAILED_SEC    = NO
  94
  95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  96 # path before files name in the file list and in the header files. If set
  97 # to NO the shortest path that makes the file name unique will be used.
  98
  99 FULL_PATH_NAMES        = YES
 100
 101 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 102 # can be used to strip a user defined part of the path. Stripping is
 103 # only done if one of the specified strings matches the left-hand part of
 104 # the path. It is allowed to use relative paths in the argument list.
 105
 106 STRIP_FROM_PATH        = @TOP_SOURCEDIR@/
 107
 108 # The INTERNAL_DOCS tag determines if documentation
 109 # that is typed after a \internal command is included. If the tag is set
 110 # to NO (the default) then the documentation will be excluded.
 111 # Set it to YES to include the internal documentation.
 112
 113 INTERNAL_DOCS          = NO
 114
 115 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
 116 # generate a class diagram (in Html and LaTeX) for classes with base or
 117 # super classes. Setting the tag to NO turns the diagrams off.
 118
 119 CLASS_DIAGRAMS         = YES
 120
 121 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 122 # be generated. Documented entities will be cross-referenced with these sources.
 123
 124 SOURCE_BROWSER         = YES
 125
 126 # Setting the INLINE_SOURCES tag to YES will include the body
 127 # of functions and classes directly in the documentation.
 128
 129 INLINE_SOURCES         = NO
 130
 131 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
 132 # doxygen to hide any special comment blocks from generated source code
 133 # fragments. Normal C and C++ comments will always remain visible.
 134
 135 STRIP_CODE_COMMENTS    = YES
 136
 137 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
 138 # will only generate file names in lower case letters. If set to
 139 # YES upper case letters are also allowed. This is useful if you have
 140 # classes or files whose names only differ in case and if your file system
 141 # supports case sensitive file names.
 142
 143 CASE_SENSE_NAMES       = YES
 144
 145 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
 146 # will show members with their full class and namespace scopes in the
 147 # documentation. If set to YES the scope will be hidden.
 148
 149 HIDE_SCOPE_NAMES       = NO
 150
 151 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 152 # will generate a verbatim copy of the header file for each class for
 153 # which an include is specified. Set to NO to disable this.
 154
 155 VERBATIM_HEADERS       = YES
 156
 157 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
 158 # will put list of the files that are included by a file in the documentation
 159 # of that file.
 160
 161 SHOW_INCLUDE_FILES     = YES
 162
 163 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
 164 # will interpret the first line (until the first dot) of a JavaDoc-style
 165 # comment as the brief description. If set to NO, the Javadoc-style will
 166 # behave just like the Qt-style comments.
 167
 168 JAVADOC_AUTOBRIEF      = YES
 169
 170 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
 171 # member inherits the documentation from any documented member that it
 172 # reimplements.
 173
 174 INHERIT_DOCS           = YES
 175
 176 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
 177 # is inserted in the documentation for inline members.
 178
 179 INLINE_INFO            = YES
 180
 181 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
 182 # will sort the (detailed) documentation of file and class members
 183 # alphabetically by member name. If set to NO the members will appear in
 184 # declaration order.
 185
 186 SORT_MEMBER_DOCS       = YES
 187
 188 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
 189 # Doxygen uses this value to replace tabs by spaces in code fragments.
 190
 191 TAB_SIZE               = 8
 192
 193 # The ENABLE_SECTIONS tag can be used to enable conditional
 194 # documentation sections, marked by \if sectionname ... \endif.
 195
 196 ENABLED_SECTIONS       =
 197
 198 # The GENERATE_TODOLIST tag can be used to enable (YES) or
 199 # disable (NO) the todo list. This list is created by putting \todo
 200 # commands in the documentation.
 201
 202 GENERATE_TODOLIST      = YES
 203
 204 # The GENERATE_TESTLIST tag can be used to enable (YES) or
 205 # disable (NO) the test list. This list is created by putting \test
 206 # commands in the documentation.
 207
 208 GENERATE_TESTLIST      = YES
 209
 210 #---------------------------------------------------------------------------
 211 # configuration options related to warning and progress messages
 212 #---------------------------------------------------------------------------
 213
 214 # The QUIET tag can be used to turn on/off the messages that are generated
 215 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 216
 217 QUIET                  = NO
 218
 219 # The WARNINGS tag can be used to turn on/off the warning messages that are
 220 # generated by doxygen. Possible values are YES and NO. If left blank
 221 # NO is used.
 222
 223 WARNINGS               = YES
 224
 225 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
 226 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
 227 # automatically be disabled.
 228
 229 WARN_IF_UNDOCUMENTED   = YES
 230
 231 # The WARN_FORMAT tag determines the format of the warning messages that
 232 # doxygen can produce. The string should contain the $file, $line, and $text
 233 # tags, which will be replaced by the file and line number from which the
 234 # warning originated and the warning text.
 235
 236 WARN_FORMAT            = "$file:$line: $text"
 237
 238 #---------------------------------------------------------------------------
 239 # configuration options related to the input files
 240 #---------------------------------------------------------------------------
 241
 242 # The INPUT tag can be used to specify the files and/or directories that contain
 243 # documented source files. You may enter file names like "myfile.cpp" or
 244 # directories like "/usr/src/myproject". Separate the files or directories
 245 # with spaces.
 246
 247 INPUT                  = \
 248         ./Doxyheader \
 249         ./build.c \
 250         ./build.h \
 251         ./config.h \
 252         ./rpmqv.c \
 253         ./rpm2cpio.c \
 254         ./system.h \
 255         ./build/build.c \
 256         ./build/buildio.h \
 257         ./build/expression.c \
 258         ./build/files.c \
 259         ./build/misc.c \
 260         ./build/myftw.c \
 261         ./build/myftw.h \
 262         ./build/names.c \
 263         ./build/pack.c \
 264         ./build/parseBuildInstallClean.c \
 265         ./build/parseChangelog.c \
 266         ./build/parseDescription.c \
 267         ./build/parseFiles.c \
 268         ./build/parsePreamble.c \
 269         ./build/parsePrep.c \
 270         ./build/parseReqs.c \
 271         ./build/parseScript.c \
 272         ./build/parseSpec.c \
 273         ./build/reqprov.c \
 274         ./build/rpmbuild.h \
 275         ./build/rpmspec.h \
 276         ./build/spec.c \
 277         ./lib/cpio.c \
 278         ./lib/cpio.h \
 279         ./lib/db1.c \
 280         ./lib/db3.c \
 281         ./lib/depends.c \
 282         ./lib/depends.h \
 283         ./lib/falloc.c \
 284         ./lib/falloc.h \
 285         ./lib/formats.c \
 286         ./lib/fprint.c \
 287         ./lib/fprint.h \
 288         ./lib/fs.c \
 289         ./lib/hash.c \
 290         ./lib/hash.h \
 291         ./lib/header.c \
 292         ./lib/header.h \
 293         ./lib/install.c \
 294         ./lib/install.h \
 295         ./lib/md5.c \
 296         ./lib/md5.h \
 297         ./lib/md5sum.c \
 298         ./lib/misc.c \
 299         ./lib/misc.h \
 300         ./lib/package.c \
 301         ./lib/poptBT.c \
 302         ./lib/poptQV.c \
 303         ./lib/problems.c \
 304         ./lib/query.c \
 305         ./lib/rpmchecksig.c \
 306         ./lib/rpmdb.c \
 307         ./lib/rpmdb.h \
 308         ./lib/rpminstall.c \
 309         ./lib/rpmlead.c \
 310         ./lib/rpmlead.h \
 311         ./lib/rpmlib.h \
 312         ./lib/rpmlibprov.c \
 313         ./lib/rpmrc.c \
 314         ./lib/signature.c \
 315         ./lib/signature.h \
 316         ./lib/stringbuf.c \
 317         ./lib/stringbuf.h \
 318         ./lib/tagName.c \
 319         ./lib/tagtable.c \
 320         ./lib/transaction.c \
 321         ./lib/uninstall.c \
 322         ./lib/verify.c \
 323         ./rpmio/base64.c \
 324         ./rpmio/base64.h \
 325         ./rpmio/digest.c \
 326         ./rpmio/macro.c \
 327         ./rpmio/rpmlog.c \
 328         ./rpmio/rpmerr.h \
 329         ./rpmio/rpmio.c \
 330         ./rpmio/rpmio.h \
 331         ./rpmio/rpmio_internal.h \
 332         ./rpmio/rpmio_api.c \
 333         ./rpmio/rpmmacro.h \
 334         ./rpmio/rpmmalloc.c \
 335         ./rpmio/rpmmessages.h \
 336         ./rpmio/rpmrpc.c \
 337         ./rpmio/rpmurl.h \
 338         ./rpmio/strcasecmp.c \
 339         ./rpmio/stubs.c \
 340         ./rpmio/ugid.c \
 341         ./rpmio/ugid.h \
 342         ./rpmio/url.c \
 343         ./popt/findme.c \
 344         ./popt/findme.h \
 345         ./popt/popt.c \
 346         ./popt/popt.h \
 347         ./popt/poptconfig.c \
 348         ./popt/popthelp.c \
 349         ./popt/poptint.h \
 350         ./popt/poptparse.c \
 351         ./python/rpmmodule.c \
 352         ./tools/dump.c \
 353         ./tools/dumpdb.c \
 354         ./tools/javadeps.c \
 355         ./tools/rpmarchive.c \
 356         ./tools/rpmchecksig.c \
 357         ./tools/rpmheader.c \
 358         ./tools/rpminject.c \
 359         ./tools/rpmlead.c \
 360         ./tools/rpmsignature.c
 361
 362 # If the value of the INPUT tag contains directories, you can use the
 363 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 364 # and *.h) to filter out the source-files in the directories. If left
 365 # blank all files are included.
 366
 367 FILE_PATTERNS          = *.c *.h
 368
 369 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 370 # should be searched for input files as well. Possible values are YES and NO.
 371 # If left blank NO is used.
 372
 373 RECURSIVE              = NO
 374
 375 # The EXCLUDE tag can be used to specify files and/or directories that should
 376 # excluded from the INPUT source files. This way you can easily exclude a
 377 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 378
 379 EXCLUDE                =
 380
 381 # If the value of the INPUT tag contains directories, you can use the
 382 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 383 # certain files from those directories.
 384
 385 EXCLUDE_PATTERNS       =
 386
 387 # The EXAMPLE_PATH tag can be used to specify one or more files or
 388 # directories that contain example code fragments that are included (see
 389 # the \include command).
 390
 391 EXAMPLE_PATH           = @TOP_SOURCEDIR@/doc/manual
 392
 393 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 394 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 395 # and *.h) to filter out the source-files in the directories. If left
 396 # blank all files are included.
 397
 398 EXAMPLE_PATTERNS       =
 399
 400 # The IMAGE_PATH tag can be used to specify one or more files or
 401 # directories that contain image that are included in the documentation (see
 402 # the \image command).
 403
 404 IMAGE_PATH             =
 405
 406 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 407 # invoke to filter for each input file. Doxygen will invoke the filter program
 408 # by executing (via popen()) the command <filter> <input-file>, where <filter>
 409 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
 410 # input file. Doxygen will then use the output that the filter program writes
 411 # to standard output.
 412
 413 INPUT_FILTER           =
 414
 415 #---------------------------------------------------------------------------
 416 # configuration options related to the alphabetical class index
 417 #---------------------------------------------------------------------------
 418
 419 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
 420 # of all compounds will be generated. Enable this if the project
 421 # contains a lot of classes, structs, unions or interfaces.
 422
 423 ALPHABETICAL_INDEX     = NO
 424
 425 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
 426 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
 427 # in which this list will be split (can be a number in the range [1..20])
 428
 429 COLS_IN_ALPHA_INDEX    = 5
 430
 431 # In case all classes in a project start with a common prefix, all
 432 # classes will be put under the same header in the alphabetical index.
 433 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
 434 # should be ignored while generating the index headers.
 435
 436 IGNORE_PREFIX          =
 437
 438 #---------------------------------------------------------------------------
 439 # configuration options related to the HTML output
 440 #---------------------------------------------------------------------------
 441
 442 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 443 # generate HTML output.
 444
 445 GENERATE_HTML          = YES
 446
 447 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 448 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 449 # put in front of it. If left blank `html' will be used as the default path.
 450
 451 HTML_OUTPUT            = html
 452
 453 # The HTML_HEADER tag can be used to specify a personal HTML header for
 454 # each generated HTML page. If it is left blank doxygen will generate a
 455 # standard header.
 456
 457 HTML_HEADER            =
 458
 459 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 460 # each generated HTML page. If it is left blank doxygen will generate a
 461 # standard footer.
 462
 463 HTML_FOOTER            =
 464
 465 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
 466 # style sheet that is used by each HTML page. It can be used to
 467 # fine-tune the look of the HTML output. If the tag is left blank doxygen
 468 # will generate a default style sheet
 469
 470 HTML_STYLESHEET        =
 471
 472 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 473 # files or namespaces will be aligned in HTML using tables. If set to
 474 # NO a bullet list will be used.
 475
 476 HTML_ALIGN_MEMBERS     = YES
 477
 478 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
 479 # will be generated that can be used as input for tools like the
 480 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
 481 # of the generated HTML documentation.
 482
 483 GENERATE_HTMLHELP      = NO
 484
 485 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
 486 # top of each HTML page. The value NO (the default) enables the index and
 487 # the value YES disables it.
 488
 489 DISABLE_INDEX          = NO
 490
 491 #---------------------------------------------------------------------------
 492 # configuration options related to the LaTeX output
 493 #---------------------------------------------------------------------------
 494
 495 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 496 # generate Latex output.
 497
 498 GENERATE_LATEX         = NO
 499
 500 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 501 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 502 # put in front of it. If left blank `latex' will be used as the default path.
 503
 504 LATEX_OUTPUT           = latex
 505
 506 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
 507 # LaTeX documents. This may be useful for small projects and may help to
 508 # save some trees in general.
 509
 510 COMPACT_LATEX          = NO
 511
 512 # The PAPER_TYPE tag can be used to set the paper type that is used
 513 # by the printer. Possible values are: a4, a4wide, letter, legal and
 514 # executive. If left blank a4wide will be used.
 515
 516 PAPER_TYPE             = a4wide
 517
 518 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 519 # packages that should be included in the LaTeX output.
 520
 521 EXTRA_PACKAGES         =
 522
 523 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
 524 # the generated latex document. The header should contain everything until
 525 # the first chapter. If it is left blank doxygen will generate a
 526 # standard header. Notice: only use this tag if you know what you are doing!
 527
 528 LATEX_HEADER           =
 529
 530 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
 531 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
 532 # contain links (just like the HTML output) instead of page references
 533 # This makes the output suitable for online browsing using a pdf viewer.
 534
 535 PDF_HYPERLINKS         = NO
 536
 537 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
 538 # plain latex in the generated Makefile. Set this option to YES to get a
 539 # higher quality PDF documentation.
 540
 541 USE_PDFLATEX           = NO
 542
 543 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
 544 # command to the generated LaTeX files. This will instruct LaTeX to keep
 545 # running if errors occur, instead of asking the user for help.
 546 # This option is also used when generating formulas in HTML.
 547
 548 LATEX_BATCHMODE        = NO
 549
 550 #---------------------------------------------------------------------------
 551 # configuration options related to the RTF output
 552 #---------------------------------------------------------------------------
 553
 554 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
 555 # The RTF output is optimised for Word 97 and may not look very pretty with
 556 # other RTF readers or editors.
 557
 558 GENERATE_RTF           = NO
 559
 560 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
 561 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 562 # put in front of it. If left blank `rtf' will be used as the default path.
 563
 564 RTF_OUTPUT             = rtf
 565
 566 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
 567 # RTF documents. This may be useful for small projects and may help to
 568 # save some trees in general.
 569
 570 COMPACT_RTF            = NO
 571
 572 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
 573 # will contain hyperlink fields. The RTF file will
 574 # contain links (just like the HTML output) instead of page references.
 575 # This makes the output suitable for online browsing using a WORD or other.
 576 # programs which support those fields.
 577 # Note: wordpad (write) and others do not support links.
 578
 579 RTF_HYPERLINKS         = NO
 580
 581 # Load stylesheet definitions from file. Syntax is similar to doxygen's
 582 # config file, i.e. a series of assigments. You only have to provide
 583 # replacements, missing definitions are set to their default value.
 584
 585 RTF_STYLESHEET_FILE    =
 586
 587 #---------------------------------------------------------------------------
 588 # configuration options related to the man page output
 589 #---------------------------------------------------------------------------
 590
 591 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 592 # generate man pages
 593
 594 GENERATE_MAN           = YES
 595
 596 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
 597 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 598 # put in front of it. If left blank `man' will be used as the default path.
 599
 600 MAN_OUTPUT             = man
 601
 602 # The MAN_EXTENSION tag determines the extension that is added to
 603 # the generated man pages (default is the subroutine's section .3)
 604
 605 MAN_EXTENSION          = .3
 606
 607 #---------------------------------------------------------------------------
 608 # configuration options related to the XML output
 609 #---------------------------------------------------------------------------
 610
 611 # If the GENERATE_XML tag is set to YES Doxygen will
 612 # generate an XML file that captures the structure of
 613 # the code including all documentation. Warning: This feature
 614 # is still experimental and very incomplete.
 615
 616 GENERATE_XML           = NO
 617
 618 #---------------------------------------------------------------------------
 619 # Configuration options related to the preprocessor
 620 #---------------------------------------------------------------------------
 621
 622 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
 623 # evaluate all C-preprocessor directives found in the sources and include
 624 # files.
 625
 626 ENABLE_PREPROCESSING   = YES
 627
 628 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
 629 # names in the source code. If set to NO (the default) only conditional
 630 # compilation will be performed. Macro expansion can be done in a controlled
 631 # way by setting EXPAND_ONLY_PREDEF to YES.
 632
 633 MACRO_EXPANSION        = YES
 634
 635 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 636 # then the macro expansion is limited to the macros specified with the
 637 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
 638
 639 EXPAND_ONLY_PREDEF     = NO
 640
 641 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 642 # in the INCLUDE_PATH (see below) will be search if a #include is found.
 643
 644 SEARCH_INCLUDES        = YES
 645
 646 # The INCLUDE_PATH tag can be used to specify one or more directories that
 647 # contain include files that are not input files but should be processed by
 648 # the preprocessor.
 649
 650 INCLUDE_PATH           =
 651
 652 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 653 # patterns (like *.h and *.hpp) to filter out the header-files in the
 654 # directories. If left blank, the patterns specified with FILE_PATTERNS will
 655 # be used.
 656
 657 INCLUDE_FILE_PATTERNS  =
 658
 659 # The PREDEFINED tag can be used to specify one or more macro names that
 660 # are defined before the preprocessor is started (similar to the -D option of
 661 # gcc). The argument of the tag is a list of macros of the form: name
 662 # or name=definition (no spaces). If the definition and the = are
 663 # omitted =1 is assumed.
 664
 665 PREDEFINED             =
 666
 667 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
 668 # this tag can be used to specify a list of macro names that should be expanded.
 669 # The macro definition that is found in the sources will be used.
 670 # Use the PREDEFINED tag if you want to use a different macro definition.
 671
 672 EXPAND_AS_DEFINED      =
 673
 674 #---------------------------------------------------------------------------
 675 # Configuration::addtions related to external references
 676 #---------------------------------------------------------------------------
 677
 678 # The TAGFILES tag can be used to specify one or more tagfiles.
 679
 680 TAGFILES               =
 681
 682 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 683 # a tag file that is based on the input files it reads.
 684
 685 GENERATE_TAGFILE       =
 686
 687 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 688 # in the class index. If set to NO only the inherited external classes
 689 # will be listed.
 690
 691 ALLEXTERNALS           = NO
 692
 693 # The PERL_PATH should be the absolute path and name of the perl script
 694 # interpreter (i.e. the result of `which perl').
 695
 696 PERL_PATH              = /usr/bin/perl
 697
 698 #---------------------------------------------------------------------------
 699 # Configuration options related to the dot tool
 700 #---------------------------------------------------------------------------
 701
 702 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
 703 # available from the path. This tool is part of Graphviz, a graph visualization
 704 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
 705 # have no effect if this option is set to NO (the default)
 706
 707 HAVE_DOT               = NO
 708
 709 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
 710 # will generate a graph for each documented class showing the direct and
 711 # indirect inheritance relations. Setting this tag to YES will force the
 712 # the CLASS_DIAGRAMS tag to NO.
 713
 714 CLASS_GRAPH            = YES
 715
 716 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
 717 # will generate a graph for each documented class showing the direct and
 718 # indirect implementation dependencies (inheritance, containment, and
 719 # class references variables) of the class with other documented classes.
 720
 721 COLLABORATION_GRAPH    = YES
 722
 723 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
 724 # YES then doxygen will generate a graph for each documented file showing
 725 # the direct and indirect include dependencies of the file with other
 726 # documented files.
 727
 728 INCLUDE_GRAPH          = YES
 729
 730 # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
 731 # YES then doxygen will generate a graph for each documented header file showing
 732 # the documented files that directly or indirectly include this file
 733
 734 INCLUDED_BY_GRAPH      = YES
 735
 736 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
 737 # will graphical hierarchy of all classes instead of a textual one.
 738
 739 GRAPHICAL_HIERARCHY    = YES
 740
 741 # The tag DOT_PATH can be used to specify the path where the dot tool can be
 742 # found. If left blank, it is assumed the dot tool can be found on the path.
 743
 744 DOT_PATH               =
 745
 746 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
 747 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
 748 # this value, doxygen will try to truncate the graph, so that it fits within
 749 # the specified constraint. Beware that most browsers cannot cope with very
 750 # large images.
 751
 752 MAX_DOT_GRAPH_WIDTH    = 1024
 753
 754 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
 755 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
 756 # this value, doxygen will try to truncate the graph, so that it fits within
 757 # the specified constraint. Beware that most browsers cannot cope with very
 758 # large images.
 759
 760 MAX_DOT_GRAPH_HEIGHT   = 1024
 761
 762 #---------------------------------------------------------------------------
 763 # Configuration::addtions related to the search engine
 764 #---------------------------------------------------------------------------
 765
 766 # The SEARCHENGINE tag specifies whether or not a search engine should be
 767 # used. If set to NO the values of all tags below this one will be ignored.
 768
 769 SEARCHENGINE           = NO
 770
 771 # The CGI_NAME tag should be the name of the CGI script that
 772 # starts the search engine (doxysearch) with the correct parameters.
 773 # A script with this name will be generated by doxygen.
 774
 775 CGI_NAME               = search.cgi
 776
 777 # The CGI_URL tag should be the absolute URL to the directory where the
 778 # cgi binaries are located. See the documentation of your http daemon for
 779 # details.
 780
 781 CGI_URL                =
 782
 783 # The DOC_URL tag should be the absolute URL to the directory where the
 784 # documentation is located. If left blank the absolute path to the
 785 # documentation, with file:// prepended to it, will be used.
 786
 787 DOC_URL                =
 788
 789 # The DOC_ABSPATH tag should be the absolute path to the directory where the
 790 # documentation is located. If left blank the directory on the local machine
 791 # will be used.
 792
 793 DOC_ABSPATH            =
 794
 795 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
 796 # is installed.
 797
 798 BIN_ABSPATH            = /usr/local/bin/
 799
 800 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
 801 # documentation generated for other projects. This allows doxysearch to search
 802 # the documentation for these projects as well.
 803
 804 EXT_DOC_PATHS          =