moparisthebest
/
pacman
mirror of https://github.com/moparisthebest/pacman
1
0
Fork 0
Code Issues Releases Wiki Activity

doxygen comments update (patch from VMiklos <vmiklos@frugalware.org>)

This commit is contained in:
Aurelien Foret 2006-01-26 19:52:47 +00:00
parent 26ec9573ef
commit 7818e6f745
1 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
lib/libalpm/alpm.c
View File

@ -272,7 +272,7 @@ int alpm_db_unregister(pmdb_t *db)
/** Get informations about a database.
* @param db database pointer
* @param parm name of the info to get
* @return a char* on success (the value), NULL on error
* @return a void* on success (the value), NULL on error
*/
void *alpm_db_getinfo(PM_DB *db, unsigned char parm)
{
@ -773,6 +773,11 @@ int alpm_trans_release()
* @{
*/
/** Get informations about a dependency.
* @param db dependency pointer
* @param parm name of the info to get
* @return a void* on success (the value), NULL on error
*/
void *alpm_dep_getinfo(pmdepmissing_t *miss, unsigned char parm)
{
void *data;
@ -799,6 +804,10 @@ void *alpm_dep_getinfo(pmdepmissing_t *miss, unsigned char parm)
* @{
*/
/** A printf-like function for logging.
* @param fmt output format
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
int alpm_logaction(char *fmt, ...)
{
char str[LOG_STR_LEN];
@ -832,11 +841,19 @@ int alpm_logaction(char *fmt, ...)
* @{
*/
/** Get the first element of a list.
* @param list the list
* @return the first element
*/
PMList *alpm_list_first(PMList *list)
{
return(list);
}
/** Get the next element of a list.
* @param entry the list entry
* @return the next element on success, NULL on error
*/
PMList *alpm_list_next(PMList *entry)
{
ASSERT(entry != NULL, return(NULL));
@ -844,6 +861,10 @@ PMList *alpm_list_next(PMList *entry)
return(entry->next);
}
/** Get the data of a list entry.
* @param entry the list entry
* @return the data on success, NULL on error
*/
void *alpm_list_getdata(PMList *entry)
{
ASSERT(entry != NULL, return(NULL));
@ -851,6 +872,10 @@ void *alpm_list_getdata(PMList *entry)
return(entry->data);
}
/** Free a list.
* @param entry list to free
* @return 0 on success, -1 on error
*/
int alpm_list_free(PMList *entry)
{
ASSERT(entry != NULL, return(-1));
@ -860,6 +885,10 @@ int alpm_list_free(PMList *entry)
return(0);
}
/** Count the entries in a list.
* @param list the list to count
* @return number of entries on success, NULL on error
*/
int alpm_list_count(PMList *list)
{
return(_alpm_list_count(list));
@ -870,6 +899,10 @@ int alpm_list_count(PMList *list)
* @{
*/
/** Get the md5 sum of file.
* @param name name of the file
* @return the checksum on success, NULL on error
*/
char *alpm_get_md5sum(char *name)
{
ASSERT(name != NULL, return(NULL));