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

Improve documentation of libalpm interface functions 

Add details to the doxygen for the initialization and relase functions
of the library.

Signed-off-by: Richard Pougnet <richard@pougnet.ca>
Signed-off-by: Allan McRae <allan@archlinux.org>
This commit is contained in:
Richard Pougnet 2013-03-24 20:02:06 -04:00 committed by Allan McRae
parent 950443a438
commit c85d155f3a
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/libalpm/alpm.c
View File

@ -37,8 +37,9 @@
* @{
*/
/** Initializes the library. This must be called before any other
* functions are called.
/** Initializes the library.
* Creates handle, connects to database and creates lockfile.
* This must be called before any other functions are called.
* @param root the root path for all filesystem operations
* @param dbpath the absolute path to the libalpm database
* @param err an optional variable to hold any error return codes
@ -86,7 +87,9 @@ cleanup:
return NULL;
}
/** Release the library. This should be the last alpm call you make.
/** Release the library.
* Disconnects from the database, removes handle and lockfile
* This should be the last alpm call you make.
* After this returns, handle should be considered invalid and cannot be reused
* in any way.
* @param myhandle the context handle