From 21ab0f72efa67879d60174ecd8e76ad59bea43cc Mon Sep 17 00:00:00 2001
From: Martin Szulecki
Date: Sat, 15 May 2010 16:10:24 +0200
Subject: Document user_data parameter in installation_proxy interface

---
 src/installation_proxy.c | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src')

diff --git a/src/installation_proxy.c b/src/installation_proxy.c
index b54ade7..4a76dd2 100644
--- a/src/installation_proxy.c
+++ b/src/installation_proxy.c
@@ -271,6 +271,7 @@ leave_unlock:
  * @param status_cb Pointer to a callback function or NULL
  * @param operation Operation name. Will be passed to the callback function
  *        in async mode or shown in debug messages in sync mode. 
+ * @param user_data Callback data passed to status_cb.
  */
 static instproxy_error_t instproxy_perform_operation(instproxy_client_t client, instproxy_status_cb_t status_cb, const char *operation, void *user_data)
 {
@@ -378,6 +379,7 @@ static gpointer instproxy_status_updater(gpointer arg)
  * @param status_cb Pointer to a callback function or NULL
  * @param operation Operation name. Will be passed to the callback function
  *        in async mode or shown in debug messages in sync mode.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS when the thread was created (async mode), or
  *         when the operation completed successfully (sync).
@@ -417,6 +419,7 @@ static instproxy_error_t instproxy_create_status_updater(instproxy_client_t clie
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
  * @param command The command to execute.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured. 
@@ -456,6 +459,7 @@ static instproxy_error_t instproxy_install_or_upgrade(instproxy_client_t client,
  *        an .app directory instead of an install package.
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured.
@@ -486,6 +490,7 @@ instproxy_error_t instproxy_install(instproxy_client_t client, const char *pkg_p
  *        an .app directory instead of an install package.
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured.
@@ -509,6 +514,7 @@ instproxy_error_t instproxy_upgrade(instproxy_client_t client, const char *pkg_p
  *        Currently there are no known client options, so pass NULL here.
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured.
@@ -601,6 +607,7 @@ leave_unlock:
  *          "ArchiveType" -> "ApplicationOnly" 
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured.
@@ -641,6 +648,7 @@ instproxy_error_t instproxy_archive(instproxy_client_t client, const char *appid
  *        Currently there are no known client options, so pass NULL here.
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured.
@@ -681,6 +689,7 @@ instproxy_error_t instproxy_restore(instproxy_client_t client, const char *appid
  *        Currently there are no known client options, so passing NULL is fine.
  * @param status_cb Callback function for progress and status information. If
  *        NULL is passed, this function will run synchronously.
+ * @param user_data Callback data passed to status_cb.
  *
  * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
  *     an error occured.
-- 
cgit v1.1-32-gdbae