[gtksourceview/gtksourcecompletion] Fixed some small documentation of API



commit 9bbfe67c64778b49d8153c697b36a52bc6a5dd7a
Author: Jesse van den Kieboom <jesse icecrew nl>
Date:   Fri Apr 17 21:56:23 2009 +0200

    Fixed some small documentation of API
---
 gtksourceview/gtksourcecompletionitem.c     |    2 +-
 gtksourceview/gtksourcecompletionprovider.c |   11 ++++++++++-
 2 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/gtksourceview/gtksourcecompletionitem.c b/gtksourceview/gtksourcecompletionitem.c
index 77009a1..bac843c 100644
--- a/gtksourceview/gtksourcecompletionitem.c
+++ b/gtksourceview/gtksourcecompletionitem.c
@@ -193,7 +193,7 @@ gtk_source_completion_item_class_init (GtkSourceCompletionItemClass *klass)
 	/**
 	 * GtkSourceCompletionItem:info:
 	 *
-	 * Info to be shown for this item
+	 * Optional extra information to be shown for this item
 	 */
 	g_object_class_install_property (object_class,
 					 PROP_INFO,
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index b0494c0..c902388 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -155,6 +155,14 @@ gtk_source_completion_provider_get_name (GtkSourceCompletionProvider *provider)
 	return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_name (provider);
 }
 
+/**
+ * gtk_source_completion_provider_get_icon:
+ * @provider: The #GtkSourceCompletionProvider
+ *
+ * Get the icon of the provider.
+ *
+ * Returns: The icon to be used for the provider, or %NULL
+ */
 const GdkPixbuf *
 gtk_source_completion_provider_get_icon (GtkSourceCompletionProvider *provider)
 {
@@ -169,7 +177,8 @@ gtk_source_completion_provider_get_icon (GtkSourceCompletionProvider *provider)
  * Get proposals from the provider for completion
  *
  * Returns: a list of #GtkSourceViewProposal or NULL if there are no proposals.
- *          The returned list is owned by the caller.
+ *          The returned list and the contained #GtkSourceViewProposal are 
+ *          owned by the caller and will be freed when no longer needed.
  */
 GList * 
 gtk_source_completion_provider_get_proposals (GtkSourceCompletionProvider *provider)



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