[gtksourceview] Added API documentation for GtkSourceUndoManager

[Jesse van den Kieboom <jessevdk src gnome org>]

commit 415045731a4953aa77e1c219f9d8d59f655772f8
Author: Jesse van den Kieboom <jessevdk gnome org>
Date:   Sun Feb 21 15:11:53 2010 +0100

    Added API documentation for GtkSourceUndoManager

 docs/reference/Makefile.am                    |    2 +-
 docs/reference/gtksourceview-2.0-sections.txt |   22 ++++++++++++
 docs/reference/gtksourceview-2.0.types        |    2 +
 docs/reference/gtksourceview-docs.sgml        |    1 +
 gtksourceview/gtksourceundomanager.c          |   45 +++++++++++++++++++++++-
 5 files changed, 69 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 0464835..ca17ccd 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -25,7 +25,6 @@ IGNORE_HFILES =					\
 	config.h				\
 	gtksourcelanguage-private.h		\
 	gtksourcetag-private.h			\
-	gtksourceundomanager.h			\
 	gtksourceview-i18n.h			\
 	gtksourceview-marshal.h			\
 	gtksourceview-typebuiltins.h		\
@@ -38,6 +37,7 @@ IGNORE_HFILES =					\
 	gtksourcegutter-private.h		\
 	gtksourcecompletionmodel.h		\
 	gtksourcecompletionutils.h		\
+	gtksourceundomanagerdefault.h		\
 	../tests/gsc-devhelp-provider.h		\
 	../tests/gsc-words-provider.h
 
diff --git a/docs/reference/gtksourceview-2.0-sections.txt b/docs/reference/gtksourceview-2.0-sections.txt
index 452e0a7..dc3209a 100644
--- a/docs/reference/gtksourceview-2.0-sections.txt
+++ b/docs/reference/gtksourceview-2.0-sections.txt
@@ -127,6 +127,28 @@ gtk_source_gutter_get_type
 </SECTION>
 
 <SECTION>
+<FILE>undomanager</FILE>
+<TITLE>GtkSourceUndoManager</TITLE>
+<INCLUDE>gtksourceview/gtksourceundomanager.h</INCLUDE>
+GtkSourceUndoManager
+GtkSourceUndoManagerIface
+gtk_source_undo_manager_can_undo
+gtk_source_undo_manager_can_redo
+gtk_source_undo_manager_undo
+gtk_source_undo_manager_redo
+gtk_source_undo_manager_begin_not_undoable_action
+gtk_source_undo_manager_end_not_undoable_action
+gtk_source_undo_manager_can_undo_changed
+gtk_source_undo_manager_can_redo_changed
+<SUBSECTION Standard>
+GTK_SOURCE_UNDO_MANAGER
+GTK_IS_SOURCE_UNDO_MANAGER
+GTK_TYPE_SOURCE_UNDO_MANAGER
+GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE
+gtk_source_undo_manager_get_type
+</SECTION>
+
+<SECTION>
 <FILE>language</FILE>
 <TITLE>GtkSourceLanguage</TITLE>
 <INCLUDE>gtksourceview/gtksourcelanguage.h</INCLUDE>
diff --git a/docs/reference/gtksourceview-2.0.types b/docs/reference/gtksourceview-2.0.types
index 0fb1298..d3a9be1 100644
--- a/docs/reference/gtksourceview-2.0.types
+++ b/docs/reference/gtksourceview-2.0.types
@@ -6,6 +6,7 @@
 #include <gtksourceview/gtksourcestyleschememanager.h>
 #include <gtksourceview/gtksourcemark.h>
 #include <gtksourceview/gtksourcegutter.h>
+#include <gtksourceview/gtksourceundomanager.h>
 
 #include <gtksourceview/gtksourcecompletion.h>
 #include <gtksourceview/gtksourcecompletionprovider.h>
@@ -30,3 +31,4 @@ gtk_source_completion_proposal_get_type
 gtk_source_completion_item_get_type
 gtk_source_completion_info_get_type
 gtk_source_gutter_get_type
+gtk_source_undo_manager_get_type
diff --git a/docs/reference/gtksourceview-docs.sgml b/docs/reference/gtksourceview-docs.sgml
index 1845770..f3f8dbd 100644
--- a/docs/reference/gtksourceview-docs.sgml
+++ b/docs/reference/gtksourceview-docs.sgml
@@ -31,6 +31,7 @@
     <xi:include href="xml/style.xml"/>
     <xi:include href="xml/stylescheme.xml"/>
     <xi:include href="xml/styleschememanager.xml"/>
+    <xi:include href="xml/undomanager.xml"/>
   </reference>
 
   <reference>
diff --git a/gtksourceview/gtksourceundomanager.c b/gtksourceview/gtksourceundomanager.c
index 1c16e8a..1cb5b4e 100644
--- a/gtksourceview/gtksourceundomanager.c
+++ b/gtksourceview/gtksourceundomanager.c
@@ -33,6 +33,25 @@
 #include "gtksourceundomanager.h"
 #include "gtksourceview-marshal.h"
 
+/**
+ * SECTION:undomanager
+ * @short_description: Undo manager interface for #GtkSourceView
+ * @title: GtkSourceUndoManager
+ * @see_also: #GtkTextBuffer, #GtkSourceView
+ *
+ * The #GtkSourceUndoManager interface can be implemented to provide custom
+ * undo management to a #GtkSourceBuffer. Use
+ * #gtk_source_buffer_set_undo_manager to install a custom undo manager for
+ * a particular source buffer.
+ *
+ * Use #gtk_source_undo_manager_can_undo_changed and
+ * #gtk_source_undo_manager_can_redo_changed when respectively the undo state
+ * or redo state of the undo stack has changed.
+ *
+ * Since: 2.10
+ *
+ */
+
 /* Signals */
 enum
 {
@@ -97,6 +116,8 @@ gtk_source_undo_manager_init (GtkSourceUndoManagerIface *iface)
 		 *
 		 * Emitted when the ability to undo has changed.
 		 *
+		 * Since: 2.10
+		 *
 		 */
 		signals[CAN_UNDO_CHANGED] =
 			g_signal_new ("can-undo-changed",
@@ -115,6 +136,8 @@ gtk_source_undo_manager_init (GtkSourceUndoManagerIface *iface)
 		 *
 		 * Emitted when the ability to redo has changed.
 		 *
+		 * Since: 2.10
+		 *
 		 */
 		signals[CAN_REDO_CHANGED] =
 			g_signal_new ("can-redo-changed",
@@ -170,7 +193,10 @@ gtk_source_undo_manager_get_type ()
  *
  * Get whether there are undo operations available.
  *
+ * Since: 2.10
+ *
  * Returns: %TRUE if there are undo operations available, %FALSE otherwise
+ *
  */
 gboolean
 gtk_source_undo_manager_can_undo (GtkSourceUndoManager *manager)
@@ -185,7 +211,10 @@ gtk_source_undo_manager_can_undo (GtkSourceUndoManager *manager)
  *
  * Get whether there are redo operations available.
  *
+ * Since: 2.10
+ *
  * Returns: %TRUE if there are redo operations available, %FALSE otherwise
+ *
  */
 gboolean
 gtk_source_undo_manager_can_redo (GtkSourceUndoManager *manager)
@@ -202,6 +231,8 @@ gtk_source_undo_manager_can_redo (GtkSourceUndoManager *manager)
  * available is an error. Use #gtk_source_undo_manager_can_undo to find out
  * if there are undo operations available.
  *
+ * Since: 2.10
+ *
  */
 void
 gtk_source_undo_manager_undo (GtkSourceUndoManager *manager)
@@ -218,6 +249,8 @@ gtk_source_undo_manager_undo (GtkSourceUndoManager *manager)
  * available is an error. Use #gtk_source_undo_manager_can_redo to find out
  * if there are redo operations available.
  *
+ * Since: 2.10
+ *
  */
 void
 gtk_source_undo_manager_redo (GtkSourceUndoManager *manager)
@@ -234,6 +267,8 @@ gtk_source_undo_manager_redo (GtkSourceUndoManager *manager)
  * and the call to #gtk_source_undo_manager_end_not_undoable_action cannot
  * be undone. This function should be re-entrant.
  *
+ * Since: 2.10
+ *
  */
 void
 gtk_source_undo_manager_begin_not_undoable_action (GtkSourceUndoManager *manager)
@@ -248,6 +283,8 @@ gtk_source_undo_manager_begin_not_undoable_action (GtkSourceUndoManager *manager
  *
  * Ends a not undoable action on the buffer.
  *
+ * Since: 2.10
+ *
  */
 void
 gtk_source_undo_manager_end_not_undoable_action (GtkSourceUndoManager *manager)
@@ -260,7 +297,9 @@ gtk_source_undo_manager_end_not_undoable_action (GtkSourceUndoManager *manager)
  * gtk_source_undo_manager_can_undo_changed:
  * @manager: A #GtkSourceUndoManager
  * 
- * Emits the ::can-undo-changed signal.
+ * Emits the #GtkSourceUndoManager::can-undo-changed signal.
+ *
+ * Since: 2.10
  *
  **/
 void
@@ -275,7 +314,9 @@ gtk_source_undo_manager_can_undo_changed (GtkSourceUndoManager *manager)
  * gtk_source_undo_manager_can_redo_changed:
  * @manager: A #GtkSourceUndoManager
  * 
- * Emits the ::can-redo-changed signal.
+ * Emits the #GtkSourceUndoManager::can-redo-changed signal.
+ *
+ * Since: 2.10
  *
  **/
 void