summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2010-03-05 16:28:12 +0100
committerGravatar Matt Colyer2010-03-08 21:08:08 -0800
commite04f879ac0a211723db43fd8fc981225663e48f1 (patch)
tree6ac177e83a57dec81b4970727539d4b057544c6c /src
parent894035083555368bc056d3ba276ebbe2312ecdab (diff)
downloadlibimobiledevice-e04f879ac0a211723db43fd8fc981225663e48f1.tar.gz
libimobiledevice-e04f879ac0a211723db43fd8fc981225663e48f1.tar.bz2
file_relay: docs updated
Diffstat (limited to 'src')
-rw-r--r--src/file_relay.c11
-rw-r--r--src/file_relay.h2
2 files changed, 7 insertions, 6 deletions
diff --git a/src/file_relay.c b/src/file_relay.c
index dd94e53..067384f 100644
--- a/src/file_relay.c
+++ b/src/file_relay.c
@@ -1,6 +1,6 @@
/*
* file_relay.c
- * file_relay service implementation.
+ * com.apple.mobile.file_relay service implementation.
*
* Copyright (c) 2010 Nikias Bassen, All Rights Reserved.
*
@@ -25,10 +25,10 @@
#include "debug.h"
/**
- * Creates a new file_relay client.
+ * Connects to the file_relay service on the specified device.
*
* @param device The device to connect to.
- * @param port Port on device to connect to.
+ * @param port Destination port (usually given by lockdownd_start_service).
* @param client Reference that will point to a newly allocated
* file_relay_client_t upon successful return.
*
@@ -57,9 +57,10 @@ file_relay_error_t file_relay_client_new(idevice_t device, uint16_t port, file_r
}
/**
- * Frees a file_relay client.
+ * Disconnects a file_relay client from the device and frees up the file_relay
+ * client data.
*
- * @param client The file_relay_client_t to free.
+ * @param client The file_relay client to disconnect and free.
*
* @return FILE_RELAY_E_SUCCESS on success,
* FILE_RELAY_E_INVALID_ARG when one of client or client->parent
diff --git a/src/file_relay.h b/src/file_relay.h
index 7a94c89..e1a133d 100644
--- a/src/file_relay.h
+++ b/src/file_relay.h
@@ -1,6 +1,6 @@
/*
* file_relay.h
- * Definitions for the file_relay service
+ * com.apple.mobile.file_relay service header file.
*
* Copyright (c) 2010 Nikias Bassen, All Rights Reserved.
*