summaryrefslogtreecommitdiff
path: root/lib/libalpm/alpm.h
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2011-09-22 16:29:03 -0500
committerDan McGee <dan@archlinux.org>2011-09-22 16:37:36 -0500
commit2517ba3303489ed35512cdaf2493ec81efd145e7 (patch)
tree76759bb258b6c61830cc18ada879fe43bccf357e /lib/libalpm/alpm.h
parentc406949226fe5759473f13b5eb1fcf48c32d67ea (diff)
downloadpacman-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/libalpm/alpm.h')
-rw-r--r--lib/libalpm/alpm.h13
1 files changed, 8 insertions, 5 deletions
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);