X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=Doxyfile.in;h=d172bc973d6591141f4facd0567def6478096d2f;hb=af26016f77ef0e9b450ade0e7e742da1c09d5867;hp=7f6a83ec2ef43dee92ffa71fc09263f3422a1e7a;hpb=cafccc00586497bdc9c5a4c12b19709fbd417976;p=platform%2Fupstream%2Frpm.git diff --git a/Doxyfile.in b/Doxyfile.in index 7f6a83e..d172bc9 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -1,6 +1,7 @@ -# Doxyfile 1.2.1 +# Doxyfile 1.3.5 -# This file describes the settings to be used by doxygen for a project +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: @@ -10,7 +11,7 @@ # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- -# General configuration options +# Project related configuration options #--------------------------------------------------------------------------- # The PROJECT_NAME tag is a single word (or a sequence of words surrounded @@ -35,43 +36,22 @@ OUTPUT_DIRECTORY = @WITH_APIDOCS_TARGET@ # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: -# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, -# Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian, -# Polish, Portuguese, Brazilian and Slovene. +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en +# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these class will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO +USE_WINDOWS_ENCODING = NO # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in @@ -87,12 +67,30 @@ BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. @@ -100,87 +98,173 @@ ALWAYS_DETAILED_SEC = NO FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user defined part of the path. Stripping is +# can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. It is allowed to use relative paths in the argument list. STRIP_FROM_PATH = @top_srcdir@/ -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. -INTERNAL_DOCS = YES +SHORT_NAMES = NO -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a class diagram (in Html and LaTeX) for classes with base or -# super classes. Setting the tag to NO turns the diagrams off. +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. -CLASS_DIAGRAMS = YES +JAVADOC_AUTOBRIEF = YES -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. -SOURCE_BROWSER = YES +MULTILINE_CPP_IS_BRIEF = NO -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. -INLINE_SOURCES = NO +DETAILS_AT_TOP = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. -STRIP_CODE_COMMENTS = YES +INHERIT_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = YES # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower case letters. If set to YES upper case letters are also +# file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows -# users are adviced to set this option to NO. +# users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -#SHORT_NAMES = NO - # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put list of the files that are included by a file in the documentation +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explict @brief command for a brief description. - -JAVADOC_AUTOBRIEF = YES - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# reimplements. - -INHERIT_DOCS = YES - # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -193,23 +277,6 @@ INLINE_INFO = YES SORT_MEMBER_DOCS = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 8 - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. @@ -228,17 +295,19 @@ GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. -ALIASES = +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consist of for it to appear in +# the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the @@ -247,13 +316,6 @@ ALIASES = MAX_INITIALIZER_LINES = 30 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. -# For instance some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = YES - # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. @@ -281,6 +343,13 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the @@ -303,157 +372,252 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = \ - @top_srcdir@/Doxyheader \ - @top_srcdir@/build.c \ - @top_srcdir@/build.h \ - @top_srcdir@/config.h \ - @top_srcdir@/debug.h \ - @top_srcdir@/macros \ - @top_srcdir@/rpmqv.c \ - @top_srcdir@/rpmpopt-@VERSION@ \ - @top_srcdir@/rpmrc \ - @top_srcdir@/rpm2cpio.c \ - @top_srcdir@/system.h \ - @top_srcdir@/build/build.c \ - @top_srcdir@/build/buildio.h \ - @top_srcdir@/build/expression.c \ - @top_srcdir@/build/files.c \ - @top_srcdir@/build/misc.c \ - @top_srcdir@/build/myftw.c \ - @top_srcdir@/build/myftw.h \ - @top_srcdir@/build/names.c \ - @top_srcdir@/build/pack.c \ - @top_srcdir@/build/parseBuildInstallClean.c \ - @top_srcdir@/build/parseChangelog.c \ - @top_srcdir@/build/parseDescription.c \ - @top_srcdir@/build/parseFiles.c \ - @top_srcdir@/build/parsePreamble.c \ - @top_srcdir@/build/parsePrep.c \ - @top_srcdir@/build/parseReqs.c \ - @top_srcdir@/build/parseScript.c \ - @top_srcdir@/build/parseSpec.c \ - @top_srcdir@/build/reqprov.c \ - @top_srcdir@/build/rpmbuild.h \ - @top_srcdir@/build/rpmspec.h \ - @top_srcdir@/build/spec.c \ - @top_srcdir@/doc/manual/builddependencies \ - @top_srcdir@/doc/manual/buildroot \ - @top_srcdir@/doc/manual/conditionalbuilds \ - @top_srcdir@/doc/manual/dependencies \ - @top_srcdir@/doc/manual/format \ - @top_srcdir@/doc/manual/hregions \ - @top_srcdir@/doc/manual/macros \ - @top_srcdir@/doc/manual/multiplebuilds \ - @top_srcdir@/doc/manual/queryformat \ - @top_srcdir@/doc/manual/signatures \ - @top_srcdir@/doc/manual/relocatable \ - @top_srcdir@/doc/manual/spec \ - @top_srcdir@/doc/manual/triggers \ - @top_srcdir@/doc/manual/tsort \ - @top_srcdir@/lib/cpio.c \ - @top_srcdir@/lib/cpio.h \ - @top_srcdir@/lib/depends.c \ - @top_srcdir@/lib/depends.h \ - @top_srcdir@/lib/formats.c \ - @top_srcdir@/lib/fs.c \ - @top_srcdir@/lib/fsm.c \ - @top_srcdir@/lib/fsm.h \ - @top_srcdir@/lib/hdrinline.h \ - @top_srcdir@/lib/header.c \ - @top_srcdir@/lib/header.h \ - @top_srcdir@/lib/header_internal.c \ - @top_srcdir@/lib/header_internal.h \ - @top_srcdir@/lib/manifest.c \ - @top_srcdir@/lib/manifest.h \ - @top_srcdir@/lib/misc.c \ - @top_srcdir@/lib/misc.h \ - @top_srcdir@/lib/package.c \ - @top_srcdir@/lib/poptBT.c \ - @top_srcdir@/lib/poptI.c \ - @top_srcdir@/lib/poptK.c \ - @top_srcdir@/lib/poptQV.c \ - @top_srcdir@/lib/problems.c \ - @top_srcdir@/lib/psm.c \ - @top_srcdir@/lib/psm.h \ - @top_srcdir@/lib/query.c \ - @top_srcdir@/lib/rpmchecksig.c \ - @top_srcdir@/lib/rpmcli.h \ - @top_srcdir@/lib/rpminstall.c \ - @top_srcdir@/lib/rpmlead.c \ - @top_srcdir@/lib/rpmlead.h \ - @top_srcdir@/lib/rpmlib.h \ - @top_srcdir@/lib/rpmlibprov.c \ - @top_srcdir@/lib/rpmrc.c \ - @top_srcdir@/lib/rpmvercmp.c \ - @top_srcdir@/lib/signature.c \ - @top_srcdir@/lib/signature.h \ - @top_srcdir@/lib/stringbuf.c \ - @top_srcdir@/lib/stringbuf.h \ - @top_srcdir@/lib/tagName.c \ - @top_srcdir@/lib/tagtable.c \ - @top_srcdir@/lib/transaction.c \ - @top_srcdir@/lib/verify.c \ - @top_srcdir@/rpmdb/db1.c \ - @top_srcdir@/rpmdb/db3.c \ - @top_srcdir@/rpmdb/dbconfig.c \ - @top_srcdir@/rpmdb/falloc.c \ - @top_srcdir@/rpmdb/falloc.h \ - @top_srcdir@/rpmdb/fprint.c \ - @top_srcdir@/rpmdb/fprint.h \ - @top_srcdir@/rpmdb/poptDB.c \ - @top_srcdir@/rpmdb/rpmhash.c \ - @top_srcdir@/rpmdb/rpmhash.h \ - @top_srcdir@/rpmdb/rpmdb.c \ - @top_srcdir@/rpmdb/rpmdb.h \ - @top_srcdir@/rpmio/digest.c \ - @top_srcdir@/rpmio/macro.c \ - @top_srcdir@/rpmio/rpmlog.c \ - @top_srcdir@/rpmio/rpmerr.h \ - @top_srcdir@/rpmio/rpmio.c \ - @top_srcdir@/rpmio/rpmio.h \ - @top_srcdir@/rpmio/rpmio_internal.h \ - @top_srcdir@/rpmio/rpmmacro.h \ - @top_srcdir@/rpmio/rpmmalloc.c \ - @top_srcdir@/rpmio/rpmmessages.h \ - @top_srcdir@/rpmio/rpmpgp.c \ - @top_srcdir@/rpmio/rpmpgp.h \ - @top_srcdir@/rpmio/rpmrpc.c \ - @top_srcdir@/rpmio/rpmurl.h \ - @top_srcdir@/rpmio/strcasecmp.c \ - @top_srcdir@/rpmio/stubs.c \ - @top_srcdir@/rpmio/ugid.c \ - @top_srcdir@/rpmio/ugid.h \ - @top_srcdir@/rpmio/url.c \ - @top_srcdir@/popt/findme.c \ - @top_srcdir@/popt/findme.h \ - @top_srcdir@/popt/popt.c \ - @top_srcdir@/popt/popt.h \ - @top_srcdir@/popt/poptconfig.c \ - @top_srcdir@/popt/popthelp.c \ - @top_srcdir@/popt/poptint.h \ - @top_srcdir@/popt/poptparse.c \ - @top_srcdir@/python/hash.c \ - @top_srcdir@/python/hash.h \ - @top_srcdir@/python/rpmmodule.c \ - @top_srcdir@/python/upgrade.c \ - @top_srcdir@/python/upgrade.h \ - @top_srcdir@/tools/dump.c \ - @top_srcdir@/tools/dumpdb.c \ - @top_srcdir@/tools/javadeps.c \ - @top_srcdir@/tools/rpmarchive.c \ - @top_srcdir@/tools/rpmchecksig.c \ - @top_srcdir@/tools/rpmheader.c \ - @top_srcdir@/tools/rpminject.c \ - @top_srcdir@/tools/rpmlead.c \ - @top_srcdir@/tools/rpmsignature.c +INPUT = @top_srcdir@/Doxyheader \ + @top_srcdir@/build.c \ + @top_srcdir@/build.h \ + @top_srcdir@/config.h \ + @top_srcdir@/debug.h \ + @top_srcdir@/macros \ + @top_srcdir@/rpmqv.c \ + @top_srcdir@/rpmpopt-@VERSION@ \ + @top_srcdir@/rpmrc \ + @top_srcdir@/rpm2cpio.c \ + @top_srcdir@/system.h \ + @top_srcdir@/build/build.c \ + @top_srcdir@/build/buildio.h \ + @top_srcdir@/build/expression.c \ + @top_srcdir@/build/files.c \ + @top_srcdir@/build/misc.c \ + @top_srcdir@/build/names.c \ + @top_srcdir@/build/pack.c \ + @top_srcdir@/build/parseBuildInstallClean.c \ + @top_srcdir@/build/parseChangelog.c \ + @top_srcdir@/build/parseDescription.c \ + @top_srcdir@/build/parseFiles.c \ + @top_srcdir@/build/parsePreamble.c \ + @top_srcdir@/build/parsePrep.c \ + @top_srcdir@/build/parseReqs.c \ + @top_srcdir@/build/parseScript.c \ + @top_srcdir@/build/parseSpec.c \ + @top_srcdir@/build/poptBT.c \ + @top_srcdir@/build/reqprov.c \ + @top_srcdir@/build/rpmbuild.h \ + @top_srcdir@/build/rpmfc.c \ + @top_srcdir@/build/rpmfc.h \ + @top_srcdir@/build/rpmspec.h \ + @top_srcdir@/build/spec.c \ + @top_srcdir@/doc/manual/builddependencies \ + @top_srcdir@/doc/manual/buildroot \ + @top_srcdir@/doc/manual/conditionalbuilds \ + @top_srcdir@/doc/manual/dependencies \ + @top_srcdir@/doc/manual/format \ + @top_srcdir@/doc/manual/hregions \ + @top_srcdir@/doc/manual/macros \ + @top_srcdir@/doc/manual/multiplebuilds \ + @top_srcdir@/doc/manual/queryformat \ + @top_srcdir@/doc/manual/signatures \ + @top_srcdir@/doc/manual/relocatable \ + @top_srcdir@/doc/manual/spec \ + @top_srcdir@/doc/manual/triggers \ + @top_srcdir@/doc/manual/tsort \ + @top_srcdir@/file/src/apprentice.c \ + @top_srcdir@/file/src/ascmagic.c \ + @top_srcdir@/file/src/compress.c \ + @top_srcdir@/file/src/file.c \ + @top_srcdir@/file/src/file.h \ + @top_srcdir@/file/src/fsmagic.c \ + @top_srcdir@/file/src/names.h \ + @top_srcdir@/file/src/print.c \ + @top_srcdir@/file/src/readelf.c \ + @top_srcdir@/file/src/readelf.h \ + @top_srcdir@/file/src/softmagic.c \ + @top_srcdir@/file/src/tar.h \ + @top_srcdir@/lib/cpio.c \ + @top_srcdir@/lib/cpio.h \ + @top_srcdir@/lib/depends.c \ + @top_srcdir@/lib/formats.c \ + @top_srcdir@/lib/fs.c \ + @top_srcdir@/lib/fsm.c \ + @top_srcdir@/lib/fsm.h \ + @top_srcdir@/lib/manifest.c \ + @top_srcdir@/lib/manifest.h \ + @top_srcdir@/lib/misc.c \ + @top_srcdir@/lib/misc.h \ + @top_srcdir@/lib/package.c \ + @top_srcdir@/lib/poptALL.c \ + @top_srcdir@/lib/poptI.c \ + @top_srcdir@/lib/poptQV.c \ + @top_srcdir@/lib/psm.c \ + @top_srcdir@/lib/psm.h \ + @top_srcdir@/lib/query.c \ + @top_srcdir@/lib/rpmal.c \ + @top_srcdir@/lib/rpmal.h \ + @top_srcdir@/lib/rpmchecksig.c \ + @top_srcdir@/lib/rpmcli.h \ + @top_srcdir@/lib/rpmds.c \ + @top_srcdir@/lib/rpmds.h \ + @top_srcdir@/lib/rpmfi.c \ + @top_srcdir@/lib/rpmfi.h \ + @top_srcdir@/lib/rpmgi.c \ + @top_srcdir@/lib/rpmgi.h \ + @top_srcdir@/lib/rpminstall.c \ + @top_srcdir@/lib/rpmlead.c \ + @top_srcdir@/lib/rpmlead.h \ + @top_srcdir@/lib/rpmlib.h \ + @top_srcdir@/lib/rpmlibprov.c \ + @top_srcdir@/lib/rpmps.c \ + @top_srcdir@/lib/rpmps.h \ + @top_srcdir@/lib/rpmrc.c \ + @top_srcdir@/lib/rpmsx.c \ + @top_srcdir@/lib/rpmsx.h \ + @top_srcdir@/lib/rpmte.c \ + @top_srcdir@/lib/rpmte.h \ + @top_srcdir@/lib/rpmts.c \ + @top_srcdir@/lib/rpmts.h \ + @top_srcdir@/lib/rpmvercmp.c \ + @top_srcdir@/lib/signature.c \ + @top_srcdir@/lib/signature.h \ + @top_srcdir@/lib/stringbuf.c \ + @top_srcdir@/lib/stringbuf.h \ + @top_srcdir@/lib/transaction.c \ + @top_srcdir@/lib/verify.c \ + @top_srcdir@/lua/lapi.c \ + @top_srcdir@/lua/lapi.h \ + @top_srcdir@/lua/lcode.c \ + @top_srcdir@/lua/lcode.h \ + @top_srcdir@/lua/ldebug.c \ + @top_srcdir@/lua/ldebug.h \ + @top_srcdir@/lua/ldo.c \ + @top_srcdir@/lua/ldo.h \ + @top_srcdir@/lua/ldump.c \ + @top_srcdir@/lua/lfunc.c \ + @top_srcdir@/lua/lfunc.h \ + @top_srcdir@/lua/lgc.c \ + @top_srcdir@/lua/lgc.h \ + @top_srcdir@/lua/llex.c \ + @top_srcdir@/lua/llex.h \ + @top_srcdir@/lua/llimits.h \ + @top_srcdir@/lua/lmem.c \ + @top_srcdir@/lua/lmem.h \ + @top_srcdir@/lua/lobject.c \ + @top_srcdir@/lua/lobject.h \ + @top_srcdir@/lua/lopcodes.c \ + @top_srcdir@/lua/lopcodes.h \ + @top_srcdir@/lua/lparser.c \ + @top_srcdir@/lua/lparser.h \ + @top_srcdir@/lua/lstate.c \ + @top_srcdir@/lua/lstate.h \ + @top_srcdir@/lua/lstring.c \ + @top_srcdir@/lua/lstring.h \ + @top_srcdir@/lua/ltable.c \ + @top_srcdir@/lua/ltable.h \ + @top_srcdir@/lua/ltests.c \ + @top_srcdir@/lua/ltm.c \ + @top_srcdir@/lua/ltm.h \ + @top_srcdir@/lua/lundump.c \ + @top_srcdir@/lua/lundump.h \ + @top_srcdir@/lua/lvm.c \ + @top_srcdir@/lua/lvm.h \ + @top_srcdir@/lua/lzio.c \ + @top_srcdir@/lua/lzio.h \ + @top_srcdir@/rpmdb/db3.c \ + @top_srcdir@/rpmdb/dbconfig.c \ + @top_srcdir@/rpmdb/fprint.c \ + @top_srcdir@/rpmdb/fprint.h \ + @top_srcdir@/rpmdb/hdrNVR.c \ + @top_srcdir@/rpmdb/hdrinline.h \ + @top_srcdir@/rpmdb/header.c \ + @top_srcdir@/rpmdb/header.h \ + @top_srcdir@/rpmdb/header_internal.c \ + @top_srcdir@/rpmdb/header_internal.h \ + @top_srcdir@/rpmdb/legacy.c \ + @top_srcdir@/rpmdb/legacy.h \ + @top_srcdir@/rpmdb/merge.c \ + @top_srcdir@/rpmdb/poptDB.c \ + @top_srcdir@/rpmdb/rpmhash.c \ + @top_srcdir@/rpmdb/rpmhash.h \ + @top_srcdir@/rpmdb/rpmdb.c \ + @top_srcdir@/rpmdb/rpmdb.h \ + @top_srcdir@/rpmdb/tagname.c \ + @top_srcdir@/rpmdb/tagtbl.c \ + @top_srcdir@/rpmio/argv.c \ + @top_srcdir@/rpmio/argv.h \ + @top_srcdir@/rpmio/digest.c \ + @top_srcdir@/rpmio/fts.c \ + @top_srcdir@/rpmio/fts.h \ + @top_srcdir@/rpmio/macro.c \ + @top_srcdir@/rpmio/rpmlog.c \ + @top_srcdir@/rpmio/rpmlog.h \ + @top_srcdir@/rpmio/rpmerr.h \ + @top_srcdir@/rpmio/rpmio.c \ + @top_srcdir@/rpmio/rpmio.h \ + @top_srcdir@/rpmio/rpmio_internal.h \ + @top_srcdir@/rpmio/rpmmacro.h \ + @top_srcdir@/rpmio/rpmmalloc.c \ + @top_srcdir@/rpmio/rpmmessages.h \ + @top_srcdir@/rpmio/rpmpgp.c \ + @top_srcdir@/rpmio/rpmpgp.h \ + @top_srcdir@/rpmio/rpmrpc.c \ + @top_srcdir@/rpmio/rpmsq.c \ + @top_srcdir@/rpmio/rpmsq.h \ + @top_srcdir@/rpmio/rpmsw.c \ + @top_srcdir@/rpmio/rpmsw.h \ + @top_srcdir@/rpmio/rpmurl.h \ + @top_srcdir@/rpmio/strcasecmp.c \ + @top_srcdir@/rpmio/stubs.c \ + @top_srcdir@/rpmio/ugid.c \ + @top_srcdir@/rpmio/ugid.h \ + @top_srcdir@/rpmio/url.c \ + @top_srcdir@/popt/findme.c \ + @top_srcdir@/popt/findme.h \ + @top_srcdir@/popt/popt.c \ + @top_srcdir@/popt/popt.h \ + @top_srcdir@/popt/poptconfig.c \ + @top_srcdir@/popt/popthelp.c \ + @top_srcdir@/popt/poptint.h \ + @top_srcdir@/popt/poptparse.c \ + @top_srcdir@/python/header-py.c \ + @top_srcdir@/python/header-py.h \ + @top_srcdir@/python/rpmal-py.c \ + @top_srcdir@/python/rpmal-py.h \ + @top_srcdir@/python/rpmdb-py.c \ + @top_srcdir@/python/rpmdb-py.h \ + @top_srcdir@/python/rpmds-py.c \ + @top_srcdir@/python/rpmds-py.h \ + @top_srcdir@/python/rpmfd-py.c \ + @top_srcdir@/python/rpmfd-py.h \ + @top_srcdir@/python/rpmfi-py.c \ + @top_srcdir@/python/rpmfi-py.h \ + @top_srcdir@/python/rpmfts-py.c \ + @top_srcdir@/python/rpmfts-py.h \ + @top_srcdir@/python/rpmmi-py.c \ + @top_srcdir@/python/rpmmi-py.h \ + @top_srcdir@/python/rpmmodule.c \ + @top_srcdir@/python/rpmrc-py.c \ + @top_srcdir@/python/rpmrc-py.h \ + @top_srcdir@/python/rpmte-py.c \ + @top_srcdir@/python/rpmte-py.h \ + @top_srcdir@/python/rpmts-py.c \ + @top_srcdir@/python/rpmts-py.h \ + @top_srcdir@/tools/dumpdb.c \ + @top_srcdir@/tools/javadeps.c \ + @top_srcdir@/tools/rpmcache.c \ + @top_srcdir@/tools/rpmdeps.c \ + @top_srcdir@/tools/rpmgraph.c \ + @top_srcdir@/tools/rpminject.c \ + @top_srcdir@/tools/rpmtool.c \ + @top_srcdir@/tools/rpmxml.c \ + @top_srcdir@/tools/rpmxp.c # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc -FILE_PATTERNS = *.c *.h +FILE_PATTERNS = *.c \ + *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -467,6 +631,11 @@ RECURSIVE = NO EXCLUDE = +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + +EXCLUDE_SYMLINKS = NO + # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. @@ -486,6 +655,13 @@ EXAMPLE_PATH = @top_srcdir@/doc/manual EXAMPLE_PATTERNS = +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). @@ -503,11 +679,51 @@ INPUT_FILTER = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source -# files to browse. +# files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -545,6 +761,12 @@ GENERATE_HTML = YES HTML_OUTPUT = html +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. @@ -557,10 +779,12 @@ HTML_HEADER = HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user defined cascading +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = @@ -577,6 +801,20 @@ HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). @@ -589,8 +827,8 @@ GENERATE_CHI = NO BINARY_TOC = NO -# The TOC_EXPAND flag can be set YES to add extra items for group members -# to the contents of the Html help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO @@ -608,8 +846,9 @@ ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be # generated containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports -# JavaScript and frames is required (for instance Netscape 4.0+ -# or Internet explorer 4.0+). +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. GENERATE_TREEVIEW = NO @@ -634,6 +873,17 @@ GENERATE_LATEX = NO LATEX_OUTPUT = latex +# 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. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. @@ -678,12 +928,18 @@ USE_PDFLATEX = NO LATEX_BATCHMODE = NO +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimised for Word 97 and may not look very pretty with +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO @@ -703,14 +959,14 @@ COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using a WORD or other. +# This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assigments. You only have to provide +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = @@ -718,7 +974,7 @@ RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -#+RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output @@ -727,7 +983,7 @@ RTF_STYLESHEET_FILE = # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages -GENERATE_MAN = YES +GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -740,6 +996,94 @@ MAN_OUTPUT = man MAN_EXTENSION = .3 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- @@ -789,20 +1133,41 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the +# parser if not removed. + +SKIP_FUNCTION_MACROS = YES + #--------------------------------------------------------------------------- # Configuration::addtions related to external references #--------------------------------------------------------------------------- -# The TAGFILES tag can be used to specify one or more tagfiles. - -TAGFILES = +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. @@ -815,6 +1180,12 @@ GENERATE_TAGFILE = Doxytags ALLEXTERNALS = NO +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). @@ -824,6 +1195,20 @@ PERL_PATH = /usr/bin/perl # Configuration options related to the dot tool #--------------------------------------------------------------------------- +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section @@ -845,29 +1230,61 @@ CLASS_GRAPH = YES COLLABORATION_GRAPH = YES -# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to -# YES then doxygen will generate a graph for each documented file showing -# the direct and indirect include dependencies of the file with other -# documented files. +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to -# YES then doxygen will generate a graph for each documented header file showing -# the documented files that directly or indirectly include this file +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. INCLUDED_BY_GRAPH = YES +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found on the path. DOT_PATH = +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width # (in pixels) of the graphs generated by dot. If a graph becomes larger than # this value, doxygen will try to truncate the graph, so that it fits within @@ -884,6 +1301,17 @@ MAX_DOT_GRAPH_WIDTH = 1024 MAX_DOT_GRAPH_HEIGHT = 1024 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# If 0 is used for the depth value (the default), the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. @@ -891,7 +1319,7 @@ MAX_DOT_GRAPH_HEIGHT = 1024 GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermedate dot files that are used to generate +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES @@ -904,38 +1332,3 @@ DOT_CLEANUP = YES # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO - -# The CGI_NAME tag should be the name of the CGI script that -# starts the search engine (doxysearch) with the correct parameters. -# A script with this name will be generated by doxygen. - -CGI_NAME = search.cgi - -# The CGI_URL tag should be the absolute URL to the directory where the -# cgi binaries are located. See the documentation of your http daemon for -# details. - -CGI_URL = - -# The DOC_URL tag should be the absolute URL to the directory where the -# documentation is located. If left blank the absolute path to the -# documentation, with file:// prepended to it, will be used. - -DOC_URL = - -# The DOC_ABSPATH tag should be the absolute path to the directory where the -# documentation is located. If left blank the directory on the local machine -# will be used. - -DOC_ABSPATH = - -# The BIN_ABSPATH tag must point to the directory where the doxysearch binary -# is installed. - -BIN_ABSPATH = /usr/local/bin/ - -# The EXT_DOC_PATHS tag can be used to specify one or more paths to -# documentation generated for other projects. This allows doxysearch to search -# the documentation for these projects as well. - -EXT_DOC_PATHS =