[gtk+] docs: Move documentation to inline comments: GtkTextView
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] docs: Move documentation to inline comments: GtkTextView
- Date: Sat, 6 Nov 2010 02:26:25 +0000 (UTC)
commit f90bdb33c85d596e0396fdf9cd88878a600bc5eb
Author: Javier Jardón <jjardon gnome org>
Date: Sat Nov 6 02:41:09 2010 +0100
docs: Move documentation to inline comments: GtkTextView
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtktextview.sgml | 883 ------------------------------
gtk/gtktextchild.h | 12 +-
gtk/gtktextview.c | 12 +
gtk/gtktextview.h | 6 +
5 files changed, 26 insertions(+), 888 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 59036d9..4c4c615 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -48,6 +48,7 @@ gtkstyle.sgml
gtktesting.sgml
gtktextiter.sgml
gtktexttagtable.sgml
+gtktextview.sgml
gtktoggleaction.sgml
gtktoolbar.sgml
gtktoolitem.sgml
diff --git a/gtk/gtktextchild.h b/gtk/gtktextchild.h
index 7835e68..dd132f4 100644
--- a/gtk/gtktextchild.h
+++ b/gtk/gtktextchild.h
@@ -36,12 +36,14 @@
G_BEGIN_DECLS
-/* A GtkTextChildAnchor is a spot in the buffer where child widgets
- * can be "anchored" (inserted inline, as if they were characters).
- * The anchor can have multiple widgets anchored, to allow for multiple
- * views.
- */
+/**
+ * GtkTextChildAnchor:
+ *
+ * A #GtkTextChildAnchor is a spot in the buffer where child widgets can
+ * be "anchored" (inserted inline, as if they were characters). The anchor
+ * can have multiple widgets anchored, to allow for multiple views.
+ */
typedef struct _GtkTextChildAnchor GtkTextChildAnchor;
typedef struct _GtkTextChildAnchorClass GtkTextChildAnchorClass;
diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c
index 4e6d372..de6619d 100644
--- a/gtk/gtktextview.c
+++ b/gtk/gtktextview.c
@@ -52,6 +52,18 @@
#include "gtkscrollable.h"
+/**
+ * SECTION:gtktextview
+ * @Short_description: Widget that displays a GtkTextBuffer
+ * @Title: GtkTextView
+ * @See_also: #GtkTextBuffer, #GtkTextIter
+ *
+ * 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.
+ */
+
+
/* How scrolling, validation, exposes, etc. work.
*
* The expose_event handler has the invariant that the onscreen lines
diff --git a/gtk/gtktextview.h b/gtk/gtktextview.h
index 4e64b33..2853c63 100644
--- a/gtk/gtktextview.h
+++ b/gtk/gtktextview.h
@@ -56,6 +56,12 @@ typedef enum
GTK_TEXT_WINDOW_BOTTOM
} GtkTextWindowType;
+/**
+ * GTK_TEXT_VIEW_PRIORITY_VALIDATE:
+ *
+ * The priority at which the text view validates onscreen lines
+ * in an idle job in the background.
+ */
#define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5)
typedef struct _GtkTextView GtkTextView;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]