Update API docs.

doc/xbps_api_doxyfile.in

@@ -1,4 +1,4 @@
-# Doxyfile 1.7.5
+# Doxyfile 1.8.2
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -136,7 +136,9 @@ FULL_PATH_NAMES        = NO
 # only done if one of the specified strings matches the left-hand part of
 # the path. The tag can be used to show relative paths in the file list.
 # If left blank the directory from which doxygen is run is used as the
-# path to strip.
+# path to strip. Note that you specify absolute paths here, but also
+# relative paths, which will be relative from the directory where doxygen is
+# started.
 
 STRIP_FROM_PATH        =
 
@@ -205,6 +207,13 @@ TAB_SIZE               = 8
 
 ALIASES                =
 
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding
+# "class=itcl::class" will allow you to use the command class in the
+# itcl::class meaning.
+
+TCL_SUBST              =
+
 # 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
@@ -232,17 +241,34 @@ OPTIMIZE_FOR_FORTRAN   = NO
 OPTIMIZE_OUTPUT_VHDL   = NO
 
 # Doxygen selects the parser to use depending on the extension of the files it
-# parses. With this tag you can assign which parser to use for a given extension.
+# parses. With this tag you can assign which parser to use for a given
-# Doxygen has a built-in mapping, but you can override or extend it using this
+# extension. Doxygen has a built-in mapping, but you can override or extend it
-# tag. The format is ext=language, where ext is a file extension, and language
+# using this tag. The format is ext=language, where ext is a file extension,
-# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
+# and language is one of the parsers supported by doxygen: IDL, Java,
-# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
+# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
-# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
+# C++. For instance to make doxygen treat .inc files as Fortran files (default
-# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
+# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
-# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+# that for custom extensions you also need to set FILE_PATTERNS otherwise the
+# files are not read by doxygen.
 
 EXTENSION_MAPPING      =
 
+# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you
+# can mix doxygen, HTML, and XML commands with Markdown formatting.
+# Disable only in case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT       = YES
+
+# When enabled doxygen tries to link words that correspond to documented classes,
+# or namespaces to their corresponding documentation. Such a link can be
+# prevented in individual cases by by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+
+AUTOLINK_SUPPORT       = YES
+
 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
 # to include (a tag file for) the STL sources as input, then you should
 # set this tag to YES in order to let doxygen match functions declarations and
@@ -263,12 +289,7 @@ CPP_CLI_SUPPORT        = NO
 
 SIP_SUPPORT            = NO
 
-# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO.
-# and setter methods for a property. Setting this option to YES (the default)
-# will make doxygen replace the get and set methods by a property in the
-# documentation. This will only work if the methods are indeed getting or
-# setting a simple type. If this is not the case, or you want to show the
-# methods anyway, you should set this option to NO.
 
 IDL_PROPERTY_SUPPORT   = YES
 
@@ -325,10 +346,21 @@ TYPEDEF_HIDES_STRUCT   = YES
 # a logarithmic scale so increasing the size by one will roughly double the
 # memory usage. The cache size is given by this formula:
 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols
+# corresponding to a cache size of 2^16 = 65536 symbols.
 
 SYMBOL_CACHE_SIZE      = 0
 
+# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
+# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
+# their name and scope. Since this can be an expensive process and often the
+# same symbol appear multiple times in the code, doxygen keeps a cache of
+# pre-resolved symbols. If the cache is too small doxygen will become slower.
+# If the cache is too large, memory is wasted. The cache size is given by this
+# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+LOOKUP_CACHE_SIZE      = 0
+
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
@@ -345,6 +377,11 @@ EXTRACT_ALL            = NO
 
 EXTRACT_PRIVATE        = NO
 
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+
+EXTRACT_PACKAGE        = NO
+
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 # will be included in the documentation.
 
@@ -532,12 +569,6 @@ MAX_INITIALIZER_LINES  = 30
 
 SHOW_USED_FILES        = NO
 
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
-# in the documentation. The default is NO.
-
-SHOW_DIRECTORIES       = NO
-
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 # This will remove the Files entry from the Quick Index and from the
 # Folder Tree View (if specified). The default is YES.
@@ -563,7 +594,7 @@ FILE_VERSION_FILTER    =
 
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
 # by doxygen. The layout file controls the global structure of the generated
-# output files in an output format independent way. The create the layout file
+# output files in an output format independent way. To create the layout file
 # that represents doxygen's defaults, run doxygen with the -l option.
 # You can optionally specify a file name after the option, if omitted
 # DoxygenLayout.xml will be used as the name of the layout file.
@@ -575,7 +606,8 @@ LAYOUT_FILE            =
 # .bib extension is automatically appended if omitted. Using this command
 # requires the bibtex tool to be installed. See also
 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
-# of the bibliography can be controlled using LATEX_BIB_STYLE.
+# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
+# feature you need bibtex and perl available in the search path.
 
 CITE_BIB_FILES         =
 
@@ -666,10 +698,11 @@ FILE_PATTERNS          = *.c \
 
 RECURSIVE              = YES
 
-# The EXCLUDE tag can be used to specify files and/or directories that should
+# The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
-# Note that relative paths are relative to directory from which doxygen is run.
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
 
 EXCLUDE                = ../.git \
                          ../bin \
@@ -678,7 +711,7 @@ EXCLUDE                = ../.git \
                          ../include/fetch.h \
                          ../lib/portableproplib
 
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
 # from the input.
 
@@ -782,7 +815,7 @@ 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.
+# fragments. Normal C, C++ and Fortran comments will always remain visible.
 
 STRIP_CODE_COMMENTS    = NO
 
@@ -869,7 +902,7 @@ HTML_FILE_EXTENSION    = .html
 # standard header. Note that when using a custom header you are responsible
 #  for the proper inclusion of any scripts and style sheets that doxygen
 # needs, which is dependent on the configuration options used.
-# It is adviced to generate a default header using "doxygen -w html
+# It is advised to generate a default header using "doxygen -w html
 # header.html footer.html stylesheet.css YourConfigFile" and then modify
 # that header. Note that the header is subject to change so you typically
 # have to redo this when upgrading to a newer version of doxygen or when
@@ -885,13 +918,23 @@ HTML_FOOTER            =
 
 # 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
+# fine-tune the look of the HTML output. If left blank doxygen will
-# will generate a default style sheet. Note that doxygen will try to copy
+# generate a default style sheet. Note that it is recommended to use
-# the style sheet file to the HTML output directory, so don't put your own
+# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
-# stylesheet in the HTML output directory as well, or it will be erased!
+# tag will in the future become obsolete.
 
 HTML_STYLESHEET        =
 
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
+# user-defined cascading style sheet that is included after the standard
+# style sheets created by doxygen. Using this option one can overrule
+# certain style aspects. This is preferred over using HTML_STYLESHEET
+# since it does not replace the standard style sheet and is therefor more
+# robust against future updates. Doxygen will copy the style sheet file to
+# the output directory.
+
+HTML_EXTRA_STYLESHEET  =
+
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
 # that these files will be copied to the base HTML output directory. Use the
@@ -902,7 +945,7 @@ HTML_STYLESHEET        =
 HTML_EXTRA_FILES       =
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
-# Doxygen will adjust the colors in the stylesheet and background images
+# Doxygen will adjust the colors in the style sheet and background images
 # according to this color. Hue is specified as an angle on a colorwheel,
 # see http://en.wikipedia.org/wiki/Hue for more information.
 # For instance the value 0 represents red, 60 is yellow, 120 is green,
@@ -932,20 +975,23 @@ HTML_COLORSTYLE_GAMMA  = 80
 
 HTML_TIMESTAMP         = YES
 
-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
-# files or namespaces will be aligned in HTML using tables. If set to
-# NO a bullet list will be used.
-
-HTML_ALIGN_MEMBERS     = NO
-
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 # documentation will contain sections that can be hidden and shown after the
-# page has loaded. For this to work a browser that supports
+# page has loaded.
-# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
-# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
 
 HTML_DYNAMIC_SECTIONS  = YES
 
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
+# entries shown in the various tree structured indices initially; the user
+# can expand and collapse entries dynamically later on. Doxygen will expand
+# the tree to such a level that at most the specified number of entries are
+# visible (unless a fully collapsed tree already exceeds this amount).
+# So setting the number of entries 1 will produce a full collapsed tree by
+# default. 0 is a special value representing an infinite number of entries
+# and will result in a full expanded tree by default.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
 # If the GENERATE_DOCSET tag is set to YES, additional index files
 # will be generated that can be used as input for Apple's Xcode 3
 # integrated development environment, introduced with OSX 10.5 (Leopard).
@@ -973,9 +1019,9 @@ DOCSET_FEEDNAME        = "Doxygen generated docs"
 
 DOCSET_BUNDLE_ID       = org.doxygen.Project
 
-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
-# the documentation publisher. This should be a reverse domain-name style
+# identify the documentation publisher. This should be a reverse domain-name
-# string, e.g. com.mycompany.MyDocSet.documentation.
+# style string, e.g. com.mycompany.MyDocSet.documentation.
 
 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 
@@ -1097,19 +1143,14 @@ GENERATE_ECLIPSEHELP   = NO
 
 ECLIPSE_DOC_ID         = org.doxygen.Project
 
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
-# top of each HTML page. The value NO (the default) enables the index and
+# at top of each HTML page. The value NO (the default) enables the index and
-# the value YES disables it.
+# the value YES disables it. Since the tabs have the same information as the
+# navigation tree you can set this option to NO if you already set
+# GENERATE_TREEVIEW to YES.
 
 DISABLE_INDEX          = NO
 
-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
-# (range [0,1..20]) that doxygen will group on one line in the generated HTML
-# documentation. Note that a value of 0 will completely suppress the enum
-# values from appearing in the overview section.
-
-ENUM_VALUES_PER_LINE   = 4
-
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information.
 # If the tag value is set to YES, a side panel will be generated
@@ -1117,13 +1158,17 @@ ENUM_VALUES_PER_LINE   = 4
 # is generated for HTML Help). For this to work a browser that supports
 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
 # Windows users are probably better off using the HTML help feature.
+# Since the tree basically has the same information as the tab index you
+# could consider to set DISABLE_INDEX to NO when enabling this option.
 
 GENERATE_TREEVIEW      = NO
 
-# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
-# and Class Hierarchy pages using a tree view instead of an ordered list.
+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
+# documentation. Note that a value of 0 will completely suppress the enum
+# values from appearing in the overview section.
 
-USE_INLINE_TREES       = NO
+ENUM_VALUES_PER_LINE   = 4
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
 # used to set the initial width (in pixels) of the frame in which the tree
@@ -1156,7 +1201,7 @@ FORMULA_TRANSPARENT    = YES
 # (see http://www.mathjax.org) which uses client side Javascript for the
 # rendering instead of using prerendered bitmaps. Use this if you do not
 # have LaTeX installed or if you want to formulas look prettier in the HTML
-# output. When enabled you also need to install MathJax separately and
+# output. When enabled you may also need to install MathJax separately and
 # configure the path to it using the MATHJAX_RELPATH option.
 
 USE_MATHJAX            = NO
@@ -1165,10 +1210,11 @@ USE_MATHJAX            = NO
 # HTML output directory using the MATHJAX_RELPATH option. The destination
 # directory should contain the MathJax.js script. For instance, if the mathjax
 # directory is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to the
+# MATHJAX_RELPATH should be ../mathjax. The default value points to
-# mathjax.org site, so you can quickly see the result without installing
+# the MathJax Content Delivery Network so you can quickly see the result without
-# MathJax, but it is strongly recommended to install a local copy of MathJax
+# installing MathJax.
-# before deployment.
+# However, it is strongly recommended to install a local
+# copy of MathJax from http://www.mathjax.org before deployment.
 
 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 
@@ -1327,7 +1373,7 @@ COMPACT_RTF            = NO
 
 RTF_HYPERLINKS         = NO
 
-# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# Load style sheet definitions from file. Syntax is similar to doxygen's
 # config file, i.e. a series of assignments. You only have to provide
 # replacements, missing definitions are set to their default value.
 
@@ -1518,22 +1564,18 @@ SKIP_FUNCTION_MACROS   = YES
 # Configuration::additions related to external references
 #---------------------------------------------------------------------------
 
-# The TAGFILES option can be used to specify one or more tagfiles.
+# The TAGFILES option can be used to specify one or more tagfiles. For each
-# Optionally an initial location of the external documentation
+# tag file the location of the external documentation should be added. The
-# can be added for each tagfile. The format of a tag file without
+# format of a tag file without this location is as follows:
-# 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
+# where "loc1" and "loc2" can be relative or absolute paths
-# URLs. If a location is present for each tag, the installdox tool
+# or URLs. Note that each tag file must have a unique name (where the name does
-# does not have to be run to correct the links.
+# NOT include the path). If a tag file is not located in the directory in which
-# Note that each tag file must have a unique name
+# doxygen is run, you must also specify the path to the tagfile here.
-# (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               =
 
@@ -1624,7 +1666,7 @@ DOT_FONTPATH           =
 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
 # will generate a graph for each documented class showing the direct and
 # indirect inheritance relations. Setting this tag to YES will force the
-# the CLASS_DIAGRAMS tag to NO.
+# CLASS_DIAGRAMS tag to NO.
 
 CLASS_GRAPH            = YES
 
@@ -1646,6 +1688,15 @@ GROUP_GRAPHS           = YES
 
 UML_LOOK               = YES
 
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# managable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+
+UML_LIMIT_NUM_FIELDS   = 10
+
 # If set to YES, the inheritance and collaboration graphs will show the
 # relations between templates and their instances.
 
@@ -1686,7 +1737,7 @@ CALLER_GRAPH           = YES
 
 GRAPHICAL_HIERARCHY    = YES
 
-# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
 # then doxygen will show the dependencies a directory has on other directories
 # in a graphical way. The dependency relations are determined by the #include
 # relations between the files in the directories.

include/xbps_api.h.in

@@ -332,12 +332,18 @@ struct xbps_state_cb_data {
 	 */
 	const char *desc;
 	/**
-	 * @var arg[0-1]
+	 * @var arg0
 	 *
-	 * State string arguments arg[0-1]. Strings set on these
+	 * State string argument 0. String set on this
-	 * variables may change depending on \a state.
+	 * variable may change depending on \a state.
 	 */
 	const char *arg0;
+	/**
+	 * @var arg1
+	 *
+	 * State string argument 1. String set on this
+	 * variable may change depending on \a state.
+	 */
 	const char *arg1;
 	/**
 	 * @var err
@@ -852,6 +858,44 @@ bool xbps_pkgdb_replace_pkg(struct xbps_handle *xhp,
  */
 int xbps_pkgdb_update(struct xbps_handle *xhp, bool flush);
 
+/**
+ * Creates a temporary file and executes it in rootdir.
+ *
+ * @param[in] xhp The pointer to the xbps_handle struct.
+ * @param[in] blob The buffer pointer where the data is stored.
+ * @param[in] blobsiz The size of the buffer data.
+ * @param[in] pkgname The package name associated.
+ * @param[in] version The package version associated.
+ * @param[in] action The action to execute on the temporary file.
+ * @param[in] update Set to true if package is being updated.
+ *
+ * @return 0 on success, or an errno value otherwise.
+ */
+int xbps_pkg_exec_buffer(struct xbps_handle *xhp,
+			 const void *blob,
+			 const size_t blobsiz,
+			 const char *pkgname,
+			 const char *version,
+			 const char *action,
+			 bool update);
+
+/**
+ * Creates a temporary file and executes it in rootdir.
+ *
+ * @param[in] xhp The pointer to the xbps_handle struct.
+ * @param[in] d Package dictionary where the script data is stored.
+ * @param[in] script Key associated with the script in dictionary.
+ * @param[in] action The action to execute on the temporary file.
+ * @param[in] update Set to true if package is being updated.
+ *
+ * @return 0 on success, or an errno value otherwise.
+ */
+int xbps_pkg_exec_script(struct xbps_handle *xhp,
+			 prop_dictionary_t d,
+			 const char *script,
+			 const char *action,
+			 bool update);
+
 /*@}*/
 
 /** @addtogroup plist */
@@ -1022,40 +1066,6 @@ bool xbps_match_string_in_array(prop_array_t array, const char *val);
 prop_object_iterator_t xbps_array_iter_from_dict(prop_dictionary_t dict,
 						 const char *key);
 
-/**
- * Creates a temporary file and executes it in rootdir.
- *
- * @param[in] xhp The pointer to the xbps_handle struct.
- * @param[in] blob The buffer pointer where the data is stored.
- * @param[in] blobsiz The size of the buffer data.
- * @param[in] pkgname The package name associated.
- * @param[in] version The package version associated.
- * @param[in] action The action to execute on the temporary file.
- * @param[in] update Set to true if package is being updated.
- */
-int xbps_pkg_exec_buffer(struct xbps_handle *xhp,
-			 const void *blob,
-			 const size_t blobsiz,
-			 const char *pkgname,
-			 const char *version,
-			 const char *action,
-			 bool update);
-
-/**
- * Creates a temporary file and executes it in rootdir.
- *
- * @param[in] xhp The pointer to the xbps_handle struct.
- * @param[in] d Package dictionary where the script data is stored.
- * @param[in] script Key associated with the script in dictionary.
- * @param[in] action The action to execute on the temporary file.
- * @param[in] update Set to true if package is being updated.
- */
-int xbps_pkg_exec_script(struct xbps_handle *xhp,
-			 prop_dictionary_t d,
-			 const char *script,
-			 const char *action,
-			 bool update);
-
 /*@}*/
 
 /** @addtogroup pkg_register */
@@ -1081,8 +1091,7 @@ int xbps_register_pkg(struct xbps_handle *xhp,
  * Unregister a package from the package database.
  *
  * @param[in] xhp The pointer to the xbps_handle struct.
- * @param[in] pkgname Package name.
+ * @param[in] pkgver Package name-version to match.
- * @param[in] version Package version.
  * @param[in] flush Set to true to make sure that pkgdb plist
  * is written to storage on success.
  *
@@ -1392,8 +1401,8 @@ prop_dictionary_t xbps_rpool_get_pkg_plist(struct xbps_handle *xhp,
  * Returns a pkg dictionary from a repository index \a ri matching
  * the expression \a pkg.
  *
- * param[in] ri Pointer to an xbps_rindex structure.
+ * @param[in] ri Pointer to an xbps_rindex structure.
- * param[in] pkg Package expression to match in this repository index.
+ * @param[in] pkg Package expression to match in this repository index.
  *
  * @return The pkg dictionary on success, NULL otherwise.
  */
@@ -1404,8 +1413,8 @@ prop_dictionary_t xbps_rindex_get_pkg(struct xbps_rindex *ri, const char *pkg);
  * the expression \a pkg. On match the first package matching the virtual
  * package expression will be returned.
  *
- * param[in] ri Pointer to an xbps_rindex structure.
+ * @param[in] ri Pointer to an xbps_rindex structure.
- * param[in] pkg Package expression to match in this repository index.
+ * @param[in] pkg Package expression to match in this repository index.
  *
  * @return The pkg dictionary on success, NULL otherwise.
  */

lib/rindex_get.c

@@ -33,8 +33,8 @@
 
 /**
  * @file lib/rindex_get.c
- * @brief Repository index get routines
+ * @brief Repository index functions
- * @defgroup rindex_get Repository index get routines
+ * @defgroup rindex Repository index functions
  */
 static prop_dictionary_t
 match_pkg_by_pkgver(prop_dictionary_t repod, const char *p)

lib/rindex_sync.c

@@ -31,15 +31,6 @@
 #include "xbps_api_impl.h"
 #include "fetch.h"
 
-/**
- * @file lib/repository_sync_index.c
- * @brief Repository package index synchronization routines
- * @defgroup reposync Repository package index synchronization functions
- *
- * Functions to manipulate repository package index plist file
- * synchronizations.
- */
-
 char HIDDEN *
 xbps_get_remote_repo_string(const char *uri)
 {

lib/rpool.c

@@ -34,7 +34,7 @@
 #include "xbps_api_impl.h"
 
 /**
- * @file lib/repository_pool.c
+ * @file lib/rpool.c
  * @brief Repository pool routines
  * @defgroup repopool Repository pool functions
  */