[gtksourceviewmm] Documented SourceCompletionContext.

[Krzesimir Nowak <krnowak src gnome org>]

commit e20d7f020fc63e22c7dad92a26cf79f0cba2eb07
Author: Krzesimir Nowak <qdlacz gmail com>
Date:   Sun Jan 17 19:10:00 2010 +0100

    Documented SourceCompletionContext.
    
    * gtksourceview/src/sourcecompletioncontext.hg: Documented.

 gtksourceview/src/sourcecompletioncontext.hg |   40 ++++++++++++++++++++++++++
 1 files changed, 40 insertions(+), 0 deletions(-)
---
diff --git a/gtksourceview/src/sourcecompletioncontext.hg b/gtksourceview/src/sourcecompletioncontext.hg
index 76d71b5..36914f1 100644
--- a/gtksourceview/src/sourcecompletioncontext.hg
+++ b/gtksourceview/src/sourcecompletioncontext.hg
@@ -38,17 +38,50 @@ class SourceCompletionProvider;
 class SourceCompletion;
 class SourceView;
 
+// TODO: need docs here.
+/** SourceCompletionContext
+ *
+ * @newin{2,10}
+ */
 class SourceCompletionContext : public Glib::Object
 {
   _CLASS_GOBJECT(SourceCompletionContext, GtkSourceCompletionContext, GTK_SOURCE_COMPLETION_CONTEXT, Glib::Object, GObject)
 public:
 #m4 _CONVERSION(`const Glib::RefPtr<SourceCompletionProvider>&',`struct _GtkSourceCompletionProvider*',`Glib::unwrap($3)')
 #m4 _CONVERSION(`const Glib::ListHandle<Glib::RefPtr<SourceCompletionProposal> >&',`GList*',`($3).data()')
+
+  /** Providers can use this function to add proposals to the completion.
+   *
+   * They can do so asynchronously by means of the @a finished argument.
+   * Providers must ensure that they always call this function with @a finished
+   * set to @c true once each population (even if no proposals need to be
+   * added).
+   *
+   * @param provider A SourceCompletionProvider.
+   * @param proposals The list of proposals to add.
+   * @param finished Whether the provider is finished adding proposals.
+   *
+   * @newin{2,10}
+   */
   _WRAP_METHOD(void add_proposals(const Glib::RefPtr<SourceCompletionProvider>& provider, const Glib::ListHandle<Glib::RefPtr<SourceCompletionProposal> >& proposals, bool finished), gtk_source_completion_context_add_proposals)
 
   _IGNORE(gtk_source_completion_context_get_iter)
+  /** Get the iter at which the completion was invoked.
+   *
+   * Providers can use this to determine how and if to match proposals.
+   *
+   * @return A Gtk::TextIter.
+   *
+   * @newin{2,10}
+   */
   SourceIter get_iter() const;
 
+  /** Get the context activation
+   *
+   * @return The context activation.
+   *
+   * @newin{2,10}
+   */
   _WRAP_METHOD(SourceCompletionActivation get_activation() const, gtk_source_completion_context_get_activation)
 
   _WRAP_PROPERTY("activation", SourceCompletionActivation)
@@ -56,6 +89,13 @@ public:
   _WRAP_PROPERTY("iter", SourceIter)
   _WRAP_PROPERTY("view", SourceView*)
 
+  /** Emitted when the current population of proposals has been cancelled.
+   *
+   * Providers adding proposals asynchronously should connect to this signal
+   * to know when to cancel running proposal queries.
+   *
+   * @newin{2,10}
+   */
   _WRAP_SIGNAL(void cancelled(), "cancelled")
 };