summaryrefslogtreecommitdiffstats
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
parent894035083555368bc056d3ba276ebbe2312ecdab (diff)
downloadlibimobiledevice-e04f879ac0a211723db43fd8fc981225663e48f1.tar.gz
libimobiledevice-e04f879ac0a211723db43fd8fc981225663e48f1.tar.bz2
file_relay: docs updated
-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 @@
1 /* 1 /*
2 * file_relay.c 2 * file_relay.c
3 * file_relay service implementation. 3 * com.apple.mobile.file_relay service implementation.
4 * 4 *
5 * Copyright (c) 2010 Nikias Bassen, All Rights Reserved. 5 * Copyright (c) 2010 Nikias Bassen, All Rights Reserved.
6 * 6 *
@@ -25,10 +25,10 @@
25#include "debug.h" 25#include "debug.h"
26 26
27/** 27/**
28 * Creates a new file_relay client. 28 * Connects to the file_relay service on the specified device.
29 * 29 *
30 * @param device The device to connect to. 30 * @param device The device to connect to.
31 * @param port Port on device to connect to. 31 * @param port Destination port (usually given by lockdownd_start_service).
32 * @param client Reference that will point to a newly allocated 32 * @param client Reference that will point to a newly allocated
33 * file_relay_client_t upon successful return. 33 * file_relay_client_t upon successful return.
34 * 34 *
@@ -57,9 +57,10 @@ file_relay_error_t file_relay_client_new(idevice_t device, uint16_t port, file_r
57} 57}
58 58
59/** 59/**
60 * Frees a file_relay client. 60 * Disconnects a file_relay client from the device and frees up the file_relay
61 * client data.
61 * 62 *
62 * @param client The file_relay_client_t to free. 63 * @param client The file_relay client to disconnect and free.
63 * 64 *
64 * @return FILE_RELAY_E_SUCCESS on success, 65 * @return FILE_RELAY_E_SUCCESS on success,
65 * FILE_RELAY_E_INVALID_ARG when one of client or client->parent 66 * 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 @@
1 /* 1 /*
2 * file_relay.h 2 * file_relay.h
3 * Definitions for the file_relay service 3 * com.apple.mobile.file_relay service header file.
4 * 4 *
5 * Copyright (c) 2010 Nikias Bassen, All Rights Reserved. 5 * Copyright (c) 2010 Nikias Bassen, All Rights Reserved.
6 * 6 *