diff options
| author | Richard Pougnet <richard@pougnet.ca> | 2013-03-25 01:02:06 +0100 |
|---|---|---|
| committer | Allan McRae <allan@archlinux.org> | 2013-03-31 03:08:54 +0200 |
| commit | c85d155f3a789ce149ecfca5f9ef205e329bb675 (patch) | |
| tree | 7aacfdd2d7d458d18bd1ad9d4e2ef8645a4e8ce0 /lib/libalpm | |
| parent | 950443a43810b9c12d541cb4b74fb65b7a6bcfde (diff) | |
| download | pacman-c85d155f3a789ce149ecfca5f9ef205e329bb675.tar.gz pacman-c85d155f3a789ce149ecfca5f9ef205e329bb675.tar.xz | |
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>
Diffstat (limited to 'lib/libalpm')
| -rw-r--r-- | lib/libalpm/alpm.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/libalpm/alpm.c b/lib/libalpm/alpm.c index cd14adbb..878c38bd 100644 --- a/lib/libalpm/alpm.c +++ b/lib/libalpm/alpm.c @@ -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 |