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

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

diff --git a/include/libimobiledevice/screenshotr.h b/include/libimobiledevice/screenshotr.h
index d9a3ffd..7e5c8a7 100644
--- a/include/libimobiledevice/screenshotr.h
+++ b/include/libimobiledevice/screenshotr.h
@@ -29,7 +29,8 @@ extern "C" {
 
 #include <libimobiledevice/libimobiledevice.h>
 
-/* Error Codes */
+/** @name Error Codes */
+/*@{*/
 #define SCREENSHOTR_E_SUCCESS                0
 #define SCREENSHOTR_E_INVALID_ARG           -1
 #define SCREENSHOTR_E_PLIST_ERROR           -2
@@ -37,7 +38,9 @@ extern "C" {
 #define SCREENSHOTR_E_BAD_VERSION           -4
 
 #define SCREENSHOTR_E_UNKNOWN_ERROR       -256
+/*@}*/
 
+/** Represents an error code. */
 typedef int16_t screenshotr_error_t;
 
 typedef struct screenshotr_client_private screenshotr_client_private;
-- 
cgit v1.1-32-gdbae