[gtksourceview] Improve documentation of GtkSourceView::show-completion



commit 8fa09824388c67ab7b356f579f18a6cbde305084
Author: SÃbastien Wilmet <swilmet src gnome org>
Date:   Wed Jul 4 23:50:34 2012 +0200

    Improve documentation of GtkSourceView::show-completion
    
    https://bugzilla.gnome.org/show_bug.cgi?id=679426

 gtksourceview/gtksourceview.c |   13 ++++++++-----
 1 files changed, 8 insertions(+), 5 deletions(-)
---
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index e934bdf..3bd0d44 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -483,13 +483,16 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
 	 * GtkSourceView::show-completion:
 	 * @view: The #GtkSourceView who emits the signal
 	 *
-	 * The ::show-completion signal is a keybinding signal which gets
-	 * emitted when the user initiates a completion in default mode.
+	 * The ::show-completion signal is a key binding signal which gets
+	 * emitted when the user requests a completion, by pressing
+	 * <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo>.
 	 *
-	 * Applications should not connect to it, but may emit it with
-	 * #g_signal_emit_by_name if they need to control the default mode
-	 * completion activation.
+	 * This will create a #GtkSourceCompletionContext with the activation
+	 * type as %GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED.
 	 *
+	 * Applications should not connect to it, but may emit it with
+	 * g_signal_emit_by_name() if they need to activate the completion by
+	 * another means, for example with another key binding or a menu entry.
 	 */
 	signals [SHOW_COMPLETION] =
 		g_signal_new ("show-completion",



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