[clutter] docs: Document ClutterTextBuffer structures



commit 2b35b2a0816155903a2fed663b0a456ee3e74241
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Thu Feb 23 11:54:41 2012 +0000

    docs: Document ClutterTextBuffer structures

 clutter/clutter-text-buffer.h |   29 ++++++++++++++++++++++++++---
 1 files changed, 26 insertions(+), 3 deletions(-)
---
diff --git a/clutter/clutter-text-buffer.h b/clutter/clutter-text-buffer.h
index 0079ff3..a21e3ac 100644
--- a/clutter/clutter-text-buffer.h
+++ b/clutter/clutter-text-buffer.h
@@ -44,20 +44,43 @@ typedef struct _ClutterTextBuffer            ClutterTextBuffer;
 typedef struct _ClutterTextBufferClass       ClutterTextBufferClass;
 typedef struct _ClutterTextBufferPrivate     ClutterTextBufferPrivate;
 
+/**
+ * ClutterTextBuffer:
+ *
+ * The <structname>ClutterTextBuffer</structname> structure contains private
+ * data and it should only be accessed using the provided API.
+ *
+ * Since: 1.10
+ */
 struct _ClutterTextBuffer
 {
+  /*< private >*/
   GObject parent_instance;
 
-  /*< private >*/
   ClutterTextBufferPrivate *priv;
 };
 
+/**
+ * ClutterTextBufferClass:
+ * @inserted_text: default handler for the #ClutterTextBuffer::inserted-text signal
+ * @deleted_text: default hanlder for the #ClutterTextBuffer::deleted-text signal
+ * @get_text: virtual function
+ * @get_length: virtual function
+ * @insert_text: virtual function
+ * @delete_text: virtual function
+ *
+ * The <structname>ClutterTextBufferClass</structname> structure contains
+ * only private data.
+ *
+ * Since: 1.10
+ */
 struct _ClutterTextBufferClass
 {
+  /*< private >*/
   GObjectClass parent_class;
 
+  /*< public >*/
   /* Signals */
-
   void         (*inserted_text)          (ClutterTextBuffer *buffer,
                                           guint              position,
                                           const gchar       *chars,
@@ -68,7 +91,6 @@ struct _ClutterTextBufferClass
                                           guint              n_chars);
 
   /* Virtual Methods */
-
   const gchar* (*get_text)               (ClutterTextBuffer *buffer,
                                           gsize             *n_bytes);
 
@@ -83,6 +105,7 @@ struct _ClutterTextBufferClass
                                           guint              position,
                                           guint              n_chars);
 
+  /*< private >*/
   /* Padding for future expansion */
   void (*_clutter_reserved1) (void);
   void (*_clutter_reserved2) (void);



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