[gtk+/gtk-2-24] [GI] Add missing (out) and (array) annotations
- From: Martin Pitt <martinpitt src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/gtk-2-24] [GI] Add missing (out) and (array) annotations
- Date: Wed, 16 Mar 2011 09:46:09 +0000 (UTC)
commit 6e178a69fc73b45f66fc511f7a274b8fefc2e2e7
Author: Pavel Holejsovsky <pholejs src gnome org>
Date: Wed Mar 16 10:45:35 2011 +0100
[GI] Add missing (out) and (array) annotations
Backported from master commit 2fb1c064.
gdk/gdk.c | 2 +-
gdk/gdkdisplay.c | 2 +-
gdk/gdkevents.c | 2 +-
gdk/gdkrectangle.c | 2 +-
gdk/gdkwindow.c | 22 +++++++++++++---------
gtk/gtkaboutdialog.c | 18 +++++++++---------
gtk/gtkalignment.c | 12 ++++++++----
gtk/gtkbuildable.c | 6 +++---
gtk/gtkbuilder.c | 4 ++--
gtk/gtkbutton.c | 4 ++--
gtk/gtkcalendar.c | 9 ++++++---
gtk/gtkcellrenderer.c | 20 ++++++++++----------
gtk/gtkcellview.c | 2 +-
gtk/gtkclipboard.c | 6 +++---
gtk/gtkcolorsel.c | 7 ++++---
gtk/gtkdialog.c | 3 ++-
gtk/gtkeditable.c | 8 ++++----
gtk/gtkentry.c | 4 ++--
gtk/gtkframe.c | 6 ++++--
gtk/gtkhsv.c | 22 +++++++++++-----------
gtk/gtkicontheme.c | 14 ++++++++------
gtk/gtkiconview.c | 8 ++++----
gtk/gtkimcontext.c | 24 ++++++++++++------------
gtk/gtklabel.c | 8 ++++----
gtk/gtklayout.c | 6 ++++--
gtk/gtkmain.c | 9 +++++----
gtk/gtkmisc.c | 10 ++++++----
gtk/gtkprintcontext.c | 8 ++++----
gtk/gtkprinter.c | 8 ++++----
gtk/gtkprintsettings.c | 9 +++++----
gtk/gtkrange.c | 8 +++++---
gtk/gtkrc.c | 9 ++++++---
gtk/gtkrecentchooser.c | 5 +++--
gtk/gtkscale.c | 4 ++--
gtk/gtkscalebutton.c | 7 ++++---
gtk/gtkscrolledwindow.c | 8 ++++----
gtk/gtkselection.c | 19 ++++++++++---------
gtk/gtkspinbutton.c | 8 ++++----
gtk/gtkstock.c | 6 +++---
gtk/gtkstyle.c | 2 +-
gtk/gtktestutils.c | 6 ++++--
gtk/gtktextbufferrichtext.c | 13 +++++++------
gtk/gtktextiter.c | 2 +-
gtk/gtktextview.c | 2 +-
gtk/gtktreednd.c | 7 ++++---
gtk/gtktreemodelfilter.c | 2 +-
gtk/gtktreeview.c | 39 ++++++++++++++++++++-------------------
gtk/gtktreeviewcolumn.c | 8 ++++----
48 files changed, 228 insertions(+), 192 deletions(-)
---
diff --git a/gdk/gdk.c b/gdk/gdk.c
index e602a80..8686a18 100644
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -225,7 +225,7 @@ gdk_pre_parse_libgtk_only (void)
/**
* gdk_parse_args:
* @argc: the number of command line arguments.
- * @argv: the array of command line arguments.
+ * @argv: (inout) (array length=argc): the array of command line arguments.
*
* Parse command line arguments, and store for future
* use by calls to gdk_display_open().
diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
index 18aefd2..f7b43cf 100644
--- a/gdk/gdkdisplay.c
+++ b/gdk/gdkdisplay.c
@@ -486,7 +486,7 @@ _gdk_display_enable_motion_hints (GdkDisplay *display)
/**
* gdk_display_get_pointer:
* @display: a #GdkDisplay
- * @screen: (allow-none): location to store the screen that the
+ * @screen: (out) (allow-none): location to store the screen that the
* cursor is on, or %NULL.
* @x: (out) (allow-none): location to store root window X coordinate of pointer, or %NULL.
* @y: (out) (allow-none): location to store root window Y coordinate of pointer, or %NULL.
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 12a0cca..53833a0 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -848,7 +848,7 @@ gdk_event_get_root_coords (const GdkEvent *event,
/**
* gdk_event_get_axis:
* @event: a #GdkEvent
- * @axis_use: (out): the axis use to look for
+ * @axis_use: the axis use to look for
* @value: (out): location to store the value found
*
* Extract the axis value for a particular axis use from
diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c
index 736fca0..f50fc05 100644
--- a/gdk/gdkrectangle.c
+++ b/gdk/gdkrectangle.c
@@ -32,7 +32,7 @@
* gdk_rectangle_union:
* @src1: a #GdkRectangle
* @src2: a #GdkRectangle
- * @dest: return location for the union of @src1 and @src2
+ * @dest: (out): return location for the union of @src1 and @src2
*
* Calculates the union of two rectangles.
* The union of rectangles @src1 and @src2 is the smallest rectangle which
diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c
index c491846..5a7cb90 100644
--- a/gdk/gdkwindow.c
+++ b/gdk/gdkwindow.c
@@ -529,8 +529,10 @@ gdk_window_class_init (GdkWindowObjectClass *klass)
* @window: the offscreen window on which the signal is emitted
* @offscreen-x: x coordinate in the offscreen window
* @offscreen-y: y coordinate in the offscreen window
- * @embedder-x: return location for the x coordinate in the embedder window
- * @embedder-y: return location for the y coordinate in the embedder window
+ * @embedder-x: (out) (type double): return location for the x
+ * coordinate in the embedder window
+ * @embedder-y: (out) (type double): return location for the y
+ * coordinate in the embedder window
*
* The ::to-embedder signal is emitted to translate coordinates
* in an offscreen window to its embedder.
@@ -558,8 +560,10 @@ gdk_window_class_init (GdkWindowObjectClass *klass)
* @window: the offscreen window on which the signal is emitted
* @embedder-x: x coordinate in the embedder window
* @embedder-y: y coordinate in the embedder window
- * @offscreen-x: return location for the x coordinate in the offscreen window
- * @offscreen-y: return location for the y coordinate in the offscreen window
+ * @offscreen-x: (out) (type double): return location for the x
+ * coordinate in the offscreen window
+ * @offscreen-y: (out) (type double): return location for the y
+ * coordinate in the offscreen window
*
* The ::from-embedder signal is emitted to translate coordinates
* in the embedder of an offscreen window to the offscreen window.
@@ -2204,7 +2208,7 @@ gdk_window_set_user_data (GdkWindow *window,
/**
* gdk_window_get_user_data:
* @window: a #GdkWindow
- * @data: return location for user data
+ * @data: (out): return location for user data
*
* Retrieves the user data for @window, which is normally the widget
* that @window belongs to. See gdk_window_set_user_data().
@@ -6343,8 +6347,8 @@ gdk_window_set_debug_updates (gboolean setting)
* @flags: a mask indicating what portions of @geometry are set
* @width: desired width of window
* @height: desired height of the window
- * @new_width: location to store resulting width
- * @new_height: location to store resulting height
+ * @new_width: (out): location to store resulting width
+ * @new_height: (out): location to store resulting height
*
* Constrains a desired width and height according to a
* set of geometry hints (such as minimum and maximum size).
@@ -8346,8 +8350,8 @@ gdk_window_get_origin (GdkWindow *window,
* @window: a #GdkWindow
* @x: X coordinate in window
* @y: Y coordinate in window
- * @root_x: return location for X coordinate
- * @root_y: return location for Y coordinate
+ * @root_x: (out): return location for X coordinate
+ * @root_y: (out): return location for Y coordinate
*
* Obtains the position of a window position in root
* window coordinates. This is similar to
diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c
index 882cee3..7a1ab6b 100644
--- a/gtk/gtkaboutdialog.c
+++ b/gtk/gtkaboutdialog.c
@@ -1433,9 +1433,9 @@ gtk_about_dialog_set_website_label (GtkAboutDialog *about,
* Returns the string which are displayed in the authors tab
* of the secondary credits dialog.
*
- * Return value: A %NULL-terminated string array containing
- * the authors. The array is owned by the about dialog
- * and must not be modified.
+ * Return value: (array zero-terminated=1) (transfer none): A
+ * %NULL-terminated string array containing the authors. The array is
+ * owned by the about dialog and must not be modified.
*
* Since: 2.6
*/
@@ -1506,9 +1506,9 @@ gtk_about_dialog_set_authors (GtkAboutDialog *about,
* Returns the string which are displayed in the documenters
* tab of the secondary credits dialog.
*
- * Return value: A %NULL-terminated string array containing
- * the documenters. The array is owned by the about dialog
- * and must not be modified.
+ * Return value: (array zero-terminated=1) (transfer none): A
+ * %NULL-terminated string array containing the documenters. The
+ * array is owned by the about dialog and must not be modified.
*
* Since: 2.6
*/
@@ -1561,9 +1561,9 @@ gtk_about_dialog_set_documenters (GtkAboutDialog *about,
* Returns the string which are displayed in the artists tab
* of the secondary credits dialog.
*
- * Return value: A %NULL-terminated string array containing
- * the artists. The array is owned by the about dialog
- * and must not be modified.
+ * Return value: (array zero-terminated=1) (transfer none): A
+ * %NULL-terminated string array containing the artists. The array is
+ * owned by the about dialog and must not be modified.
*
* Since: 2.6
*/
diff --git a/gtk/gtkalignment.c b/gtk/gtkalignment.c
index ad74175..04e5f44 100644
--- a/gtk/gtkalignment.c
+++ b/gtk/gtkalignment.c
@@ -611,10 +611,14 @@ gtk_alignment_set_padding (GtkAlignment *alignment,
/**
* gtk_alignment_get_padding:
* @alignment: a #GtkAlignment
- * @padding_top: (allow-none): location to store the padding for the top of the widget, or %NULL
- * @padding_bottom: (allow-none): location to store the padding for the bottom of the widget, or %NULL
- * @padding_left: (allow-none): location to store the padding for the left of the widget, or %NULL
- * @padding_right: (allow-none): location to store the padding for the right of the widget, or %NULL
+ * @padding_top: (out) (allow-none): location to store the padding for
+ * the top of the widget, or %NULL
+ * @padding_bottom: (out) (allow-none): location to store the padding
+ * for the bottom of the widget, or %NULL
+ * @padding_left: (out) (allow-none): location to store the padding
+ * for the left of the widget, or %NULL
+ * @padding_right: (out) (allow-none): location to store the padding
+ * for the right of the widget, or %NULL
*
* Gets the padding on the different sides of the widget.
* See gtk_alignment_set_padding ().
diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c
index 6605305..c5b02e0 100644
--- a/gtk/gtkbuildable.c
+++ b/gtk/gtkbuildable.c
@@ -235,8 +235,8 @@ gtk_buildable_construct_child (GtkBuildable *buildable,
* @builder: a #GtkBuilder used to construct this object
* @child: (allow-none): child object or %NULL for non-child tags
* @tagname: name of tag
- * @parser: a #GMarkupParser structure to fill in
- * @data: return location for user data that will be passed in
+ * @parser: (out): a #GMarkupParser structure to fill in
+ * @data: (out): return location for user data that will be passed in
* to parser functions
*
* This is called for each unknown element under <child>.
@@ -273,7 +273,7 @@ gtk_buildable_custom_tag_start (GtkBuildable *buildable,
* @builder: #GtkBuilder used to construct this object
* @child: (allow-none): child object or %NULL for non-child tags
* @tagname: name of tag
- * @data: user data that will be passed in to parser functions
+ * @data: (type gpointer): user data that will be passed in to parser functions
*
* This is called at the end of each custom element handled by
* the buildable.
diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c
index 1225fd9..a8b4526 100644
--- a/gtk/gtkbuilder.c
+++ b/gtk/gtkbuilder.c
@@ -1123,7 +1123,7 @@ gtk_builder_connect_signals_full (GtkBuilder *builder,
* @builder: a #GtkBuilder
* @pspec: the #GParamSpec for the property
* @string: the string representation of the value
- * @value: the #GValue to store the result in
+ * @value: (out): the #GValue to store the result in
* @error: (allow-none): return location for an error, or %NULL
*
* This function demarshals a value from a string. This function
@@ -1179,7 +1179,7 @@ gtk_builder_value_from_string (GtkBuilder *builder,
* @builder: a #GtkBuilder
* @type: the #GType of the value
* @string: the string representation of the value
- * @value: the #GValue to store the result in
+ * @value: (out): the #GValue to store the result in
* @error: (allow-none): return location for an error, or %NULL
*
* Like gtk_builder_value_from_string(), this function demarshals
diff --git a/gtk/gtkbutton.c b/gtk/gtkbutton.c
index 8292c2c..ecad81b 100644
--- a/gtk/gtkbutton.c
+++ b/gtk/gtkbutton.c
@@ -2027,8 +2027,8 @@ gtk_button_set_alignment (GtkButton *button,
/**
* gtk_button_get_alignment:
* @button: a #GtkButton
- * @xalign: return location for horizontal alignment
- * @yalign: return location for vertical alignment
+ * @xalign: (out): return location for horizontal alignment
+ * @yalign: (out): return location for vertical alignment
*
* Gets the alignment of the child in the button.
*
diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c
index 5db4f41..2dd68d6 100644
--- a/gtk/gtkcalendar.c
+++ b/gtk/gtkcalendar.c
@@ -3925,9 +3925,12 @@ gtk_calendar_unmark_day (GtkCalendar *calendar,
/**
* gtk_calendar_get_date:
* @calendar: a #GtkCalendar
- * @year: (out) (allow-none): location to store the year as a decimal number (e.g. 2011), or %NULL
- * @month: (out) (allow-none): location to store the month number (between 0 and 11), or %NULL
- * @day: (out) (allow-none): location to store the day number (between 1 and 31), or %NULL
+ * @year: (out) (allow-none): location to store the year as a decimal
+ * number (e.g. 2011), or %NULL
+ * @month: (out) (allow-none): location to store the month number
+ * (between 0 and 11), or %NULL
+ * @day: (out) (allow-none): location to store the day number (between
+ * 1 and 31), or %NULL
*
* Obtains the selected date from a #GtkCalendar.
**/
diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c
index 505a7a3..dcce8dc 100644
--- a/gtk/gtkcellrenderer.c
+++ b/gtk/gtkcellrenderer.c
@@ -480,10 +480,10 @@ set_cell_bg_color (GtkCellRenderer *cell,
* @cell: a #GtkCellRenderer
* @widget: the widget the renderer is rendering to
* @cell_area: (allow-none): The area a cell will be allocated, or %NULL
- * @x_offset: (allow-none): location to return x offset of cell relative to @cell_area, or %NULL
- * @y_offset: (allow-none): location to return y offset of cell relative to @cell_area, or %NULL
- * @width: (allow-none): location to return width needed to render a cell, or %NULL
- * @height: (allow-none): location to return height needed to render a cell, or %NULL
+ * @x_offset: (out) (allow-none): location to return x offset of cell relative to @cell_area, or %NULL
+ * @y_offset: (out) (allow-none): location to return y offset of cell relative to @cell_area, or %NULL
+ * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
+ * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
*
* Obtains the width and height needed to render the cell. Used by view
* widgets to determine the appropriate size for the cell_area passed to
@@ -718,8 +718,8 @@ gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_fixed_size:
* @cell: A #GtkCellRenderer
- * @width: (allow-none): location to fill in with the fixed width of the cell, or %NULL
- * @height: (allow-none): location to fill in with the fixed height of the cell, or %NULL
+ * @width: (out) (allow-none): location to fill in with the fixed width of the cell, or %NULL
+ * @height: (out) (allow-none): location to fill in with the fixed height of the cell, or %NULL
*
* Fills in @width and @height with the appropriate size of @cell.
**/
@@ -778,8 +778,8 @@ gtk_cell_renderer_set_alignment (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_alignment:
* @cell: A #GtkCellRenderer
- * @xalign: (allow-none): location to fill in with the x alignment of the cell, or %NULL
- * @yalign: (allow-none): location to fill in with the y alignment of the cell, or %NULL
+ * @xalign: (out) (allow-none): location to fill in with the x alignment of the cell, or %NULL
+ * @yalign: (out) (allow-none): location to fill in with the y alignment of the cell, or %NULL
*
* Fills in @xalign and @yalign with the appropriate values of @cell.
*
@@ -839,8 +839,8 @@ gtk_cell_renderer_set_padding (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_padding:
* @cell: A #GtkCellRenderer
- * @xpad: (allow-none): location to fill in with the x padding of the cell, or %NULL
- * @ypad: (allow-none): location to fill in with the y padding of the cell, or %NULL
+ * @xpad: (out) (allow-none): location to fill in with the x padding of the cell, or %NULL
+ * @ypad: (out) (allow-none): location to fill in with the y padding of the cell, or %NULL
*
* Fills in @xpad and @ypad with the appropriate values of @cell.
*
diff --git a/gtk/gtkcellview.c b/gtk/gtkcellview.c
index 0dcfdad..bbb4f7b 100644
--- a/gtk/gtkcellview.c
+++ b/gtk/gtkcellview.c
@@ -971,7 +971,7 @@ gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
* gtk_cell_view_get_size_of_row:
* @cell_view: a #GtkCellView
* @path: a #GtkTreePath
- * @requisition: return location for the size
+ * @requisition: (out): return location for the size
*
* Sets @requisition to the size needed by @cell_view to display
* the model row pointed to by @path.
diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c
index 053c88a..9b17f6f 100644
--- a/gtk/gtkclipboard.c
+++ b/gtk/gtkclipboard.c
@@ -1929,9 +1929,9 @@ gtk_clipboard_store_timeout (GtkClipboard *clipboard)
/**
* gtk_clipboard_set_can_store:
* @clipboard: a #GtkClipboard
- * @targets: (allow-none): array containing information about which forms
- * should be stored or %NULL to indicate that all forms should
- * be stored.
+ * @targets: (allow-none) (array length=n_targets): array containing
+ * information about which forms should be stored or %NULL
+ * to indicate that all forms should be stored.
* @n_targets: number of elements in @targets
*
* Hints that the clipboard data should be stored somewhere when the
diff --git a/gtk/gtkcolorsel.c b/gtk/gtkcolorsel.c
index 6f260ee..6c65d9e 100644
--- a/gtk/gtkcolorsel.c
+++ b/gtk/gtkcolorsel.c
@@ -2644,7 +2644,7 @@ gtk_color_selection_set_previous_alpha (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_previous_color:
* @colorsel: a #GtkColorSelection.
- * @color: a #GdkColor to fill in with the original color value.
+ * @color: (out): a #GdkColor to fill in with the original color value.
*
* Fills @color in with the original color value.
**/
@@ -2739,7 +2739,8 @@ gtk_color_selection_is_adjusting (GtkColorSelection *colorsel)
/**
* gtk_color_selection_palette_from_string:
* @str: a string encoding a color palette.
- * @colors: return location for allocated array of #GdkColor.
+ * @colors: (out) (array length=n_colors): return location for allocated
+ * array of #GdkColor.
* @n_colors: return location for length of array.
*
* Parses a color palette string; the string is a colon-separated
@@ -2824,7 +2825,7 @@ gtk_color_selection_palette_from_string (const gchar *str,
/**
* gtk_color_selection_palette_to_string:
- * @colors: an array of colors.
+ * @colors: (array length=n_colors): an array of colors.
* @n_colors: length of the array.
*
* Encodes a palette as a string, useful for persistent storage.
diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c
index b85dd44..a2c0318 100644
--- a/gtk/gtkdialog.c
+++ b/gtk/gtkdialog.c
@@ -1319,7 +1319,8 @@ gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
* gtk_dialog_set_alternative_button_order_from_array:
* @dialog: a #GtkDialog
* @n_params: the number of response ids in @new_order
- * @new_order: an array of response ids of @dialog's buttons
+ * @new_order: (array length=n_params): an array of response ids of
+ * @dialog's buttons
*
* Sets an alternative button order. If the
* #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
diff --git a/gtk/gtkeditable.c b/gtk/gtkeditable.c
index d7eaa94..875f01f 100644
--- a/gtk/gtkeditable.c
+++ b/gtk/gtkeditable.c
@@ -70,10 +70,10 @@ gtk_editable_base_init (gpointer g_class)
* @new_text: the new text to insert
* @new_text_length: the length of the new text, in bytes,
* or -1 if new_text is nul-terminated
- * @position: the position, in characters, at which to insert
- * the new text. this is an in-out parameter.
- * After the signal emission is finished, it should
- * point after the newly inserted text.
+ * @position: (inout) (type int): the position, in characters,
+ * at which to insert the new text. this is an in-out
+ * parameter. After the signal emission is finished, it
+ * should point after the newly inserted text.
*
* This signal is emitted when text is inserted into
* the widget by the user. The default handler for
diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c
index fd2ebdb..5d0c569 100644
--- a/gtk/gtkentry.c
+++ b/gtk/gtkentry.c
@@ -7494,8 +7494,8 @@ gtk_entry_text_index_to_layout_index (GtkEntry *entry,
/**
* gtk_entry_get_layout_offsets:
* @entry: a #GtkEntry
- * @x: (allow-none): location to store X offset of layout, or %NULL
- * @y: (allow-none): location to store Y offset of layout, or %NULL
+ * @x: (out) (allow-none): location to store X offset of layout, or %NULL
+ * @y: (out) (allow-none): location to store Y offset of layout, or %NULL
*
*
* Obtains the position of the #PangoLayout used to render text
diff --git a/gtk/gtkframe.c b/gtk/gtkframe.c
index 8f2f9fe..252e74d 100644
--- a/gtk/gtkframe.c
+++ b/gtk/gtkframe.c
@@ -462,8 +462,10 @@ gtk_frame_set_label_align (GtkFrame *frame,
/**
* gtk_frame_get_label_align:
* @frame: a #GtkFrame
- * @xalign: (allow-none): location to store X alignment of frame's label, or %NULL
- * @yalign: (allow-none): location to store X alignment of frame's label, or %NULL
+ * @xalign: (out) (allow-none): location to store X alignment of
+ * frame's label, or %NULL
+ * @yalign: (out) (allow-none): location to store X alignment of
+ * frame's label, or %NULL
*
* Retrieves the X and Y alignment of the frame's label. See
* gtk_frame_set_label_align().
diff --git a/gtk/gtkhsv.c b/gtk/gtkhsv.c
index a906f03..a2d64cd 100644
--- a/gtk/gtkhsv.c
+++ b/gtk/gtkhsv.c
@@ -1406,9 +1406,9 @@ gtk_hsv_set_color (GtkHSV *hsv,
/**
* gtk_hsv_get_color:
* @hsv: An HSV color selector
- * @h: Return value for the hue
- * @s: Return value for the saturation
- * @v: Return value for the value
+ * @h: (out): Return value for the hue
+ * @s: (out): Return value for the saturation
+ * @v: (out): Return value for the value
*
* Queries the current color in an HSV color selector.
* Returned values will be in the [0.0, 1.0] range.
@@ -1476,8 +1476,8 @@ gtk_hsv_set_metrics (GtkHSV *hsv,
/**
* gtk_hsv_get_metrics:
* @hsv: An HSV color selector
- * @size: Return value for the diameter of the hue ring
- * @ring_width: Return value for the width of the hue ring
+ * @size: (out): Return value for the diameter of the hue ring
+ * @ring_width: (out): Return value for the width of the hue ring
*
* Queries the size and ring width of an HSV color selector.
*
@@ -1533,9 +1533,9 @@ gtk_hsv_is_adjusting (GtkHSV *hsv)
* @h: Hue
* @s: Saturation
* @v: Value
- * @r: Return value for the red component
- * @g: Return value for the green component
- * @b: Return value for the blue component
+ * @r: (out): Return value for the red component
+ * @g: (out): Return value for the green component
+ * @b: (out): Return value for the blue component
*
* Converts a color from HSV space to RGB.
* Input values must be in the [0.0, 1.0] range;
@@ -1572,9 +1572,9 @@ gtk_hsv_to_rgb (gdouble h,
* @r: Red
* @g: Green
* @b: Blue
- * @h: Return value for the hue component
- * @s: Return value for the saturation component
- * @v: Return value for the value component
+ * @h: (out): Return value for the hue component
+ * @s: (out): Return value for the saturation component
+ * @v: (out): Return value for the value component
*
* Converts a color from RGB space to HSV.
* Input values must be in the [0.0, 1.0] range;
diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
index 9ecf0d5..087bf1b 100644
--- a/gtk/gtkicontheme.c
+++ b/gtk/gtkicontheme.c
@@ -696,7 +696,8 @@ gtk_icon_theme_finalize (GObject *object)
/**
* gtk_icon_theme_set_search_path:
* @icon_theme: a #GtkIconTheme
- * @path: array of directories that are searched for icon themes
+ * @path: (array length=n_elements) (element-type filename): array of
+ * directories that are searched for icon themes
* @n_elements: number of elements in @path.
*
* Sets the search path for the icon theme object. When looking
@@ -1450,7 +1451,8 @@ gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme,
/**
* gtk_icon_theme_choose_icon:
* @icon_theme: a #GtkIconTheme
- * @icon_names: %NULL-terminated array of icon names to lookup
+ * @icon_names: (array zero-terminated=1): %NULL-terminated array of
+ * icon names to lookup
* @size: desired icon size
* @flags: flags modifying the behavior of the icon lookup
*
@@ -1625,9 +1627,9 @@ add_size (gpointer key,
* that the icon is available in a scalable format. The array
* is zero-terminated.
*
- * Return value: An newly allocated array describing the sizes at
- * which the icon is available. The array should be freed with g_free()
- * when it is no longer needed.
+ * Return value: (array zero-terminated=1): An newly allocated array
+ * describing the sizes at which the icon is available. The array
+ * should be freed with g_free() when it is no longer needed.
*
* Since: 2.6
**/
@@ -3152,7 +3154,7 @@ icon_info_scale_point (GtkIconInfo *icon_info,
/**
* gtk_icon_info_get_embedded_rect:
* @icon_info: a #GtkIconInfo
- * @rectangle: #GdkRectangle in which to store embedded
+ * @rectangle: (out): #GdkRectangle in which to store embedded
* rectangle coordinates; coordinates are only stored
* when this function returns %TRUE.
*
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index 711e8a8..8ce402f 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -4801,8 +4801,8 @@ gtk_icon_view_new_with_model (GtkTreeModel *model)
* @icon_view: a #GtkIconView
* @wx: X coordinate relative to the widget
* @wy: Y coordinate relative to the widget
- * @bx: return location for bin_window X coordinate
- * @by: return location for bin_window Y coordinate
+ * @bx: (out): return location for bin_window X coordinate
+ * @by: (out): return location for bin_window Y coordinate
*
* Converts widget coordinates to coordinates for the bin_window,
* as expected by e.g. gtk_icon_view_get_path_at_pos().
@@ -5007,8 +5007,8 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
/**
* gtk_icon_view_get_tooltip_context:
* @icon_view: an #GtkIconView
- * @x: the x coordinate (relative to widget coordinates)
- * @y: the y coordinate (relative to widget coordinates)
+ * @x: (inout): the x coordinate (relative to widget coordinates)
+ * @y: (inout): the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not
* @model: (out) (allow-none): a pointer to receive a #GtkTreeModel or %NULL
* @path: (out) (allow-none): a pointer to receive a #GtkTreePath or %NULL
diff --git a/gtk/gtkimcontext.c b/gtk/gtkimcontext.c
index 2768b0b..7905214 100644
--- a/gtk/gtkimcontext.c
+++ b/gtk/gtkimcontext.c
@@ -420,12 +420,12 @@ gtk_im_context_set_client_window (GtkIMContext *context,
/**
* gtk_im_context_get_preedit_string:
* @context: a #GtkIMContext
- * @str: location to store the retrieved string. The
- * string retrieved must be freed with g_free ().
- * @attrs: location to store the retrieved attribute list.
- * When you are done with this list, you must
- * unreference it with pango_attr_list_unref().
- * @cursor_pos: location to store position of cursor (in characters)
+ * @str: (out) (transfer full): location to store the retrieved
+ * string. The string retrieved must be freed with g_free().
+ * @attrs: (out) (transfer full): location to store the retrieved
+ * attribute list. When you are done with this list, you
+ * must unreference it with pango_attr_list_unref().
+ * @cursor_pos: (out): location to store position of cursor (in characters)
* within the preedit string.
*
* Retrieve the current preedit string for the input context,
@@ -621,12 +621,12 @@ gtk_im_context_set_surrounding (GtkIMContext *context,
/**
* gtk_im_context_get_surrounding:
* @context: a #GtkIMContext
- * @text: location to store a UTF-8 encoded string of text
- * holding context around the insertion point.
- * If the function returns %TRUE, then you must free
- * the result stored in this location with g_free().
- * @cursor_index: location to store byte index of the insertion cursor
- * within @text.
+ * @text: (out) (transfer full): location to store a UTF-8 encoded
+ * string of text holding context around the insertion point.
+ * If the function returns %TRUE, then you must free the result
+ * stored in this location with g_free().
+ * @cursor_index: (out) location to store byte index of the insertion
+ * cursor within @text.
*
* Retrieves context around the insertion point. Input methods
* typically want context in order to constrain input text based on
diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c
index 9d555bc..313e3bc 100644
--- a/gtk/gtklabel.c
+++ b/gtk/gtklabel.c
@@ -4950,8 +4950,8 @@ gtk_label_select_region (GtkLabel *label,
/**
* gtk_label_get_selection_bounds:
* @label: a #GtkLabel
- * @start: return location for start of selection, as a character offset
- * @end: return location for end of selection, as a character offset
+ * @start: (out): return location for start of selection, as a character offset
+ * @end: (out): return location for end of selection, as a character offset
*
* Gets the selected range of characters in the label, returning %TRUE
* if there's a selection.
@@ -5040,8 +5040,8 @@ gtk_label_get_layout (GtkLabel *label)
/**
* gtk_label_get_layout_offsets:
* @label: a #GtkLabel
- * @x: (allow-none): location to store X offset of layout, or %NULL
- * @y: (allow-none): location to store Y offset of layout, or %NULL
+ * @x: (out) (allow-none): location to store X offset of layout, or %NULL
+ * @y: (out) (allow-none): location to store Y offset of layout, or %NULL
*
* Obtains the coordinates where the label will draw the #PangoLayout
* representing the text in the label; useful to convert mouse events
diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c
index fc4d07d..2bb1e57 100644
--- a/gtk/gtklayout.c
+++ b/gtk/gtklayout.c
@@ -514,8 +514,10 @@ gtk_layout_set_size (GtkLayout *layout,
/**
* gtk_layout_get_size:
* @layout: a #GtkLayout
- * @width: (allow-none): location to store the width set on @layout, or %NULL
- * @height: (allow-none): location to store the height set on @layout, or %NULL
+ * @width: (out) (allow-none): location to store the width set on
+ * @layout, or %NULL
+ * @height: (out) (allow-none): location to store the height set on
+ * @layout, or %NULL
*
* Gets the size that has been set on the layout, and that determines
* the total extents of the layout's scrollbar area. See
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 17a8b21..d081f70 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -855,12 +855,13 @@ gtk_get_option_group (gboolean open_default_display)
/**
* gtk_init_with_args:
* @argc: a pointer to the number of command line arguments.
- * @argv: a pointer to the array of command line arguments.
+ * @argv: (inout) (array length=argc): a pointer to the array of
+ * command line arguments.
* @parameter_string: a string which is displayed in
* the first line of <option>--help</option> output, after
* <literal><replaceable>programname</replaceable> [OPTION...]</literal>
- * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
- * describing the options of your program
+ * @entries: (array zero-terminated=1): a %NULL-terminated array
+ * of #GOptionEntry<!-- -->s describing the options of your program
* @translation_domain: a translation domain to use for translating
* the <option>--help</option> output for the options in @entries
* with gettext(), or %NULL
@@ -2328,7 +2329,7 @@ gtk_get_current_event_time (void)
/**
* gtk_get_current_event_state:
- * @state: a location to store the state of the current event
+ * @state: (out): a location to store the state of the current event
*
* If there is a current event and it has a state field, place
* that state field in @state and return %TRUE, otherwise return
diff --git a/gtk/gtkmisc.c b/gtk/gtkmisc.c
index 93d8421..ff1c2ff 100644
--- a/gtk/gtkmisc.c
+++ b/gtk/gtkmisc.c
@@ -221,8 +221,8 @@ gtk_misc_set_alignment (GtkMisc *misc,
/**
* gtk_misc_get_alignment:
* @misc: a #GtkMisc
- * @xalign: (allow-none): location to store X alignment of @misc, or %NULL
- * @yalign: (allow-none): location to store Y alignment of @misc, or %NULL
+ * @xalign: (out) (allow-none): location to store X alignment of @misc, or %NULL
+ * @yalign: (out) (allow-none): location to store Y alignment of @misc, or %NULL
*
* Gets the X and Y alignment of the widget within its allocation.
* See gtk_misc_set_alignment().
@@ -283,8 +283,10 @@ gtk_misc_set_padding (GtkMisc *misc,
/**
* gtk_misc_get_padding:
* @misc: a #GtkMisc
- * @xpad: (allow-none): location to store padding in the X direction, or %NULL
- * @ypad: (allow-none): location to store padding in the Y direction, or %NULL
+ * @xpad: (out) (allow-none): location to store padding in the X
+ * direction, or %NULL
+ * @ypad: (out) (allow-none): location to store padding in the Y
+ * direction, or %NULL
*
* Gets the padding in the X and Y directions of the widget.
* See gtk_misc_set_padding().
diff --git a/gtk/gtkprintcontext.c b/gtk/gtkprintcontext.c
index b072902..4f317cc 100644
--- a/gtk/gtkprintcontext.c
+++ b/gtk/gtkprintcontext.c
@@ -384,10 +384,10 @@ gtk_print_context_get_dpi_y (GtkPrintContext *context)
/**
* gtk_print_context_get_hard_margins:
* @context: a #GtkPrintContext
- * @top: top hardware printer margin
- * @bottom: bottom hardware printer margin
- * @left: left hardware printer margin
- * @right: right hardware printer margin
+ * @top: (out): top hardware printer margin
+ * @bottom: (out): bottom hardware printer margin
+ * @left: (out): left hardware printer margin
+ * @right: (out): right hardware printer margin
*
* Obtains the hardware printer margins of the #GtkPrintContext, in units.
*
diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c
index bb70c2b..810b29d 100644
--- a/gtk/gtkprinter.c
+++ b/gtk/gtkprinter.c
@@ -978,10 +978,10 @@ gtk_printer_get_default_page_size (GtkPrinter *printer)
/**
* gtk_printer_get_hard_margins:
* @printer: a #GtkPrinter
- * @top: a location to store the top margin in
- * @bottom: a location to store the bottom margin in
- * @left: a location to store the left margin in
- * @right: a location to store the right margin in
+ * @top: (out): a location to store the top margin in
+ * @bottom: (out): a location to store the bottom margin in
+ * @left: (out): a location to store the left margin in
+ * @right: (out): a location to store the right margin in
*
* Retrieve the hard margins of @printer, i.e. the margins that define
* the area at the borders of the paper that the printer cannot print to.
diff --git a/gtk/gtkprintsettings.c b/gtk/gtkprintsettings.c
index 79d3bff..cc16149 100644
--- a/gtk/gtkprintsettings.c
+++ b/gtk/gtkprintsettings.c
@@ -1406,12 +1406,13 @@ gtk_print_settings_set_print_pages (GtkPrintSettings *settings,
/**
* gtk_print_settings_get_page_ranges:
* @settings: a #GtkPrintSettings
- * @num_ranges: return location for the length of the returned array
+ * @num_ranges: (out): return location for the length of the returned array
*
* Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
*
- * Return value: (transfer full): an array of #GtkPageRange<!-- -->s.
- * Use g_free() to free the array when it is no longer needed.
+ * Return value: (array length=num_ranges) (transfer full): an array
+ * of #GtkPageRange<!-- -->s. Use g_free() to free the array when
+ * it is no longer needed.
*
* Since: 2.10
*/
@@ -1468,7 +1469,7 @@ gtk_print_settings_get_page_ranges (GtkPrintSettings *settings,
/**
* gtk_print_settings_set_page_ranges:
* @settings: a #GtkPrintSettings
- * @page_ranges: an array of #GtkPageRange<!-- -->s
+ * @page_ranges: (array length=num_ranges): an array of #GtkPageRange<!-- -->s
* @num_ranges: the length of @page_ranges
*
* Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
diff --git a/gtk/gtkrange.c b/gtk/gtkrange.c
index fbd01ee..3932976 100644
--- a/gtk/gtkrange.c
+++ b/gtk/gtkrange.c
@@ -1059,7 +1059,7 @@ gtk_range_get_min_slider_size (GtkRange *range)
/**
* gtk_range_get_range_rect:
* @range: a #GtkRange
- * @range_rect: return location for the range rectangle
+ * @range_rect: (out): return location for the range rectangle
*
* This function returns the area that contains the range's trough
* and its steppers, in widget->window coordinates.
@@ -1083,8 +1083,10 @@ gtk_range_get_range_rect (GtkRange *range,
/**
* gtk_range_get_slider_range:
* @range: a #GtkRange
- * @slider_start: (allow-none): return location for the slider's start, or %NULL
- * @slider_end: (allow-none): return location for the slider's end, or %NULL
+ * @slider_start: (out) (allow-none): return location for the slider's
+ * start, or %NULL
+ * @slider_end: (out) (allow-none): return location for the slider's
+ * end, or %NULL
*
* This function returns sliders range along the long dimension,
* in widget->window coordinates.
diff --git a/gtk/gtkrc.c b/gtk/gtkrc.c
index 4cea61d..6eefa34 100644
--- a/gtk/gtkrc.c
+++ b/gtk/gtkrc.c
@@ -605,7 +605,8 @@ gtk_rc_set_default_files (gchar **filenames)
* Retrieves the current list of RC files that will be parsed
* at the end of gtk_init().
*
- * Return value: (transfer none): A %NULL-terminated array of filenames.
+ * Return value: (transfer none) (array zero-terminated=1) (element-type filename):
+ * A %NULL-terminated array of filenames.
* This memory is owned by GTK+ and must not be freed by the application.
* If you want to store this information, you should make a copy.
**/
@@ -3847,7 +3848,8 @@ gtk_rc_parse_priority (GScanner *scanner,
/**
* gtk_rc_parse_color:
* @scanner: a #GScanner
- * @color: a pointer to a #GdkColor structure in which to store the result
+ * @color: (out): a pointer to a #GdkColor structure in which to store
+ * the result
*
* Parses a color in the <link linkend="color=format">format</link> expected
* in a RC file.
@@ -3869,7 +3871,8 @@ gtk_rc_parse_color (GScanner *scanner,
* gtk_rc_parse_color_full:
* @scanner: a #GScanner
* @style: (allow-none): a #GtkRcStyle, or %NULL
- * @color: a pointer to a #GdkColor structure in which to store the result
+ * @color: (out): a pointer to a #GdkColor structure in which to store
+ * the result
*
* Parses a color in the <link linkend="color=format">format</link> expected
* in a RC file. If @style is not %NULL, it will be consulted to resolve
diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c
index de60dc2..71d4e49 100644
--- a/gtk/gtkrecentchooser.c
+++ b/gtk/gtkrecentchooser.c
@@ -925,8 +925,9 @@ gtk_recent_chooser_get_items (GtkRecentChooser *chooser)
*
* Since the returned array is %NULL terminated, @length may be %NULL.
*
- * Return value: (transfer full): A newly allocated, %NULL-terminated array
- * of strings. Use g_strfreev() to free it.
+ * Return value: (array length=length zero-terminated=1) (transfer full):
+ * A newly allocated, %NULL-terminated array of strings. Use
+ * g_strfreev() to free it.
*
* Since: 2.10
*/
diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c
index d04ee2a..d7159d9 100644
--- a/gtk/gtkscale.c
+++ b/gtk/gtkscale.c
@@ -1300,8 +1300,8 @@ gtk_scale_get_layout (GtkScale *scale)
/**
* gtk_scale_get_layout_offsets:
* @scale: a #GtkScale
- * @x: (allow-none): location to store X offset of layout, or %NULL
- * @y: (allow-none): location to store Y offset of layout, or %NULL
+ * @x: (out) (allow-none): location to store X offset of layout, or %NULL
+ * @y: (out) (allow-none): location to store Y offset of layout, or %NULL
*
* Obtains the coordinates where the scale will draw the
* #PangoLayout representing the text in the scale. Remember
diff --git a/gtk/gtkscalebutton.c b/gtk/gtkscalebutton.c
index fbfca35..df9b574 100644
--- a/gtk/gtkscalebutton.c
+++ b/gtk/gtkscalebutton.c
@@ -546,8 +546,9 @@ gtk_scale_button_dispose (GObject *object)
* @max: the maximum value of the scale (usually 100)
* @step: the stepping of value when a scroll-wheel event,
* or up/down arrow event occurs (usually 2)
- * @icons: (allow-none): a %NULL-terminated array of icon names, or %NULL if
- * you want to set the list later with gtk_scale_button_set_icons()
+ * @icons: (allow-none) (array zero-terminated=1): a %NULL-terminated
+ * array of icon names, or %NULL if you want to set the list
+ * later with gtk_scale_button_set_icons()
*
* Creates a #GtkScaleButton, with a range between @min and @max, with
* a stepping of @step.
@@ -627,7 +628,7 @@ gtk_scale_button_set_value (GtkScaleButton *button,
/**
* gtk_scale_button_set_icons:
* @button: a #GtkScaleButton
- * @icons: a %NULL-terminated array of icon names
+ * @icons: (array zero-terminated=1): a %NULL-terminated array of icon names
*
* Sets the icons to be used by the scale button.
* For details, see the #GtkScaleButton:icons property.
diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c
index ffb151d..05389fa 100644
--- a/gtk/gtkscrolledwindow.c
+++ b/gtk/gtkscrolledwindow.c
@@ -651,10 +651,10 @@ gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
/**
* gtk_scrolled_window_get_policy:
* @scrolled_window: a #GtkScrolledWindow
- * @hscrollbar_policy: location to store the policy for the horizontal
- * scrollbar, or %NULL.
- * @vscrollbar_policy: location to store the policy for the vertical
- * scrollbar, or %NULL.
+ * @hscrollbar_policy: (out) (allow-none): location to store the policy
+ * for the horizontal scrollbar, or %NULL.
+ * @vscrollbar_policy: (out) (allow-none): location to store the policy
+ * for the vertical scrollbar, or %NULL.
*
* Retrieves the current policy values for the horizontal and vertical
* scrollbars. See gtk_scrolled_window_set_policy().
diff --git a/gtk/gtkselection.c b/gtk/gtkselection.c
index 45a10e8..3d45c07 100644
--- a/gtk/gtkselection.c
+++ b/gtk/gtkselection.c
@@ -188,8 +188,8 @@ static const char gtk_selection_handler_key[] = "gtk-selection-handlers";
/**
* gtk_target_list_new:
- * @targets: Pointer to an array of #GtkTargetEntry
- * @ntargets: number of entries in @targets.
+ * @targets: (array length=ntargets): Pointer to an array of #GtkTargetEntry
+ * @ntargets: number of entries in @targets.
*
* Creates a new #GtkTargetList from an array of #GtkTargetEntry.
*
@@ -471,7 +471,7 @@ gtk_target_list_add_uri_targets (GtkTargetList *list,
/**
* gtk_target_list_add_table:
* @list: a #GtkTargetList
- * @targets: the table of #GtkTargetEntry
+ * @targets: (array length=ntargets): the table of #GtkTargetEntry
* @ntargets: number of targets in the table
*
* Prepends a table of #GtkTargetEntry to a target list.
@@ -903,7 +903,7 @@ gtk_selection_add_target (GtkWidget *widget,
* gtk_selection_add_targets:
* @widget: a #GtkWidget
* @selection: the selection
- * @targets: a table of targets to add
+ * @targets: (array length=ntargets): a table of targets to add
* @ntargets: number of entries in @targets
*
* Prepends a table of targets to the list of supported targets
@@ -1698,7 +1698,8 @@ gtk_selection_data_get_pixbuf (GtkSelectionData *selection_data)
/**
* gtk_selection_data_set_uris:
* @selection_data: a #GtkSelectionData
- * @uris: a %NULL-terminated array of strings holding URIs
+ * @uris: (array zero-terminated=1): a %NULL-terminated array of
+ * strings holding URIs
*
* Sets the contents of the selection from a list of URIs.
* The string is converted to the form determined by
@@ -1842,7 +1843,7 @@ gtk_selection_data_get_targets (GtkSelectionData *selection_data,
/**
* gtk_targets_include_text:
- * @targets: an array of #GdkAtom<!-- -->s
+ * @targets: (array length=n_targets): an array of #GdkAtom<!-- -->s
* @n_targets: the length of @targets
*
* Determines if any of the targets in @targets can be used to
@@ -1887,7 +1888,7 @@ gtk_targets_include_text (GdkAtom *targets,
/**
* gtk_targets_include_rich_text:
- * @targets: an array of #GdkAtom<!-- -->s
+ * @targets: (array length=n_targets): an array of #GdkAtom<!-- -->s
* @n_targets: the length of @targets
* @buffer: a #GtkTextBuffer
*
@@ -2005,7 +2006,7 @@ gtk_selection_data_targets_include_rich_text (GtkSelectionData *selection_data,
/**
* gtk_targets_include_image:
- * @targets: an array of #GdkAtom<!-- -->s
+ * @targets: (array length=n_targets): an array of #GdkAtom<!-- -->s
* @n_targets: the length of @targets
* @writable: whether to accept only targets for which GTK+ knows
* how to convert a pixbuf into the format
@@ -2087,7 +2088,7 @@ gtk_selection_data_targets_include_image (GtkSelectionData *selection_data,
/**
* gtk_targets_include_uri:
- * @targets: an array of #GdkAtom<!-- -->s
+ * @targets: (array length=n_targets): an array of #GdkAtom<!-- -->s
* @n_targets: the length of @targets
*
* Determines if any of the targets in @targets can be used to
diff --git a/gtk/gtkspinbutton.c b/gtk/gtkspinbutton.c
index 53734cc..1bfa035 100644
--- a/gtk/gtkspinbutton.c
+++ b/gtk/gtkspinbutton.c
@@ -1860,8 +1860,8 @@ gtk_spin_button_set_increments (GtkSpinButton *spin_button,
/**
* gtk_spin_button_get_increments:
* @spin_button: a #GtkSpinButton
- * @step: (allow-none): location to store step increment, or %NULL
- * @page: (allow-none): location to store page increment, or %NULL
+ * @step: (out) (allow-none): location to store step increment, or %NULL
+ * @page: (out) (allow-none): location to store page increment, or %NULL
*
* Gets the current step and page the increments used by @spin_button. See
* gtk_spin_button_set_increments().
@@ -1912,8 +1912,8 @@ gtk_spin_button_set_range (GtkSpinButton *spin_button,
/**
* gtk_spin_button_get_range:
* @spin_button: a #GtkSpinButton
- * @min: (allow-none): location to store minimum allowed value, or %NULL
- * @max: (allow-none): location to store maximum allowed value, or %NULL
+ * @min: (out) (allow-none): location to store minimum allowed value, or %NULL
+ * @max: (out) (allow-none): location to store maximum allowed value, or %NULL
*
* Gets the range allowed for @spin_button. See
* gtk_spin_button_set_range().
diff --git a/gtk/gtkstock.c b/gtk/gtkstock.c
index 2ba74ae..66b0ed5 100644
--- a/gtk/gtkstock.c
+++ b/gtk/gtkstock.c
@@ -123,7 +123,7 @@ real_add (const GtkStockItem *items,
/**
* gtk_stock_add:
- * @items: a #GtkStockItem or array of items
+ * @items: (array length=n_items): a #GtkStockItem or array of items
* @n_items: number of #GtkStockItem in @items
*
* Registers each of the stock items in @items. If an item already
@@ -145,7 +145,7 @@ gtk_stock_add (const GtkStockItem *items,
/**
* gtk_stock_add_static:
- * @items: a #GtkStockItem or array of #GtkStockItem
+ * @items: (array length=n_items): a #GtkStockItem or array of #GtkStockItem
* @n_items: number of items
*
* Same as gtk_stock_add(), but doesn't copy @items, so
@@ -164,7 +164,7 @@ gtk_stock_add_static (const GtkStockItem *items,
/**
* gtk_stock_lookup:
* @stock_id: a stock item name
- * @item: stock item to initialize with values
+ * @item: (out): stock item to initialize with values
*
* Fills @item with the registered values for @stock_id, returning %TRUE
* if @stock_id was known.
diff --git a/gtk/gtkstyle.c b/gtk/gtkstyle.c
index 0914d61..234ba9a 100644
--- a/gtk/gtkstyle.c
+++ b/gtk/gtkstyle.c
@@ -906,7 +906,7 @@ gtk_style_lookup_icon_set (GtkStyle *style,
* gtk_style_lookup_color:
* @style: a #GtkStyle
* @color_name: the name of the logical color to look up
- * @color: the #GdkColor to fill in
+ * @color: (out): the #GdkColor to fill in
*
* Looks up @color_name in the style's logical color mappings,
* filling in @color and returning %TRUE if found, otherwise
diff --git a/gtk/gtktestutils.c b/gtk/gtktestutils.c
index b49b262..d47c2c2 100644
--- a/gtk/gtktestutils.c
+++ b/gtk/gtktestutils.c
@@ -44,7 +44,8 @@
* gtk_test_init:
* @argcp: Address of the <parameter>argc</parameter> parameter of the
* main() function. Changed if any arguments were handled.
- * @argvp: Address of the <parameter>argv</parameter> parameter of main().
+ * @argvp: (inout) (array length=argcp): Address of the
+ * <parameter>argv</parameter> parameter of main().
* Any parameters understood by g_test_init() or gtk_init() are
* stripped before return.
* @Varargs: currently unused
@@ -620,7 +621,8 @@ static guint n_all_registered_types = 0;
/**
* gtk_test_list_all_types
* @n_types: location to store number of types
- * @returns: 0-terminated array of type ids
+ * @returns: (array length=n_types zero-terminated=1) (transfer none):
+ * 0-terminated array of type ids
*
* Return the type ids that have been registered after
* calling gtk_test_register_all_types().
diff --git a/gtk/gtktextbufferrichtext.c b/gtk/gtktextbufferrichtext.c
index 057cacc..8136cf1 100644
--- a/gtk/gtktextbufferrichtext.c
+++ b/gtk/gtktextbufferrichtext.c
@@ -409,8 +409,8 @@ gtk_text_buffer_deserialize_get_can_create_tags (GtkTextBuffer *buffer,
* with @buffer using gtk_text_buffer_register_serialize_format() or
* gtk_text_buffer_register_serialize_tagset()
*
- * Return value: an array of #GdkAtom<!-- -->s representing the registered
- * formats.
+ * Return value: (array length=n_formats) (transfer container): an array of
+ * #GdkAtom<!-- -->s representing the registered formats.
*
* Since: 2.10
**/
@@ -437,8 +437,8 @@ gtk_text_buffer_get_serialize_formats (GtkTextBuffer *buffer,
* with @buffer using gtk_text_buffer_register_deserialize_format() or
* gtk_text_buffer_register_deserialize_tagset()
*
- * Return value: an array of #GdkAtom<!-- -->s representing the registered
- * formats.
+ * Return value: (array length=n_formats) (transfer container): an array of
+ * #GdkAtom<!-- -->s representing the registered formats.
*
* Since: 2.10
**/
@@ -472,7 +472,8 @@ gtk_text_buffer_get_deserialize_formats (GtkTextBuffer *buffer,
* gtk_text_buffer_register_serialize_format() or
* gtk_text_buffer_register_serialize_tagset() beforehand.
*
- * Return value: the serialized data, encoded as @format
+ * Return value: (array length=length) (transfer full): the serialized
+ * data, encoded as @format
*
* Since: 2.10
**/
@@ -521,7 +522,7 @@ gtk_text_buffer_serialize (GtkTextBuffer *register_buffer,
* @content_buffer: the #GtkTextBuffer to deserialize into
* @format: the rich text format to use for deserializing
* @iter: insertion point for the deserialized text
- * @data: data to deserialize
+ * @data: (array length=length): data to deserialize
* @length: length of @data
* @error: return location for a #GError
*
diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c
index 85beaf1..c335e1c 100644
--- a/gtk/gtktextiter.c
+++ b/gtk/gtktextiter.c
@@ -1714,7 +1714,7 @@ gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter)
/**
* gtk_text_iter_get_attributes:
* @iter: an iterator
- * @values: a #GtkTextAttributes to be filled in
+ * @values: (out): a #GtkTextAttributes to be filled in
*
* Computes the effect of any tags applied to this spot in the
* text. The @values parameter should be initialized to the default
diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c
index 9a2edc0..57316f6 100644
--- a/gtk/gtktextview.c
+++ b/gtk/gtktextview.c
@@ -2281,7 +2281,7 @@ gtk_text_view_move_mark_onscreen (GtkTextView *text_view,
/**
* gtk_text_view_get_visible_rect:
* @text_view: a #GtkTextView
- * @visible_rect: rectangle to fill
+ * @visible_rect: (out): rectangle to fill
*
* Fills @visible_rect with the currently-visible
* region of the buffer, in buffer coordinates. Convert to window coordinates
diff --git a/gtk/gtktreednd.c b/gtk/gtktreednd.c
index 7e07945..5b31ebb 100644
--- a/gtk/gtktreednd.c
+++ b/gtk/gtktreednd.c
@@ -136,7 +136,8 @@ gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source,
* gtk_tree_drag_source_drag_data_get:
* @drag_source: a #GtkTreeDragSource
* @path: row that was dragged
- * @selection_data: a #GtkSelectionData to fill with data from the dragged row
+ * @selection_data: (out): a #GtkSelectionData to fill with data
+ * from the dragged row
*
* Asks the #GtkTreeDragSource to fill in @selection_data with a
* representation of the row at @path. @selection_data->target gives
@@ -283,8 +284,8 @@ gtk_tree_set_row_drag_data (GtkSelectionData *selection_data,
/**
* gtk_tree_get_row_drag_data:
* @selection_data: a #GtkSelectionData
- * @tree_model: a #GtkTreeModel
- * @path: row in @tree_model
+ * @tree_model: (out): a #GtkTreeModel
+ * @path: (out): row in @tree_model
*
* Obtains a @tree_model and @path from selection data of target type
* %GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler.
diff --git a/gtk/gtktreemodelfilter.c b/gtk/gtktreemodelfilter.c
index cc9d8e3..3adc82d 100644
--- a/gtk/gtktreemodelfilter.c
+++ b/gtk/gtktreemodelfilter.c
@@ -3074,7 +3074,7 @@ gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
* gtk_tree_model_filter_set_modify_func:
* @filter: A #GtkTreeModelFilter.
* @n_columns: The number of columns in the filter model.
- * @types: The #GType<!-- -->s of the columns.
+ * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
* @func: A #GtkTreeModelFilterModifyFunc
* @data: (allow-none): User data to pass to the modify function, or %NULL.
* @destroy: (allow-none): Destroy notifier of @data, or %NULL.
diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c
index 4119a75..47d0282 100644
--- a/gtk/gtktreeview.c
+++ b/gtk/gtktreeview.c
@@ -12905,7 +12905,7 @@ gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @path: (allow-none): a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
* @column: (allow-none): a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates
- * @rect: rectangle to fill with cell rect
+ * @rect: (out): rectangle to fill with cell rect
*
* Fills the bounding rectangle in bin_window coordinates for the cell at the
* row specified by @path and the column specified by @column. If @path is
@@ -12990,7 +12990,7 @@ gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @path: (allow-none): a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
* @column: (allow-none): a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes
- * @rect: rectangle to fill with cell background rect
+ * @rect: (out): rectangle to fill with cell background rect
*
* Fills the bounding rectangle in bin_window coordinates for the cell at the
* row specified by @path and the column specified by @column. If @path is
@@ -13046,7 +13046,7 @@ gtk_tree_view_get_background_area (GtkTreeView *tree_view,
/**
* gtk_tree_view_get_visible_rect:
* @tree_view: a #GtkTreeView
- * @visible_rect: rectangle to fill
+ * @visible_rect: (out): rectangle to fill
*
* Fills @visible_rect with the currently-visible region of the
* buffer, in tree coordinates. Convert to bin_window coordinates with
@@ -13143,8 +13143,8 @@ gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @wx: X coordinate relative to the widget
* @wy: Y coordinate relative to the widget
- * @tx: return location for tree X coordinate
- * @ty: return location for tree Y coordinate
+ * @tx: (out): return location for tree X coordinate
+ * @ty: (out): return location for tree Y coordinate
*
* Converts widget coordinates to coordinates for the
* tree (the full scrollable area of the tree).
@@ -13175,8 +13175,8 @@ gtk_tree_view_convert_widget_to_tree_coords (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @tx: X coordinate relative to the tree
* @ty: Y coordinate relative to the tree
- * @wx: return location for widget X coordinate
- * @wy: return location for widget Y coordinate
+ * @wx: (out): return location for widget X coordinate
+ * @wy: (out): return location for widget Y coordinate
*
* Converts tree coordinates (coordinates in full scrollable area of the tree)
* to widget coordinates.
@@ -13207,8 +13207,8 @@ gtk_tree_view_convert_tree_to_widget_coords (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @wx: X coordinate relative to the widget
* @wy: Y coordinate relative to the widget
- * @bx: return location for bin_window X coordinate
- * @by: return location for bin_window Y coordinate
+ * @bx: (out): return location for bin_window X coordinate
+ * @by: (out): return location for bin_window Y coordinate
*
* Converts widget coordinates to coordinates for the bin_window
* (see gtk_tree_view_get_bin_window()).
@@ -13235,8 +13235,8 @@ gtk_tree_view_convert_widget_to_bin_window_coords (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @bx: bin_window X coordinate
* @by: bin_window Y coordinate
- * @wx: return location for widget X coordinate
- * @wy: return location for widget Y coordinate
+ * @wx: (out): return location for widget X coordinate
+ * @wy: (out): return location for widget Y coordinate
*
* Converts bin_window coordinates (see gtk_tree_view_get_bin_window())
* to widget relative coordinates.
@@ -13263,8 +13263,8 @@ gtk_tree_view_convert_bin_window_to_widget_coords (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @tx: tree X coordinate
* @ty: tree Y coordinate
- * @bx: return location for X coordinate relative to bin_window
- * @by: return location for Y coordinate relative to bin_window
+ * @bx: (out): return location for X coordinate relative to bin_window
+ * @by: (out): return location for Y coordinate relative to bin_window
*
* Converts tree coordinates (coordinates in full scrollable area of the tree)
* to bin_window coordinates.
@@ -13291,8 +13291,8 @@ gtk_tree_view_convert_tree_to_bin_window_coords (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView
* @bx: X coordinate relative to bin_window
* @by: Y coordinate relative to bin_window
- * @tx: return location for tree X coordinate
- * @ty: return location for tree Y coordinate
+ * @tx: (out): return location for tree X coordinate
+ * @ty: (out): return location for tree Y coordinate
*
* Converts bin_window coordinates to coordinates for the
* tree (the full scrollable area of the tree).
@@ -13319,8 +13319,9 @@ gtk_tree_view_convert_bin_window_to_tree_coords (GtkTreeView *tree_view,
/**
* gtk_tree_view_get_visible_range:
* @tree_view: A #GtkTreeView
- * @start_path: (allow-none): Return location for start of region, or %NULL.
- * @end_path: (allow-none): Return location for end of region, or %NULL.
+ * @start_path: (out) (allow-none): Return location for start of region,
+ * or %NULL.
+ * @end_path: (out) (allow-none): Return location for end of region, or %NULL.
*
* Sets @start_path and @end_path to be the first and last visible path.
* Note that there may be invisible paths in between.
@@ -15550,8 +15551,8 @@ gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view,
/**
* gtk_tree_view_get_tooltip_context:
* @tree_view: a #GtkTreeView
- * @x: the x coordinate (relative to widget coordinates)
- * @y: the y coordinate (relative to widget coordinates)
+ * @x: (inout): the x coordinate (relative to widget coordinates)
+ * @y: (inout): the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not
* @model: (out) (allow-none): a pointer to receive a #GtkTreeModel or %NULL
* @path: (out) (allow-none): a pointer to receive a #GtkTreePath or %NULL
diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index 1e646ab..3e94826 100644
--- a/gtk/gtktreeviewcolumn.c
+++ b/gtk/gtktreeviewcolumn.c
@@ -2600,10 +2600,10 @@ gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
* gtk_tree_view_column_cell_get_size:
* @tree_column: A #GtkTreeViewColumn.
* @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
- * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
- * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
- * @width: (allow-none): location to return width needed to render a cell, or %NULL
- * @height: (allow-none): location to return height needed to render a cell, or %NULL
+ * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
+ * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
+ * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
+ * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
*
* Obtains the width and height needed to render the column. This is used
* primarily by the #GtkTreeView.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
