From 2517ba3303489ed35512cdaf2493ec81efd145e7 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Thu, 22 Sep 2011 16:29:03 -0500 Subject: Update Doxyfile and fix some documentation errors caught by Doxygen A few parameters were outdated or wrongly named, and a few things were explicitly linked that Doxygen wasn't able to resolve. Signed-off-by: Dan McGee --- doc/Doxyfile | 143 ++++++++++++++++++++++++++++++++---------------- lib/libalpm/alpm.c | 2 +- lib/libalpm/alpm.h | 13 +++-- lib/libalpm/alpm_list.c | 1 - lib/libalpm/deps.c | 1 + lib/libalpm/signing.c | 4 +- lib/libalpm/sync.c | 2 +- 7 files changed, 109 insertions(+), 57 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index f287bbcd..6423a35a 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1,11 +1,13 @@ -# Doxyfile 1.5.5 +# Doxyfile 1.7.5.1 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = libalpm -PROJECT_NUMBER = +PROJECT_NUMBER = +PROJECT_BRIEF = "Arch Linux Package Manager Library" +PROJECT_LOGO = OUTPUT_DIRECTORY = ./ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English @@ -25,27 +27,31 @@ ABBREVIATE_BRIEF = "The $name class" \ ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 -ALIASES = +ALIASES = OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -63,20 +69,27 @@ INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES +FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = +ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES SHOW_DIRECTORIES = NO -FILE_VERSION_FILTER = +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -86,25 +99,26 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = ../lib/libalpm/ INPUT_ENCODING = UTF-8 -FILE_PATTERNS = +FILE_PATTERNS = RECURSIVE = NO -EXCLUDE = +EXCLUDE = EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = EXAMPLE_PATTERNS = * EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- @@ -121,31 +135,58 @@ VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = NO COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = NO HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = YES HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO +HTML_DYNAMIC_SECTIONS = NO GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_BUNDLE_ID = org.doxygen.Project -HTML_DYNAMIC_SECTIONS = NO -CHM_FILE = -HHC_LOCATION = +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = GENERATE_CHI = NO +CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.doxygen.Project DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = NO +USE_INLINE_TREES = NO TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +USE_MATHJAX = NO +MATHJAX_RELPATH = http://www.mathjax.org/mathjax +MATHJAX_EXTENSIONS = +SEARCHENGINE = NO +SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -154,13 +195,16 @@ LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = +PAPER_TYPE = letter +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = PDF_HYPERLINKS = NO USE_PDFLATEX = NO LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO +LATEX_BIB_STYLE = plain #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -168,8 +212,8 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- @@ -182,8 +226,8 @@ MAN_LINKS = NO #--------------------------------------------------------------------------- GENERATE_XML = NO XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = +XML_SCHEMA = +XML_DTD = XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output @@ -195,9 +239,9 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO PERLMOD_LATEX = NO PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES @@ -207,24 +251,31 @@ INCLUDE_PATH = ../.. INCLUDE_FILE_PATTERNS = *.h PREDEFINED = HAVE_CONFIG_H= \ SYMHIDDEN= \ - SYMEXPORT= -EXPAND_AS_DEFINED = + SYMEXPORT= \ + HAVE_LIBARCHIVE \ + HAVE_LIBCURL \ + HAVE_LIBGPGME +EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = +TAGFILES = +GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = NO -MSCGEN_PATH = +MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES +DOT_NUM_THREADS = 0 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES @@ -237,15 +288,13 @@ CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 3 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- -SEARCHENGINE = NO diff --git a/lib/libalpm/alpm.c b/lib/libalpm/alpm.c index f9dd8d38..772c84d9 100644 --- a/lib/libalpm/alpm.c +++ b/lib/libalpm/alpm.c @@ -96,7 +96,7 @@ cleanup: /** Release the library. This should be the last alpm call you make. * After this returns, handle should be considered invalid and cannot be reused * in any way. - * @param handle the context handle + * @param myhandle the context handle * @return 0 on success, -1 on error */ int SYMEXPORT alpm_release(alpm_handle_t *myhandle) diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index 75e3c4a9..a93d4e3e 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -226,15 +226,18 @@ typedef struct _alpm_pgpkey_t { time_t expires; } alpm_pgpkey_t; -/** Signature result. Contains the number of signatures found and pointers to - * arrays containing key and status info. All contained arrays have size - * #count.*/ +/** Signature result. Contains the key, status, and validity of a given + * signature. + */ typedef struct _alpm_sigresult_t { alpm_pgpkey_t key; alpm_sigstatus_t status; alpm_sigvalidity_t validity; } alpm_sigresult_t; +/** Signature list. Contains the number of signatures found and a pointer to an + * array of results. The array is of size count. + */ typedef struct _alpm_siglist_t { size_t count; alpm_sigresult_t *results; @@ -678,7 +681,7 @@ int alpm_db_set_pkgreason(alpm_handle_t *handle, alpm_pkg_t *pkg, * @return 0 on success, -1 on error (pm_errno is set accordingly) */ int alpm_pkg_load(alpm_handle_t *handle, const char *filename, int full, - alpm_siglevel_t, alpm_pkg_t **pkg); + alpm_siglevel_t level, alpm_pkg_t **pkg); /** Free a package. * @param pkg package pointer to free @@ -731,7 +734,7 @@ const char *alpm_pkg_get_name(alpm_pkg_t *pkg); const char *alpm_pkg_get_version(alpm_pkg_t *pkg); /** Returns the origin of the package. - * @return a #alpm_pkgfrom_t constant, -1 on error + * @return an alpm_pkgfrom_t constant, -1 on error */ alpm_pkgfrom_t alpm_pkg_get_origin(alpm_pkg_t *pkg); diff --git a/lib/libalpm/alpm_list.c b/lib/libalpm/alpm_list.c index 0ab9356c..274d3afd 100644 --- a/lib/libalpm/alpm_list.c +++ b/lib/libalpm/alpm_list.c @@ -548,7 +548,6 @@ inline alpm_list_t SYMEXPORT *alpm_list_next(const alpm_list_t *node) * @brief Get the previous element of a list. * * @param list the list head - * @param node the list node * * @return the previous element, or NULL when no previous element exist */ diff --git a/lib/libalpm/deps.c b/lib/libalpm/deps.c index 08494a6c..c99701e9 100644 --- a/lib/libalpm/deps.c +++ b/lib/libalpm/deps.c @@ -693,6 +693,7 @@ alpm_pkg_t SYMEXPORT *alpm_find_dbs_satisfier(alpm_handle_t *handle, * @param handle the context handle * @param localpkgs is the list of local packages * @param pkg is the package to resolve + * @param preferred packages to prefer when resolving * @param packages is a pointer to a list of packages which will be * searched first for any dependency packages needed to complete the * resolve, and to which will be added any [pkg] and all of its diff --git a/lib/libalpm/signing.c b/lib/libalpm/signing.c index 92095655..203460cc 100644 --- a/lib/libalpm/signing.c +++ b/lib/libalpm/signing.c @@ -358,7 +358,7 @@ error: * The return value will be 0 if nothing abnormal happened during the signature * check, and -1 if an error occurred while checking signatures or if a * signature could not be found; pm_errno will be set. Note that "abnormal" - * does not include a failed signature; the value in #siglist should be checked + * does not include a failed signature; the value in siglist should be checked * to determine if the signature(s) are good. * @param handle the context handle * @param path the full path to a file @@ -841,7 +841,7 @@ int SYMEXPORT alpm_db_check_pgp_signature(alpm_db_t *db, /** * Clean up and free a signature result list. - * Note that this does not free the #alpm_siglist_t object itself in case that + * Note that this does not free the siglist object itself in case that * was allocated on the stack; this is the responsibility of the caller. * @param siglist a pointer to storage for signature results * @return 0 on success, -1 on error diff --git a/lib/libalpm/sync.c b/lib/libalpm/sync.c index abd7cdb8..b6b84301 100644 --- a/lib/libalpm/sync.c +++ b/lib/libalpm/sync.c @@ -240,7 +240,7 @@ int SYMEXPORT alpm_sync_sysupgrade(alpm_handle_t *handle, int enable_downgrade) * If a member exists in several databases, only the first database is used. * IgnorePkg is also handled. * @param dbs the list of alpm_db_t * - * @pram name the name of the group + * @param name the name of the group * @return the list of alpm_pkg_t * (caller is responsible for alpm_list_free) */ alpm_list_t SYMEXPORT *alpm_find_group_pkgs(alpm_list_t *dbs, -- cgit v1.2.3-70-g09d2