From efea94bec6ab14bba256b7dc0a45922401c076a5 Mon Sep 17 00:00:00 2001 From: Juan RP Date: Wed, 19 Jan 2011 00:31:22 +0100 Subject: [PATCH] Fixed API documentation comments for doxygen. --- include/xbps_api.h | 6 ++++-- lib/package_configure.c | 2 +- lib/package_orphans.c | 2 +- lib/package_purge.c | 2 +- lib/package_register.c | 2 +- lib/package_remove.c | 2 +- lib/package_state.c | 2 +- lib/package_unpack.c | 2 +- 8 files changed, 11 insertions(+), 9 deletions(-) diff --git a/include/xbps_api.h b/include/xbps_api.h index f8b924c3..471006dc 100644 --- a/include/xbps_api.h +++ b/include/xbps_api.h @@ -597,7 +597,7 @@ int xbps_repository_unregister(const char *uri); * @note The function name might be misleading, but is correct because * if package is found, it will be marked as "going to be installed". * - * @param pkg Package name or pattern to find. + * @param pkgpattern Package name or pattern to find. * * @return 0 on success, otherwise an errno value. */ @@ -703,7 +703,7 @@ struct repository_pool_index { */ prop_dictionary_t rpi_repod; /** - * @var rp_uri + * @var rpi_uri * * URI string associated with repository. */ @@ -781,6 +781,8 @@ prop_dictionary_t */ int xbps_repository_sync_pkg_index(const char *uri); +/*@}*/ + /** @addtogroup pkgstates */ /*@{*/ diff --git a/lib/package_configure.c b/lib/package_configure.c index a60a87a6..aecfe72a 100644 --- a/lib/package_configure.c +++ b/lib/package_configure.c @@ -32,7 +32,7 @@ #include "xbps_api_impl.h" /** - * @file lib/configure.c + * @file lib/package_configure.c * @brief Package configuration routines * @defgroup configure Package configuration functions * diff --git a/lib/package_orphans.c b/lib/package_orphans.c index fb946ed1..29f517bf 100644 --- a/lib/package_orphans.c +++ b/lib/package_orphans.c @@ -34,7 +34,7 @@ #include "queue.h" /** - * @file lib/orphans.c + * @file lib/package_orphans.c * @brief Package orphans handling routines * @defgroup pkg_orphans Package orphans handling functions * diff --git a/lib/package_purge.c b/lib/package_purge.c index 455624e3..3ef78a8c 100644 --- a/lib/package_purge.c +++ b/lib/package_purge.c @@ -33,7 +33,7 @@ #include "xbps_api_impl.h" /** - * @file lib/purge.c + * @file lib/package_purge.c * @brief Package purging routines * @defgroup purge Package purging functions * diff --git a/lib/package_register.c b/lib/package_register.c index ca3501de..5e18dc62 100644 --- a/lib/package_register.c +++ b/lib/package_register.c @@ -32,7 +32,7 @@ #include "xbps_api_impl.h" /** - * @file lib/register.c + * @file lib/package_register.c * @brief Package registration routines * @defgroup pkg_register Package registration functions * diff --git a/lib/package_remove.c b/lib/package_remove.c index 3b92496d..847ab38f 100644 --- a/lib/package_remove.c +++ b/lib/package_remove.c @@ -35,7 +35,7 @@ #include "xbps_api_impl.h" /** - * @file lib/remove.c + * @file lib/package_remove.c * @brief Package removal routines * @defgroup pkg_remove Package removal functions * diff --git a/lib/package_state.c b/lib/package_state.c index d2835908..f59580cd 100644 --- a/lib/package_state.c +++ b/lib/package_state.c @@ -33,7 +33,7 @@ #include "xbps_api_impl.h" /** - * @file lib/state.c + * @file lib/package_state.c * @brief Package state handling routines * @defgroup pkgstates Package state handling functions */ diff --git a/lib/package_unpack.c b/lib/package_unpack.c index 5da251d9..915603dc 100644 --- a/lib/package_unpack.c +++ b/lib/package_unpack.c @@ -34,7 +34,7 @@ #include "xbps_api_impl.h" /** - * @file lib/unpack.c + * @file lib/package_unpack.c * @brief Binary package file unpacking routines * @defgroup unpack Binary package file unpacking functions *