summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/file_relay.h
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2010-03-16 03:13:38 +0100
committerGravatar Martin Szulecki2010-03-16 03:13:38 +0100
commit08d2af5d611319748afba2aaba5e6c8a99f1b396 (patch)
tree8bf4a3533f2acf11368dc37a9c653689ace99b77 /include/libimobiledevice/file_relay.h
parent3e0c5021100c879ff7d0776d4c7bb4f0ec88e0d7 (diff)
downloadlibimobiledevice-08d2af5d611319748afba2aaba5e6c8a99f1b396.tar.gz
libimobiledevice-08d2af5d611319748afba2aaba5e6c8a99f1b396.tar.bz2
Complete documentation of public interface and fix a lot of bogus comments
This change unifies the documentation comment syntax, fixes a few bad documentation comments and completes documentation where it was missing.
Diffstat (limited to 'include/libimobiledevice/file_relay.h')
-rw-r--r--include/libimobiledevice/file_relay.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/libimobiledevice/file_relay.h b/include/libimobiledevice/file_relay.h
index dd65b38..b3900db 100644
--- a/include/libimobiledevice/file_relay.h
+++ b/include/libimobiledevice/file_relay.h
@@ -29,7 +29,8 @@ extern "C" {
#include <libimobiledevice/libimobiledevice.h>
-/* Error Codes */
+/** @name Error Codes */
+/*@{*/
#define FILE_RELAY_E_SUCCESS 0
#define FILE_RELAY_E_INVALID_ARG -1
#define FILE_RELAY_E_PLIST_ERROR -2
@@ -38,7 +39,9 @@ extern "C" {
#define FILE_RELAY_E_STAGING_EMPTY -5
#define FILE_RELAY_E_UNKNOWN_ERROR -256
+/*@}*/
+/** Represents an error code. */
typedef int16_t file_relay_error_t;
typedef struct file_relay_client_private file_relay_client_private;