Fixed API documentation comments for doxygen.

This commit is contained in:
Juan RP 2011-01-19 00:31:22 +01:00
parent 2adaf610e7
commit efea94bec6
8 changed files with 11 additions and 9 deletions

View File

@ -597,7 +597,7 @@ int xbps_repository_unregister(const char *uri);
* @note The function name might be misleading, but is correct because * @note The function name might be misleading, but is correct because
* if package is found, it will be marked as "going to be installed". * 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. * @return 0 on success, otherwise an errno value.
*/ */
@ -703,7 +703,7 @@ struct repository_pool_index {
*/ */
prop_dictionary_t rpi_repod; prop_dictionary_t rpi_repod;
/** /**
* @var rp_uri * @var rpi_uri
* *
* URI string associated with repository. * URI string associated with repository.
*/ */
@ -781,6 +781,8 @@ prop_dictionary_t
*/ */
int xbps_repository_sync_pkg_index(const char *uri); int xbps_repository_sync_pkg_index(const char *uri);
/*@}*/
/** @addtogroup pkgstates */ /** @addtogroup pkgstates */
/*@{*/ /*@{*/

View File

@ -32,7 +32,7 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/** /**
* @file lib/configure.c * @file lib/package_configure.c
* @brief Package configuration routines * @brief Package configuration routines
* @defgroup configure Package configuration functions * @defgroup configure Package configuration functions
* *

View File

@ -34,7 +34,7 @@
#include "queue.h" #include "queue.h"
/** /**
* @file lib/orphans.c * @file lib/package_orphans.c
* @brief Package orphans handling routines * @brief Package orphans handling routines
* @defgroup pkg_orphans Package orphans handling functions * @defgroup pkg_orphans Package orphans handling functions
* *

View File

@ -33,7 +33,7 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/** /**
* @file lib/purge.c * @file lib/package_purge.c
* @brief Package purging routines * @brief Package purging routines
* @defgroup purge Package purging functions * @defgroup purge Package purging functions
* *

View File

@ -32,7 +32,7 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/** /**
* @file lib/register.c * @file lib/package_register.c
* @brief Package registration routines * @brief Package registration routines
* @defgroup pkg_register Package registration functions * @defgroup pkg_register Package registration functions
* *

View File

@ -35,7 +35,7 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/** /**
* @file lib/remove.c * @file lib/package_remove.c
* @brief Package removal routines * @brief Package removal routines
* @defgroup pkg_remove Package removal functions * @defgroup pkg_remove Package removal functions
* *

View File

@ -33,7 +33,7 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/** /**
* @file lib/state.c * @file lib/package_state.c
* @brief Package state handling routines * @brief Package state handling routines
* @defgroup pkgstates Package state handling functions * @defgroup pkgstates Package state handling functions
*/ */

View File

@ -34,7 +34,7 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/** /**
* @file lib/unpack.c * @file lib/package_unpack.c
* @brief Binary package file unpacking routines * @brief Binary package file unpacking routines
* @defgroup unpack Binary package file unpacking functions * @defgroup unpack Binary package file unpacking functions
* *