Doxyfile.in

   1 # Doxyfile 1.0.0
   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 # Values that contain spaces should be placed between quotes (" ")
   9
  10 #---------------------------------------------------------------------------
  11 # General configuration options
  12 #---------------------------------------------------------------------------
  13
  14 # The PROJECT_NAME tag is a single word (or a sequence of word surrounded
  15 # by quotes) that should identify the project.
  16
  17 PROJECT_NAME         = @PACKAGE@
  18
  19 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  20 # This could be handy for archiving the generated documentation or
  21 # if some version control system is used.
  22
  23 PROJECT_NUMBER       = @VERSION@
  24
  25 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  26 # base path where the generated documentation will be put.
  27 # If a relative path is entered, it will be relative to the location
  28 # where doxygen was started. If left blank the current directory will be used.
  29
  30 OUTPUT_DIRECTORY     = doxygen
  31
  32 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  33 # documentation generated by doxygen is written. Doxygen will use this
  34 # information to generate all constant output in the proper language.
  35 # The default language is English, other supported languages are:
  36 # Dutch, French, Italian, Czech, Swedish, German and Japanese
  37
  38 OUTPUT_LANGUAGE      = English
  39
  40 # The QUIET tag can be used to turn on/off the messages that are generated
  41 # by doxygen. Possible values are YES and NO. If left blank NO is used.
  42
  43 QUIET                = NO
  44
  45 # The WARNINGS tag can be used to turn on/off the warning messages that are
  46 # generated by doxygen. Possible values are YES and NO. If left blank
  47 # NO is used.
  48
  49 WARNINGS             = YES
  50
  51 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  52 # top of each HTML page. The value NO (the default) enables the index and
  53 # the value YES disables it.
  54
  55 DISABLE_INDEX        = NO
  56
  57 # If the EXTRACT_ALL tag is set to YES all classes and functions will be
  58 # included in the documentation, even if no documentation was available.
  59
  60 EXTRACT_ALL          = YES
  61
  62 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  63 # will be included in the documentation.
  64
  65 EXTRACT_PRIVATE      = NO
  66
  67 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  68 # undocumented members inside documented classes or files.
  69
  70 HIDE_UNDOC_MEMBERS   = NO
  71
  72 # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all
  73 # undocumented classes.
  74
  75 HIDE_UNDOC_CLASSES   = NO
  76
  77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  78 # include brief member descriptions after the members that are listed in
  79 # the file and class documentation (similar to JavaDoc).
  80 # Set to NO to disable this.
  81
  82 BRIEF_MEMBER_DESC    = YES
  83
  84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  85 # the brief description of a member or function before the detailed description.
  86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  87 # brief descriptions will be completely suppressed.
  88
  89 REPEAT_BRIEF         = YES
  90
  91 # If the ALWAYS_DETAILS_SEC and REPEAT_BRIEF tags are both set to YES then
  92 # Doxygen will generate a detailed section even if there is only a brief
  93 # description.
  94
  95 ALWAYS_DETAILED_SEC  = NO
  96
  97 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  98 # path before files name in the file list and in the header files. If set
  99 # to NO the shortest path that makes the file name unique will be used.
 100
 101 FULL_PATH_NAMES      = NO
 102
 103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 104 # can be used to strip a user defined part of the path. Stripping is
 105 # only done if one of the specified strings matches the left-hand part of
 106 # the path.
 107
 108 STRIP_FROM_PATH      =
 109
 110 # The INTERNAL_DOCS tag determines if documentation
 111 # that is typed after a \internal command is included. If the tag is set
 112 # to NO (the default) then the documentation will be excluded.
 113 # Set it to YES to include the internal documentation.
 114
 115 INTERNAL_DOCS        = NO
 116
 117 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
 118 # generate a class diagram (in Html and LaTeX) for classes with base or
 119 # super classes. Setting the tag to NO turns the diagrams off.
 120
 121 CLASS_DIAGRAMS       = YES
 122
 123 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 124 # be generated. Documented entities will be cross-referenced with these sources.
 125
 126 SOURCE_BROWSER       = YES
 127
 128 # Setting the INLINE_SOURCES tag to YES will include the body
 129 # of functions and classes directly in the documentation.
 130
 131 INLINE_SOURCES       = NO
 132
 133 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
 134 # will only generate file names in lower case letters. If set to
 135 # YES upper case letters are also allowed. This is useful if you have
 136 # classes or files whose names only differ in case and if your file system
 137 # supports case sensitive file names.
 138
 139 CASE_SENSE_NAMES     = NO
 140
 141 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 142 # will generate a verbatim copy of the header file for each class for
 143 # which an include is specified. Set to NO to disable this.
 144
 145 VERBATIM_HEADERS     = YES
 146
 147 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
 148 # will interpret the first line (until the first dot) of a JavaDoc-style
 149 # comment as the brief description. If set to NO, the Javadoc-style will
 150 # behave just like the Qt-style comments.
 151
 152 JAVADOC_AUTOBRIEF    = YES
 153
 154 # if the INHERIT_DOCS tag is set to YES (the default) then an undocumented
 155 # member inherits the documentation from any documented member that it
 156 # reimplements.
 157
 158 INHERIT_DOCS         = YES
 159
 160 # if the INLINE_INFO tag is set to YES (the default) then a tag [inline]
 161 # is inserted in the documentation for inline members.
 162
 163 INLINE_INFO          = YES
 164
 165 # the TAB_SIZE tag can be used to set the number of spaces in a tab.
 166 # Doxygen uses this value to replace tabs by spaces in code fragments.
 167
 168 TAB_SIZE             = 8
 169
 170 #---------------------------------------------------------------------------
 171 # configuration options related to the input files
 172 #---------------------------------------------------------------------------
 173
 174 # The INPUT tag can be used to specify the files and/or directories that contain
 175 # documented source files. You may enter file names like "myfile.cpp" or
 176 # directories like "/usr/src/myproject". Separate the files or directories
 177 # with spaces.
 178
 179 INPUT                = \
 180         ./build.c \
 181         ./build.h \
 182         ./config.h \
 183         ./build.c \
 184         ./convertdb.c \
 185         ./oldrpmdb.c \
 186         ./rpm.c \
 187         ./rpm2cpio.c \
 188         ./build/build.c \
 189         ./build/expression.c \
 190         ./build/files.c \
 191         ./build/misc.c \
 192         ./build/myftw.c \
 193         ./build/myftw.h \
 194         ./build/names.c \
 195         ./build/pack.c \
 196         ./build/parseBuildInstallClean.c \
 197         ./build/parseChangelog.c \
 198         ./build/parseDescription.c \
 199         ./build/parseFiles.c \
 200         ./build/parsePreamble.c \
 201         ./build/parsePrep.c \
 202         ./build/parseReqs.c \
 203         ./build/parseScript.c \
 204         ./build/parseSpec.c \
 205         ./build/reqprov.c \
 206         ./build/rpmbuild.h \
 207         ./build/spec.c \
 208         ./lib/cpio.c \
 209         ./lib/dbindex.c \
 210         ./lib/depends.c \
 211         ./lib/falloc.c \
 212         ./lib/formats.c \
 213         ./lib/fprint.c \
 214         ./lib/fs.c \
 215         ./lib/hash.c \
 216         ./lib/header.c \
 217         ./lib/install.c \
 218         ./lib/lookup.c \
 219         ./lib/macro.c \
 220         ./lib/misc.h \
 221         ./lib/md5.c \
 222         ./lib/md5sum.c \
 223         ./lib/messages.c \
 224         ./lib/misc.c \
 225         ./lib/oldheader.c \
 226         ./lib/package.c \
 227         ./lib/problems.c \
 228         ./lib/query.c \
 229         ./lib/rebuilddb.c \
 230         ./lib/rpmchecksig.c \
 231         ./lib/rpmdb.c \
 232         ./lib/rpmerr.c \
 233         ./lib/rpminstall.c \
 234         ./lib/rpmio.c \
 235         ./lib/rpmio.h \
 236         ./lib/rpmlead.c \
 237         ./lib/rpmlib.h \
 238         ./lib/rpmmalloc.c \
 239         ./lib/rpmrc.c \
 240         ./lib/signature.c \
 241         ./lib/stringbuf.c \
 242         ./lib/stringbuf.h \
 243         ./lib/stubs.c \
 244         ./lib/tagName.c \
 245         ./lib/tagtable.c \
 246         ./lib/test.c \
 247         ./lib/transaction.c \
 248         ./lib/tufdio.c \
 249         ./lib/uninstall.c \
 250         ./lib/url.c \
 251         ./lib/verify.c \
 252         ./popt/findme.c \
 253         ./popt/popt.c \
 254         ./popt/poptconfig.c \
 255         ./popt/popthelp.c \
 256         ./popt/poptparse.c \
 257         ./tools/dump.c \
 258         ./tools/dumpdb.c \
 259         ./tools/fstrcmp.c \
 260         ./tools/javadeps.c \
 261         ./tools/message.c \
 262         ./tools/rpmarchive.c \
 263         ./tools/rpmchecksig.c \
 264         ./tools/rpmgettext.c \
 265         ./tools/rpmheader.c \
 266         ./tools/rpminject.c \
 267         ./tools/rpmlead.c \
 268         ./tools/rpmsignature.c \
 269         ./tools/str-list.c
 270
 271 #       ./system.h \
 272 #       ./build/buildio.h \
 273 #       ./build/rpmspec.h \
 274 #       ./lib/dbindex.h \
 275 #       ./lib/header.h \
 276 #       ./lib/rpmmacro.h \
 277 #       ./lib/rpmurl.h \
 278 #       ./popt/findme.h \
 279 #       ./popt/poptint.h \
 280 #       ./popt/popt.h \
 281
 282 # If the value of the INPUT tag contains directories, you can use the
 283 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 284 # and *.h) to filter out the source-files in the directories. If left
 285 # blank all files are included.
 286
 287 FILE_PATTERNS        = *.c *.h
 288
 289 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 290 # should be searched for input files as well. Possible values are YES and NO.
 291 # If left blank NO is used.
 292
 293 RECURSIVE            = NO
 294
 295 # The EXCLUDE tag can be used to specify files and/or directories that should
 296 # excluded from the INPUT source files. This way you can easily exclude a
 297 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 298
 299 EXCLUDE              =
 300
 301 # If the value of the INPUT tag contains directories, you can use the
 302 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 303 # certain files from those directories.
 304
 305 EXCLUDE_PATTERNS     =
 306
 307 # The EXAMPLE_PATH tag can be used to specify one or more files or
 308 # directories that contain example code fragments that are included (see
 309 # the \include command).
 310
 311 EXAMPLE_PATH         =
 312
 313 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 314 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 315 # and *.h) to filter out the source-files in the directories. If left
 316 # blank all files are included.
 317
 318 EXAMPLE_PATTERNS     =
 319
 320 # The IMAGE_PATH tag can be used to specify one or more files or
 321 # directories that contain image that are included in the documentation (see
 322 # the \image command).
 323
 324 IMAGE_PATH           =
 325
 326 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 327 # invoke to filter for each input file. Doxygen will invoke the filter program
 328 # by executing (via popen()) the command <filter> <input-file>, where <filter>
 329 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
 330 # input file. Doxygen will then use the output that the filter program writes
 331 # to standard output.
 332
 333 INPUT_FILTER         =
 334
 335 #---------------------------------------------------------------------------
 336 # configuration options related to the HTML output
 337 #---------------------------------------------------------------------------
 338
 339 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 340 # generate HTML output
 341
 342 GENERATE_HTML        = YES
 343
 344 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 345 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 346 # put in front of it. If left blank `html' will be used as the default path.
 347
 348 HTML_OUTPUT          =
 349
 350 # The HTML_HEADER tag can be used to specify a personal HTML header for
 351 # each generated HTML page. If it is left blank doxygen will generate a
 352 # standard header.
 353
 354 HTML_HEADER          =
 355
 356 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 357 # each generated HTML page. If it is left blank doxygen will generate a
 358 # standard footer.
 359
 360 HTML_FOOTER          =
 361
 362 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
 363 # style sheet that is used by each HTML page. It can be used to
 364 # fine-tune the look of the HTML output. If the tag is left blank doxygen
 365 # will generate a default style sheet
 366
 367 HTML_STYLESHEET      =
 368
 369 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 370 # files or namespaces will be aligned in HTML using tables. If set to
 371 # NO a bullet list will be used.
 372
 373 HTML_ALIGN_MEMBERS   = YES
 374
 375 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
 376 # will be generated that can be used as input for tools like the
 377 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
 378 # of the generated HTML documentation.
 379
 380 GENERATE_HTMLHELP    = NO
 381
 382 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
 383 # of all compounds will be generated. Enable this if the project
 384 # contains a lot of classes, structs, unions or interfaces.
 385
 386 ALPHABETICAL_INDEX   = NO
 387
 388 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
 389 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
 390 # in which this list will be split (can be a number in the range [1..20])
 391
 392 COLS_IN_ALPHA_INDEX  = 5
 393
 394 #---------------------------------------------------------------------------
 395 # configuration options related to the LaTeX output
 396 #---------------------------------------------------------------------------
 397
 398 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 399 # generate Latex output.
 400
 401 GENERATE_LATEX       = NO
 402
 403 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 404 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 405 # put in front of it. If left blank `latex' will be used as the default path.
 406
 407 LATEX_OUTPUT         =
 408
 409 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
 410 # LaTeX documents. This may be useful for small projects and may help to
 411 # save some trees in general.
 412
 413 COMPACT_LATEX        = NO
 414
 415 # The PAPER_TYPE tag can be used to set the paper type that is used
 416 # by the printer. Possible values are: a4, a4wide, letter, legal and
 417 # executive. If left blank a4wide will be used.
 418
 419 PAPER_TYPE           = a4wide
 420
 421 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 422 # packages that should be included in the LaTeX output.
 423
 424 EXTRA_PACKAGES       =
 425
 426 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
 427 # the generated latex document. The header should contain everything until
 428 # the first chapter. If it is left blank doxygen will generate a
 429 # standard header. Notice: only use this tag if you know what you are doing!
 430
 431 LATEX_HEADER         =
 432
 433 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
 434 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
 435 # contain links (just like the HTML output) instead of page references
 436 # This makes the output suitable for online browsing using a pdf viewer.
 437
 438 PDF_HYPERLINKS       = NO
 439
 440 #---------------------------------------------------------------------------
 441 # configuration options related to the man page output
 442 #---------------------------------------------------------------------------
 443
 444 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 445 # generate man pages
 446
 447 GENERATE_MAN         = YES
 448
 449 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
 450 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 451 # put in front of it. If left blank `man' will be used as the default path.
 452
 453 MAN_OUTPUT           =
 454
 455 # The MAN_EXTENSION tag determines the extension that is added to
 456 # the generated man pages (default is the subroutine's section .3)
 457
 458 MAN_EXTENSION        = .3
 459
 460 #---------------------------------------------------------------------------
 461 # Configuration options related to the preprocessor
 462 #---------------------------------------------------------------------------
 463
 464 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
 465 # evaluate all C-preprocessor directives found in the sources and include
 466 # files.
 467
 468 ENABLE_PREPROCESSING = YES
 469
 470 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
 471 # names in the source code. If set to NO (the default) only conditional
 472 # compilation will be performed.
 473
 474 MACRO_EXPANSION      = NO
 475
 476 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 477 # in the INCLUDE_PATH (see below) will be search if a #include is found.
 478
 479 SEARCH_INCLUDES      = YES
 480
 481 # The INCLUDE_PATH tag can be used to specify one or more directories that
 482 # contain include files that are not input files but should be processed by
 483 # the preprocessor.
 484
 485 INCLUDE_PATH         =
 486
 487 # The PREDEFINED tag can be used to specify one or more macro names that
 488 # are defined before the preprocessor is started (similar to the -D option of
 489 # gcc). The argument of the tag is a list of macros of the form: name
 490 # or name=definition (no spaces). If the definition and the = are
 491 # omitted =1 is assumed.
 492
 493 PREDEFINED           =
 494
 495 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 496 # then the macro expansion is limited to the macros specified with the
 497 # PREDEFINED tag.
 498
 499 EXPAND_ONLY_PREDEF   = NO
 500
 501 #---------------------------------------------------------------------------
 502 # Configuration options related to external references
 503 #---------------------------------------------------------------------------
 504
 505 # The TAGFILES tag can be used to specify one or more tagfiles.
 506
 507 TAGFILES             =
 508
 509 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 510 # a tag file that is based on the input files it reads.
 511
 512 GENERATE_TAGFILE     =
 513
 514 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 515 # in the class index. If set to NO only the inherited external classes
 516 # will be listed.
 517
 518 ALLEXTERNALS         = NO
 519
 520 # The PERL_PATH should be the absolute path and name of the perl script
 521 # interpreter (i.e. the result of `which perl').
 522
 523 PERL_PATH            = /usr/bin/perl
 524
 525 #---------------------------------------------------------------------------
 526 # Configuration options related to the search engine
 527 #---------------------------------------------------------------------------
 528
 529 # The SEARCHENGINE tag specifies whether or not a search engine should be
 530 # used. If set to NO the values of all tags below this one will be ignored.
 531
 532 SEARCHENGINE         = NO
 533
 534 # The CGI_NAME tag should be the name of the CGI script that
 535 # starts the search engine (doxysearch) with the correct parameters.
 536 # A script with this name will be generated by doxygen.
 537
 538 CGI_NAME             = search.cgi
 539
 540 # The CGI_URL tag should be the absolute URL to the directory where the
 541 # cgi binaries are located. See the documentation of your http daemon for
 542 # details.
 543
 544 CGI_URL              =
 545
 546 # The DOC_URL tag should be the absolute URL to the directory where the
 547 # documentation is located. If left blank the absolute path to the
 548 # documentation, with file:// prepended to it, will be used.
 549
 550 DOC_URL              =
 551
 552 # The DOC_ABSPATH tag should be the absolute path to the directory where the
 553 # documentation is located. If left blank the directory on the local machine
 554 # will be used.
 555
 556 DOC_ABSPATH          =
 557
 558 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
 559 # is installed.
 560
 561 BIN_ABSPATH          = /usr/local/bin/
 562
 563 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
 564 # documentation generated for other projects. This allows doxysearch to search
 565 # the documentation for these projects as well.
 566
 567 EXT_DOC_PATHS        =