[gtksourceview] Doc: explain the default widget for the CompletionInfo window



commit 6e33a3e89f6d366362c0aacc73d6a51ef49b72e3
Author: SÃbastien Wilmet <swilmet gnome org>
Date:   Sat Jan 12 19:09:00 2013 +0100

    Doc: explain the default widget for the CompletionInfo window

 gtksourceview/gtksourcecompletionprovider.c |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)
---
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index deaa126..d8b85d4 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -234,10 +234,12 @@ gtk_source_completion_provider_match (GtkSourceCompletionProvider *provider,
  * This allows for customized widgets on a proposal basis, although in general
  * providers will have the same custom widget for all their proposals and
  * @proposal can be ignored. The implementation of this function is optional.
- * If implemented, #gtk_source_completion_provider_update_info MUST also be
- * implemented. If not implemented, the default
- * #gtk_source_completion_proposal_get_info will be used to display extra
- * information about a #GtkSourceCompletionProposal.
+ * If implemented, gtk_source_completion_provider_update_info() MUST also be
+ * implemented.
+ *
+ * If this function is not implemented, the default widget is a #GtkLabel. The
+ * return value of gtk_source_completion_proposal_get_info() is used as the
+ * content of the #GtkLabel.
  *
  * Returns: (transfer none): a custom #GtkWidget to show extra
  * information about @proposal.



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