gtksourceview r2250 - in branches/gtksourcecompletion: . gtksourceview

[icq svn gnome org]

Author: icq
Date: Fri Apr 10 13:43:41 2009
New Revision: 2250
URL: http://svn.gnome.org/viewvc/gtksourceview?rev=2250&view=rev

Log:
2009-04-10  Ignacio Casal Quinteiro  <nacho resa gmail com>

        * gtksourceview/gtksourcecompletion.c:
        * gtksourceview/gtksourcecompletion.h:
        * gtksourceview/gtksourcecompletionproposal.c:
        * gtksourceview/gtksourcecompletionproposal.h:
        Fixed some doc warnings.



Modified:
   branches/gtksourcecompletion/ChangeLog
   branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.c
   branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.h
   branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.c
   branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.h

Modified: branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.c
==============================================================================
--- branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.c	(original)
+++ branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.c	Fri Apr 10 13:43:41 2009
@@ -1482,7 +1482,7 @@
 /**
  * _gtk_source_completion_new:
  *
- * Returns The new #GtkSourceCompletion
+ * Returns: The new #GtkSourceCompletion
  */
 GtkSourceCompletion *
 _gtk_source_completion_new (GtkTextView *view)
@@ -1537,7 +1537,7 @@
  * gtk_source_completion_register_provider:
  * @self: the #GtkSourceCompletion
  * @provider: The #GtkSourceCompletionProvider.
- * @trigger_name: The trigger name what you want to register this provider
+ * @trigger: The trigger name what you want to register this provider
  *
  * This function register the provider into the completion and reference it. When 
  * an event is raised, completion call to the provider to get the data. When the user
@@ -1546,7 +1546,6 @@
  * 
  * Returns: %TRUE if it was registered or %FALSE if not (because it has been already registered,
  * or the trigger doesn't exists)
- *
  **/
 gboolean
 gtk_source_completion_register_provider (GtkSourceCompletion *self,
@@ -1633,9 +1632,8 @@
  *
  * This function unregister the provider.
  * 
- * Returns TRUE if it was unregistered or FALSE if not (because it doesn't exists,
+ * Returns: %TRUE if it was unregistered or %FALSE if not (because it doesn't exists,
  * or the trigger don't exists)
- * 
  **/
 gboolean
 gtk_source_completion_unregister_provider (GtkSourceCompletion *self,

Modified: branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.h
==============================================================================
--- branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.h	(original)
+++ branches/gtksourcecompletion/gtksourceview/gtksourcecompletion.h	Fri Apr 10 13:43:41 2009
@@ -70,17 +70,6 @@
 				       GtkSourceCompletionProposal *proposal);
 };
 
-/* ********************* Control Functions ******************** */
-/* 
- * FIXME This functions will be deleted when we insert GtkSourceCompletion
- * into GtkSourceView. These functions store the relationship between the
- * GtkSourceCompletions and the GtkTextView.
- */
-
-GtkSourceCompletion	*gtk_source_completion_get_from_view	(GtkTextView *view);
-
-/* ************************************************************* */
-
 GType		 gtk_source_completion_get_type			(void) G_GNUC_CONST;
 
 GtkSourceCompletion
@@ -132,12 +121,12 @@
 GtkSourceCompletionInfo
 		*gtk_source_completion_get_info_widget		(GtkSourceCompletion *self);
 
-gint		gtk_source_completion_get_page_pos		(GtkSourceCompletion *self,
+gint		 gtk_source_completion_get_page_pos		(GtkSourceCompletion *self,
 								 const gchar *page_name);
 
-gint		gtk_source_completion_get_n_pages		(GtkSourceCompletion *self);
+gint		 gtk_source_completion_get_n_pages		(GtkSourceCompletion *self);
 
-void	gtk_source_completion_set_page_pos		(GtkSourceCompletion *self,
+void		 gtk_source_completion_set_page_pos		(GtkSourceCompletion *self,
 								 const gchar *page_name,
 								 gint position);
 

Modified: branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.c
==============================================================================
--- branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.c	(original)
+++ branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.c	Fri Apr 10 13:43:41 2009
@@ -274,79 +274,79 @@
 
 /**
  * gtk_source_completion_proposal_get_label:
- * @self: The #GtkSourceCompletionProposal
+ * @proposal: The #GtkSourceCompletionProposal
  *
  * Returns: The proposal label that will be shown into the popup
  */
 const gchar *
-gtk_source_completion_proposal_get_label (GtkSourceCompletionProposal *self)
+gtk_source_completion_proposal_get_label (GtkSourceCompletionProposal *proposal)
 {
-	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (self), NULL);
+	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
 	
-	return self->priv->label;
+	return proposal->priv->label;
 }
 
 /**
  * gtk_source_completion_proposal_get_icon:
- * @self: The #GtkSourceCompletionProposal
+ * @proposal: The #GtkSourceCompletionProposal
  *
  * Gets the icon of this @proposal that will be shown into the popup.
  *
  * Returns: the icon of this @proposal that will be shown into the popup
  */
 const GdkPixbuf *
-gtk_source_completion_proposal_get_icon (GtkSourceCompletionProposal *self)
+gtk_source_completion_proposal_get_icon (GtkSourceCompletionProposal *proposal)
 {
-	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (self), NULL);
+	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
 
-	return self->priv->icon;
+	return proposal->priv->icon;
 }
 
 /**
  * gtk_source_completion_proposal_set_page_name:
- * @self: The #GtkSourceCompletionProposal
+ * @proposal: The #GtkSourceCompletionProposal
  * @page_name: The name for the page
  *
  * Sets the name of the page where this proposal will be shown.
  * If @page_name is %NULL the default page will be used.
  */
 void
-gtk_source_completion_proposal_set_page_name (GtkSourceCompletionProposal *self,
+gtk_source_completion_proposal_set_page_name (GtkSourceCompletionProposal *proposal,
 					      const gchar *page_name)
 {
-	g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (self));
+	g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal));
 
-	g_free (self->priv->page_name);
+	g_free (proposal->priv->page_name);
 	
 	if (page_name == NULL)
 	{
-		self->priv->page_name = g_strdup (GTK_SOURCE_COMPLETION_PROPOSAL_DEFAULT_PAGE);
+		proposal->priv->page_name = g_strdup (GTK_SOURCE_COMPLETION_PROPOSAL_DEFAULT_PAGE);
 	}
 	else
 	{
-		self->priv->page_name = g_strdup (page_name);
+		proposal->priv->page_name = g_strdup (page_name);
 	}
 }
 
 /**
  * gtk_source_completion_proposal_get_page_name:
- * @self: The #GtkSourceCompletionProposal
+ * @proposal: The #GtkSourceCompletionProposal
  *
  * Gets the page name where the @proposal will be placed.
  *
  * Returns: the page name where the @proposal will be placed.
  */
 const gchar *
-gtk_source_completion_proposal_get_page_name (GtkSourceCompletionProposal *self)
+gtk_source_completion_proposal_get_page_name (GtkSourceCompletionProposal *proposal)
 {
-	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (self), NULL);
+	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
 	
-	return self->priv->page_name;
+	return proposal->priv->page_name;
 }
 
 /**
  * gtk_source_completion_proposal_get_info:
- * @self: The #GtkSourceCompletionProposal
+ * @proposal: The #GtkSourceCompletionProposal
  *
  * The completion calls this function when the user wants to see the proposal info.
  * You can overwrite this function if you need to change the default mechanism.
@@ -354,16 +354,16 @@
  * Returns: The proposal info markup asigned for this proposal or NULL;
  */
 const gchar *
-gtk_source_completion_proposal_get_info (GtkSourceCompletionProposal *self)
+gtk_source_completion_proposal_get_info (GtkSourceCompletionProposal *proposal)
 {
-	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (self), NULL);
+	g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
 
-	return GTK_SOURCE_COMPLETION_PROPOSAL_GET_CLASS (self)->get_info (self);
+	return GTK_SOURCE_COMPLETION_PROPOSAL_GET_CLASS (proposal)->get_info (proposal);
 }
 
 /**
  * gtk_source_completion_proposal_apply:
- * @self: The #GtkSourceCompletionProposal
+ * @proposal: The #GtkSourceCompletionProposal
  * @view: The #GtkTextView
  * 
  * The completion calls this function when the user selects the proposal. 
@@ -371,12 +371,12 @@
  * You can overwrite this function.
  */
 void
-gtk_source_completion_proposal_apply (GtkSourceCompletionProposal *self,
+gtk_source_completion_proposal_apply (GtkSourceCompletionProposal *proposal,
 				      GtkTextView *view)
 {
-	g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (self));
+	g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal));
 	
-	GTK_SOURCE_COMPLETION_PROPOSAL_GET_CLASS (self)->apply (self, view);
+	GTK_SOURCE_COMPLETION_PROPOSAL_GET_CLASS (proposal)->apply (proposal, view);
 }
 
 

Modified: branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.h
==============================================================================
--- branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.h	(original)
+++ branches/gtksourcecompletion/gtksourceview/gtksourcecompletionproposal.h	Fri Apr 10 13:43:41 2009
@@ -68,7 +68,7 @@
 const GdkPixbuf		*gtk_source_completion_proposal_get_icon	(GtkSourceCompletionProposal *proposal);
 
 
-void			 gtk_source_completion_proposal_set_page_name	(GtkSourceCompletionProposal *self,
+void			 gtk_source_completion_proposal_set_page_name	(GtkSourceCompletionProposal *proposal,
 									 const gchar *page_name);
 
 const gchar		*gtk_source_completion_proposal_get_page_name	(GtkSourceCompletionProposal *proposal);