[gtk+] Move documentation to inline comments: GtkTextBuffer



commit 0553a5524dd2208fd8c82484458ac7c02a8b412d
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Apr 18 00:12:49 2011 +0100

    Move documentation to inline comments: GtkTextBuffer

 docs/reference/gtk/tmpl/.gitignore         |    1 +
 docs/reference/gtk/tmpl/gtktextbuffer.sgml |  974 ----------------------------
 gtk/gtktextbuffer.c                        |   12 +
 gtk/gtktextbufferrichtext.h                |   32 +
 4 files changed, 45 insertions(+), 974 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 35d3e2a..8c3a63d 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -113,6 +113,7 @@ gtkstyle.sgml
 gtktable.sgml
 gtktearoffmenuitem.sgml
 gtktesting.sgml
+gtktextbuffer.sgml
 gtktextiter.sgml
 gtktextmark.sgml
 gtktexttag.sgml
diff --git a/gtk/gtktextbuffer.c b/gtk/gtktextbuffer.c
index a576c69..24ca6e1 100644
--- a/gtk/gtktextbuffer.c
+++ b/gtk/gtktextbuffer.c
@@ -43,6 +43,18 @@
 #include "gtkintl.h"
 
 
+/**
+ * SECTION:gtktextbuffer
+ * @Short_description: Stores attributed text for display in a GtkTextView
+ * @Title: GtkTextBuffer
+ * @See_also: #GtkTextView, #GtkTextIter, #GtkTextMark
+ *
+ * You may wish to begin by reading the <link linkend="TextWidget">text widget
+ * conceptual overview</link> which gives an overview of all the objects and data
+ * types related to the text widget and how they work together.
+ */
+
+
 typedef struct _GtkTextLogAttrCache GtkTextLogAttrCache;
 
 struct _GtkTextBufferPrivate
diff --git a/gtk/gtktextbufferrichtext.h b/gtk/gtktextbufferrichtext.h
index 614b43d..795247e 100644
--- a/gtk/gtktextbufferrichtext.h
+++ b/gtk/gtktextbufferrichtext.h
@@ -30,12 +30,44 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GtkTextBufferSerializeFunc:
+ * @register_buffer: the #GtkTextBuffer for which the format is registered
+ * @content_buffer: the #GtkTextBuffer to serialize
+ * @start: start of the block of text to serialize
+ * @end: end of the block of text to serialize
+ * @length: Return location for the length of the serialized data
+ * @user_data: user data that was specified when registering the format
+ *
+ * A function that is called to serialize the content of a text buffer.
+ * It must return the serialized form of the content.
+ *
+ * Returns: a newly-allocated array of guint8 which contains the serialized
+ *   data, or %NULL if an error occurred
+ */
 typedef guint8 * (* GtkTextBufferSerializeFunc)   (GtkTextBuffer     *register_buffer,
                                                    GtkTextBuffer     *content_buffer,
                                                    const GtkTextIter *start,
                                                    const GtkTextIter *end,
                                                    gsize             *length,
                                                    gpointer           user_data);
+
+/**
+ * GtkTextBufferDeserializeFunc:
+ * @register_buffer: the #GtkTextBuffer the format is registered with
+ * @content_buffer: the #GtkTextBuffer to deserialize into
+ * @iter: insertion point for the deserialized text
+ * @data: data to deserialize
+ * @length: length of %data
+ * @create_tags: %TRUE if deserializing may create tags
+ * @user_data: user data that was specified when registering the format
+ * @error: return location for a #GError
+ *
+ * A function that is called to deserialize rich text that has been
+ * serialized with gtk_text_buffer_serialize(), and insert it at @iter.
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
+ */
 typedef gboolean (* GtkTextBufferDeserializeFunc) (GtkTextBuffer     *register_buffer,
                                                    GtkTextBuffer     *content_buffer,
                                                    GtkTextIter       *iter,



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