[gtksourceview] Fix up the docs and add preliminary GObject Introspection support
- From: Garrett Regier <gregier src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview] Fix up the docs and add preliminary GObject Introspection support
- Date: Sun, 16 May 2010 21:26:01 +0000 (UTC)
commit 9b539d8c1509f84c8bc5290ba813170e8bf33885
Author: Garrett Regier <alias301 gmail com>
Date: Sun May 16 14:25:50 2010 -0700
Fix up the docs and add preliminary GObject Introspection support
gtksourceview/gtksourcebuffer.c | 83 ++++++++++++++-------------
gtksourceview/gtksourcecompletion.c | 55 ++++++++---------
gtksourceview/gtksourcecompletioncontext.c | 20 +++----
gtksourceview/gtksourcecompletioninfo.c | 31 ++++------
gtksourceview/gtksourcecompletionitem.c | 35 +++++------
gtksourceview/gtksourcecompletionproposal.c | 42 +++++++------
gtksourceview/gtksourcecompletionprovider.c | 66 +++++++++++-----------
gtksourceview/gtksourcecompletionutils.c | 32 +++++-----
gtksourceview/gtksourcegutter.c | 40 +++++++-------
gtksourceview/gtksourceiter.c | 12 ++--
gtksourceview/gtksourcelanguage.c | 31 +++++-----
gtksourceview/gtksourcelanguagemanager.c | 20 ++++---
gtksourceview/gtksourcemark.c | 22 ++++----
gtksourceview/gtksourceprintcompositor.c | 80 +++++++++++++-------------
gtksourceview/gtksourcestyle.c | 2 +-
gtksourceview/gtksourcestylescheme.c | 16 +++---
gtksourceview/gtksourcestyleschememanager.c | 32 ++++++-----
gtksourceview/gtksourceundomanager.c | 35 +++++------
gtksourceview/gtksourceview.c | 63 ++++++++++-----------
19 files changed, 357 insertions(+), 360 deletions(-)
---
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 11307dd..7691195 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -634,7 +634,7 @@ gtk_source_buffer_get_property (GObject *object,
/**
* gtk_source_buffer_new:
- * @table: a #GtkTextTagTable, or %NULL to create a new one.
+ * @table: (allow-none): a #GtkTextTagTable, or %NULL to create a new one.
*
* Creates a new source buffer.
*
@@ -1456,9 +1456,9 @@ gtk_source_buffer_set_highlight_syntax (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_set_language:
* @buffer: a #GtkSourceBuffer.
- * @language: a #GtkSourceLanguage to set, or %NULL.
+ * @language: (allow-none): a #GtkSourceLanguage to set, or %NULL.
*
- * Associate a #GtkSourceLanguage with the source buffer. If @language is
+ * Associate a #GtkSourceLanguage with the buffer. If @language is
* not-%NULL and syntax highlighting is enabled (see gtk_source_buffer_set_highlight_syntax()),
* the syntax patterns defined in @language will be used to highlight the text
* contained in the buffer. If @language is %NULL, the text contained in the
@@ -1518,7 +1518,7 @@ gtk_source_buffer_set_language (GtkSourceBuffer *buffer,
* see gtk_source_buffer_set_language(). The returned object should not be
* unreferenced by the user.
*
- * Return value: #GtkSourceLanguage associated with the buffer, or %NULL.
+ * Return value: (transfer none): the #GtkSourceLanguage associated with the buffer, or %NULL.
**/
GtkSourceLanguage *
gtk_source_buffer_get_language (GtkSourceBuffer *buffer)
@@ -1582,7 +1582,7 @@ gtk_source_buffer_ensure_highlight (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_set_style_scheme:
* @buffer: a #GtkSourceBuffer.
- * @scheme: style scheme.
+ * @scheme: (allow-none): a #GtkSourceStyleScheme or %NULL.
*
* Sets style scheme used by the buffer. If @scheme is %NULL no
* style scheme is used.
@@ -1614,15 +1614,18 @@ gtk_source_buffer_set_style_scheme (GtkSourceBuffer *buffer,
* gtk_source_buffer_get_style_scheme:
* @buffer: a #GtkSourceBuffer.
*
- * Returns the #GtkSourceStyleScheme currently used in @buffer.
+ * Returns the #GtkSourceStyleScheme associated with the buffer,
+ * see gtk_source_buffer_set_style_scheme().
+ * The returned object should not be unreferenced by the user.
*
- * Returns: the #GtkSourceStyleScheme set by
- * gtk_source_buffer_set_style_scheme(), or %NULL.
+ * Return value: (transfer none): the #GtkSourceStyleScheme associated
+ * with the buffer, or %NULL.
**/
GtkSourceStyleScheme *
gtk_source_buffer_get_style_scheme (GtkSourceBuffer *buffer)
{
g_return_val_if_fail (GTK_IS_SOURCE_BUFFER (buffer), NULL);
+
return buffer->priv->style_scheme;
}
@@ -1812,7 +1815,7 @@ gtk_source_buffer_real_redo (GtkSourceBuffer *buffer)
/**
* gtk_source_buffer_create_source_mark:
* @buffer: a #GtkSourceBuffer.
- * @name: the name of the mark, or %NULL.
+ * @name: (allow-none): the name of the mark, or %NULL.
* @category: a string defining the mark category.
* @where: location to place the mark.
*
@@ -1830,7 +1833,7 @@ gtk_source_buffer_real_redo (GtkSourceBuffer *buffer)
* Typical uses for a source mark are bookmarks, breakpoints, current
* executing instruction indication in a source file, etc..
*
- * Return value: a new #GtkSourceMark, owned by the buffer.
+ * Return value: (transfer none): a new #GtkSourceMark, owned by the buffer.
*
* Since: 2.2
**/
@@ -1946,13 +1949,13 @@ _gtk_source_buffer_source_mark_prev (GtkSourceBuffer *buffer,
* gtk_source_buffer_forward_iter_to_source_mark:
* @buffer: a #GtkSourceBuffer.
* @iter: an iterator.
- * @category: category to search for or %NULL
+ * @category: (allow-none): category to search for, or %NULL
*
* Moves @iter to the position of the next #GtkSourceMark of the given
- * @category. Returns #TRUE if @iter was moved. If @category is NULL, the
+ * @category. Returns %TRUE if @iter was moved. If @category is NULL, the
* next source mark can be of any category.
*
- * Returns: whether iter moved.
+ * Returns: whether @iter was moved.
*
* Since: 2.2
**/
@@ -2005,13 +2008,13 @@ gtk_source_buffer_forward_iter_to_source_mark (GtkSourceBuffer *buffer,
* gtk_source_buffer_backward_iter_to_source_mark:
* @buffer: a #GtkSourceBuffer.
* @iter: an iterator.
- * @category: category to search for or %NULL
+ * @category: (allow-none): category to search for, or %NULL
*
* Moves @iter to the position of the previous #GtkSourceMark of the given
- * category. Returns #TRUE if @iter was moved. If @category is NULL, the
+ * category. Returns %TRUE if @iter was moved. If @category is NULL, the
* previous source mark can be of any category.
*
- * Returns: whether iter moved.
+ * Returns: whether @iter was moved.
*
* Since: 2.2
**/
@@ -2063,12 +2066,12 @@ gtk_source_buffer_backward_iter_to_source_mark (GtkSourceBuffer *buffer,
* gtk_source_buffer_get_source_marks_at_iter:
* @buffer: a #GtkSourceBuffer.
* @iter: an iterator.
- * @category: category to search for or %NULL
+ * @category: (allow-none): category to search for, or %NULL
*
* Returns the list of marks of the given category at @iter. If @category
* is %NULL it returns all marks at @iter.
*
- * Returns: a newly allocated #GSList.
+ * Returns: (element-type GtkSource.Mark): a newly allocated #GSList.
*
* Since: 2.2
**/
@@ -2078,6 +2081,8 @@ gtk_source_buffer_get_source_marks_at_iter (GtkSourceBuffer *buffer,
const gchar *category)
{
GSList *marks, *l, *res;
+
+ g_return_val_if_fail (iter != NULL, NULL);
res = NULL;
marks = gtk_text_iter_get_marks (iter);
@@ -2106,12 +2111,12 @@ gtk_source_buffer_get_source_marks_at_iter (GtkSourceBuffer *buffer,
* gtk_source_buffer_get_source_marks_at_line:
* @buffer: a #GtkSourceBuffer.
* @line: a line number.
- * @category: category to search for or %NULL
+ * @category: (allow-none): category to search for, or %NULL
*
* Returns the list of marks of the given category at @line.
* If @category is NULL, all marks at @line are returned.
*
- * Returns: a newly allocated #GSList.
+ * Returns: (element-type GtkSource.Mark): a newly allocated #GSList.
*
* Since: 2.2
**/
@@ -2158,9 +2163,9 @@ gtk_source_buffer_get_source_marks_at_line (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_remove_source_marks:
* @buffer: a #GtkSourceBuffer.
- * @start: a #GtkTextIter
- * @end: a #GtkTextIter
- * @category: category to search for or NULL
+ * @start: a #GtkTextIter.
+ * @end: a #GtkTextIter.
+ * @category: (allow-none): category to search for, or %NULL.
*
* Remove all marks of @category between @start and @end from the buffer.
* If @category is NULL, all marks in the range will be removed.
@@ -2218,8 +2223,8 @@ gtk_source_buffer_remove_source_marks (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_iter_has_context_class:
* @buffer: a #GtkSourceBuffer.
- * @iter: a #GtkTextIter
- * @context_class: class to search for
+ * @iter: a #GtkTextIter.
+ * @context_class: class to search for.
*
* Check if the class @context_klass is set on @iter.
*
@@ -2257,12 +2262,12 @@ gtk_source_buffer_iter_has_context_class (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_get_context_classes_at_iter:
* @buffer: a #GtkSourceBuffer.
- * @iter: a #GtkTextIter
+ * @iter: a #GtkTextIter.
*
* Get all defined context classes at @iter.
*
- * Returns: 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): 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
**/
@@ -2298,8 +2303,8 @@ gtk_source_buffer_get_context_classes_at_iter (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_iter_forward_to_context_class_toggle:
* @buffer: a #GtkSourceBuffer.
- * @iter: a #GtkTextIter
- * @context_class: the context class
+ * @iter: a #GtkTextIter.
+ * @context_class: the context class.
*
* Moves forward to the next toggle (on or off) of the context class. If no
* matching context class toggles are found, returns %FALSE, otherwise %TRUE.
@@ -2343,8 +2348,8 @@ gtk_source_buffer_iter_forward_to_context_class_toggle (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_iter_backward_to_context_class_toggle:
* @buffer: a #GtkSourceBuffer.
- * @iter: a #GtkTextIter
- * @context_class: the context class
+ * @iter: a #GtkTextIter.
+ * @context_class: the context class.
*
* Moves backward to the next toggle (on or off) of the context class. If no
* matching context class toggles are found, returns %FALSE, otherwise %TRUE.
@@ -2387,12 +2392,11 @@ gtk_source_buffer_iter_backward_to_context_class_toggle (GtkSourceBuffer *buffer
/**
* gtk_source_buffer_set_undo_manager:
- * @buffer: A #GtkSourceBuffer
- * @manager: A #GtkSourceUndoManager
+ * @buffer: a #GtkSourceBuffer.
+ * @manager: (allow-none): A #GtkSourceUndoManager or %NULL.
*
* Set the buffer undo manager. If @manager is %NULL the default undo manager
* will be set.
- *
**/
void
gtk_source_buffer_set_undo_manager (GtkSourceBuffer *buffer,
@@ -2421,12 +2425,13 @@ gtk_source_buffer_set_undo_manager (GtkSourceBuffer *buffer,
/**
* gtk_source_buffer_get_undo_manager:
- * @buffer: A #GtkSourceBuffer
- *
- * Get the undo manager associated with the buffer.
+ * @buffer: a #GtkSourceBuffer.
*
- * Returns: A #GtkSourceUndoManager
+ * Returns the #GtkSourceUndoManager associated with the buffer,
+ * see gtk_source_buffer_set_undo_manager(). The returned object should not be
+ * unreferenced by the user.
*
+ * Returns: (transfer none): the #GtkSourceUndoManager associated with the buffer, or %NULL.
**/
GtkSourceUndoManager *
gtk_source_buffer_get_undo_manager (GtkSourceBuffer *buffer)
diff --git a/gtksourceview/gtksourcecompletion.c b/gtksourceview/gtksourcecompletion.c
index 2c96fa8..1597d77 100644
--- a/gtksourceview/gtksourcecompletion.c
+++ b/gtksourceview/gtksourcecompletion.c
@@ -3251,9 +3251,9 @@ _gtk_source_completion_add_proposals (GtkSourceCompletion *completion,
/**
* gtk_source_completion_show:
- * @completion: A #GtkSourceCompletion
- * @providers: A list of #GtkSourceCompletionProvider or %NULL
- * @context: The #GtkSourceCompletionContext with which to start the completion
+ * @completion: z #GtkSourceCompletion.
+ * @providers: (allow-none): z list of #GtkSourceCompletionProvider, or %NULL.
+ * @context: 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.
@@ -3313,12 +3313,12 @@ gtk_source_completion_show (GtkSourceCompletion *completion,
/**
* gtk_source_completion_get_providers:
- * @completion: The #GtkSourceCompletion
+ * @completion: a #GtkSourceCompletion.
*
* Get list of providers registered on @completion. The returned list is owned
* by the completion and should not be freed.
*
- * Returns: list of #GtkSourceCompletionProvider
+ * Returns: (transfer none): list of #GtkSourceCompletionProvider.
*/
GList *
gtk_source_completion_get_providers (GtkSourceCompletion *completion)
@@ -3342,11 +3342,11 @@ gtk_source_completion_error_quark (void)
/**
* gtk_source_completion_new:
- * @view: A #GtkSourceView
+ * @view: a #GtkSourceView.
*
- * Create a new #GtkSourceCompletion associated with @view.
+ * Creates a new #GtkSourceCompletion associated with @view.
*
- * Returns: The new #GtkSourceCompletion.
+ * Returns: a new #GtkSourceCompletion.
*/
GtkSourceCompletion *
gtk_source_completion_new (GtkSourceView *view)
@@ -3360,9 +3360,9 @@ gtk_source_completion_new (GtkSourceView *view)
/**
* gtk_source_completion_add_provider:
- * @completion: A #GtkSourceCompletion
- * @provider: A #GtkSourceCompletionProvider
- * @error: A #GError
+ * @completion: a #GtkSourceCompletion.
+ * @provider: a #GtkSourceCompletionProvider.
+ * @error: (allow-none): a #GError.
*
* Add a new #GtkSourceCompletionProvider to the completion object. This will
* add a reference @provider, so make sure to unref your own copy when you
@@ -3425,9 +3425,9 @@ gtk_source_completion_add_provider (GtkSourceCompletion *completion,
/**
* gtk_source_completion_remove_provider:
- * @completion: A #GtkSourceCompletion
- * @provider: A #GtkSourceCompletionProvider
- * @error: A #GError
+ * @completion: a #GtkSourceCompletion.
+ * @provider: a #GtkSourceCompletionProvider.
+ * @error: (allow-none): a #GError.
*
* Remove @provider from the completion.
*
@@ -3492,7 +3492,7 @@ gtk_source_completion_remove_provider (GtkSourceCompletion *completion,
/**
* gtk_source_completion_hide:
- * @completion: A #GtkSourceCompletion
+ * @completion: a #GtkSourceCompletion.
*
* Hides the completion if it is active (visible).
*/
@@ -3510,12 +3510,13 @@ gtk_source_completion_hide (GtkSourceCompletion *completion)
/**
* gtk_source_completion_get_info_window:
- * @completion: A #GtkSourceCompletion
+ * @completion: a #GtkSourceCompletion.
*
* The info widget is the window where the completion displays optional extra
* information of the proposal.
*
- * Returns: The #GtkSourceCompletionInfo window.
+ * Returns: (transfer none): The #GtkSourceCompletionInfo window
+ * associated with @completion.
*/
GtkSourceCompletionInfo *
gtk_source_completion_get_info_window (GtkSourceCompletion *completion)
@@ -3525,11 +3526,11 @@ gtk_source_completion_get_info_window (GtkSourceCompletion *completion)
/**
* gtk_source_completion_get_view:
- * @completion: A #GtkSourceCompletion
+ * @completion: a #GtkSourceCompletion.
*
* The #GtkSourceView associated with @completion.
*
- * Returns: The #GtkSourceView associated with @completion.
+ * Returns: (transfer none): The #GtkSourceView associated with @completion.
*/
GtkSourceView *
gtk_source_completion_get_view (GtkSourceCompletion *completion)
@@ -3541,8 +3542,8 @@ gtk_source_completion_get_view (GtkSourceCompletion *completion)
/**
* gtk_source_completion_create_context:
- * @completion: A #GtkSourceCompletion
- * @position: A #GtkTextIter
+ * @completion: a #GtkSourceCompletion.
+ * @position: (allow-none): a #GtkTextIter, or %NULL.
*
* Create a new #GtkSourceCompletionContext for @completion. The position at
* which the completion using the new context will consider completion can
@@ -3552,7 +3553,6 @@ gtk_source_completion_get_view (GtkSourceCompletion *completion)
* 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.
- *
*/
GtkSourceCompletionContext *
gtk_source_completion_create_context (GtkSourceCompletion *completion,
@@ -3576,11 +3576,10 @@ gtk_source_completion_create_context (GtkSourceCompletion *completion,
/**
* gtk_source_completion_move_window:
- * @completion: A #GtkSourceCompletion
- * @iter: A #GtkTextIter
+ * @completion: a #GtkSourceCompletion.
+ * @iter: a #GtkTextIter.
*
* Move the completion window to a specific iter.
- *
*/
void
gtk_source_completion_move_window (GtkSourceCompletion *completion,
@@ -3601,13 +3600,12 @@ gtk_source_completion_move_window (GtkSourceCompletion *completion,
/**
* gtk_source_completion_block_interactive:
- * @completion: A # GtkSourceCompletion
+ * @completion: a #GtkSourceCompletion.
*
* Block interactive completion. This can be used to disable interactive
* completion when inserting or deleting text from the buffer associated with
* the completion. Use #gtk_source_completion_unblock_interactive to enable
* interactive completion again.
- *
**/
void
gtk_source_completion_block_interactive (GtkSourceCompletion *completion)
@@ -3622,12 +3620,11 @@ gtk_source_completion_block_interactive (GtkSourceCompletion *completion)
/**
* gtk_source_completion_unblock_interactive:
- * @completion: A # GtkSourceCompletion
+ * @completion: a #GtkSourceCompletion.
*
* Unblock interactive completion. This can be used after using
* #gtk_source_completion_block_interactive to enable interactive completion
* again.
- *
**/
void
gtk_source_completion_unblock_interactive (GtkSourceCompletion *completion)
diff --git a/gtksourceview/gtksourcecompletioncontext.c b/gtksourceview/gtksourcecompletioncontext.c
index 53d2d06..d635775 100644
--- a/gtksourceview/gtksourcecompletioncontext.c
+++ b/gtksourceview/gtksourcecompletioncontext.c
@@ -285,16 +285,15 @@ gtk_source_completion_context_init (GtkSourceCompletionContext *context)
/**
* gtk_source_completion_context_add_proposals:
- * @context: A #GtkSourceCompletionContext
- * @provider: A #GtkSourceCompletionProvider
- * @proposals: The list of proposals to add
- * @finished: Whether the provider is finished adding proposals
+ * @context: a #GtkSourceCompletionContext.
+ * @provider: a #GtkSourceCompletionProvider.
+ * @proposals: 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
* can do so asynchronously by means of the @finished argument. Providers must
* ensure that they always call this function with @finished set to %TRUE
* once each population (even if no proposals need to be added).
- *
**/
void
gtk_source_completion_context_add_proposals (GtkSourceCompletionContext *context,
@@ -314,12 +313,11 @@ gtk_source_completion_context_add_proposals (GtkSourceCompletionContext *contex
/**
* gtk_source_completion_context_get_iter:
- * @context: A #GtkSourceCompletionContext
- * @iter: A #GtkTextIter
+ * @context: a #GtkSourceCompletionContext.
+ * @iter: a #GtkTextIter.
*
* Get the iter at which the completion was invoked. Providers can use this
* to determine how and if to match proposals.
- *
**/
void
gtk_source_completion_context_get_iter (GtkSourceCompletionContext *context,
@@ -345,11 +343,11 @@ gtk_source_completion_context_get_iter (GtkSourceCompletionContext *context,
/**
* gtk_source_completion_context_get_activation:
- * @context: A #GtkSourceCompletionContext
+ * @context: a #GtkSourceCompletionContext.
*
- * Get the context activation
+ * Get the context activation.
*
- * Returns: The context activation
+ * Returns: The context activation.
*/
GtkSourceCompletionActivation
gtk_source_completion_context_get_activation (GtkSourceCompletionContext *context)
diff --git a/gtksourceview/gtksourcecompletioninfo.c b/gtksourceview/gtksourcecompletioninfo.c
index 095b2d1..ae72678 100644
--- a/gtksourceview/gtksourcecompletioninfo.c
+++ b/gtksourceview/gtksourcecompletioninfo.c
@@ -388,8 +388,7 @@ gtk_source_completion_info_class_init (GtkSourceCompletionInfoClass *klass)
/**
* gtk_source_completion_info_new:
*
- * Returns: The new GtkSourceCompletionInfo.
- *
+ * Returns: a new GtkSourceCompletionInfo.
*/
GtkSourceCompletionInfo *
gtk_source_completion_info_new (void)
@@ -401,15 +400,14 @@ gtk_source_completion_info_new (void)
/**
* gtk_source_completion_info_move_to_iter:
- * @info: A #GtkSourceCompletionInfo
- * @view: A #GtkTextView on which the info window should be positioned
- * @iter: A #GtkTextIter
+ * @info: a #GtkSourceCompletionInfo.
+ * @view: a #GtkTextView on which the info window should be positioned.
+ * @iter: (allow-none): a #GtkTextIter.
*
* Moves the #GtkSourceCompletionInfo to @iter. If @iter is %NULL @info is
* moved to the cursor position. Moving will respect the #GdkGravity setting
* of the info window and will ensure the line at @iter is not occluded by
* the window.
- *
*/
void
gtk_source_completion_info_move_to_iter (GtkSourceCompletionInfo *info,
@@ -441,19 +439,18 @@ gtk_source_completion_info_move_to_iter (GtkSourceCompletionInfo *info,
/**
* gtk_source_completion_info_set_sizing:
- * @info: A #GtkSourceCompletionInfo
- * @width: The maximum/requested width of the window (-1 to default)
- * @height: The maximum/requested height of the window (-1 to default)
- * @shrink_width: Whether to shrink the width of the window to fit its contents
+ * @info: a #GtkSourceCompletionInfo.
+ * @width: The maximum/requested width of the window (-1 to default).
+ * @height: The maximum/requested height of the window (-1 to default).
+ * @shrink_width: Whether to shrink the width of the window to fit its contents.
* @shrink_height: Whether to shrink the height of the window to fit its
- * contents
+ * contents.
*
* Set sizing information for the info window. If @shrink_width or
* @shrink_height is %TRUE, the info window will try to resize to fit the
* window contents, with a maximum size given by @width and @height. Setting
* @width or @height to -1 removes the maximum size of respectively the width
* and height of the window.
- *
*/
void
gtk_source_completion_info_set_sizing (GtkSourceCompletionInfo *info,
@@ -532,13 +529,12 @@ create_scrolled_window (GtkSourceCompletionInfo *info)
/**
* gtk_source_completion_info_set_widget:
- * @info: A #GtkSourceCompletionInfo
- * @widget: A #GtkWidget
+ * @info: a #GtkSourceCompletionInfo.
+ * @widget: (allow-none): a #GtkWidget.
*
* Sets the content widget of the info window. If @widget does not fit within
* the size requirements of the window, a #GtkScrolledWindow will automatically
* be created and added to the window.
- *
*/
void
gtk_source_completion_info_set_widget (GtkSourceCompletionInfo *info,
@@ -613,12 +609,11 @@ gtk_source_completion_info_set_widget (GtkSourceCompletionInfo *info,
/**
* gtk_source_completion_info_get_widget:
- * @info: A #GtkSourceCompletionInfo
+ * @info: a #GtkSourceCompletionInfo.
*
* Get the current content widget.
*
- * Returns: The current content widget.
- *
+ * Returns: (transfer none): The current content widget.
*/
GtkWidget *
gtk_source_completion_info_get_widget (GtkSourceCompletionInfo* info)
diff --git a/gtksourceview/gtksourcecompletionitem.c b/gtksourceview/gtksourcecompletionitem.c
index b9de44a..58e01d6 100644
--- a/gtksourceview/gtksourcecompletionitem.c
+++ b/gtksourceview/gtksourcecompletionitem.c
@@ -283,7 +283,7 @@ gtk_source_completion_item_class_init (GtkSourceCompletionItemClass *klass)
NULL,
G_PARAM_READWRITE));
- g_type_class_add_private (object_class, sizeof(GtkSourceCompletionItemPrivate));
+ g_type_class_add_private (object_class, sizeof (GtkSourceCompletionItemPrivate));
}
static void
@@ -294,17 +294,16 @@ gtk_source_completion_item_init (GtkSourceCompletionItem *self)
/**
* gtk_source_completion_item_new:
- * @label: The item label
- * @text: The item text
- * @icon: The item icon
- * @info: The item extra information
+ * @label: The item label.
+ * @text: The item text.
+ * @icon: (allow-none): The item icon.
+ * @info: (allow-none): The item extra information.
*
* Create a new #GtkSourceCompletionItem with label @label, icon @icon and
* extra information @info. Both @icon and @info can be %NULL in which case
* there will be no icon shown and no extra information available.
*
- * Returns: The new #GtkSourceCompletionItem.
- *
+ * Returns: a new #GtkSourceCompletionItem.
*/
GtkSourceCompletionItem *
gtk_source_completion_item_new (const gchar *label,
@@ -322,17 +321,16 @@ gtk_source_completion_item_new (const gchar *label,
/**
* gtk_source_completion_item_new_with_markup:
- * @markup: The item markup label
- * @text: The item text
- * @icon: The item icon
- * @info: The item extra information
+ * @markup: The item markup label.
+ * @text: The item text.
+ * @icon: (allow-none): The item icon.
+ * @info: (allow-none): The item extra information.
*
* Create a new #GtkSourceCompletionItem with markup label @markup, icon
* @icon and extra information @info. Both @icon and @info can be %NULL in
* which case there will be no icon shown and no extra information available.
*
- * Returns: The new #GtkSourceCompletionItem.
- *
+ * Returns: a new #GtkSourceCompletionItem.
*/
GtkSourceCompletionItem *
gtk_source_completion_item_new_with_markup (const gchar *markup,
@@ -350,16 +348,15 @@ gtk_source_completion_item_new_with_markup (const gchar *markup,
/**
* gtk_source_completion_item_new_from_stock:
- * @label: The item label
- * @text: The item text
- * @stock: The stock icon
- * @info: The item extra information
+ * @label: (allow-none): The item label.
+ * @text: The item text.
+ * @stock: The stock icon.
+ * @info: (allow-none): The item extra information.
*
* Creates a new #GtkSourceCompletionItem from a stock item. If @label is %NULL,
* the stock label will be used.
*
- * Returns: the newly constructed #GtkSourceCompletionItem.
- *
+ * Returns: a new #GtkSourceCompletionItem.
*/
GtkSourceCompletionItem *
gtk_source_completion_item_new_from_stock (const gchar *label,
diff --git a/gtksourceview/gtksourcecompletionproposal.c b/gtksourceview/gtksourcecompletionproposal.c
index 52859fb..35724dc 100644
--- a/gtksourceview/gtksourcecompletionproposal.c
+++ b/gtksourceview/gtksourcecompletionproposal.c
@@ -160,61 +160,64 @@ gtk_source_completion_proposal_get_type ()
/**
* gtk_source_completion_proposal_get_label:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Gets the label of @proposal. The label is shown in the list of proposals as
* plain text. If you need any markup (such as bold or italic text), you have
* to implement #gtk_source_completion_proposal_get_markup. The returned string
* must be freed with g_free().
*
- * Returns: A new string containing the label of @proposal.
+ * Returns: a new string containing the label of @proposal.
*/
gchar *
gtk_source_completion_proposal_get_label (GtkSourceCompletionProposal *proposal)
{
- g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+ g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+
return GTK_SOURCE_COMPLETION_PROPOSAL_GET_INTERFACE (proposal)->get_label (proposal);
}
/**
* gtk_source_completion_proposal_get_markup:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Gets the label of @proposal with markup. The label is shown in the list of
* proposals and may contain markup. This will be used instead of
* #gtk_source_completion_proposal_get_label if implemented. The returned string
* must be freed with g_free().
*
- * Returns: A new string containing the label of @proposal with markup.
+ * Returns: a new string containing the label of @proposal with markup.
*/
gchar *
gtk_source_completion_proposal_get_markup (GtkSourceCompletionProposal *proposal)
{
- g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+ g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+
return GTK_SOURCE_COMPLETION_PROPOSAL_GET_INTERFACE (proposal)->get_markup (proposal);
}
/**
* gtk_source_completion_proposal_get_text:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Gets the text of @proposal. The text that is inserted into
* the text buffer when the proposal is activated by the default activation.
* You are free to implement a custom activation handler in the provider and
* not implement this function. The returned string must be freed with g_free().
*
- * Returns: A new string containing the text of @proposal.
+ * Returns: a new string containing the text of @proposal.
*/
gchar *
gtk_source_completion_proposal_get_text (GtkSourceCompletionProposal *proposal)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+
return GTK_SOURCE_COMPLETION_PROPOSAL_GET_INTERFACE (proposal)->get_text (proposal);
}
/**
* gtk_source_completion_proposal_get_icon:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Gets the icon of @proposal.
*
@@ -224,56 +227,57 @@ GdkPixbuf *
gtk_source_completion_proposal_get_icon (GtkSourceCompletionProposal *proposal)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+
return GTK_SOURCE_COMPLETION_PROPOSAL_GET_INTERFACE (proposal)->get_icon (proposal);
}
/**
* gtk_source_completion_proposal_get_info:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Gets extra information associated to the proposal. This information will be
* used to present the user with extra, detailed information about the
* selected proposal. The returned string must be freed with g_free().
*
- * Returns: A new string containing extra information of @proposal or %NULL if
+ * Returns: a new string containing extra information of @proposal or %NULL if
* no extra information is associated to @proposal.
*/
gchar *
gtk_source_completion_proposal_get_info (GtkSourceCompletionProposal *proposal)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
+
return GTK_SOURCE_COMPLETION_PROPOSAL_GET_INTERFACE (proposal)->get_info (proposal);
}
/**
* gtk_source_completion_proposal_hash:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Get the hash value of @proposal. This is used to (together with
* #gtk_source_completion_proposal_equal) to match proposals in the completion
* model. By default, it uses a direct hash (#g_direct_hash).
*
- * Returns: The hash value of @proposal
- *
+ * Returns: The hash value of @proposal.
**/
guint
-gtk_source_completion_proposal_hash (GtkSourceCompletionProposal *proposal)
+gtk_source_completion_proposal_hash (GtkSourceCompletionProposal *proposal)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), 0);
+
return GTK_SOURCE_COMPLETION_PROPOSAL_GET_INTERFACE (proposal)->hash (proposal);
}
/**
* gtk_source_completion_proposal_equal:
- * @proposal: A #GtkSourceCompletionProposal
- * @other: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
+ * @other: a #GtkSourceCompletionProposal.
*
* Get whether two proposal objects are the same. This is used to (together
* with #gtk_source_completion_proposal_hash) to match proposals in the
* completion model. By default, it uses direct equality (#g_direct_equal).
*
* Returns: %TRUE if @proposal and @object are the same proposal
- *
**/
gboolean
gtk_source_completion_proposal_equal (GtkSourceCompletionProposal *proposal,
@@ -287,7 +291,7 @@ gtk_source_completion_proposal_equal (GtkSourceCompletionProposal *proposal,
/**
* gtk_source_completion_proposal_changed:
- * @proposal: A #GtkSourceCompletionProposal
+ * @proposal: a #GtkSourceCompletionProposal.
*
* Emits the "changed" signal on @proposal. This should be called by
* implementations whenever the name, icon or info of the proposal has
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index 755051e..8e2e8a8 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -173,18 +173,19 @@ gtk_source_completion_provider_get_type ()
/**
* gtk_source_completion_provider_get_name:
- * @provider: The #GtkSourceCompletionProvider
+ * @provider: a #GtkSourceCompletionProvider.
*
* Get the name of the provider. This should be a translatable name for
* display to the user. For example: _("Document word completion provider"). The
* returned string must be freed with g_free().
*
- * Returns: A new string containing the name of the provider.
+ * Returns: a new string containing the name of the provider.
*/
gchar *
gtk_source_completion_provider_get_name (GtkSourceCompletionProvider *provider)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider), NULL);
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_name (provider);
}
@@ -201,64 +202,66 @@ GdkPixbuf *
gtk_source_completion_provider_get_icon (GtkSourceCompletionProvider *provider)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider), NULL);
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_icon (provider);
}
/**
* gtk_source_completion_provider_populate:
- * @provider: The #GtkSourceCompletionProvider
- * @context: The #GtkSourceCompletionContext
- *
- * Populate @context with proposals from @provider
+ * @provider: a #GtkSourceCompletionProvider.
+ * @context: a #GtkSourceCompletionContext.
*
+ * Populate @context with proposals from @provider.
*/
void
gtk_source_completion_provider_populate (GtkSourceCompletionProvider *provider,
GtkSourceCompletionContext *context)
{
g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider));
+
GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->populate (provider, context);
}
/**
* gtk_source_completion_provider_get_activation:
- * @provider: A #GtkSourceCompletionProvider
+ * @provider: a #GtkSourceCompletionProvider.
*
* Get with what kind of activation the provider should be activated.
*
* Returns: a combination of #GtkSourceCompletionActivation.
- *
**/
GtkSourceCompletionActivation
gtk_source_completion_provider_get_activation (GtkSourceCompletionProvider *provider)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider), GTK_SOURCE_COMPLETION_ACTIVATION_NONE);
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_activation (provider);
}
/**
* gtk_source_completion_provider_match:
- * @provider: The #GtkSourceCompletionProvider
- * @context: The #GtkSourceCompletionContext
+ * @provider: a #GtkSourceCompletionProvider.
+ * @context: a #GtkSourceCompletionContext.
*
* Get whether the provider match the context of completion detailed in
* @context.
*
- * Returns: %TRUE if @provider matches the completion context, %FALSE otherwise
+ * Returns: %TRUE if @provider matches the completion context, %FALSE otherwise.
*/
gboolean
gtk_source_completion_provider_match (GtkSourceCompletionProvider *provider,
GtkSourceCompletionContext *context)
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider), TRUE);
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->match (provider,
context);
}
/**
* gtk_source_completion_provider_get_info_widget:
- * @provider: The #GtkSourceCompletionProvider
- * @proposal: The currently selected #GtkSourceCompletionProposal
+ * @provider: a #GtkSourceCompletionProvider.
+ * @proposal: a currently selected #GtkSourceCompletionProposal.
*
* Get a customized info widget to show extra information of a proposal.
* This allows for customized widgets on a proposal basis, although in general
@@ -277,15 +280,15 @@ gtk_source_completion_provider_get_info_widget (GtkSourceCompletionProvider *pro
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider), NULL);
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), NULL);
-
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_info_widget (provider, proposal);
}
/**
* gtk_source_completion_provider_update_info:
- * @provider: A #GtkSourceCompletionProvider
- * @proposal: A #GtkSourceCompletionProposal
- * @info: A #GtkSourceCompletionInfo
+ * @provider: a #GtkSourceCompletionProvider.
+ * @proposal: a #GtkSourceCompletionProposal.
+ * @info: a #GtkSourceCompletionInfo.
*
* Update extra information shown in @info for @proposal. This should be
* implemented if your provider sets a custom info widget for @proposal.
@@ -300,24 +303,23 @@ gtk_source_completion_provider_update_info (GtkSourceCompletionProvider *provide
g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider));
g_return_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal));
g_return_if_fail (GTK_IS_SOURCE_COMPLETION_INFO (info));
-
+
GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->update_info (provider, proposal, info);
}
/**
* gtk_source_completion_provider_get_start_iter:
- * @provider: A #GtkSourceCompletionProvider
- * @proposal: A #GtkSourceCompletionProposal
- * @context: A #GtkSourceCompletionContext
- * @iter: A #GtkTextIter
+ * @provider: a #GtkSourceCompletionProvider.
+ * @proposal: a #GtkSourceCompletionProposal.
+ * @context: a #GtkSourceCompletionContext.
+ * @iter: a #GtkTextIter.
*
* Get the #GtkTextIter at which the completion for @proposal starts. When
* implemented, the completion can use this information to position the
* completion window accordingly when a proposal is selected in the completion
* window.
*
- * Returns: %TRUE if @iter was set for @proposal, %FALSE otherwise
- *
+ * Returns: %TRUE if @iter was set for @proposal, %FALSE otherwise.
**/
gboolean
gtk_source_completion_provider_get_start_iter (GtkSourceCompletionProvider *provider,
@@ -329,7 +331,7 @@ gtk_source_completion_provider_get_start_iter (GtkSourceCompletionProvider *prov
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_CONTEXT (context), FALSE);
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), FALSE);
g_return_val_if_fail (iter != NULL, FALSE);
-
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_start_iter (provider,
context,
proposal,
@@ -338,9 +340,9 @@ gtk_source_completion_provider_get_start_iter (GtkSourceCompletionProvider *prov
/**
* gtk_source_completion_provider_activate_proposal:
- * @provider: A #GtkSourceCompletionProvider
- * @proposal: A #GtkSourceCompletionProposal
- * @iter: A #GtkTextIter
+ * @provider: a #GtkSourceCompletionProvider.
+ * @proposal: a #GtkSourceCompletionProposal.
+ * @iter: a #GtkTextIter.
*
* Activate @proposal at @iter. When this functions returns %FALSE, the default
* activation of @proposal will take place which replaces the word at @iter
@@ -356,7 +358,7 @@ gtk_source_completion_provider_activate_proposal (GtkSourceCompletionProvider *p
{
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROVIDER (provider), FALSE);
g_return_val_if_fail (GTK_IS_SOURCE_COMPLETION_PROPOSAL (proposal), FALSE);
-
+
return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->activate_proposal (provider,
proposal,
iter);
@@ -364,14 +366,13 @@ gtk_source_completion_provider_activate_proposal (GtkSourceCompletionProvider *p
/**
* gtk_source_completion_provider_get_interactive_delay:
- * @provider: A # GtkSourceCompletionProvider
+ * @provider: a #GtkSourceCompletionProvider.
*
* Get the delay in milliseconds before starting interactive completion for
* this provider. A value of -1 indicates to use the default value as set
* by #GtkSourceCompletion::auto-complete-delay.
*
* Returns: the interactive delay in milliseconds.
- *
**/
gint
gtk_source_completion_provider_get_interactive_delay (GtkSourceCompletionProvider *provider)
@@ -383,14 +384,13 @@ gtk_source_completion_provider_get_interactive_delay (GtkSourceCompletionProvide
/**
* gtk_source_completion_provider_get_priority:
- * @provider: A # GtkSourceCompletionProvider
+ * @provider: a #GtkSourceCompletionProvider.
*
* Get the provider priority. The priority determines the order in which
* proposals appear in the completion popup. Higher priorities are sorted
* before lower priorities. The default priority is 0.
*
* Returns: the provider priority.
- *
**/
gint
gtk_source_completion_provider_get_priority (GtkSourceCompletionProvider *provider)
diff --git a/gtksourceview/gtksourcecompletionutils.c b/gtksourceview/gtksourcecompletionutils.c
index e43c934..1b61398 100644
--- a/gtksourceview/gtksourcecompletionutils.c
+++ b/gtksourceview/gtksourcecompletionutils.c
@@ -25,11 +25,11 @@
/**
* gtk_source_completion_utils_is_separator:
- * @ch: The character to check
+ * @ch: the character to check.
*
* A separator is a character like (, an space etc. An _ is not a separator
*
- * Returns: TRUE if @ch is a separator
+ * Returns: %TRUE if @ch is a separator.
*/
gboolean
gtk_source_completion_utils_is_separator (const gunichar ch)
@@ -46,11 +46,11 @@ gtk_source_completion_utils_is_separator (const gunichar ch)
/**
* gtk_source_completion_utils_get_word_iter:
*
- * @source_buffer: The #GtkSourceBuffer
- * @start_word: if != NULL then assign it the start position of the word
- * @end_word: if != NULL then assing it the end position of the word
+ * @source_buffer: a #GtkSourceBuffer.
+ * @start_word: (allow-none): if != NULL then assign it the start position of the word
+ * @end_word: (allow-none): if != NULL then assing it the end position of the word
*
- * Returns: the current word
+ * Returns: the current word.
*/
gchar *
gtk_source_completion_utils_get_word_iter (GtkSourceBuffer *source_buffer,
@@ -101,9 +101,9 @@ gtk_source_completion_utils_get_word_iter (GtkSourceBuffer *source_buffer,
/**
* gtk_source_completion_utils_get_word:
- * @source_buffer: The #GtkSourceBuffer
+ * @source_buffer: a #GtkSourceBuffer.
*
- * Returns: the current word
+ * Returns: the current word.
*/
gchar *
gtk_source_completion_utils_get_word (GtkSourceBuffer *source_buffer)
@@ -184,10 +184,10 @@ gtk_source_completion_utils_replace_word (GtkSourceBuffer *source_buffer,
/**
* gtk_source_completion_utils_replace_current_word:
- * @source_buffer: The #GtkSourceBuffer
- * @text: The text to be inserted instead of the current word
+ * @source_buffer: a #GtkSourceBuffer.
+ * @text: (allow-none): The text to be inserted instead of the current word.
*
- * Replaces the current word in the #GtkSourceBuffer with the new word
+ * Replaces the current word in the #GtkSourceBuffer with the new word.
*/
void
gtk_source_completion_utils_replace_current_word (GtkSourceBuffer *source_buffer,
@@ -285,9 +285,9 @@ move_overlap (gint *x,
/**
* gtk_source_completion_utils_move_to_iter:
- * @window: the #GtkWindow to move
- * @view: the view
- * @iter: the iter to move @window to
+ * @window: (allow-none): the #GtkWindow to move.
+ * @view: the #GtkSourceView.
+ * @iter: the iter to move @window to.
*
*/
void
@@ -360,8 +360,8 @@ gtk_source_completion_utils_move_to_iter (GtkWindow *window,
/**
* gtk_source_completion_utils_get_pos_at_cursor:
- * @window: the #GtkWindow to move
- * @view: the view
+ * @window: the #GtkWindow to move.
+ * @view: the #GtkSoureView.
*
*/
void
diff --git a/gtksourceview/gtksourcegutter.c b/gtksourceview/gtksourcegutter.c
index 084333f..28c9d43 100644
--- a/gtksourceview/gtksourcegutter.c
+++ b/gtksourceview/gtksourcegutter.c
@@ -491,7 +491,7 @@ gtk_source_gutter_new (GtkSourceView *view,
/**
* gtk_source_gutter_get_window:
- * @gutter: a #GtkSourceGutter
+ * @gutter: a #GtkSourceGutter.
*
* 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.
@@ -512,9 +512,9 @@ gtk_source_gutter_get_window (GtkSourceGutter *gutter)
/**
* gtk_source_gutter_insert:
- * @gutter: a #GtkSourceGutter
- * @renderer: a #GtkCellRenderer
- * @position: the renderers position
+ * @gutter: a #GtkSourceGutter.
+ * @renderer: a #GtkCellRenderer.
+ * @position: the renderers position.
*
* Inserts @renderer into @gutter at @position.
*
@@ -560,9 +560,9 @@ renderer_find (GtkSourceGutter *gutter,
/**
* gtk_source_gutter_reorder:
- * @gutter: a #GtkSourceGutter
- * @renderer: a #GtkCellRenderer
- * @position: the new renderer position
+ * @gutter: a #GtkSourceGutter.
+ * @renderer: a #GtkCellRenderer.
+ * @position: the new renderer position.
*
* Reorders @renderer in @gutter to new @position.
*
@@ -589,8 +589,8 @@ gtk_source_gutter_reorder (GtkSourceGutter *gutter,
/**
* gtk_source_gutter_remove:
- * @gutter: a #GtkSourceGutter
- * @renderer: a #GtkCellRenderer
+ * @gutter: a #GtkSourceGutter.
+ * @renderer: a #GtkCellRenderer.
*
* Removes @renderer from @gutter.
*
@@ -617,11 +617,11 @@ gtk_source_gutter_remove (GtkSourceGutter *gutter,
/**
* gtk_source_gutter_set_cell_data_func:
- * @gutter: a #GtkSourceGutter
- * @renderer: a #GtkCellRenderer
- * @func: the #GtkSourceGutterDataFunc to use
- * @func_data: the user data for @func
- * @destroy: the destroy notification for @func_data
+ * @gutter: a #GtkSourceGutter.
+ * @renderer: a #GtkCellRenderer.
+ * @func: (allow-none): the #GtkSourceGutterDataFunc to use.
+ * @func_data: (allow-none): the user data for @func.
+ * @destroy: (allow-none): the destroy notification for @func_data.
*
* Sets the #GtkSourceGutterDataFunc to use for @renderer. This function is
* used to setup the cell renderer properties for rendering the current cell.
@@ -659,11 +659,11 @@ gtk_source_gutter_set_cell_data_func (GtkSourceGutter *gutter,
/**
* gtk_source_gutter_set_cell_size_func:
- * @gutter: a #GtkSourceGutter
- * @renderer: a #GtkCellRenderer
- * @func: the #GtkSourceGutterSizeFunc to use
- * @func_data: the user data for @func
- * @destroy: the destroy notification for @func_data
+ * @gutter: a #GtkSourceGutter.
+ * @renderer: a #GtkCellRenderer.
+ * @func: (allow-none): the #GtkSourceGutterSizeFunc to use.
+ * @func_data: (allow-none): the user data for @func.
+ * @destroy: (allow-none): the destroy notification for @func_data.
*
* Sets the #GtkSourceGutterSizeFunc to use for @renderer. This function is
* used to setup the cell renderer properties for measuring the maximum size
@@ -702,7 +702,7 @@ gtk_source_gutter_set_cell_size_func (GtkSourceGutter *gutter,
/**
* gtk_source_gutter_queue_draw:
- * @gutter: a #GtkSourceGutter
+ * @gutter: a #GtkSourceGutter.
*
* Invalidates the drawable area of the gutter. You can use this to force a
* redraw of the gutter if something has changed and needs to be redrawn.
diff --git a/gtksourceview/gtksourceiter.c b/gtksourceview/gtksourceiter.c
index 6a9eb6f..6f2584f 100644
--- a/gtksourceview/gtksourceiter.c
+++ b/gtksourceview/gtksourceiter.c
@@ -571,9 +571,9 @@ breakup_string (const char *string,
* @iter: start of search.
* @str: a search string.
* @flags: flags affecting how the search is done.
- * @match_start: return location for start of match, or %NULL.
- * @match_end: return location for end of match, or %NULL.
- * @limit: bound for the search, or %NULL for the end of the buffer.
+ * @match_start: (allow-none): return location for start of match, or %NULL.
+ * @match_end: (allow-none): return location for end of match, or %NULL.
+ * @limit: (allow-none): bound for the search, or %NULL for the end of the buffer.
*
* Searches forward for @str. Any match is returned by setting
* @match_start to the first character of the match and @match_end to the
@@ -691,9 +691,9 @@ gtk_source_iter_forward_search (const GtkTextIter *iter,
* @iter: a #GtkTextIter where the search begins.
* @str: search string.
* @flags: bitmask of flags affecting the search.
- * @match_start: return location for start of match, or %NULL.
- * @match_end: return location for end of match, or %NULL.
- * @limit: location of last possible @match_start, or %NULL for start of buffer.
+ * @match_start:: (allow-none) return location for start of match, or %NULL.
+ * @match_end: (allow-none): return location for end of match, or %NULL.
+ * @limit: (allow-none): location of last possible @match_start, or %NULL for start of buffer.
*
* Same as gtk_text_iter_backward_search(), but supports case insensitive
* searching.
diff --git a/gtksourceview/gtksourcelanguage.c b/gtksourceview/gtksourcelanguage.c
index 87038ad..1873121 100644
--- a/gtksourceview/gtksourcelanguage.c
+++ b/gtksourceview/gtksourcelanguage.c
@@ -475,10 +475,10 @@ _gtk_source_language_translate_string (GtkSourceLanguage *language,
* @language: a #GtkSourceLanguage.
*
* Returns the ID of the language. The ID is not locale-dependent.
- *
- * Returns: the ID of @language.
* The returned string is owned by @language and should not be freed
* or modified.
+ *
+ * Returns: the ID of @language.
**/
const gchar *
gtk_source_language_get_id (GtkSourceLanguage *language)
@@ -494,10 +494,10 @@ gtk_source_language_get_id (GtkSourceLanguage *language)
* @language: a #GtkSourceLanguage.
*
* Returns the localized name of the language.
- *
- * Returns: the name of @language.
* The returned string is owned by @language and should not be freed
* or modified.
+ *
+ * Returns: the name of @language.
**/
const gchar *
gtk_source_language_get_name (GtkSourceLanguage *language)
@@ -515,10 +515,10 @@ gtk_source_language_get_name (GtkSourceLanguage *language)
* Returns the localized section of the language.
* Each language belong to a section (ex. HTML belogs to the
* Markup section).
- *
- * Returns: the section of @language.
* The returned string is owned by @language and should not be freed
* or modified.
+ *
+ * Returns: the section of @language.
**/
const gchar *
gtk_source_language_get_section (GtkSourceLanguage *language)
@@ -535,7 +535,7 @@ gtk_source_language_get_section (GtkSourceLanguage *language)
*
* Returns whether the language should be hidden from the user.
*
- * Returns: TRUE if the language should be hidden, FALSE otherwise.
+ * Returns: %TRUE if the language should be hidden, %FALSE otherwise.
*/
gboolean
gtk_source_language_get_hidden (GtkSourceLanguage *language)
@@ -574,8 +574,9 @@ gtk_source_language_get_metadata (GtkSourceLanguage *language,
* retrieve the "mimetypes" metadata property and split it into an
* array.
*
- * Returns: a newly-allocated %NULL terminated array containing
- * the mime types or %NULL if no mime types are found.
+ * Returns: (array zero-terminated=1): 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().
**/
gchar **
@@ -600,7 +601,7 @@ 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: a newly-allocated %NULL terminated array containing
+ * Returns: (array zero-terminated=1): 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().
**/
@@ -622,7 +623,7 @@ gtk_source_language_get_globs (GtkSourceLanguage *language)
* _gtk_source_language_get_language_manager:
* @language: a #GtkSourceLanguage.
*
- * Returns: #GtkSourceLanguageManager for @language.
+ * Returns: (transfer none): the #GtkSourceLanguageManager for @language.
**/
GtkSourceLanguageManager *
_gtk_source_language_get_language_manager (GtkSourceLanguage *language)
@@ -830,11 +831,11 @@ force_styles (GtkSourceLanguage *language)
/**
* gtk_source_language_get_style_ids:
- * @language: a #GtkSourceLanguage
+ * @language: a #GtkSourceLanguage.
*
* Returns the ids of the styles defined by this @language.
*
- * Returns: a %NULL terminated array containing
+ * 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().
*/
@@ -867,8 +868,8 @@ get_style_info (GtkSourceLanguage *language, const char *style_id)
/**
* gtk_source_language_get_style_name:
- * @language: a #GtkSourceLanguage
- * @style_id: a style ID
+ * @language: a #GtkSourceLanguage.
+ * @style_id: a style ID.
*
* Returns the name of the style with ID @style_id defined by this @language.
*
diff --git a/gtksourceview/gtksourcelanguagemanager.c b/gtksourceview/gtksourcelanguagemanager.c
index ac6466a..e592b19 100644
--- a/gtksourceview/gtksourcelanguagemanager.c
+++ b/gtksourceview/gtksourcelanguagemanager.c
@@ -183,7 +183,7 @@ gtk_source_language_manager_init (GtkSourceLanguageManager *lm)
* manager or a private language manager instance then use
* gtk_source_language_manager_get_default() instead.
*
- * Returns: a #GtkSourceLanguageManager.
+ * Returns: a new #GtkSourceLanguageManager.
*/
GtkSourceLanguageManager *
gtk_source_language_manager_new (void)
@@ -196,7 +196,7 @@ gtk_source_language_manager_new (void)
*
* Returns the default #GtkSourceLanguageManager instance.
*
- * Returns: a #GtkSourceLanguageManager. Return value is owned
+ * Returns: (transfer-none): a #GtkSourceLanguageManager. Return value is owned
* by GtkSourceView library and must not be unref'ed.
*/
GtkSourceLanguageManager *
@@ -224,7 +224,8 @@ notify_search_path (GtkSourceLanguageManager *mgr)
/**
* gtk_source_language_manager_set_search_path:
* @lm: a #GtkSourceLanguageManager.
- * @dirs: a %NULL-terminated array of strings or %NULL.
+ * @dirs: (allow-none) (array zero-terminated=1):
+ * a %NULL-terminated array of strings or %NULL.
*
* Sets the list of directories where the @lm looks for
* language files.
@@ -269,7 +270,8 @@ gtk_source_language_manager_set_search_path (GtkSourceLanguageManager *lm,
*
* Gets the list directories where @lm looks for language files.
*
- * Returns: %NULL-terminated array containg a list of language files directories.
+ * Returns: (array zero-terminated) (transfer none): %NULL-terminated array
+ * containg a list of language files directories.
* The array is owned by @lm and must not be modified.
*/
G_CONST_RETURN gchar* G_CONST_RETURN *
@@ -382,7 +384,7 @@ ensure_languages (GtkSourceLanguageManager *lm)
/**
* gtk_source_language_manager_get_language_ids:
- * @lm: a #GtkSourceLanguageManager
+ * @lm: a #GtkSourceLanguageManager.
*
* Returns the ids of the available languages.
*
@@ -408,7 +410,7 @@ gtk_source_language_manager_get_language_ids (GtkSourceLanguageManager *lm)
* Gets the #GtkSourceLanguage identified by the given @id in the language
* manager.
*
- * Returns: a #GtkSourceLanguage, or %NULL if there is no language
+ * Returns: (transfer none): a #GtkSourceLanguage, or %NULL if there is no language
* identified by the given @id. Return value is owned by @lm and should not
* be freed.
*/
@@ -571,8 +573,8 @@ pick_lang_for_mime_type (GtkSourceLanguageManager *lm,
/**
* gtk_source_language_manager_guess_language:
* @lm: a #GtkSourceLanguageManager.
- * @filename: a filename in Glib filename encoding, or %NULL.
- * @content_type: a content type (as in GIO API), or %NULL.
+ * @filename: (allow-none): a filename in Glib filename encoding, or %NULL.
+ * @content_type: (allow-none): a content type (as in GIO API), or %NULL.
*
* Picks a #GtkSourceLanguage for given file name and content type,
* according to the information in lang files. Either @filename or
@@ -607,7 +609,7 @@ pick_lang_for_mime_type (GtkSourceLanguageManager *lm,
* etc. Use gtk_source_language_get_mime_types() and gtk_source_language_get_globs()
* if you need full control over file -> language mapping.
*
- * Returns: a #GtkSourceLanguage, or %NULL if there is no suitable language
+ * Returns: (transfer none): a #GtkSourceLanguage, or %NULL if there is no suitable language
* for given @filename and/or @content_type. Return value is owned by @lm
* and should not be freed.
*
diff --git a/gtksourceview/gtksourcemark.c b/gtksourceview/gtksourcemark.c
index 6c6d29c..21407f1 100644
--- a/gtksourceview/gtksourcemark.c
+++ b/gtksourceview/gtksourcemark.c
@@ -166,7 +166,7 @@ gtk_source_mark_init (GtkSourceMark *mark)
* Normally marks are created using the utility function
* gtk_source_buffer_create_mark().
*
- * Returns: a new #GtkSourceMark that can be added using gtk_text_buffer_add_mark()
+ * Returns: a new #GtkSourceMark that can be added using gtk_text_buffer_add_mark().
*
* Since: 2.2
*/
@@ -185,11 +185,11 @@ gtk_source_mark_new (const gchar *name,
/**
* gtk_source_mark_get_category:
- * @mark: a #GtkSourceMark
+ * @mark: a #GtkSourceMark.
*
- * Returns the mark category
+ * Returns the mark category.
*
- * Returns: the category of the #GtkSourceMark
+ * Returns: the category of the #GtkSourceMark.
*
* Since: 2.2
*/
@@ -203,15 +203,15 @@ gtk_source_mark_get_category (GtkSourceMark *mark)
/**
* gtk_source_mark_next:
- * @mark: a #GtkSourceMark
- * @category: a string specifying the mark category or %NULL
+ * @mark: a #GtkSourceMark.
+ * @category: (allow-none): a string specifying the mark category, or %NULL.
*
* Returns the next #GtkSourceMark in the buffer or %NULL if the mark
* was not added to a buffer. If there is no next mark, %NULL will be returned.
*
- * If @category is %NULL, looks for marks of any category
+ * If @category is %NULL, looks for marks of any category.
*
- * Returns: the next #GtkSourceMark or %NULL
+ * Returns: the next #GtkSourceMark, or %NULL.
*
* Since: 2.2
*/
@@ -233,15 +233,15 @@ gtk_source_mark_next (GtkSourceMark *mark,
/**
* gtk_source_mark_prev:
- * @mark: a #GtkSourceMark
- * @category: a string specifying the mark category or %NULL
+ * @mark: a #GtkSourceMark.
+ * @category: a string specifying the mark category, or %NULL.
*
* Returns the previous #GtkSourceMark in the buffer or %NULL if the mark
* was not added to a buffer. If there is no previous mark, %NULL is returned.
*
* If @category is %NULL, looks for marks of any category
*
- * Returns: the previous #GtkSourceMark or %NULL
+ * Returns: the previous #GtkSourceMark, or %NULL.
*
* Since: 2.2
*/
diff --git a/gtksourceview/gtksourceprintcompositor.c b/gtksourceview/gtksourceprintcompositor.c
index d6e305b..9d801cf 100644
--- a/gtksourceview/gtksourceprintcompositor.c
+++ b/gtksourceview/gtksourceprintcompositor.c
@@ -759,7 +759,7 @@ gtk_source_print_compositor_init (GtkSourcePrintCompositor *compositor)
/**
* gtk_source_print_compositor_new:
- * @buffer: the #GtkSourceBuffer to print
+ * @buffer: the #GtkSourceBuffer to print.
*
* Creates a new print compositor that can be used to print @buffer.
*
@@ -834,7 +834,7 @@ gtk_source_print_compositor_new_from_view (GtkSourceView *view)
* object reference is owned by the compositor object and
* should not be unreferenced.
*
- * Return value: the #GtkSourceBuffer associated with the compositor.
+ * Return value: (transfer none): the #GtkSourceBuffer associated with the compositor.
*
* Since: 2.2
**/
@@ -1135,9 +1135,9 @@ gtk_source_print_compositor_get_print_footer (GtkSourcePrintCompositor *composit
* gtk_source_print_compositor_set_header_format:
* @compositor: a #GtkSourcePrintCompositor.
* @separator: %TRUE if you want a separator line to be printed.
- * @left: a format string to print on the left of the header.
- * @center: a format string to print on the center of the header.
- * @right: a format string to print on the right of the header.
+ * @left: (allow-none): a format string to print on the left of the header.
+ * @center: (allow-none): a format string to print on the center of the header.
+ * @right: (allow-none): a format string to print on the right of the header.
*
* Sets strftime like header format strings, to be printed on the
* left, center and right of the top of each page. The strings may
@@ -1186,9 +1186,9 @@ gtk_source_print_compositor_set_header_format (GtkSourcePrintCompositor *composi
* gtk_source_print_compositor_set_footer_format:
* @compositor: a #GtkSourcePrintCompositor.
* @separator: %TRUE if you want a separator line to be printed.
- * @left: a format string to print on the left of the footer.
- * @center: a format string to print on the center of the footer.
- * @right: a format string to print on the right of the footer.
+ * @left: (allow-none): a format string to print on the left of the footer.
+ * @center: (allow-none): a format string to print on the center of the footer.
+ * @right: (allow-none): a format string to print on the right of the footer.
*
* Sets strftime like header format strings, to be printed on the
* left, center and right of the bottom of each page. The strings may
@@ -1249,7 +1249,7 @@ guint
gtk_source_print_compositor_get_print_line_numbers (GtkSourcePrintCompositor *compositor)
{
g_return_val_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor), 0);
-
+
return compositor->priv->print_line_numbers;
}
@@ -1340,7 +1340,7 @@ gtk_source_print_compositor_get_body_font_name (GtkSourcePrintCompositor *compos
/**
* gtk_source_print_compositor_set_line_numbers_font_name:
* @compositor: a #GtkSourcePrintCompositor.
- * @font_name: the name of the font for line numbers, or %NULL.
+ * @font_name: (allow-none): the name of the font for line numbers, or %NULL.
*
* Sets the font for printing line numbers on the left margin. If
* %NULL is supplied, the default font (i.e. the one being used for the
@@ -1363,7 +1363,7 @@ gtk_source_print_compositor_set_line_numbers_font_name (GtkSourcePrintCompositor
g_return_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor));
g_return_if_fail (font_name != NULL);
g_return_if_fail (compositor->priv->state == INIT);
-
+
if (set_font_description_from_name (compositor,
&compositor->priv->line_numbers_font,
font_name))
@@ -1377,7 +1377,7 @@ gtk_source_print_compositor_set_line_numbers_font_name (GtkSourcePrintCompositor
* @compositor: a #GtkSourcePrintCompositor.
*
* Returns the name of the font used to print line numbers on the left margin.
- * The returned string must be freed with g_free())
+ * The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print
* line numbers on the left margin.
@@ -1401,7 +1401,7 @@ gtk_source_print_compositor_get_line_numbers_font_name (GtkSourcePrintCompositor
/**
* gtk_source_print_compositor_set_header_font_name:
* @compositor: a #GtkSourcePrintCompositor.
- * @font_name: the name of the font for header text, or %NULL.
+ * @font_name: (allow-none): the name of the font for header text, or %NULL.
*
* Sets the font for printing the page header. If
* %NULL is supplied, the default font (i.e. the one being used for the
@@ -1424,7 +1424,7 @@ gtk_source_print_compositor_set_header_font_name (GtkSourcePrintCompositor *comp
g_return_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor));
g_return_if_fail (font_name != NULL);
g_return_if_fail (compositor->priv->state == INIT);
-
+
if (set_font_description_from_name (compositor,
&compositor->priv->header_font,
font_name))
@@ -1439,7 +1439,7 @@ gtk_source_print_compositor_set_header_font_name (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
*
* Returns the name of the font used to print the page header.
- * The returned string must be freed with g_free())
+ * The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print
* the page header.
@@ -1456,14 +1456,14 @@ gtk_source_print_compositor_get_header_font_name (GtkSourcePrintCompositor *comp
g_return_val_if_fail (compositor->priv->body_font != NULL, NULL);
compositor->priv->header_font = pango_font_description_copy (compositor->priv->body_font);
}
-
+
return pango_font_description_to_string (compositor->priv->header_font);
}
/**
* gtk_source_print_compositor_set_footer_font_name:
* @compositor: a #GtkSourcePrintCompositor.
- * @font_name: the name of the font for the footer text, or %NULL.
+ * @font_name: (allow-none): the name of the font for the footer text, or %NULL.
*
* Sets the font for printing the page footer. If
* %NULL is supplied, the default font (i.e. the one being used for the
@@ -1501,7 +1501,7 @@ gtk_source_print_compositor_set_footer_font_name (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
*
* Returns the name of the font used to print the page footer.
- * The returned string must be freed with g_free())
+ * The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print
* the page footer.
@@ -1518,7 +1518,7 @@ gtk_source_print_compositor_get_footer_font_name (GtkSourcePrintCompositor *comp
g_return_val_if_fail (compositor->priv->body_font != NULL, NULL);
compositor->priv->footer_font = pango_font_description_copy (compositor->priv->body_font);
}
-
+
return pango_font_description_to_string (compositor->priv->footer_font);
}
@@ -1538,7 +1538,7 @@ gtk_source_print_compositor_set_top_margin (GtkSourcePrintCompositor *compositor
GtkUnit unit)
{
g_return_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor));
-
+
compositor->priv->margin_top = convert_to_mm (margin, unit);
}
@@ -1565,8 +1565,8 @@ gtk_source_print_compositor_get_top_margin (GtkSourcePrintCompositor *compositor
/**
* gtk_source_print_compositor_set_bottom_margin:
* @compositor: a #GtkSourcePrintCompositor.
- * @margin: the new bottom margin in units of @unit
- * @unit: the units for @margin
+ * @margin: the new bottom margin in units of @unit.
+ * @unit: the units for @margin.
*
* Sets the bottom margin used by @compositor.
*
@@ -1578,7 +1578,7 @@ gtk_source_print_compositor_set_bottom_margin (GtkSourcePrintCompositor *composi
GtkUnit unit)
{
g_return_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor));
-
+
compositor->priv->margin_bottom = convert_to_mm (margin, unit);
}
@@ -1605,8 +1605,8 @@ gtk_source_print_compositor_get_bottom_margin (GtkSourcePrintCompositor *composi
/**
* gtk_source_print_compositor_set_left_margin:
* @compositor: a #GtkSourcePrintCompositor.
- * @margin: the new left margin in units of @unit
- * @unit: the units for @margin
+ * @margin: the new left margin in units of @unit.
+ * @unit: the units for @margin.
*
* Sets the left margin used by @compositor.
*
@@ -1618,7 +1618,7 @@ gtk_source_print_compositor_set_left_margin (GtkSourcePrintCompositor *composito
GtkUnit unit)
{
g_return_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor));
-
+
compositor->priv->margin_left = convert_to_mm (margin, unit);
}
@@ -1645,8 +1645,8 @@ gtk_source_print_compositor_get_left_margin (GtkSourcePrintCompositor *composito
/**
* gtk_source_print_compositor_set_right_margin:
* @compositor: a #GtkSourcePrintCompositor.
- * @margin: the new right margin in units of @unit
- * @unit: the units for @margin
+ * @margin: the new right margin in units of @unit.
+ * @unit: the units for @margin.
*
* Sets the right margin used by @compositor.
*
@@ -1658,7 +1658,7 @@ gtk_source_print_compositor_set_right_margin (GtkSourcePrintCompositor *composit
GtkUnit unit)
{
g_return_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor));
-
+
compositor->priv->margin_right = convert_to_mm (margin, unit);
}
@@ -1669,7 +1669,7 @@ gtk_source_print_compositor_set_right_margin (GtkSourcePrintCompositor *composit
*
* Gets the right margin in units of @unit.
*
- * Return value: the right margin
+ * Return value: the right margin.
*
* Since: 2.2
*/
@@ -1698,10 +1698,10 @@ gint
gtk_source_print_compositor_get_n_pages (GtkSourcePrintCompositor *compositor)
{
g_return_val_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor), -1);
-
+
if (compositor->priv->state != DONE)
return -1;
-
+
return compositor->priv->n_pages;
}
@@ -2821,7 +2821,7 @@ gtk_source_print_compositor_paginate (GtkSourcePrintCompositor *compositor,
*
* Returns the current fraction of the document pagination that has been completed.
*
- * Return value: a fraction from 0.0 to 1.0 inclusive
+ * Return value: a fraction from 0.0 to 1.0 inclusive.
*
* Since: 2.2
*/
@@ -2830,25 +2830,25 @@ gtk_source_print_compositor_get_pagination_progress (GtkSourcePrintCompositor *c
{
GtkTextIter current;
gint char_count;
-
+
g_return_val_if_fail (GTK_IS_SOURCE_PRINT_COMPOSITOR (compositor), 0.0);
if (compositor->priv->state == INIT)
return 0.0;
-
+
if (compositor->priv->state == DONE)
return 1.0;
-
+
char_count = gtk_text_buffer_get_char_count (GTK_TEXT_BUFFER (compositor->priv->buffer));
if (char_count == 0)
return 1.0;
-
+
g_return_val_if_fail (compositor->priv->pagination_mark != NULL, 0.0);
gtk_text_buffer_get_iter_at_mark (GTK_TEXT_BUFFER (compositor->priv->buffer),
¤t,
compositor->priv->pagination_mark);
-
+
return (gdouble) gtk_text_iter_get_offset (¤t) / (gdouble) char_count;
}
@@ -3147,12 +3147,12 @@ gtk_source_print_compositor_draw_page (GtkSourcePrintCompositor *compositor,
{
print_header (compositor, cr);
}
-
+
if (is_footer_to_print (compositor))
{
print_footer (compositor, cr);
}
-
+
x = get_text_x (compositor);
y = get_text_y (compositor);
ln_x = get_line_numbers_x (compositor);
diff --git a/gtksourceview/gtksourcestyle.c b/gtksourceview/gtksourcestyle.c
index f89fd1c..bf81477 100644
--- a/gtksourceview/gtksourcestyle.c
+++ b/gtksourceview/gtksourcestyle.c
@@ -401,7 +401,7 @@ gtk_source_style_copy (const GtkSourceStyle *style)
/**
* _gtk_source_style_apply:
- * @style: a #GtkSourceStyle to apply.
+ * @style: (allow-none): a #GtkSourceStyle to apply.
* @tag: a #GtkTextTag to apply styles to.
*
* Applies text styles set in @style if it's not %NULL, or
diff --git a/gtksourceview/gtksourcestylescheme.c b/gtksourceview/gtksourcestylescheme.c
index 0e9db1e..500a90e 100644
--- a/gtksourceview/gtksourcestylescheme.c
+++ b/gtksourceview/gtksourcestylescheme.c
@@ -289,7 +289,7 @@ gtk_source_style_scheme_get_name (GtkSourceStyleScheme *scheme)
* gtk_source_style_scheme_get_description:
* @scheme: a #GtkSourceStyleScheme.
*
- * Returns: @scheme description (if defined) or NULL.
+ * Returns: @scheme description (if defined), or %NULL.
*
* Since: 2.0
*/
@@ -305,9 +305,8 @@ gtk_source_style_scheme_get_description (GtkSourceStyleScheme *scheme)
* gtk_source_style_scheme_get_authors:
* @scheme: a #GtkSourceStyleScheme.
*
- * Returns: a %NULL-terminated array containing the @scheme authors or
- * %NULL if no author is specified by the style
- * scheme.
+ * Returns: (array zero-terminated): a %NULL-terminated array containing
+ * the @scheme authors or %NULL if no author is specified by the style scheme.
*
* Since: 2.0
*/
@@ -327,7 +326,7 @@ gtk_source_style_scheme_get_authors (GtkSourceStyleScheme *scheme)
* @scheme: a #GtkSourceStyleScheme.
*
* Returns: @scheme file name if the scheme was created parsing a
- * style scheme file or NULL in the other cases.
+ * style scheme file or %NULL in the other cases.
*
* Since: 2.0
*/
@@ -735,7 +734,7 @@ update_cursor_colors (GtkWidget *widget,
/**
* _gtk_source_style_scheme_apply:
- * @scheme: a #GtkSourceStyleScheme or NULL.
+ * @scheme: (allow-none): a #GtkSourceStyleScheme or %NULL.
* @widget: a #GtkWidget to apply styles to.
*
* Sets text colors from @scheme in the @widget.
@@ -746,7 +745,7 @@ void
_gtk_source_style_scheme_apply (GtkSourceStyleScheme *scheme,
GtkWidget *widget)
{
- g_return_if_fail (!scheme || GTK_IS_SOURCE_STYLE_SCHEME (scheme));
+ g_return_if_fail (scheme == NULL || GTK_IS_SOURCE_STYLE_SCHEME (scheme));
g_return_if_fail (GTK_IS_WIDGET (widget));
if (scheme != NULL)
@@ -1171,6 +1170,7 @@ const gchar *
_gtk_source_style_scheme_get_parent_id (GtkSourceStyleScheme *scheme)
{
g_return_val_if_fail (GTK_IS_SOURCE_STYLE_SCHEME (scheme), NULL);
+
return scheme->priv->parent_id;
}
@@ -1190,7 +1190,7 @@ _gtk_source_style_scheme_set_parent (GtkSourceStyleScheme *scheme,
GtkSourceStyleScheme *parent_scheme)
{
g_return_if_fail (GTK_IS_SOURCE_STYLE_SCHEME (scheme));
- g_return_if_fail (!parent_scheme || GTK_IS_SOURCE_STYLE_SCHEME (parent_scheme));
+ g_return_if_fail (parent_scheme == NULL || GTK_IS_SOURCE_STYLE_SCHEME (parent_scheme));
if (scheme->priv->parent != NULL)
g_object_unref (scheme->priv->parent);
diff --git a/gtksourceview/gtksourcestyleschememanager.c b/gtksourceview/gtksourcestyleschememanager.c
index aff21bf..55fe63b 100644
--- a/gtksourceview/gtksourcestyleschememanager.c
+++ b/gtksourceview/gtksourcestyleschememanager.c
@@ -184,7 +184,7 @@ gtk_source_style_scheme_manager_init (GtkSourceStyleSchemeManager *mgr)
* Creates a new style manager. If you do not need more than one style
* manager then use gtk_source_style_scheme_manager_get_default() instead.
*
- * Returns: a #GtkSourceStyleSchemeManager.
+ * Returns: a new #GtkSourceStyleSchemeManager.
*/
GtkSourceStyleSchemeManager *
gtk_source_style_scheme_manager_new (void)
@@ -197,8 +197,8 @@ gtk_source_style_scheme_manager_new (void)
*
* Returns the default #GtkSourceStyleSchemeManager instance.
*
- * Returns: a #GtkSourceStyleSchemeManager. Return value is owned
- * by GtkSourceView library and must not be unref'ed.
+ * Returns: (transfer-none): a #GtkSourceStyleSchemeManager. Return value
+ * is owned by GtkSourceView library and must not be unref'ed.
*/
GtkSourceStyleSchemeManager *
gtk_source_style_scheme_manager_get_default (void)
@@ -406,11 +406,12 @@ notify_search_path (GtkSourceStyleSchemeManager *mgr)
/**
* gtk_source_style_scheme_manager_set_search_path:
* @manager: a #GtkSourceStyleSchemeManager.
- * @path: a %NULL-terminated array of strings or %NULL.
+ * @path: (array zero-terminated=1) (allow-none):
+ * a %NULL-terminated array of strings or %NULL.
*
* Sets the list of directories where the @manager looks for
* style scheme files.
- * If @dirs is %NULL, the search path is reset to default.
+ * If @path is %NULL, the search path is reset to default.
*/
void
gtk_source_style_scheme_manager_set_search_path (GtkSourceStyleSchemeManager *manager,
@@ -510,7 +511,8 @@ 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: a NULL-terminated array of string containing the search path.
+ * Returns: (array zero-terminated) (tranfer none): a %NULL-terminated array
+ * of string containing the search path.
* The array is owned by the @manager and must not be modified.
*/
G_CONST_RETURN gchar* G_CONST_RETURN *
@@ -526,7 +528,7 @@ gtk_source_style_scheme_manager_get_search_path (GtkSourceStyleSchemeManager *ma
/**
* gtk_source_style_scheme_manager_force_rescan:
- * @manager: a #GtkSourceStyleSchemeManager
+ * @manager: a #GtkSourceStyleSchemeManager.
*
* Mark any currently cached information about the available style scehems
* as invalid. All the available style schemes will be reloaded next time
@@ -535,6 +537,8 @@ gtk_source_style_scheme_manager_get_search_path (GtkSourceStyleSchemeManager *ma
void
gtk_source_style_scheme_manager_force_rescan (GtkSourceStyleSchemeManager *manager)
{
+ g_return_if_fail (GTK_IS_SOURCE_STYLE_SCHEME_MANAGER (manager));
+
manager->priv->need_reload = TRUE;
g_object_notify (G_OBJECT (manager), "scheme-ids");
@@ -542,13 +546,13 @@ gtk_source_style_scheme_manager_force_rescan (GtkSourceStyleSchemeManager *manag
/**
* gtk_source_style_scheme_manager_get_scheme_ids:
- * @manager: a #GtkSourceStyleSchemeManager
+ * @manager: a #GtkSourceStyleSchemeManager.
*
* Returns the ids of the available style schemes.
*
- * Returns: a %NULL-terminated array of string containing the ids of the
- * available style schemes or %NULL if no style scheme is available. The array
- * is owned by the @manager and must not be modified.
+ * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array
+ * of string containing the ids of the available style schemes or %NULL if no
+ * style scheme is available. The array is owned by the @manager and must not be modified.
*/
G_CONST_RETURN gchar* G_CONST_RETURN *
gtk_source_style_scheme_manager_get_scheme_ids (GtkSourceStyleSchemeManager *manager)
@@ -562,12 +566,12 @@ gtk_source_style_scheme_manager_get_scheme_ids (GtkSourceStyleSchemeManager *man
/**
* gtk_source_style_scheme_manager_get_scheme:
- * @manager: a #GtkSourceStyleSchemeManager
- * @scheme_id: style scheme id to find
+ * @manager: a #GtkSourceStyleSchemeManager.
+ * @scheme_id: style scheme id to find.
*
* Looks up style scheme by id.
*
- * Returns: a #GtkSourceStyleScheme object. Returned value is owned by
+ * Returns: (transfer none): a #GtkSourceStyleScheme object. Returned value is owned by
* @manager and must not be unref'ed.
*/
GtkSourceStyleScheme *
diff --git a/gtksourceview/gtksourceundomanager.c b/gtksourceview/gtksourceundomanager.c
index 1cb5b4e..84d369c 100644
--- a/gtksourceview/gtksourceundomanager.c
+++ b/gtksourceview/gtksourceundomanager.c
@@ -49,7 +49,6 @@
* or redo state of the undo stack has changed.
*
* Since: 2.10
- *
*/
/* Signals */
@@ -189,118 +188,117 @@ gtk_source_undo_manager_get_type ()
/**
* gtk_source_undo_manager_can_undo:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Get whether there are undo operations available.
*
- * Since: 2.10
- *
* Returns: %TRUE if there are undo operations available, %FALSE otherwise
*
+ * Since: 2.10
*/
gboolean
gtk_source_undo_manager_can_undo (GtkSourceUndoManager *manager)
{
g_return_val_if_fail (GTK_IS_SOURCE_UNDO_MANAGER (manager), FALSE);
+
return GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE (manager)->can_undo (manager);
}
/**
* gtk_source_undo_manager_can_redo:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Get whether there are redo operations available.
*
- * Since: 2.10
- *
* Returns: %TRUE if there are redo operations available, %FALSE otherwise
*
+ * Since: 2.10
*/
gboolean
gtk_source_undo_manager_can_redo (GtkSourceUndoManager *manager)
{
g_return_val_if_fail (GTK_IS_SOURCE_UNDO_MANAGER (manager), FALSE);
+
return GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE (manager)->can_redo (manager);
}
/**
* gtk_source_undo_manager_undo:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Perform a single undo. Calling this function when there are no undo operations
* available is an error. Use #gtk_source_undo_manager_can_undo to find out
* if there are undo operations available.
*
* Since: 2.10
- *
*/
void
gtk_source_undo_manager_undo (GtkSourceUndoManager *manager)
{
g_return_if_fail (GTK_IS_SOURCE_UNDO_MANAGER (manager));
+
GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE (manager)->undo (manager);
}
/**
* gtk_source_undo_manager_redo:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Perform a single redo. Calling this function when there are no redo operations
* available is an error. Use #gtk_source_undo_manager_can_redo to find out
* if there are redo operations available.
*
* Since: 2.10
- *
*/
void
gtk_source_undo_manager_redo (GtkSourceUndoManager *manager)
{
g_return_if_fail (GTK_IS_SOURCE_UNDO_MANAGER (manager));
+
GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE (manager)->redo (manager);
}
/**
* gtk_source_undo_manager_begin_not_undoable_action:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Begin a not undoable action on the buffer. All changes between this call
* and the call to #gtk_source_undo_manager_end_not_undoable_action cannot
* be undone. This function should be re-entrant.
*
* Since: 2.10
- *
*/
void
gtk_source_undo_manager_begin_not_undoable_action (GtkSourceUndoManager *manager)
{
g_return_if_fail (GTK_IS_SOURCE_UNDO_MANAGER (manager));
+
GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE (manager)->begin_not_undoable_action (manager);
}
/**
* gtk_source_undo_manager_end_not_undoable_action:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Ends a not undoable action on the buffer.
*
* Since: 2.10
- *
*/
void
gtk_source_undo_manager_end_not_undoable_action (GtkSourceUndoManager *manager)
{
g_return_if_fail (GTK_IS_SOURCE_UNDO_MANAGER (manager));
+
GTK_SOURCE_UNDO_MANAGER_GET_INTERFACE (manager)->end_not_undoable_action (manager);
}
/**
* gtk_source_undo_manager_can_undo_changed:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Emits the #GtkSourceUndoManager::can-undo-changed signal.
*
* Since: 2.10
- *
**/
void
gtk_source_undo_manager_can_undo_changed (GtkSourceUndoManager *manager)
@@ -312,12 +310,11 @@ gtk_source_undo_manager_can_undo_changed (GtkSourceUndoManager *manager)
/**
* gtk_source_undo_manager_can_redo_changed:
- * @manager: A #GtkSourceUndoManager
+ * @manager: a #GtkSourceUndoManager.
*
* Emits the #GtkSourceUndoManager::can-redo-changed signal.
*
* Since: 2.10
- *
**/
void
gtk_source_undo_manager_can_redo_changed (GtkSourceUndoManager *manager)
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index cb01bb8..3a305c9 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -3050,7 +3050,7 @@ calculate_real_tab_width (GtkSourceView *view, guint tab_size, gchar c)
* created for you. If you want to specify your own buffer, consider
* gtk_source_view_new_with_buffer().
*
- * Return value: a new #GtkSourceView
+ * Return value: a new #GtkSourceView.
**/
GtkWidget *
gtk_source_view_new (void)
@@ -3071,7 +3071,7 @@ gtk_source_view_new (void)
* Creates a new #GtkSourceView widget displaying the buffer
* @buffer. One buffer can be shared among many widgets.
*
- * Return value: a new #GtkTextView.
+ * Return value: a new #GtkSourceView.
**/
GtkWidget *
gtk_source_view_new_with_buffer (GtkSourceBuffer *buffer)
@@ -3109,7 +3109,6 @@ gtk_source_view_get_show_line_numbers (GtkSourceView *view)
* @show: whether line numbers should be displayed.
*
* If %TRUE line numbers will be displayed beside the text.
- *
**/
void
gtk_source_view_set_show_line_numbers (GtkSourceView *view,
@@ -3402,10 +3401,10 @@ gtk_source_view_ensure_category (GtkSourceView *view,
* gtk_source_view_set_mark_category_icon_from_pixbuf:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @pixbuf: a #GdkPixbuf or #NULL.
+ * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL.
*
* Sets the icon to be used for @category to @pixbuf.
- * If @pixbuf is #NULL, the icon is unset.
+ * If @pixbuf is %NULL, the icon is unset.
*
* Since: 2.8
*/
@@ -3445,10 +3444,10 @@ gtk_source_view_set_mark_category_icon_from_pixbuf (GtkSourceView *view,
* gtk_source_view_set_mark_category_icon_from_icon_name:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @name: the themed icon name or #NULL.
+ * @name: (allow-none): the themed icon name, or %NULL.
*
* Sets the icon to be used for @category to the named theme item @name.
- * If @name is #NULL, the icon is unset.
+ * If @name is %NULL, the icon is unset.
*
* Since: 2.8
*/
@@ -3487,10 +3486,10 @@ gtk_source_view_set_mark_category_icon_from_icon_name (GtkSourceView *view,
* gtk_source_view_set_mark_category_icon_from_stock:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @stock_id: the stock id or #NULL.
+ * @stock_id: (allow-none): the stock id, or %NULL.
*
* Sets the icon to be used for @category to the stock item @stock_id.
- * If @stock_id is #NULL, the icon is unset.
+ * If @stock_id is %NULL, the icon is unset.
*
* Since: 2.8
*/
@@ -3529,12 +3528,12 @@ gtk_source_view_set_mark_category_icon_from_stock (GtkSourceView *view,
* gtk_source_view_set_mark_category_pixbuf:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @pixbuf: a #GdkPixbuf or #NULL.
+ * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL.
*
* Associates a given @pixbuf with a given mark @category.
- * If @pixbuf is #NULL, the pixbuf is unset.
+ * If @pixbuf is %NULL, the pixbuf is unset.
*
- * Deprecated: Use #gtk_source_view_set_mark_category_icon_from_pixbuf instead
+ * Deprecated: Use #gtk_source_view_set_mark_category_icon_from_pixbuf instead.
*
* Since: 2.2
*/
@@ -3617,10 +3616,10 @@ set_mark_category_tooltip_func (GtkSourceView *view,
* gtk_source_view_set_mark_category_tooltip_func:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @func: a #GtkSourceViewMarkTooltipFunc or %NULL.
- * @user_data: user data which will be passed to @func.
- * @user_data_notify:a function to free the memory allocated for @user_data
- * or %NULL if you do not want to supply such a function.
+ * @func: (allow-none): a #GtkSourceViewMarkTooltipFunc or %NULL.
+ * @user_data: (allow-none): user data which will be passed to @func.
+ * @user_data_notify: (allow-none):a function to free the memory allocated
+ * for @user_data or %NULL if you do not want to supply such a function.
*
* Set a #GtkSourceViewMarkTooltipFunc used to set tooltip on marks from the
* given mark @category.
@@ -3666,10 +3665,10 @@ gtk_source_view_set_mark_category_tooltip_func (GtkSourceView *view,
* gtk_source_view_set_mark_category_tooltip_markup_func:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @markup_func: a #GtkSourceViewMarkTooltipFunc or %NULL.
- * @user_data: user data which will be passed to @func.
- * @user_data_notify:a function to free the memory allocated for @user_data
- * or %NULL if you do not want to supply such a function.
+ * @markup_func: (allow-none): a #GtkSourceViewMarkTooltipFunc or %NULL.
+ * @user_data: (allow-none): user data which will be passed to @func.
+ * @user_data_notify: (allow-none):a function to free the memory allocated
+ * for @user_data or %NULL if you do not want to supply such a function.
*
* See gtk_source_view_set_mark_category_tooltip_func() for more information.
*
@@ -3690,10 +3689,10 @@ gtk_source_view_set_mark_category_tooltip_markup_func (GtkSourceView *view,
* gtk_source_view_set_mark_category_background:
* @view: a #GtkSourceView.
* @category: a mark category.
- * @color: background color or %NULL to unset it.
+ * @color: (allow-none): background color or %NULL to unset it.
*
* Sets given background @color for mark @category.
- * If @color is #NULL, the background color is unset.
+ * If @color is %NULL, the background color is unset.
*
* Since: 2.4
*/
@@ -4546,7 +4545,6 @@ gtk_source_view_get_auto_indent (GtkSourceView *view)
* @enable: whether to enable auto indentation.
*
* If %TRUE auto indentation of text is enabled.
- *
**/
void
gtk_source_view_set_auto_indent (GtkSourceView *view, gboolean enable)
@@ -4587,7 +4585,6 @@ gtk_source_view_get_insert_spaces_instead_of_tabs (GtkSourceView *view)
*
* If %TRUE any tabulator character inserted is replaced by a group
* of space characters.
- *
**/
void
gtk_source_view_set_insert_spaces_instead_of_tabs (GtkSourceView *view, gboolean enable)
@@ -4717,9 +4714,9 @@ view_dnd_drop (GtkTextView *view,
/**
* gtk_source_view_get_highlight_current_line:
- * @view: a #GtkSourceView
+ * @view: a #GtkSourceView.
*
- * Returns whether the current line is highlighted
+ * Returns whether the current line is highlighted.
*
* Return value: %TRUE if the current line is highlighted.
**/
@@ -4733,8 +4730,8 @@ gtk_source_view_get_highlight_current_line (GtkSourceView *view)
/**
* gtk_source_view_set_highlight_current_line:
- * @view: a #GtkSourceView
- * @show: whether to highlight the current line
+ * @view: a #GtkSourceView.
+ * @show: whether to highlight the current line.
*
* If @show is %TRUE the current line is highlighted.
**/
@@ -4776,7 +4773,7 @@ gtk_source_view_get_show_right_margin (GtkSourceView *view)
* @view: a #GtkSourceView.
* @show: whether to show a right margin.
*
- * If %TRUE a right margin is displayed
+ * If %TRUE a right margin is displayed.
**/
void
gtk_source_view_set_show_right_margin (GtkSourceView *view, gboolean show)
@@ -5143,7 +5140,7 @@ gtk_source_view_update_style_scheme (GtkSourceView *view)
/**
* gtk_source_view_get_completion:
- * @view: a #GtkSourceView
+ * @view: a #GtkSourceView.
*
* Gets the #GtkSourceCompletion associated with @view.
*
@@ -5165,8 +5162,8 @@ gtk_source_view_get_completion (GtkSourceView *view)
/**
* gtk_source_view_get_gutter:
- * @view: a #GtkSourceView
- * @window_type: the gutter window type
+ * @view: a #GtkSourceView.
+ * @window_type: the gutter window type.
*
* Returns the #GtkSourceGutter object associated with @window_type for @view.
* Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported,
@@ -5176,7 +5173,7 @@ gtk_source_view_get_completion (GtkSourceView *view)
*
* Since: 2.8
*
- * Returns: the #GtkSourceGutter.
+ * Returns: (transfer none): the #GtkSourceGutter.
**/
GtkSourceGutter *
gtk_source_view_get_gutter (GtkSourceView *view,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
