diff options
author | Javier Jardón <jjardon@gnome.org> | 2010-11-06 02:41:09 +0100 |
---|---|---|
committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2010-11-08 11:31:01 +0900 |
commit | 0331e1fab7f7c1d25662fc1b8156e78b1ed89954 (patch) | |
tree | 70a4da5dd1a7d3e01357f72cdf22c0e30f6d1654 /gtk | |
parent | 3b541bcfd4ab43c66849e80bac2fb2953ae150b9 (diff) | |
download | gtk+-0331e1fab7f7c1d25662fc1b8156e78b1ed89954.tar.gz |
docs: Move documentation to inline comments: GtkTextView
Diffstat (limited to 'gtk')
-rw-r--r-- | gtk/gtktextchild.h | 12 | ||||
-rw-r--r-- | gtk/gtktextview.c | 12 | ||||
-rw-r--r-- | gtk/gtktextview.h | 6 |
3 files changed, 25 insertions, 5 deletions
diff --git a/gtk/gtktextchild.h b/gtk/gtktextchild.h index 7835e68f91..dd132f4278 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 27c21d0edd..78d380f98a 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 4e64b33e15..2853c63962 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; |