From cacf968970bbc63e8eb519e40194e6c083ba6a06 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Thu, 14 Jun 2007 11:12:21 -0400 Subject: Update Doxyfile and add a few missing parts of documentation Signed-off-by: Dan McGee --- lib/libalpm/Doxyfile | 16 +++++++++++++++- lib/libalpm/db.c | 11 +++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/libalpm/Doxyfile b/lib/libalpm/Doxyfile index 69e35e79..fed75a7e 100644 --- a/lib/libalpm/Doxyfile +++ b/lib/libalpm/Doxyfile @@ -86,7 +86,21 @@ WARN_LOGFILE = INPUT = alpm.c \ alpm.h \ alpm_list.c \ - alpm_list.h + alpm_list.h \ + conflict.c \ + db.c \ + deps.c \ + error.c \ + group.c \ + handle.c \ + log.c \ + md5driver.c \ + package.c \ + server.c \ + sha1.c \ + sync.c \ + trans.c \ + versioncmp.c INPUT_ENCODING = UTF-8 FILE_PATTERNS = RECURSIVE = NO diff --git a/lib/libalpm/db.c b/lib/libalpm/db.c index 9d75c5c0..470f45aa 100644 --- a/lib/libalpm/db.c +++ b/lib/libalpm/db.c @@ -258,6 +258,10 @@ int SYMEXPORT alpm_db_update(int force, pmdb_t *db) return(0); } +/** Get the name of a package database + * @param db pointer to the package database + * @return the name of the package database, NULL on error + */ const char SYMEXPORT *alpm_db_get_name(const pmdb_t *db) { ALPM_LOG_FUNC; @@ -269,6 +273,10 @@ const char SYMEXPORT *alpm_db_get_name(const pmdb_t *db) return db->treename; } +/** Get a download URL for the package database + * @param db pointer to the package database + * @return a fully-specified download URL, NULL on error + */ const char SYMEXPORT *alpm_db_get_url(const pmdb_t *db) { char path[PATH_MAX]; @@ -400,6 +408,9 @@ alpm_list_t SYMEXPORT *alpm_db_search(pmdb_t *db, const alpm_list_t* needles) /* This function is mostly the same as sync.c find_replacements and sysupgrade * functions, and we should be able to combine them - this is an interim * solution made for -Qu operation */ +/** Get a list of upgradable packages on the current system + * @return a pmsyncpkg_t list of packages that are out of date + */ alpm_list_t SYMEXPORT *alpm_db_get_upgrades() { alpm_list_t *syncpkgs = NULL; -- cgit v1.2.3-24-g4f1b