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/heartbeat.c | 67 ---------------------------------------------------------
 1 file changed, 67 deletions(-)

(limited to 'src/heartbeat.c')

diff --git a/src/heartbeat.c b/src/heartbeat.c
index e03b44e..7654dd0 100644
--- a/src/heartbeat.c
+++ b/src/heartbeat.c
@@ -58,18 +58,6 @@ static heartbeat_error_t heartbeat_error(property_list_service_error_t err)
 	return HEARTBEAT_E_UNKNOWN_ERROR;
 }
 
-/**
- * Connects to the heartbeat 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
- *     heartbeat_client_t upon successful return. Must be freed using
- *     heartbeat_client_free() after use.
- *
- * @return HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when
- *     client is NULL, or an HEARTBEAT_E_* error code otherwise.
- */
 heartbeat_error_t heartbeat_client_new(idevice_t device, lockdownd_service_descriptor_t service, heartbeat_client_t * client)
 {
 	*client = NULL;
@@ -97,19 +85,6 @@ heartbeat_error_t heartbeat_client_new(idevice_t device, lockdownd_service_descr
 	return 0;
 }
 
-/**
- * Starts a new heartbeat 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
- *     heartbeat_client_t upon successful return. Must be freed using
- *     heartbeat_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 HEARTBEAT_E_SUCCESS on success, or an HEARTBEAT_E_* error
- *     code otherwise.
- */
 heartbeat_error_t heartbeat_client_start_service(idevice_t device, heartbeat_client_t * client, const char* label)
 {
 	heartbeat_error_t err = HEARTBEAT_E_UNKNOWN_ERROR;
@@ -117,15 +92,6 @@ heartbeat_error_t heartbeat_client_start_service(idevice_t device, heartbeat_cli
 	return err;
 }
 
-/**
- * Disconnects a heartbeat client from the device and frees up the
- * heartbeat client data.
- *
- * @param client The heartbeat client to disconnect and free.
- *
- * @return HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when
- *     client is NULL, or an HEARTBEAT_E_* error code otherwise.
- */
 heartbeat_error_t heartbeat_client_free(heartbeat_client_t client)
 {
 	if (!client)
@@ -137,15 +103,6 @@ heartbeat_error_t heartbeat_client_free(heartbeat_client_t client)
 	return err;
 }
 
-/**
- * Sends a plist to the service.
- *
- * @param client The heartbeat client
- * @param plist The plist to send
- *
- * @return HEARTBEAT_E_SUCCESS on success,
- *  HEARTBEAT_E_INVALID_ARG when client or plist is NULL
- */
 heartbeat_error_t heartbeat_send(heartbeat_client_t client, plist_t plist)
 {
 	heartbeat_error_t res = HEARTBEAT_E_UNKNOWN_ERROR;
@@ -161,35 +118,11 @@ heartbeat_error_t heartbeat_send(heartbeat_client_t client, plist_t plist)
 	return res;
 }
 
-/**
- * Receives a plist from the service.
- *
- * @param client The heartbeat client
- * @param plist The plist to store the received data
- *
- * @return HEARTBEAT_E_SUCCESS on success,
- *  HEARTBEAT_E_INVALID_ARG when client or plist is NULL
- */
 heartbeat_error_t heartbeat_receive(heartbeat_client_t client, plist_t * plist)
 {
 	return heartbeat_receive_with_timeout(client, plist, 1000);
 }
 
-/**
- * Receives a plist using the given heartbeat client.
- *
- * @param client The heartbeat client to use for receiving
- * @param plist pointer to a plist_t that will point to the received plist
- *      upon successful return
- * @param timeout Maximum time in milliseconds to wait for data.
- *
- * @return HEARTBEAT_E_SUCCESS on success,
- *      HEARTBEAT_E_INVALID_ARG when client or *plist is NULL,
- *      HEARTBEAT_E_PLIST_ERROR when the received data cannot be
- *      converted to a plist, HEARTBEAT_E_MUX_ERROR when a
- *      communication error occurs, or HEARTBEAT_E_UNKNOWN_ERROR
- *      when an unspecified error occurs.
- */
 heartbeat_error_t heartbeat_receive_with_timeout(heartbeat_client_t client, plist_t * plist, uint32_t timeout_ms)
 {
 	heartbeat_error_t res = HEARTBEAT_E_UNKNOWN_ERROR;
-- 
cgit v1.1-32-gdbae