From 2342dc5b4ef148b993fbe3816f3facdef8365546 Mon Sep 17 00:00:00 2001
From: Aaron Burghardt
Date: Thu, 27 Mar 2014 10:07:09 -0400
Subject: Moved Doxygen comments from source files to public headers.

Conflicts:
	include/libimobiledevice/afc.h
---
 src/syslog_relay.c | 87 ------------------------------------------------------
 1 file changed, 87 deletions(-)

(limited to 'src/syslog_relay.c')

diff --git a/src/syslog_relay.c b/src/syslog_relay.c
index b908153..a636e6e 100644
--- a/src/syslog_relay.c
+++ b/src/syslog_relay.c
@@ -61,18 +61,6 @@ static syslog_relay_error_t syslog_relay_error(service_error_t err)
 	return SYSLOG_RELAY_E_UNKNOWN_ERROR;
 }
 
-/**
- * Connects to the syslog_relay service on the specified device.
- *
- * @param device The device to connect to.
- * @param service The service descriptor returned by lockdownd_start_service.
- * @param client Pointer that will point to a newly allocated
- *     syslog_relay_client_t upon successful return. Must be freed using
- *     syslog_relay_client_free() after use.
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when
- *     client is NULL, or an SYSLOG_RELAY_E_* error code otherwise.
- */
 syslog_relay_error_t syslog_relay_client_new(idevice_t device, lockdownd_service_descriptor_t service, syslog_relay_client_t * client)
 {
 	*client = NULL;
@@ -101,19 +89,6 @@ syslog_relay_error_t syslog_relay_client_new(idevice_t device, lockdownd_service
 	return 0;
 }
 
-/**
- * Starts a new syslog_relay service on the specified device and connects to it.
- *
- * @param device The device to connect to.
- * @param client Pointer that will point to a newly allocated
- *     syslog_relay_client_t upon successful return. Must be freed using
- *     syslog_relay_client_free() after use.
- * @param label The label to use for communication. Usually the program name.
- *  Pass NULL to disable sending the label in requests to lockdownd.
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success, or an SYSLOG_RELAY_E_* error
- *     code otherwise.
- */
 syslog_relay_error_t syslog_relay_client_start_service(idevice_t device, syslog_relay_client_t * client, const char* label)
 {
 	syslog_relay_error_t err = SYSLOG_RELAY_E_UNKNOWN_ERROR;
@@ -121,15 +96,6 @@ syslog_relay_error_t syslog_relay_client_start_service(idevice_t device, syslog_
 	return err;
 }
 
-/**
- * Disconnects a syslog_relay client from the device and frees up the
- * syslog_relay client data.
- *
- * @param client The syslog_relay client to disconnect and free.
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when
- *     client is NULL, or an SYSLOG_RELAY_E_* error code otherwise.
- */
 syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client)
 {
 	if (!client)
@@ -146,38 +112,11 @@ syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client)
 	return err;
 }
 
-/**
- * Receives data from the service.
- *
- * @param client The syslog_relay client
- * @param data Buffer that will be filled with the data received
- * @param size Number of bytes to receive
- * @param received Number of bytes received (can be NULL to ignore)
- * @param timeout Maximum time in milliseconds to wait for data.
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success,
- *  SYSLOG_RELAY_E_INVALID_ARG when client or plist is NULL
- */
 syslog_relay_error_t syslog_relay_receive(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received)
 {
 	return syslog_relay_receive_with_timeout(client, data, size, received, 1000);
 }
 
-/**
- * Receives data using the given syslog_relay client with specified timeout.
- *
- * @param client The syslog_relay client to use for receiving
- * @param data Buffer that will be filled with the data received
- * @param size Number of bytes to receive
- * @param received Number of bytes received (can be NULL to ignore)
- * @param timeout Maximum time in milliseconds to wait for data.
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success,
- *      SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
- *      invalid, SYSLOG_RELAY_E_MUX_ERROR when a communication error
- *      occurs, or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
- *      error occurs.
- */
 syslog_relay_error_t syslog_relay_receive_with_timeout(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received, unsigned int timeout)
 {
 	syslog_relay_error_t res = SYSLOG_RELAY_E_UNKNOWN_ERROR;
@@ -232,20 +171,6 @@ void *syslog_relay_worker(void *arg)
 	return NULL;
 }
 
-/**
- * Starts capturing the syslog of the device using a callback.
- *
- * Use syslog_relay_stop_capture() to stop receiving the syslog.
- *
- * @param client The syslog_relay client to use
- * @param callback Callback to receive each character from the syslog.
- * @param user_data Custom pointer passed to the callback function.
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success,
- *      SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
- *      invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
- *      error occurs or a syslog capture has already been started.
- */
 syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data)
 {
 	if (!client || !callback)
@@ -273,18 +198,6 @@ syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, sy
 	return res;
 }
 
-/**
- * Stops capturing the syslog of the device.
- *
- * Use syslog_relay_start_capture() to start receiving the syslog.
- *
- * @param client The syslog_relay client to use
- *
- * @return SYSLOG_RELAY_E_SUCCESS on success,
- *      SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
- *      invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
- *      error occurs or a syslog capture has already been started.
- */
 syslog_relay_error_t syslog_relay_stop_capture(syslog_relay_client_t client)
 {
 	if (client->worker) {
-- 
cgit v1.1-32-gdbae