From 08d2af5d611319748afba2aaba5e6c8a99f1b396 Mon Sep 17 00:00:00 2001
From: Martin Szulecki
Date: Tue, 16 Mar 2010 03:13:38 +0100
Subject: 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.
---
 include/libimobiledevice/afc.h | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

(limited to 'include/libimobiledevice/afc.h')

diff --git a/include/libimobiledevice/afc.h b/include/libimobiledevice/afc.h
index d800d19..c060eb7 100644
--- a/include/libimobiledevice/afc.h
+++ b/include/libimobiledevice/afc.h
@@ -29,7 +29,8 @@ extern "C" {
 
 #include <libimobiledevice/libimobiledevice.h>
 
-/* Error Codes */
+/** @name Error Codes */
+/*@{*/
 #define AFC_E_SUCCESS                 0
 #define AFC_E_UNKNOWN_ERROR           1
 #define AFC_E_OP_HEADER_INVALID       2
@@ -59,28 +60,32 @@ extern "C" {
 #define AFC_E_NO_MEM                 31
 #define AFC_E_NOT_ENOUGH_DATA        32
 #define AFC_E_DIR_NOT_EMPTY          33
+/*@}*/
 
+/** Represents an error code. */
 typedef int16_t afc_error_t;
 
-/* Flags */
+/** Flags for afc_file_open */
 typedef enum {
-	AFC_FOPEN_RDONLY   = 0x00000001, // r   O_RDONLY
-	AFC_FOPEN_RW       = 0x00000002, // r+  O_RDWR   | O_CREAT
-	AFC_FOPEN_WRONLY   = 0x00000003, // w   O_WRONLY | O_CREAT  | O_TRUNC
-	AFC_FOPEN_WR       = 0x00000004, // w+  O_RDWR   | O_CREAT  | O_TRUNC
-	AFC_FOPEN_APPEND   = 0x00000005, // a   O_WRONLY | O_APPEND | O_CREAT
-	AFC_FOPEN_RDAPPEND = 0x00000006  // a+  O_RDWR   | O_APPEND | O_CREAT
+	AFC_FOPEN_RDONLY   = 0x00000001, /**< r   O_RDONLY */
+	AFC_FOPEN_RW       = 0x00000002, /**< r+  O_RDWR   | O_CREAT */
+	AFC_FOPEN_WRONLY   = 0x00000003, /**< w   O_WRONLY | O_CREAT  | O_TRUNC */
+	AFC_FOPEN_WR       = 0x00000004, /**< w+  O_RDWR   | O_CREAT  | O_TRUNC */
+	AFC_FOPEN_APPEND   = 0x00000005, /**< a   O_WRONLY | O_APPEND | O_CREAT */
+	AFC_FOPEN_RDAPPEND = 0x00000006  /**< a+  O_RDWR   | O_APPEND | O_CREAT */
 } afc_file_mode_t;
 
+/** Type of link for afc_make_link() calls */
 typedef enum {
 	AFC_HARDLINK = 1,
 	AFC_SYMLINK = 2
 } afc_link_type_t;
 
+/** Lock operation flags */
 typedef enum {
-	AFC_LOCK_SH = 1 | 4, // shared lock
-	AFC_LOCK_EX = 2 | 4, // exclusive lock
-	AFC_LOCK_UN = 8 | 4  // unlock
+	AFC_LOCK_SH = 1 | 4, /**< shared lock */
+	AFC_LOCK_EX = 2 | 4, /**< exclusive lock */
+	AFC_LOCK_UN = 8 | 4  /**< unlock */
 } afc_lock_op_t;
 
 typedef struct afc_client_private afc_client_private;
-- 
cgit v1.1-32-gdbae