[gtksourceview] Better documentation about completion population



commit 269fc2e41a25dd2b5fbc7c1a9793aaf3a747093f
Author: SÃbastien Wilmet <swilmet src gnome org>
Date:   Thu Jul 5 02:36:16 2012 +0200

    Better documentation about completion population
    
    https://bugzilla.gnome.org/show_bug.cgi?id=679426

 gtksourceview/gtksourcecompletioncontext.c  |    2 ++
 gtksourceview/gtksourcecompletionprovider.c |    3 ++-
 2 files changed, 4 insertions(+), 1 deletions(-)
---
diff --git a/gtksourceview/gtksourcecompletioncontext.c b/gtksourceview/gtksourcecompletioncontext.c
index 32d89cf..d5fe671 100644
--- a/gtksourceview/gtksourcecompletioncontext.c
+++ b/gtksourceview/gtksourcecompletioncontext.c
@@ -305,6 +305,8 @@ gtk_source_completion_context_init (GtkSourceCompletionContext *context)
  * can do so asynchronously by means of the @finished argument. Providers must
  * ensure that they always call this function with @finished set to %TRUE
  * once each population (even if no proposals need to be added).
+ * Population occurs when the gtk_source_completion_provider_populate()
+ * function is called.
  **/
 void
 gtk_source_completion_context_add_proposals (GtkSourceCompletionContext  *context,
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index 5217aa2..73a4a04 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -175,7 +175,8 @@ gtk_source_completion_provider_get_icon (GtkSourceCompletionProvider *provider)
  * @provider: a #GtkSourceCompletionProvider.
  * @context: a #GtkSourceCompletionContext.
  *
- * Populate @context with proposals from @provider.
+ * Populate @context with proposals from @provider added with the
+ * gtk_source_completion_context_add_proposals() function.
  */
 void
 gtk_source_completion_provider_populate (GtkSourceCompletionProvider *provider,



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