Doxyfile.in

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