[gtksourceview/wip/public-region] region: write docs



commit 47af27f28a5f643429e5b932b9df6075752d983d
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Apr 2 18:37:14 2016 +0200

    region: write docs

 gtksourceview/gtksourceregion.c |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/gtksourceview/gtksourceregion.c b/gtksourceview/gtksourceregion.c
index 3d79bc1..2939839 100644
--- a/gtksourceview/gtksourceregion.c
+++ b/gtksourceview/gtksourceregion.c
@@ -22,6 +22,21 @@
 
 #include "gtksourceregion.h"
 
+/**
+ * SECTION:region
+ * @Short_description: Region utility
+ * @Title: GtkSourceRegion
+ * @See_also: #GtkTextBuffer
+ *
+ * A #GtkSourceRegion permits to store a group of subregions of a
+ * #GtkTextBuffer. #GtkSourceRegion stores the subregions with pairs of
+ * #GtkTextMark's, so the region is still valid after insertions and deletions
+ * in the #GtkTextBuffer.
+ *
+ * The #GtkTextMark for the start of a subregion has a left gravity, while the
+ * #GtkTextMark for the end of a subregion has a right gravity.
+ */
+
 #undef ENABLE_DEBUG
 /*
 #define ENABLE_DEBUG


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