summaryrefslogtreecommitdiffstats
path: root/src/installation_proxy.c
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2010-03-05 16:27:34 +0100
committerGravatar Matt Colyer2010-03-08 21:08:07 -0800
commit894035083555368bc056d3ba276ebbe2312ecdab (patch)
treecd5e544afe6cef41b8b31f8b9b304676c2b5ca02 /src/installation_proxy.c
parent77aa0b3c5b4fc6cff147e98a2130dd11204b40ad (diff)
downloadlibimobiledevice-894035083555368bc056d3ba276ebbe2312ecdab.tar.gz
libimobiledevice-894035083555368bc056d3ba276ebbe2312ecdab.tar.bz2
installation_proxy: docs updated
Diffstat (limited to 'src/installation_proxy.c')
-rw-r--r--src/installation_proxy.c17
1 files changed, 10 insertions, 7 deletions
diff --git a/src/installation_proxy.c b/src/installation_proxy.c
index 3a6d22a..9fb5109 100644
--- a/src/installation_proxy.c
+++ b/src/installation_proxy.c
@@ -1,6 +1,6 @@
/*
* installation_proxy.c
- * Installation Proxy implementation.
+ * com.apple.mobile.installation_proxy service implementation.
*
* Copyright (c) 2009 Nikias Bassen, All Rights Reserved.
*
@@ -35,7 +35,8 @@ struct instproxy_status_data {
char *operation;
};
-/** Locks an installation_proxy client, done for thread safety stuff.
+/**
+ * Locks an installation_proxy client, used for thread safety.
*
* @param client The installation_proxy client to lock
*/
@@ -45,7 +46,8 @@ static void instproxy_lock(instproxy_client_t client)
g_mutex_lock(client->mutex);
}
-/** Unlocks an installation_proxy client, done for thread safety stuff.
+/**
+ * Unlocks an installation_proxy client, used for thread safety.
*
* @param client The installation_proxy client to lock
*/
@@ -82,7 +84,7 @@ static instproxy_error_t instproxy_error(property_list_service_error_t err)
}
/**
- * Creates a new installation_proxy client
+ * Connects to the installation_proxy service on the specified device.
*
* @param device The device to connect to
* @param port Destination port (usually given by lockdownd_start_service).
@@ -116,9 +118,10 @@ instproxy_error_t instproxy_client_new(idevice_t device, uint16_t port, instprox
}
/**
- * Frees an installation_proxy client.
+ * Disconnects an installation_proxy client from the device and frees up the
+ * installation_proxy client data.
*
- * @param client The installation_proxy client to free.
+ * @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.
@@ -144,7 +147,7 @@ instproxy_error_t instproxy_client_free(instproxy_client_t client)
/**
* Send a command with specified options to the device.
- * Internally used only.
+ * Only used internally.
*
* @param client The connected installation_proxy client.
* @param command The command to execute. Required.