From 5552fa0fcc7501d3206fb3d3a64c1d04062ec53b Mon Sep 17 00:00:00 2001 From: Martin Szulecki Date: Sun, 5 Oct 2014 16:15:34 +0200 Subject: restore: Correct wrong error names in @return doc comments --- include/libimobiledevice/restore.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/include/libimobiledevice/restore.h b/include/libimobiledevice/restore.h index f4e8822..63f8915 100644 --- a/include/libimobiledevice/restore.h +++ b/include/libimobiledevice/restore.h @@ -59,7 +59,7 @@ typedef restored_client_private *restored_client_t; /**< The client handle. */ * @param client The pointer to the location of the new restored_client * @param label The label to use for communication. Usually the program name. * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL */ restored_error_t restored_client_new(idevice_t device, restored_client_t *client, const char *label); @@ -69,7 +69,7 @@ restored_error_t restored_client_new(idevice_t device, restored_client_t *client * * @param client The restore client * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL */ restored_error_t restored_client_free(restored_client_t client); @@ -82,7 +82,7 @@ restored_error_t restored_client_free(restored_client_t client); * @param type The type returned by the service daemon. Pass NULL to ignore. * @param version The restore protocol version. Pass NULL to ignore. * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL */ restored_error_t restored_query_type(restored_client_t client, char **type, uint64_t *version); @@ -93,7 +93,7 @@ restored_error_t restored_query_type(restored_client_t client, char **type, uint * @param key The key name to request * @param value A plist node representing the result value node * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found */ restored_error_t restored_query_value(restored_client_t client, const char *key, plist_t *value); @@ -104,7 +104,7 @@ restored_error_t restored_query_value(restored_client_t client, const char *key, * @param key The key name to request or NULL to query for all keys * @param value A plist node representing the result value node * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found */ restored_error_t restored_get_value(restored_client_t client, const char *key, plist_t *value) ; @@ -117,7 +117,7 @@ restored_error_t restored_get_value(restored_client_t client, const char *key, p * @param client The restored client * @param plist The plist to send * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client or + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client or * plist is NULL */ restored_error_t restored_send(restored_client_t client, plist_t plist); @@ -128,7 +128,7 @@ restored_error_t restored_send(restored_client_t client, plist_t plist); * @param client The restored client * @param plist The plist to store the received data * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client or + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client or * plist is NULL */ restored_error_t restored_receive(restored_client_t client, plist_t *plist); @@ -138,7 +138,7 @@ restored_error_t restored_receive(restored_client_t client, plist_t *plist); * * @param client The restore client * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, * RESTORE_E_PLIST_ERROR if the device did not acknowledge the request */ restored_error_t restored_goodbye(restored_client_t client); @@ -151,7 +151,7 @@ restored_error_t restored_goodbye(restored_client_t client); * @param options PLIST_DICT with options for the restore process or NULL * @param version the restore protocol version, see restored_query_type() * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter * is NULL, RESTORE_E_START_RESTORE_FAILED if the request fails */ restored_error_t restored_start_restore(restored_client_t client, plist_t options, uint64_t version); @@ -161,7 +161,7 @@ restored_error_t restored_start_restore(restored_client_t client, plist_t option * * @param client The restored client * - * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter + * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter * is NULL */ restored_error_t restored_reboot(restored_client_t client); -- cgit v1.1-32-gdbae