[gtk+] Move GtkTextTag docs inline



commit 6cf78a12c1e179b2d5eef4f045e242ceae475709
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jan 14 17:49:48 2011 -0500

    Move GtkTextTag docs inline

 docs/reference/gtk/tmpl/.gitignore      |    1 +
 docs/reference/gtk/tmpl/gtktexttag.sgml |  498 -------------------------------
 gtk/gtkenums.h                          |   13 +-
 gtk/gtktextattributes.h                 |    8 +
 gtk/gtktexttag.c                        |   16 +
 5 files changed, 37 insertions(+), 499 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 1cea81d..2d8d067 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -67,6 +67,7 @@ gtkstatusbar.sgml
 gtkstyle.sgml
 gtktesting.sgml
 gtktextiter.sgml
+gtktexttag.sgml
 gtktexttagtable.sgml
 gtktextview.sgml
 gtktoggleaction.sgml
diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h
index e62e43e..78ea40c 100644
--- a/gtk/gtkenums.h
+++ b/gtk/gtkenums.h
@@ -619,7 +619,18 @@ typedef enum
   GTK_WINDOW_POPUP
 } GtkWindowType;
 
-/* Text wrap */
+/**
+ * GtkWrapMode:
+ * @GTK_WRAP_NONE: do not wrap lines; just make the text area wider
+ * @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can
+ *     appear (between characters, usually - if you want to be technical,
+ *     between graphemes, see pango_get_log_attrs())
+ * @GTK_WRAP_WORD: wrap text, breaking lines in between words
+ * @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if
+ *     that is not enough, also between graphemes
+ *
+ * Describes a type of line wrapping.
+ */
 typedef enum
 {
   GTK_WRAP_NONE,
diff --git a/gtk/gtktextattributes.h b/gtk/gtktextattributes.h
index 5d43676..aa7d6f8 100644
--- a/gtk/gtktextattributes.h
+++ b/gtk/gtktextattributes.h
@@ -67,6 +67,14 @@ typedef struct _GtkTextAttributes GtkTextAttributes;
 
 typedef struct _GtkTextAppearance GtkTextAppearance;
 
+/**
+ * GtkTextAttributes:
+ *
+ * Using #GtkTextAttributes directly should rarely be necessary.
+ * It's primarily useful with gtk_text_iter_get_attributes().
+ * As with most GTK+ structs, the fields in this struct should only
+ * be read, never modified directly.
+ */
 struct _GtkTextAppearance
 {
   /*< public >*/
diff --git a/gtk/gtktexttag.c b/gtk/gtktexttag.c
index 9d9e788..bae8826 100644
--- a/gtk/gtktexttag.c
+++ b/gtk/gtktexttag.c
@@ -47,6 +47,22 @@
  *
  */
 
+/**
+ * SECTION:GtkTextTag
+ * @Title: GtkTextTag
+ * @Short_description: A tag that can be applied to text in a GtkTextBuffer
+ *
+ * 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.
+ *
+ * Tags should be in the #GtkTextTagTable for a given #GtkTextBuffer
+ * before using them with that buffer.
+ *
+ * gtk_text_buffer_create_tag() is the best way to create tags.
+ * See <application>gtk3-demo</application> for numerous examples.
+ */
+
 #include "config.h"
 
 #include <stdlib.h>



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