installation_proxy: Improve comment formatting and some whitespaces
diff --git a/include/libimobiledevice/installation_proxy.h b/include/libimobiledevice/installation_proxy.h
index 67307e2..c15f0d0 100644
--- a/include/libimobiledevice/installation_proxy.h
+++ b/include/libimobiledevice/installation_proxy.h
@@ -58,10 +58,10 @@
* @param device The device to connect to
* @param service The service descriptor returned by lockdownd_start_service.
* @param client Pointer that will be set to a newly allocated
- * instproxy_client_t upon successful return.
+ * instproxy_client_t upon successful return.
*
* @return INSTPROXY_E_SUCCESS on success, or an INSTPROXY_E_* error value
- * when an error occured.
+ * when an error occured.
*/
instproxy_error_t instproxy_client_new(idevice_t device, lockdownd_service_descriptor_t service, instproxy_client_t *client);
@@ -70,13 +70,13 @@
*
* @param device The device to connect to.
* @param client Pointer that will point to a newly allocated
- * instproxy_client_t upon successful return. Must be freed using
- * instproxy_client_free() after use.
+ * instproxy_client_t upon successful return. Must be freed using
+ * instproxy_client_free() after use.
* @param label The label to use for communication. Usually the program name.
- * Pass NULL to disable sending the label in requests to lockdownd.
+ * Pass NULL to disable sending the label in requests to lockdownd.
*
* @return INSTPROXY_E_SUCCESS on success, or an INSTPROXY_E_* error
- * code otherwise.
+ * code otherwise.
*/
instproxy_error_t instproxy_client_start_service(idevice_t device, instproxy_client_t * client, const char* label);
@@ -87,24 +87,25 @@
* @param client The installation_proxy client to disconnect and free.
*
* @return INSTPROXY_E_SUCCESS on success
- * or INSTPROXY_E_INVALID_ARG if client is NULL.
+ * or INSTPROXY_E_INVALID_ARG if client is NULL.
*/
instproxy_error_t instproxy_client_free(instproxy_client_t client);
-
/**
* List installed applications. This function runs synchronously.
*
* @param client The connected installation_proxy client
* @param client_options The client options to use, as PLIST_DICT, or NULL.
* Valid client options include:
- * "ApplicationType" -> "User"
* "ApplicationType" -> "System"
+ * "ApplicationType" -> "User"
+ * "ApplicationType" -> "Internal"
+ * "ApplicationType" -> "Any"
* @param result Pointer that will be set to a plist that will hold an array
* of PLIST_DICT holding information about the applications found.
*
* @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
- * an error occured.
+ * an error occured.
*/
instproxy_error_t instproxy_browse(instproxy_client_t client, plist_t client_options, plist_t *result);
@@ -125,12 +126,12 @@
* @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.
+ * an error occured.
*
* @note If a callback function is given (async mode), this function returns
- * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
- * created successfully; any error occuring during the operation has to be
- * handled inside the specified callback function.
+ * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
+ * created successfully; any error occuring during the command has to be
+ * handled inside the specified callback function.
*/
instproxy_error_t instproxy_install(instproxy_client_t client, const char *pkg_path, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data);
@@ -153,12 +154,12 @@
* @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.
+ * an error occured.
*
* @note If a callback function is given (async mode), this function returns
- * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
- * created successfully; any error occuring during the operation has to be
- * handled inside the specified callback function.
+ * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
+ * created successfully; any error occuring during the command has to be
+ * handled inside the specified callback function.
*/
instproxy_error_t instproxy_upgrade(instproxy_client_t client, const char *pkg_path, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data);
@@ -177,13 +178,12 @@
* an error occured.
*
* @note If a callback function is given (async mode), this function returns
- * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
- * created successfully; any error occuring during the operation has to be
- * handled inside the specified callback function.
+ * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
+ * created successfully; any error occuring during the command has to be
+ * handled inside the specified callback function.
*/
instproxy_error_t instproxy_uninstall(instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data);
-
/**
* List archived applications. This function runs synchronously.
*
@@ -196,7 +196,7 @@
* holding information about the archived applications found.
*
* @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if
- * an error occured.
+ * an error occured.
*/
instproxy_error_t instproxy_lookup_archives(instproxy_client_t client, plist_t client_options, plist_t *result);
@@ -220,9 +220,9 @@
* an error occured.
*
* @note If a callback function is given (async mode), this function returns
- * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
- * created successfully; any error occuring during the operation has to be
- * handled inside the specified callback function.
+ * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
+ * created successfully; any error occuring during the command has to be
+ * handled inside the specified callback function.
*/
instproxy_error_t instproxy_archive(instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data);
@@ -234,7 +234,8 @@
* @param client The connected installation proxy client
* @param appid ApplicationIdentifier of the app to restore.
* @param client_options The client options to use, as PLIST_DICT, or NULL.
- * Currently there are no known client options, so pass NULL here.
+ * Valid options include:
+ * "ArchiveType" -> "DocumentsOnly"
* @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.
@@ -243,9 +244,9 @@
* an error occured.
*
* @note If a callback function is given (async mode), this function returns
- * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
- * created successfully; any error occuring during the operation has to be
- * handled inside the specified callback function.
+ * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
+ * created successfully; any error occuring during the command has to be
+ * handled inside the specified callback function.
*/
instproxy_error_t instproxy_restore(instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data);
@@ -263,12 +264,12 @@
* @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.
+ * an error occured.
*
* @note If a callback function is given (async mode), this function returns
- * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
- * created successfully; any error occuring during the operation has to be
- * handled inside the specified callback function.
+ * INSTPROXY_E_SUCCESS immediately if the status updater thread has been
+ * created successfully; any error occuring during the command has to be
+ * handled inside the specified callback function.
*/
instproxy_error_t instproxy_remove_archive(instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data);
@@ -282,7 +283,7 @@
plist_t instproxy_client_options_new(void);
/**
- * Add one or more new key:value pairs to the given client_options.
+ * Adds one or more new key:value pairs to the given client_options.
*
* @param client_options The client options to modify.
* @param ... KEY, VALUE, [KEY, VALUE], NULL
@@ -294,7 +295,7 @@
void instproxy_client_options_add(plist_t client_options, ...);
/**
- * Free client_options plist.
+ * Frees client_options plist.
*
* @param client_options The client options plist to free. Does nothing if NULL
* is passed.
@@ -302,7 +303,7 @@
void instproxy_client_options_free(plist_t client_options);
/**
- * Query the device for the path of an application.
+ * Queries the device for the path of an application.
*
* @param client The connected installation proxy client.
* @param appid ApplicationIdentifier of app to retrieve the path for.
diff --git a/src/installation_proxy.c b/src/installation_proxy.c
index 9a11e36..e279edf 100644
--- a/src/installation_proxy.c
+++ b/src/installation_proxy.c
@@ -59,7 +59,7 @@
}
/**
- * Convert a property_list_service_error_t value to an instproxy_error_t value.
+ * Converts a property_list_service_error_t value to an instproxy_error_t value.
* Used internally to get correct error codes.
*
* @param err A property_list_service_error_t error code
@@ -130,7 +130,7 @@
}
/**
- * Send a command with specified options to the device.
+ * Sends a command to the device.
* Only used internally.
*
* @param client The connected installation_proxy client.
@@ -383,7 +383,6 @@
return res;
}
-
/**
* Internal function used by instproxy_install and instproxy_upgrade.
*
@@ -528,6 +527,7 @@
return INSTPROXY_E_OP_IN_PROGRESS;
}
+ /* send command */
instproxy_lock(client);
instproxy_error_t res = instproxy_send_command(client, "RemoveArchive", client_options, appid, NULL);
instproxy_unlock(client);
@@ -548,6 +548,7 @@
{
if (!client_options)
return;
+
va_list args;
va_start(args, client_options);
char *arg = va_arg(args, char*);
@@ -607,6 +608,7 @@
// query device for list of apps
instproxy_error_t ierr = instproxy_browse(client, client_opts, &apps);
instproxy_client_options_free(client_opts);
+
if (ierr != INSTPROXY_E_SUCCESS) {
return ierr;
}
