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/installation_proxy.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

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

diff --git a/include/libimobiledevice/installation_proxy.h b/include/libimobiledevice/installation_proxy.h
index 8a7cfb9..2bf738d 100644
--- a/include/libimobiledevice/installation_proxy.h
+++ b/include/libimobiledevice/installation_proxy.h
@@ -30,7 +30,8 @@ extern "C" {
 #include <libimobiledevice/libimobiledevice.h>
 #include <glib.h>
 
-/* Error Codes */
+/** @name Error Codes */
+/*@{*/
 #define INSTPROXY_E_SUCCESS                0
 #define INSTPROXY_E_INVALID_ARG           -1
 #define INSTPROXY_E_PLIST_ERROR           -2
@@ -39,12 +40,15 @@ extern "C" {
 #define INSTPROXY_E_OP_FAILED             -5
 
 #define INSTPROXY_E_UNKNOWN_ERROR       -256
+/*@}*/
 
+/** Represents an error code. */
 typedef int16_t instproxy_error_t;
 
 typedef struct instproxy_client_private instproxy_client_private;
 typedef instproxy_client_private *instproxy_client_t; /**< The client handle. */
 
+/** Reports the status of the given operation */
 typedef void (*instproxy_status_cb_t) (const char *operation, plist_t status);
 
 /* Interface */
-- 
cgit v1.1-32-gdbae