summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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 @@
1/** 1/**
2 * @file libimobiledevice/sbservices.h 2 * @file libimobiledevice/sbservices.h
3 * @brief Implementation to talk to com.apple.springboardservices on a device 3 * @brief Implementation to talk to the SpringBoard services on a device
4 * \internal 4 * \internal
5 * 5 *
6 * Copyright (c) 2009 Nikias Bassen All Rights Reserved. 6 * 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 @@
1/* 1/*
2 * sbservices.c 2 * sbservices.c
3 * SpringBoard Services implementation. 3 * com.apple.springboardservices service implementation.
4 * 4 *
5 * Copyright (c) 2009 Nikias Bassen, All Rights Reserved. 5 * Copyright (c) 2009 Nikias Bassen, All Rights Reserved.
6 * 6 *
@@ -29,9 +29,10 @@
29#include "property_list_service.h" 29#include "property_list_service.h"
30#include "debug.h" 30#include "debug.h"
31 31
32/** Locks an sbservices client, done for thread safety stuff. 32/**
33 * Locks an sbservices client, used for thread safety.
33 * 34 *
34 * @param client The sbservices client to lock. 35 * @param client sbservices client to lock.
35 */ 36 */
36static void sbs_lock(sbservices_client_t client) 37static void sbs_lock(sbservices_client_t client)
37{ 38{
@@ -39,9 +40,10 @@ static void sbs_lock(sbservices_client_t client)
39 g_mutex_lock(client->mutex); 40 g_mutex_lock(client->mutex);
40} 41}
41 42
42/** Unlocks an sbservices client, done for thread safety stuff. 43/**
44 * Unlocks an sbservices client, used for thread safety.
43 * 45 *
44 * @param client The sbservices client to unlock 46 * @param client sbservices client to unlock
45 */ 47 */
46static void sbs_unlock(sbservices_client_t client) 48static void sbs_unlock(sbservices_client_t client)
47{ 49{
@@ -76,10 +78,10 @@ static sbservices_error_t sbservices_error(property_list_service_error_t err)
76} 78}
77 79
78/** 80/**
79 * Creates a new sbservices client. 81 * Connects to the springboardservices service on the specified device.
80 * 82 *
81 * @param device The device to connect to. 83 * @param device The device to connect to.
82 * @param port The port on device to connect to. 84 * @param port Destination port (usually given by lockdownd_start_service).
83 * @param client Pointer that will point to a newly allocated 85 * @param client Pointer that will point to a newly allocated
84 * sbservices_client_t upon successful return. 86 * sbservices_client_t upon successful return.
85 * 87 *
@@ -110,9 +112,10 @@ sbservices_error_t sbservices_client_new(idevice_t device, uint16_t port, sbserv
110} 112}
111 113
112/** 114/**
113 * Frees an sbservices client. 115 * Disconnects an sbservices client from the device and frees up the
116 * sbservices client data.
114 * 117 *
115 * @param client The sbservices client to free. 118 * @param client The sbservices client to disconnect and free.
116 * 119 *
117 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when 120 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
118 * client is NULL, or an SBSERVICES_E_* error code otherwise. 121 * 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 @@
1/* 1/*
2 * sbservices.h 2 * sbservices.h
3 * SpringBoard Services header file. 3 * com.apple.springboardservices service header file.
4 * 4 *
5 * Copyright (c) 2009 Nikias Bassen, All Rights Reserved. 5 * Copyright (c) 2009 Nikias Bassen, All Rights Reserved.
6 * 6 *