[gtksourceview/gtksourcecompletion] Added some missing docs.



commit 5fa1fd079eef154ee2ba2216797fcb975e192d6b
Author: Ignacio Casal Quinteiro <icq gnome org>
Date:   Sat Apr 18 00:14:35 2009 +0200

    Added some missing docs.
---
 docs/reference/gtksourceview-2.0-sections.txt |    3 ++-
 gtksourceview/gtksourcecompletion.c           |   12 +++++++++++-
 gtksourceview/gtksourcecompletionitem.c       |    6 +++---
 gtksourceview/gtksourcecompletionproposal.c   |    2 ++
 4 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/docs/reference/gtksourceview-2.0-sections.txt b/docs/reference/gtksourceview-2.0-sections.txt
index 4771179..ec85cbc 100644
--- a/docs/reference/gtksourceview-2.0-sections.txt
+++ b/docs/reference/gtksourceview-2.0-sections.txt
@@ -381,7 +381,8 @@ gtk_source_completion_provider_get_name
 gtk_source_completion_provider_get_icon
 gtk_source_completion_provider_get_proposals
 gtk_source_completion_provider_filter_proposal
-gtk_source_completion_provider_can_auto_complete
+gtk_source_completion_provider_get_automatic
+gtk_source_completion_provider_get_interactive
 gtk_source_completion_provider_get_info_widget
 gtk_source_completion_provider_update_info
 <SUBSECTION Standard>
diff --git a/gtksourceview/gtksourcecompletion.c b/gtksourceview/gtksourcecompletion.c
index 8ef37ca..f2f8159 100644
--- a/gtksourceview/gtksourcecompletion.c
+++ b/gtksourceview/gtksourcecompletion.c
@@ -1854,6 +1854,16 @@ add_proposals (GtkSourceCompletion         *completion,
 	g_list_free (proposals);
 }
 
+/**
+ * gtk_source_completion_popup:
+ * @completion: the #GtkSourceCompletion
+ * @providers: the list of #GtkSourceCompletionProvider
+ * @criteria: the filter criteria
+ *
+ * Shows the popup completion window.
+ *
+ * Returns: %TRUE if it was possible show the popup completion window.
+ */
 gboolean
 gtk_source_completion_popup (GtkSourceCompletion *completion,
                              GList               *providers,
@@ -2063,7 +2073,7 @@ gtk_source_completion_finish (GtkSourceCompletion *completion)
 }
 
 /**
- * gtk_source_completion_get_info_widget:
+ * gtk_source_completion_get_info_window:
  * @completion: The #GtkSourceCompletion
  *
  * The info widget is the window where the completion shows the
diff --git a/gtksourceview/gtksourcecompletionitem.c b/gtksourceview/gtksourcecompletionitem.c
index bac843c..582c0e8 100644
--- a/gtksourceview/gtksourcecompletionitem.c
+++ b/gtksourceview/gtksourcecompletionitem.c
@@ -239,13 +239,13 @@ gtk_source_completion_item_new (const gchar *label,
 /** 
  * gtk_source_completion_item_new_from_stock:
  * @label: the item label
- * @icon: the item icon
+ * @stock: the stock icon
  * @info: the item extra information
  *
- * Create a new #GtkSourceCompletionItem from a stock item. If @label is NULL, 
+ * Creates a new #GtkSourceCompletionItem from a stock item. If @label is %NULL, 
  * the stock label will be used.
  *
- * Return value: the newly constructed #GtkSourceCompletionItem
+ * Returns: the newly constructed #GtkSourceCompletionItem
  *
  */
 GtkSourceCompletionItem *
diff --git a/gtksourceview/gtksourcecompletionproposal.c b/gtksourceview/gtksourcecompletionproposal.c
index 1862e71..2ae0df8 100644
--- a/gtksourceview/gtksourcecompletionproposal.c
+++ b/gtksourceview/gtksourcecompletionproposal.c
@@ -185,6 +185,8 @@ gtk_source_completion_proposal_get_info (GtkSourceCompletionProposal *proposal)
  * This emits the "activate" signal on @proposal. This function is generally 
  * called when @proposal is activated from the completion window. 
  * Implementations should take action in the default handler of the signal.
+ *
+ * Returns: %TRUE if @proposal was activated.
  */
 gboolean
 gtk_source_completion_proposal_activate (GtkSourceCompletionProposal *proposal,



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