[libgsf] Documented enumeration types



commit 89b95713acfa59fe1897d6c47cce882a96bd71c9
Author: J.H.M. Dassen (Ray) <jdassen debian org>
Date:   Sat Mar 6 22:08:15 2010 +0100

    Documented enumeration types

 gsf/gsf-clip-data.h |   10 ++++++++++
 gsf/gsf-utils.h     |    6 ++++++
 2 files changed, 16 insertions(+), 0 deletions(-)
---
diff --git a/gsf/gsf-clip-data.h b/gsf/gsf-clip-data.h
index f96e121..5a90794 100644
--- a/gsf/gsf-clip-data.h
+++ b/gsf/gsf-clip-data.h
@@ -5,6 +5,16 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GsfClipFormat:
+ * @GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD: Windows clipboard format
+ * @GSF_CLIP_FORMAT_MACINTOSH_CLIPBOARD: Macintosh clipboard format
+ * @GSF_CLIP_FORMAT_GUID: GUID that contains a format identifier
+ * @GSF_CLIP_FORMAT_NO_DATA: No clipboard data
+ * @GSF_CLIP_FORMAT_CLIPBOARD_FORMAT_NAME: Custom clipboard format
+ * @GSF_CLIP_FORMAT_UNKNOWN: Unknown clipboard type or invalid data
+ */
+
 typedef enum {
 	GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD = -1,
 	GSF_CLIP_FORMAT_MACINTOSH_CLIPBOARD = -2,
diff --git a/gsf/gsf-utils.h b/gsf/gsf-utils.h
index 41aeaa8..c61d7e4 100644
--- a/gsf/gsf-utils.h
+++ b/gsf/gsf-utils.h
@@ -318,6 +318,12 @@ void        gsf_property_settings_free (GParameter *params,
 
 #define GSF_ERROR (gsf_error_quark ())
 
+/**
+ * GsfError:
+ * @GSF_ERROR_OUT_OF_MEMORY: Memory allocation failed
+ * @GSF_ERROR_INVALID_DATA: Invalid data encountered (e.g. not enough data)
+ */
+
 typedef enum {
 	GSF_ERROR_OUT_OF_MEMORY,
 	GSF_ERROR_INVALID_DATA



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]