summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2011-09-22 23:29:03 +0200
committerDan McGee <dan@archlinux.org>2011-09-22 23:37:36 +0200
commit2517ba3303489ed35512cdaf2493ec81efd145e7 (patch)
tree76759bb258b6c61830cc18ada879fe43bccf357e /lib
parentc406949226fe5759473f13b5eb1fcf48c32d67ea (diff)
downloadpacman-2517ba3303489ed35512cdaf2493ec81efd145e7.tar.gz
pacman-2517ba3303489ed35512cdaf2493ec81efd145e7.tar.xz
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 <dan@archlinux.org>
Diffstat (limited to 'lib')
-rw-r--r--lib/libalpm/alpm.c2
-rw-r--r--lib/libalpm/alpm.h13
-rw-r--r--lib/libalpm/alpm_list.c1
-rw-r--r--lib/libalpm/deps.c1
-rw-r--r--lib/libalpm/signing.c4
-rw-r--r--lib/libalpm/sync.c2
6 files changed, 13 insertions, 10 deletions
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,