GNOME.org
 

[gtksourceview] Fix most introspection warnings

commit cd59e529baed0d2b23cf1196aab1ff960a7aa697
Author: Garrett Regier <alias301 gmail com>
Date:   Mon Sep 20 08:41:16 2010 -0700

    Fix most introspection warnings

 gtksourceview/gtksourcebuffer.c             |   11 +++++++----
 gtksourceview/gtksourcecompletion.c         |   17 ++++++++++-------
 gtksourceview/gtksourcecompletioncontext.c  |    4 ++--
 gtksourceview/gtksourcecompletionproposal.c |    2 +-
 gtksourceview/gtksourcecompletionprovider.c |    7 ++++---
 gtksourceview/gtksourcegutter.c             |    3 ++-
 gtksourceview/gtksourcelanguage.c           |   15 ++++++++-------
 gtksourceview/gtksourcelanguagemanager.c    |   11 ++++++-----
 gtksourceview/gtksourcemark.c               |    4 ++--
 gtksourceview/gtksourcestyle.c              |    3 ++-
 gtksourceview/gtksourcestylescheme.c        |   11 ++++++-----
 gtksourceview/gtksourcestyleschememanager.c |    4 ++--
 gtksourceview/gtksourceview.c               |    3 ++-
 13 files changed, 54 insertions(+), 41 deletions(-)
---
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 4edb13c..4b00d80 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -2067,7 +2067,8 @@ gtk_source_buffer_backward_iter_to_source_mark (GtkSourceBuffer *buffer,
  * Returns the list of marks of the given category at @iter. If @category
  * is %NULL it returns all marks at @iter.
  *
- * Returns: (element-type GtkSource.Mark): a newly allocated #GSList.
+ * Returns: (element-type GtkSource.Mark) (transfer container):
+ * a newly allocated #GSList.
  *
  * Since: 2.2
  **/
@@ -2112,7 +2113,8 @@ gtk_source_buffer_get_source_marks_at_iter (GtkSourceBuffer *buffer,
  * Returns the list of marks of the given category at @line.
  * If @category is NULL, all marks at @line are returned.
  *
- * Returns: (element-type GtkSource.Mark): a newly allocated #GSList.
+ * Returns: (element-type GtkSource.Mark) (transfer container):
+ * a newly allocated #GSList.
  *
  * Since: 2.2
  **/
@@ -2262,8 +2264,9 @@ gtk_source_buffer_iter_has_context_class (GtkSourceBuffer   *buffer,
  *
  * Get all defined context classes at @iter.
  *
- * Returns: (array zero-terminated=1): a new %NULL terminated array of context
- * class names. Use #g_strfreev to free the array if it is no longer needed.
+ * Returns: (array zero-terminated=1) (transfer full): a new %NULL
+ * terminated array of context class names.
+ * Use g_strfreev() to free the array if it is no longer needed.
  *
  * Since: 2.10
  **/
diff --git a/gtksourceview/gtksourcecompletion.c b/gtksourceview/gtksourcecompletion.c
index d28508d..b72ae28 100644
--- a/gtksourceview/gtksourcecompletion.c
+++ b/gtksourceview/gtksourcecompletion.c
@@ -3251,9 +3251,10 @@ _gtk_source_completion_add_proposals (GtkSourceCompletion         *completion,
 /**
  * gtk_source_completion_show:
  * @completion: a #GtkSourceCompletion.
- * @providers: (element-type CompletionProvider) (allow-none):
+ * @providers: (element-type GtkSource.CompletionProvider) (allow-none):
  * a list of #GtkSourceCompletionProvider, or %NULL.
- * @context: The #GtkSourceCompletionContext with which to start the completion.
+ * @context: (transfer full): The #GtkSourceCompletionContext
+ * with which to start the completion.
  *
  * Starts a new completion with the specified #GtkSourceCompletionContext and
  * a list of potential candidate providers for completion.
@@ -3318,7 +3319,7 @@ gtk_source_completion_show (GtkSourceCompletion        *completion,
  * Get list of providers registered on @completion. The returned list is owned
  * by the completion and should not be freed.
  *
- * Returns: (element-type CompletionProvider) (transfer none):
+ * Returns: (element-type GtkSource.CompletionProvider) (transfer none):
  * list of #GtkSourceCompletionProvider.
  */
 GList *
@@ -3531,7 +3532,8 @@ gtk_source_completion_get_info_window (GtkSourceCompletion *completion)
  *
  * The #GtkSourceView associated with @completion.
  *
- * Returns: (type View) (transfer none): The #GtkSourceView associated with @completion.
+ * Returns: (type GtkSource.View) (transfer none):
+ * The #GtkSourceView associated with @completion.
  */
 GtkSourceView *
 gtk_source_completion_get_view (GtkSourceCompletion *completion)
@@ -3551,9 +3553,10 @@ gtk_source_completion_get_view (GtkSourceCompletion *completion)
  * be provider by @position. If @position is %NULL, the current cursor
  * position will be used.
  *
- * Returns: a new #GtkSourceCompletionContext. The reference being returned
- * is a 'floating' reference, so if you invoke #gtk_source_completion_show
- * with this context you don't need to unref it.
+ * Returns: (transfer full): a new #GtkSourceCompletionContext.
+ * The reference being returned is a 'floating' reference,
+ * so if you invoke #gtk_source_completion_show with this context
+ * you don't need to unref it.
  */
 GtkSourceCompletionContext *
 gtk_source_completion_create_context (GtkSourceCompletion *completion,
diff --git a/gtksourceview/gtksourcecompletioncontext.c b/gtksourceview/gtksourcecompletioncontext.c
index 40479d9..b04782b 100644
--- a/gtksourceview/gtksourcecompletioncontext.c
+++ b/gtksourceview/gtksourcecompletioncontext.c
@@ -286,8 +286,8 @@ gtk_source_completion_context_init (GtkSourceCompletionContext *context)
 /**
  * gtk_source_completion_context_add_proposals:
  * @context: a #GtkSourceCompletionContext.
- * @provider: (type CompletionProvider): a #GtkSourceCompletionProvider.
- * @proposals: (element-type CompletionItem): The list of proposals to add.
+ * @provider: (type GtkSource.CompletionProvider): a #GtkSourceCompletionProvider.
+ * @proposals: (element-type GtkSource.CompletionItem): The list of proposals to add.
  * @finished: Whether the provider is finished adding proposals.
  * 
  * Providers can use this function to add proposals to the completion. They
diff --git a/gtksourceview/gtksourcecompletionproposal.c b/gtksourceview/gtksourcecompletionproposal.c
index 2d9158b..3d5317e 100644
--- a/gtksourceview/gtksourcecompletionproposal.c
+++ b/gtksourceview/gtksourcecompletionproposal.c
@@ -192,7 +192,7 @@ gtk_source_completion_proposal_get_text (GtkSourceCompletionProposal *proposal)
  *
  * Gets the icon of @proposal.
  *
- * Returns: The icon of @proposal.
+ * Returns: (transfer none): The icon of @proposal.
  */
 GdkPixbuf *
 gtk_source_completion_proposal_get_icon (GtkSourceCompletionProposal *proposal)
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index c9ba1c8..947d93f 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -166,8 +166,8 @@ gtk_source_completion_provider_get_name (GtkSourceCompletionProvider *provider)
  *
  * Get the icon of the provider.
  *
- * Returns: The icon to be used for the provider, or %NULL if the provider does
- *          not have a special icon.
+ * Returns: (transfer none): The icon to be used for the provider,
+ *          or %NULL if the provider does not have a special icon.
  */
 GdkPixbuf *
 gtk_source_completion_provider_get_icon (GtkSourceCompletionProvider *provider)
@@ -243,7 +243,8 @@ gtk_source_completion_provider_match (GtkSourceCompletionProvider *provider,
  * #gtk_source_completion_proposal_get_info will be used to display extra
  * information about a #GtkSourceCompletionProposal.
  *
- * Returns: a custom #GtkWidget to show extra information about @proposal.
+ * Returns: (transfer none): a custom #GtkWidget to show extra
+ * information about @proposal.
  */
 GtkWidget *
 gtk_source_completion_provider_get_info_widget (GtkSourceCompletionProvider *provider,
diff --git a/gtksourceview/gtksourcegutter.c b/gtksourceview/gtksourcegutter.c
index 14c36c8..a2cca89 100644
--- a/gtksourceview/gtksourcegutter.c
+++ b/gtksourceview/gtksourcegutter.c
@@ -495,7 +495,8 @@ gtk_source_gutter_new (GtkSourceView     *view,
  * Get the #GdkWindow of the gutter. The window will only be available when the
  * gutter has at least one, non-zero width, cell renderer packed.
  *
- * Returns: the #GdkWindow of the gutter, or %NULL if the gutter has no window.
+ * Returns: (transfer none): the #GdkWindow of the gutter, or %NULL
+ * if the gutter has no window.
  *
  * Since: 2.8
  */
diff --git a/gtksourceview/gtksourcelanguage.c b/gtksourceview/gtksourcelanguage.c
index 46ad1cb..4210ffd 100644
--- a/gtksourceview/gtksourcelanguage.c
+++ b/gtksourceview/gtksourcelanguage.c
@@ -575,8 +575,8 @@ gtk_source_language_get_metadata (GtkSourceLanguage *language,
  * retrieve the "mimetypes" metadata property and split it into an
  * array.
  *
- * Returns: (array zero-terminated=1): a newly-allocated %NULL
- * terminated array containing the mime types or %NULL if no 
+ * Returns: (array zero-terminated=1) (transfer full): a newly-allocated
+ * %NULL terminated array containing the mime types or %NULL if no 
  * mime types are found.
  * The returned array must be freed with g_strfreev().
  **/
@@ -602,8 +602,8 @@ gtk_source_language_get_mime_types (GtkSourceLanguage *language)
  * an utility wrapper around gtk_source_language_get_metadata() to
  * retrieve the "globs" metadata property and split it into an array.
  *
- * Returns: (array zero-terminated=1): a newly-allocated %NULL terminated array containing
- * the globs or %NULL if no globs are found.
+ * Returns: (array zero-terminated=1) (transfer full): a newly-allocated
+ * %NULL terminated array containing the globs or %NULL if no globs are found.
  * The returned array must be freed with g_strfreev().
  **/
 gchar **
@@ -836,9 +836,10 @@ force_styles (GtkSourceLanguage *language)
  *
  * Returns the ids of the styles defined by this @language.
  *
- * Returns: (array zero-terminated=1): a  %NULL terminated array containing
- * ids of the styles defined by this @language or %NULL if no style is
- * defined.  The returned array must be freed with g_strfreev().
+ * Returns: (array zero-terminated=1) (transfer full): a  %NULL terminated
+ * array containing ids of the styles defined by this @language or
+ * %NULL if no style is defined.
+ * The returned array must be freed with g_strfreev().
 */
 gchar **
 gtk_source_language_get_style_ids (GtkSourceLanguage *language)
diff --git a/gtksourceview/gtksourcelanguagemanager.c b/gtksourceview/gtksourcelanguagemanager.c
index 1d86bca..020245b 100644
--- a/gtksourceview/gtksourcelanguagemanager.c
+++ b/gtksourceview/gtksourcelanguagemanager.c
@@ -197,8 +197,8 @@ gtk_source_language_manager_new (void)
  *
  * Returns the default #GtkSourceLanguageManager instance.
  *
- * Returns: (transfer-none): a #GtkSourceLanguageManager. Return value is owned
- * by GtkSourceView library and must not be unref'ed.
+ * Returns: (transfer none): a #GtkSourceLanguageManager.
+ * Return value is owned by GtkSourceView library and must not be unref'ed.
  */
 GtkSourceLanguageManager *
 gtk_source_language_manager_get_default (void)
@@ -389,9 +389,10 @@ ensure_languages (GtkSourceLanguageManager *lm)
  *
  * Returns the ids of the available languages.
  *
- * Returns: a %NULL-terminated array of string containing the ids of the
- * available languages or %NULL if no language is available. The array
- * is owned by @lm and must not be modified.
+ * Returns: (transfer none): a %NULL-terminated array of string
+ * containing the ids of the available languages or %NULL if
+ * no language is available.
+ * The array is owned by @lm and must not be modified.
  */
 G_CONST_RETURN gchar* G_CONST_RETURN *
 gtk_source_language_manager_get_language_ids (GtkSourceLanguageManager *lm)
diff --git a/gtksourceview/gtksourcemark.c b/gtksourceview/gtksourcemark.c
index 85780e8..7ed86b7 100644
--- a/gtksourceview/gtksourcemark.c
+++ b/gtksourceview/gtksourcemark.c
@@ -211,7 +211,7 @@ gtk_source_mark_get_category (GtkSourceMark *mark)
  *
  * If @category is %NULL, looks for marks of any category.
  *
- * Returns: the next #GtkSourceMark, or %NULL.
+ * Returns: (transfer none): the next #GtkSourceMark, or %NULL.
  *
  * Since: 2.2
  */
@@ -241,7 +241,7 @@ gtk_source_mark_next (GtkSourceMark *mark,
  * 
  * If @category is %NULL, looks for marks of any category
  *
- * Returns: the previous #GtkSourceMark, or %NULL.
+ * Returns: (transfer none): the previous #GtkSourceMark, or %NULL.
  *
  * Since: 2.2
  */
diff --git a/gtksourceview/gtksourcestyle.c b/gtksourceview/gtksourcestyle.c
index 734960d..c516e4d 100644
--- a/gtksourceview/gtksourcestyle.c
+++ b/gtksourceview/gtksourcestyle.c
@@ -375,7 +375,8 @@ gtk_source_style_get_property (GObject      *object,
  * Creates a copy of @style, that is a new #GtkSourceStyle instance which
  * has the same attributes set.
  *
- * Returns: copy of @style, call g_object_unref() when you are done with it.
+ * Returns: (transfer full): copy of @style, call g_object_unref()
+ * when you are done with it.
  *
  * Since: 2.0
  */
diff --git a/gtksourceview/gtksourcestylescheme.c b/gtksourceview/gtksourcestylescheme.c
index 9e5e627..85802d1 100644
--- a/gtksourceview/gtksourcestylescheme.c
+++ b/gtksourceview/gtksourcestylescheme.c
@@ -305,8 +305,9 @@ gtk_source_style_scheme_get_description (GtkSourceStyleScheme *scheme)
  * gtk_source_style_scheme_get_authors:
  * @scheme: a #GtkSourceStyleScheme.
  *
- * Returns: (array zero-terminated): a %NULL-terminated array containing
- * the @scheme authors or %NULL if no author is specified by the style scheme.
+ * Returns: (array zero-terminated) (transfer none): a %NULL-terminated
+ * array containing the @scheme authors or %NULL if no author
+ * is specified by the style scheme.
  *
  * Since: 2.0
  */
@@ -448,9 +449,9 @@ fix_style_colors (GtkSourceStyleScheme *scheme,
  * @scheme: a #GtkSourceStyleScheme.
  * @style_id: id of the style to retrieve.
  *
- * Returns: style which corresponds to @style_id in the @scheme,
- * or %NULL when no style with this name found. It is owned by @scheme
- * and may not be unref'ed.
+ * Returns: (transfer none): style which corresponds to @style_id
+ * in the @scheme, or %NULL when no style with this name found.
+ * It is owned by @scheme and may not be unref'ed.
  *
  * Since: 2.0
  */
diff --git a/gtksourceview/gtksourcestyleschememanager.c b/gtksourceview/gtksourcestyleschememanager.c
index 7b58908..cba042f 100644
--- a/gtksourceview/gtksourcestyleschememanager.c
+++ b/gtksourceview/gtksourcestyleschememanager.c
@@ -198,7 +198,7 @@ gtk_source_style_scheme_manager_new (void)
  *
  * Returns the default #GtkSourceStyleSchemeManager instance.
  *
- * Returns: (transfer-none): a #GtkSourceStyleSchemeManager. Return value
+ * Returns: (transfer none): a #GtkSourceStyleSchemeManager. Return value
  * is owned by GtkSourceView library and must not be unref'ed.
  */
 GtkSourceStyleSchemeManager *
@@ -512,7 +512,7 @@ gtk_source_style_scheme_manager_prepend_search_path (GtkSourceStyleSchemeManager
  * Returns the current search path for the @manager.
  * See gtk_source_style_scheme_manager_set_search_path() for details.
  *
- * Returns: (array zero-terminated) (tranfer none): a %NULL-terminated array
+ * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array
  * of string containing the search path.
  * The array is owned by the @manager and must not be modified.
  */
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index cb75fae..655b601 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -5226,7 +5226,8 @@ gtk_source_view_update_style_scheme (GtkSourceView *view)
  *
  * Gets the #GtkSourceCompletion associated with @view.
  *
- * Returns: (type Completion) (transfer none): the #GtkSourceCompletion associated with @view.
+ * Returns: (type GtkSource.Completion) (transfer none):
+ * the #GtkSourceCompletion associated with @view.
  */
 GtkSourceCompletion *
 gtk_source_view_get_completion (GtkSourceView *view)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]