[gtksourceview] Document completion error symbols



commit 4bcfe83589dfcfd8bab05021e902db3faccbe4ed
Author: SÃbastien Wilmet <swilmet gnome org>
Date:   Thu Dec 27 13:31:45 2012 +0100

    Document completion error symbols
    
    GTK_SOURCE_COMPLETION_ERROR_ALREADY_BOUND is used only in
    gtk_source_completion_add_provider().
    
    GTK_SOURCE_COMPLETION_ERROR_NOT_BOUND is used only in
    gtk_source_completion_remove_provider().

 docs/reference/gtksourceview-3.0-sections.txt |    6 +++++-
 gtksourceview/gtksourcecompletion.h           |   17 +++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/gtksourceview-3.0-sections.txt b/docs/reference/gtksourceview-3.0-sections.txt
index a209f4b..4723240 100644
--- a/docs/reference/gtksourceview-3.0-sections.txt
+++ b/docs/reference/gtksourceview-3.0-sections.txt
@@ -446,6 +446,9 @@ GtkSourcePrintCompositorClass
 <FILE>completion</FILE>
 <TITLE>GtkSourceCompletion</TITLE>
 GtkSourceCompletion
+GTK_SOURCE_COMPLETION_ERROR
+GtkSourceCompletionError
+<SUBSECTION>
 gtk_source_completion_add_provider
 gtk_source_completion_remove_provider
 gtk_source_completion_get_providers
@@ -465,8 +468,9 @@ GTK_SOURCE_COMPLETION_CLASS
 GTK_SOURCE_COMPLETION_GET_CLASS
 GTK_SOURCE_TYPE_COMPLETION
 GtkSourceCompletionPrivate
-gtk_source_completion_get_type
 GtkSourceCompletionClass
+gtk_source_completion_get_type
+gtk_source_completion_error_quark
 </SECTION>
 
 <SECTION>
diff --git a/gtksourceview/gtksourcecompletion.h b/gtksourceview/gtksourcecompletion.h
index 116b76e..dec8c7f 100644
--- a/gtksourceview/gtksourcecompletion.h
+++ b/gtksourceview/gtksourcecompletion.h
@@ -38,11 +38,28 @@ G_BEGIN_DECLS
 #define GTK_SOURCE_IS_COMPLETION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_SOURCE_TYPE_COMPLETION))
 #define GTK_SOURCE_COMPLETION_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_SOURCE_TYPE_COMPLETION, GtkSourceCompletionClass))
 
+/**
+ * GTK_SOURCE_COMPLETION_ERROR:
+ *
+ * Error domain for the completion. Errors in this domain will be from the
+ * #GtkSourceCompletionError enumeration. See #GError for more information on
+ * error domains.
+ */
 #define GTK_SOURCE_COMPLETION_ERROR		(gtk_source_completion_error_quark ())
 
 typedef struct _GtkSourceCompletionPrivate GtkSourceCompletionPrivate;
 typedef struct _GtkSourceCompletionClass GtkSourceCompletionClass;
 
+/**
+ * GtkSourceCompletionError:
+ * @GTK_SOURCE_COMPLETION_ERROR_ALREADY_BOUND: The #GtkSourceCompletionProvider
+ * is already bound to the #GtkSourceCompletion object.
+ * @GTK_SOURCE_COMPLETION_ERROR_NOT_BOUND: The #GtkSourceCompletionProvider is
+ * not bound to the #GtkSourceCompletion object.
+ *
+ * An error code used with %GTK_SOURCE_COMPLETION_ERROR in a #GError returned
+ * from a completion-related function.
+ */
 typedef enum
 {
 	GTK_SOURCE_COMPLETION_ERROR_ALREADY_BOUND = 0,



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