[gtksourceview] Doc: small section for the CompletionWords provider



commit 6e77d9ca173e32f407ba436ffa3d4174e193e652
Author: SÃbastien Wilmet <swilmet gnome org>
Date:   Sat Jan 12 18:47:49 2013 +0100

    Doc: small section for the CompletionWords provider

 .../words/gtksourcecompletionwords.c               |   12 +++++++++++-
 1 files changed, 11 insertions(+), 1 deletions(-)
---
diff --git a/gtksourceview/completion-providers/words/gtksourcecompletionwords.c b/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
index d09a175..a57986e 100644
--- a/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
+++ b/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
@@ -19,6 +19,16 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+/**
+ * SECTION:completionwords
+ * @title: GtkSourceCompletionWords
+ * @short_description: A #GtkSourceCompletionProvider for the completion of words
+ *
+ * The #GtkSourceCompletionWords is an example of an implementation of
+ * the #GtkSourceCompletionProvider interface. The proposals are words
+ * appearing in the registered #GtkTextBuffer<!-- -->s.
+ */
+
 #include "gtksourcecompletionwords.h"
 #include "gtksourcecompletionwordslibrary.h"
 #include "gtksourcecompletionwordsbuffer.h"
@@ -650,7 +660,7 @@ gtk_source_completion_words_register (GtkSourceCompletionWords *words,
  * @words: a #GtkSourceCompletionWords
  * @buffer: a #GtkTextBuffer
  *
- * Unregisters @buffer from teh @words provider.
+ * Unregisters @buffer from the @words provider.
  */
 void
 gtk_source_completion_words_unregister (GtkSourceCompletionWords *words,



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