diff options
author | Aaron Burghardt | 2014-03-27 10:07:09 -0400 |
---|---|---|
committer | Aaron Burghardt | 2014-03-27 21:40:43 -0400 |
commit | 2342dc5b4ef148b993fbe3816f3facdef8365546 (patch) | |
tree | 69f812d91b2fc07db0fad5dcba6c80d2f8b6849e /src/webinspector.c | |
parent | ee82e861a8c942b5013accd7589cf898d1f97167 (diff) | |
download | libimobiledevice-2342dc5b4ef148b993fbe3816f3facdef8365546.tar.gz libimobiledevice-2342dc5b4ef148b993fbe3816f3facdef8365546.tar.bz2 |
Moved Doxygen comments from source files to public headers.
Conflicts:
include/libimobiledevice/afc.h
Diffstat (limited to 'src/webinspector.c')
-rw-r--r-- | src/webinspector.c | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/src/webinspector.c b/src/webinspector.c index 14a8bd8..31c5b2c 100644 --- a/src/webinspector.c +++ b/src/webinspector.c @@ -58,18 +58,6 @@ static webinspector_error_t webinspector_error(property_list_service_error_t err return WEBINSPECTOR_E_UNKNOWN_ERROR; } -/** - * Connects to the webinspector service on the specified device. - * - * @param device The device to connect to. - * @param service The service descriptor returned by lockdownd_start_service. - * @param client Pointer that will point to a newly allocated - * webinspector_client_t upon successful return. Must be freed using - * webinspector_client_free() after use. - * - * @return WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when - * client is NULL, or an WEBINSPECTOR_E_* error code otherwise. - */ webinspector_error_t webinspector_client_new(idevice_t device, lockdownd_service_descriptor_t service, webinspector_client_t * client) { *client = NULL; @@ -97,19 +85,6 @@ webinspector_error_t webinspector_client_new(idevice_t device, lockdownd_service return 0; } -/** - * Starts a new webinspector service on the specified device and connects to it. - * - * @param device The device to connect to. - * @param client Pointer that will point to a newly allocated - * webinspector_client_t upon successful return. Must be freed using - * webinspector_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. - * - * @return WEBINSPECTOR_E_SUCCESS on success, or an WEBINSPECTOR_E_* error - * code otherwise. - */ webinspector_error_t webinspector_client_start_service(idevice_t device, webinspector_client_t * client, const char* label) { webinspector_error_t err = WEBINSPECTOR_E_UNKNOWN_ERROR; @@ -117,15 +92,6 @@ webinspector_error_t webinspector_client_start_service(idevice_t device, webinsp return err; } -/** - * Disconnects a webinspector client from the device and frees up the - * webinspector client data. - * - * @param client The webinspector client to disconnect and free. - * - * @return WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when - * client is NULL, or an WEBINSPECTOR_E_* error code otherwise. - */ webinspector_error_t webinspector_client_free(webinspector_client_t client) { if (!client) @@ -137,15 +103,6 @@ webinspector_error_t webinspector_client_free(webinspector_client_t client) return err; } -/** - * Sends a plist to the service. - * - * @param client The webinspector client - * @param plist The plist to send - * - * @return DIAGNOSTICS_RELAY_E_SUCCESS on success, - * DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL - */ webinspector_error_t webinspector_send(webinspector_client_t client, plist_t plist) { webinspector_error_t res = WEBINSPECTOR_E_UNKNOWN_ERROR; @@ -203,35 +160,11 @@ webinspector_error_t webinspector_send(webinspector_client_t client, plist_t pli return res; } -/** - * Receives a plist from the service. - * - * @param client The webinspector client - * @param plist The plist to store the received data - * - * @return DIAGNOSTICS_RELAY_E_SUCCESS on success, - * DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL - */ webinspector_error_t webinspector_receive(webinspector_client_t client, plist_t * plist) { return webinspector_receive_with_timeout(client, plist, 5000); } -/** - * Receives a plist using the given webinspector client. - * - * @param client The webinspector client to use for receiving - * @param plist pointer to a plist_t that will point to the received plist - * upon successful return - * @param timeout Maximum time in milliseconds to wait for data. - * - * @return WEBINSPECTOR_E_SUCCESS on success, - * WEBINSPECTOR_E_INVALID_ARG when client or *plist is NULL, - * WEBINSPECTOR_E_PLIST_ERROR when the received data cannot be - * converted to a plist, WEBINSPECTOR_E_MUX_ERROR when a - * communication error occurs, or WEBINSPECTOR_E_UNKNOWN_ERROR - * when an unspecified error occurs. - */ webinspector_error_t webinspector_receive_with_timeout(webinspector_client_t client, plist_t * plist, uint32_t timeout_ms) { webinspector_error_t res = WEBINSPECTOR_E_UNKNOWN_ERROR; |