summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2010-03-05 16:28:34 +0100
committerGravatar Matt Colyer2010-03-08 21:08:14 -0800
commit1d59d15f3b78f26fb231a9bf401ee40cd7b60463 (patch)
tree7265db3db6da997f87133a4c088ca1fa13a0c89c
parente04f879ac0a211723db43fd8fc981225663e48f1 (diff)
downloadlibimobiledevice-1d59d15f3b78f26fb231a9bf401ee40cd7b60463.tar.gz
libimobiledevice-1d59d15f3b78f26fb231a9bf401ee40cd7b60463.tar.bz2
sbservices: docs updated
-rw-r--r--include/libimobiledevice/sbservices.h2
-rw-r--r--src/sbservices.c21
-rw-r--r--src/sbservices.h2
3 files changed, 14 insertions, 11 deletions
diff --git a/include/libimobiledevice/sbservices.h b/include/libimobiledevice/sbservices.h
index 921d6be..2923082 100644
--- a/include/libimobiledevice/sbservices.h
+++ b/include/libimobiledevice/sbservices.h
@@ -1,6 +1,6 @@
/**
* @file libimobiledevice/sbservices.h
- * @brief Implementation to talk to com.apple.springboardservices on a device
+ * @brief Implementation to talk to the SpringBoard services on a device
* \internal
*
* Copyright (c) 2009 Nikias Bassen All Rights Reserved.
diff --git a/src/sbservices.c b/src/sbservices.c
index 8cf8b26..25602d3 100644
--- a/src/sbservices.c
+++ b/src/sbservices.c
@@ -1,6 +1,6 @@
/*
* sbservices.c
- * SpringBoard Services implementation.
+ * com.apple.springboardservices service implementation.
*
* Copyright (c) 2009 Nikias Bassen, All Rights Reserved.
*
@@ -29,9 +29,10 @@
#include "property_list_service.h"
#include "debug.h"
-/** Locks an sbservices client, done for thread safety stuff.
+/**
+ * Locks an sbservices client, used for thread safety.
*
- * @param client The sbservices client to lock.
+ * @param client sbservices client to lock.
*/
static void sbs_lock(sbservices_client_t client)
{
@@ -39,9 +40,10 @@ static void sbs_lock(sbservices_client_t client)
g_mutex_lock(client->mutex);
}
-/** Unlocks an sbservices client, done for thread safety stuff.
+/**
+ * Unlocks an sbservices client, used for thread safety.
*
- * @param client The sbservices client to unlock
+ * @param client sbservices client to unlock
*/
static void sbs_unlock(sbservices_client_t client)
{
@@ -76,10 +78,10 @@ static sbservices_error_t sbservices_error(property_list_service_error_t err)
}
/**
- * Creates a new sbservices client.
+ * Connects to the springboardservices service on the specified device.
*
* @param device The device to connect to.
- * @param port The port on device to connect to.
+ * @param port Destination port (usually given by lockdownd_start_service).
* @param client Pointer that will point to a newly allocated
* sbservices_client_t upon successful return.
*
@@ -110,9 +112,10 @@ sbservices_error_t sbservices_client_new(idevice_t device, uint16_t port, sbserv
}
/**
- * Frees an sbservices client.
+ * Disconnects an sbservices client from the device and frees up the
+ * sbservices client data.
*
- * @param client The sbservices client to free.
+ * @param client The sbservices client to disconnect and free.
*
* @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
* client is NULL, or an SBSERVICES_E_* error code otherwise.
diff --git a/src/sbservices.h b/src/sbservices.h
index 4ade579..7be1447 100644
--- a/src/sbservices.h
+++ b/src/sbservices.h
@@ -1,6 +1,6 @@
/*
* sbservices.h
- * SpringBoard Services header file.
+ * com.apple.springboardservices service header file.
*
* Copyright (c) 2009 Nikias Bassen, All Rights Reserved.
*