[gtksourceview/wip/improve-doc: 2/4] docs: better description of GtkSourceView and GtkSourceBuffer



commit eee40df59074f90cf1067c5ca4da228d51a7d4aa
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Nov 22 18:28:33 2014 +0100

    docs: better description of GtkSourceView and GtkSourceBuffer

 gtksourceview/gtksourcebuffer.c |    9 ++++-----
 gtksourceview/gtksourceview.c   |    7 +++----
 2 files changed, 7 insertions(+), 9 deletions(-)
---
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 2b55820..237a3b4 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -47,15 +47,14 @@
 
 /**
  * SECTION:buffer
- * @Short_description: Buffer object for GtkSourceView
+ * @Short_description: Stores the text for display in a GtkSourceView
  * @Title: GtkSourceBuffer
  * @See_also: #GtkTextBuffer, #GtkSourceView
  *
- * The #GtkSourceBuffer object is the model for #GtkSourceView widgets.
- * It extends the #GtkTextBuffer object by adding features useful to display
+ * A #GtkSourceBuffer object is the model for #GtkSourceView widgets.
+ * It extends the #GtkTextBuffer class by adding features useful to display
  * and edit source code such as syntax highlighting and bracket matching. It
- * also implements support for undo/redo operations, and for the search and
- * replace.
+ * also implements support for undo/redo operations, and the search and replace.
  *
  * To create a #GtkSourceBuffer use gtk_source_buffer_new() or
  * gtk_source_buffer_new_with_language(). The second form is just a convenience
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index a2c9856..9fe88a4 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -49,13 +49,12 @@
 
 /**
  * SECTION:view
- * @Short_description: The view object
+ * @Short_description: Widget that displays a GtkSourceBuffer
  * @Title: GtkSourceView
  * @See_also: #GtkTextView, #GtkSourceBuffer
  *
- * #GtkSourceView is the main object of the GtkSourceView library. It provides
- * a text view with syntax highlighting, undo/redo and text marks. Use a
- * #GtkSourceBuffer to display text with a #GtkSourceView.
+ * #GtkSourceView is the main class of the GtkSourceView library.
+ * Use a #GtkSourceBuffer to display text with a #GtkSourceView.
  *
  * # GtkSourceView as GtkBuildable
  *


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