From ab431f6810ed49045a95fe232cd678d39708fc02 Mon Sep 17 00:00:00 2001
From: morganamilo <morganamilo@archlinux.org>
Date: Mon, 7 Dec 2020 22:19:37 +0000
Subject: doc: document handle

Signed-off-by: Allan McRae <allan@archlinux.org>
---
 lib/libalpm/alpm.h | 58 ++++++++++++++++++++++++++++--------------------------
 1 file changed, 30 insertions(+), 28 deletions(-)

(limited to 'lib')

diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
index 06d0f5a3..9717c192 100644
--- a/lib/libalpm/alpm.h
+++ b/lib/libalpm/alpm.h
@@ -242,6 +242,36 @@ const char *alpm_strerror(alpm_errno_t err);
 /* End of alpm_errors */
 /** @} */
 
+
+/** \addtogroup alpm_handle Handle
+ * @brief Functions to initialize and release libalpm
+ * @{
+ */
+
+/** 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
+ * @return a context handle on success, NULL on error, err will be set if provided
+ */
+alpm_handle_t *alpm_initialize(const char *root, const char *dbpath,
+		alpm_errno_t *err);
+
+/** 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
+ * @return 0 on success, -1 on error
+ */
+int alpm_release(alpm_handle_t *handle);
+
+/* End of alpm_handle */
+/** @} */
+
 typedef int64_t alpm_time_t;
 
 /*
@@ -1914,34 +1944,6 @@ char *alpm_compute_sha256sum(const char *filename);
 
 /** @} */
 
-/** \addtogroup alpm_interface Interface Functions
- * @brief Functions to initialize and release libalpm
- * @{
- */
-
-/** 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
- * @return a context handle on success, NULL on error, err will be set if provided
- */
-alpm_handle_t *alpm_initialize(const char *root, const char *dbpath,
-		alpm_errno_t *err);
-
-/** 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
- * @return 0 on success, -1 on error
- */
-int alpm_release(alpm_handle_t *handle);
-
-/** @} */
-
 /** Remove the database lock file
  * @param handle the context handle
  * @return 0 on success, -1 on error
-- 
cgit v1.2.3-70-g09d2