Commit 2fb1c064 authored by Pavel Holejsovsky's avatar Pavel Holejsovsky

[GI] Add missing (out) and (array) annotations

parent 2f0d4033
......@@ -268,7 +268,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().
......
......@@ -697,8 +697,8 @@ gdk_device_get_n_keys (GdkDevice *device)
* gdk_device_get_key:
* @device: a #GdkDevice.
* @index_: the index of the macro button to get.
* @keyval: return value for the keyval.
* @modifiers: return value for modifiers.
* @keyval: (out): return value for the keyval.
* @modifiers: (out): return value for modifiers.
*
* If @index_ has a valid keyval, this function will return %TRUE
* and fill in @keyval and @modifiers with the keyval settings.
......
......@@ -597,7 +597,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.
......@@ -1571,7 +1571,8 @@ gdk_display_supports_clipboard_persistence (GdkDisplay *display)
* @display: a #GdkDisplay
* @clipboard_window: a #GdkWindow belonging to the clipboard owner
* @time_: a timestamp
* @targets: an array of targets that should be saved, or %NULL
* @targets: (array length=n_targets): an array of targets
* that should be saved, or %NULL
* if all available targets should be saved.
* @n_targets: length of the @targets array
*
......@@ -1771,7 +1772,7 @@ gdk_display_get_app_launch_context (GdkDisplay *display)
* gdk_drag_get_protocol_for_display:
* @display: the #GdkDisplay where the destination window resides
* @xid: the windowing system id of the destination window.
* @protocol: location where the supported DND protocol is returned.
* @protocol: (out): location where the supported DND protocol is returned.
*
* Finds out the DND protocol supported by a window.
*
......
......@@ -918,7 +918,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
......@@ -1261,7 +1261,7 @@ gdk_events_get_axis_distances (GdkEvent *event1,
* gdk_events_get_distance:
* @event1: first #GdkEvent
* @event2: second #GdkEvent
* @distance: return location for the distance
* @distance: (out): return location for the distance
*
* If both events have X/Y information, the distance between both coordinates
* (as in a straight line going from @event1 to @event2) will be returned.
......@@ -1284,7 +1284,7 @@ gdk_events_get_distance (GdkEvent *event1,
* gdk_events_get_angle:
* @event1: first #GdkEvent
* @event2: second #GdkEvent
* @angle: return location for the relative angle between both events
* @angle: (out): return location for the relative angle between both events
*
* If both events contain X/Y information, this function will return %TRUE
* and return in @angle the relative angle from @event1 to @event2. The rotation
......
......@@ -397,8 +397,10 @@ gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
* gdk_keymap_get_entries_for_keycode:
* @keymap: a #GdkKeymap
* @hardware_keycode: a keycode
* @keys: (out): return location for array of #GdkKeymapKey, or %NULL
* @keyvals: (out): return location for array of keyvals, or %NULL
* @keys: (out) (array length=n_entries) (transfer full): return
* location for array of #GdkKeymapKey, or %NULL
* @keyvals: (out) (array length=n_entries) (transfer full): return
* location for array of keyvals, or %NULL
* @n_entries: length of @keys and @keyvals
*
* Returns the keyvals bound to @hardware_keycode.
......@@ -532,7 +534,7 @@ gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
/**
* gdk_keymap_add_virtual_modifiers:
* @keymap: a #GdkKeymap
* @state: pointer to the modifier mask to change
* @state: (out): pointer to the modifier mask to change
*
* Adds virtual modifiers (i.e. Super, Hyper and Meta) which correspond
* to the real modifiers (i.e Mod2, Mod3, ...) in @modifiers.
......@@ -558,7 +560,7 @@ gdk_keymap_add_virtual_modifiers (GdkKeymap *keymap,
/**
* gdk_keymap_map_virtual_modifiers:
* @keymap: a #GdkKeymap
* @state: pointer to the modifier state to map
* @state: (out): pointer to the modifier state to map
*
* Maps the virtual modifiers (i.e. Super, Hyper and Meta) which
* are set in @state to their non-virtual counterparts (i.e. Mod2,
......
......@@ -53,7 +53,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
......
......@@ -282,10 +282,11 @@ gdk_selection_convert (GdkWindow *requestor,
* @display: a #GdkDisplay
* @encoding: an atom representing the encoding of the text
* @format: the format of the property
* @text: the text to convert
* @text: (array length=length): the text to convert
* @length: the length of @text, in bytes
* @list: location to store the list of strings or %NULL. The
* list should be freed with g_strfreev().
* @list: (out) (array zero-terminated=1): location to store the list
* of strings or %NULL. The list should be freed with
* g_strfreev().
*
* Converts a text property in the given encoding to
* a list of UTF-8 strings.
......
......@@ -241,7 +241,8 @@ gdk_query_depths (gint **depths,
/**
* gdk_query_visual_types:
* @visual_types: return location for the available visual types
* @visual_types: (out) (array length=count) (transfer none): return
* location for the available visual types
* @count: return location for the number of available visual types
*
* This function returns the available visual types for the default
......
......@@ -406,8 +406,10 @@ gdk_window_class_init (GdkWindowClass *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.
......@@ -435,8 +437,10 @@ gdk_window_class_init (GdkWindowClass *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.
......@@ -2076,7 +2080,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().
......@@ -4781,8 +4785,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).
......@@ -6924,8 +6928,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
......@@ -10063,8 +10067,8 @@ gdk_window_set_transient_for (GdkWindow *window,
/**
* gdk_window_get_root_origin:
* @window: a toplevel #GdkWindow
* @x: return location for X position of window frame
* @y: return location for Y position of window frame
* @x: (out): return location for X position of window frame
* @y: (out): return location for Y position of window frame
*
* Obtains the top-left corner of the window manager frame in root
* window coordinates.
......@@ -10487,7 +10491,7 @@ gdk_window_set_decorations (GdkWindow *window,
/**
* gdk_window_get_decorations:
* @window: The toplevel #GdkWindow to get the decorations from
* @decorations: The window decorations will be written here
* @decorations: (out): The window decorations will be written here
*
* Returns the decorations set on the GdkWindow with
* gdk_window_set_decorations().
......@@ -10837,9 +10841,9 @@ gdk_test_simulate_button (GdkWindow *window,
* when rounded up).
* @pdelete: if %TRUE, delete the property after retrieving the
* data.
* @actual_property_type: location to store the actual type of
* the property.
* @actual_format: location to store the actual return format of the
* @actual_property_type: (out) (transfer none): location to store the
* actual type of the property.
* @actual_format: (out): location to store the actual return format of the
* data; either 8, 16 or 32 bits.
* @actual_length: location to store the length of the retrieved data, in
* bytes. Data returned in the 32 bit format is stored
......@@ -10847,9 +10851,9 @@ gdk_test_simulate_button (GdkWindow *window,
* elements should be be calculated via
* @actual_length / sizeof(glong) to ensure portability to
* 64 bit systems.
* @data: location to store a pointer to the data. The retrieved
* data should be freed with g_free() when you are finished
* using it.
* @data: (out) (array length=actual_length) (transfer full): location
* to store a pointer to the data. The retrieved data should be
* freed with g_free() when you are finished using it.
*
* Retrieves a portion of the contents of a property. If the
* property does not exist, then the function returns %FALSE,
......
......@@ -576,11 +576,12 @@ _gdk_x11_display_text_property_to_utf8_list (GdkDisplay *display,
* gdk_x11_display_string_to_compound_text:
* @display: the #GdkDisplay where the encoding is defined
* @str: a nul-terminated string
* @encoding: location to store the encoding atom
* @encoding: (out) (transfer none): location to store the encoding atom
* (to be used as the type for the property)
* @format: location to store the format of the property
* @ctext: location to store newly allocated data for the property
* @length: the length of @text, in bytes
* @format: (out): location to store the format of the property
* @ctext: (out) (array length=length): location to store newly
* allocated data for the property
* @length: the length of @ctext, in bytes
*
* Convert a string from the encoding of the current
* locale into a form suitable for storing in a window property.
......@@ -696,9 +697,9 @@ _gdk_x11_display_utf8_to_string_target (GdkDisplay *display,
* gdk_x11_display_utf8_to_compound_text:
* @display: a #GdkDisplay
* @str: a UTF-8 string
* @encoding: location to store resulting encoding
* @format: location to store format of the result
* @ctext: location to store the data of the result
* @encoding: (out): location to store resulting encoding
* @format: (out): location to store format of the result
* @ctext: (out) (array length=length): location to store the data of the result
* @length: location to store the length of the data
* stored in @ctext
*
......
......@@ -1480,9 +1480,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
*/
......@@ -1535,9 +1535,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
*/
......@@ -1590,9 +1590,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
*/
......
......@@ -753,10 +753,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 ().
......
......@@ -1505,10 +1505,14 @@ gtk_box_reorder_child (GtkBox *box,
* gtk_box_query_child_packing:
* @box: a #GtkBox
* @child: the #GtkWidget of the child to query
* @expand: pointer to return location for #GtkBox:expand child property
* @fill: pointer to return location for #GtkBox:fill child property
* @padding: pointer to return location for #GtkBox:padding child property
* @pack_type: pointer to return location for #GtkBox:pack-type child property
* @expand: (out): pointer to return location for #GtkBox:expand child
* property
* @fill: (out): pointer to return location for #GtkBox:fill child
* property
* @padding: (out): pointer to return location for #GtkBox:padding
* child property
* @pack_type: (out): pointer to return location for #GtkBox:pack-type
* child property
*
* Obtains information about how @child is packed into @box.
*/
......
......@@ -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.
......
......@@ -1341,7 +1341,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
......@@ -1397,7 +1397,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
......
......@@ -2240,8 +2240,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.
*
......
......@@ -3878,9 +3878,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.
*/
......
......@@ -2458,8 +2458,9 @@ gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
*
* Returns all cell properties of a cell area class.
*
* Return value: a newly allocated %NULL-terminated array of #GParamSpec*.
* The array must be freed with g_free().
* Return value: (array length=n_properties) (transfer container): a newly
* allocated %NULL-terminated array of #GParamSpec*. The array
* must be freed with g_free().
*
* Since: 3.0
*/
......
......@@ -613,10 +613,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
......@@ -857,8 +857,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.
**/
......@@ -925,8 +925,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.
*
......@@ -994,8 +994,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.
*
......@@ -1374,8 +1374,8 @@ gtk_cell_renderer_get_request_mode (GtkCellRenderer *cell)
* gtk_cell_renderer_get_preferred_width:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @minimum_size: location to store the minimum size, or %NULL
* @natural_size: location to store the natural size, or %NULL
* @minimum_size: (out) (allow-none): location to store the minimum size, or %NULL
* @natural_size: (out) (allow-none): location to store the natural size, or %NULL
*
* Retreives a renderer's natural size when rendered to @widget.
*
......@@ -1422,8 +1422,8 @@ gtk_cell_renderer_get_preferred_width (GtkCellRenderer *cell,
* gtk_cell_renderer_get_preferred_height:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @minimum_size: location to store the minimum size, or %NULL
* @natural_size: location to store the natural size, or %NULL
* @minimum_size: (out) (allow-none): location to store the minimum size, or %NULL
* @natural_size: (out) (allow-none): location to store the natural size, or %NULL
*
* Retreives a renderer's natural size when rendered to @widget.
*
......@@ -1471,8 +1471,8 @@ gtk_cell_renderer_get_preferred_height (GtkCellRenderer *cell,
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @height: the size which is available for allocation
* @minimum_width: location for storing the minimum size, or %NULL
* @natural_width: location for storing the preferred size, or %NULL
* @minimum_width: (out) (allow-none): location for storing the minimum size, or %NULL
* @natural_width: (out) (allow-none): location for storing the preferred size, or %NULL
*
* Retreives a cell renderers's minimum and natural width if it were rendered to
* @widget with the specified @height.
......@@ -1521,8 +1521,8 @@ gtk_cell_renderer_get_preferred_width_for_height (GtkCellRenderer *cell,
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @width: the size which is available for allocation
* @minimum_height: location for storing the minimum size, or %NULL
* @natural_height: location for storing the preferred size, or %NULL
* @minimum_height: (out) (allow-none): location for storing the minimum size, or %NULL
* @natural_height: (out) (allow-none): location for storing the preferred size, or %NULL
*
* Retreives a cell renderers's minimum and natural height if it were rendered to
* @widget with the specified @width.
......@@ -1633,8 +1633,8 @@ gtk_cell_renderer_get_preferred_size (GtkCellRenderer *cell,
* @widget: the #GtkWidget this cell will be rendering to
* @flags: render flags
* @cell_area: cell area which would be passed to gtk_cell_renderer_render()
* @aligned_area: the return location for the space inside @cell_area that
* would acually be used to render.
* @aligned_area: (out): the return location for the space inside @cell_area
* that would acually be used to render.
*
* Gets the aligned area used by @cell inside @cell_area. Used for finding
* the appropriate edit and focus rectangle.
......
......@@ -1179,7 +1179,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.
......
......@@ -1405,19 +1405,20 @@ clipboard_rich_text_received_func (GtkClipboard *clipboard,
* gtk_clipboard_wait_for_rich_text:
* @clipboard: a #GtkClipboard
* @buffer: a #GtkTextBuffer
* @format: return location for the format of the returned data
* @format: (out): return location for the format of the returned data
* @length: return location for the length of the returned data
*
* Requests the contents of the clipboard as rich text. This function
* waits for the data to be received using the main loop, so events,
* timeouts, etc, may be dispatched during the wait.
*
* Return value: a newly-allocated binary block of data which must
* be freed with g_free(), or %NULL if retrieving
* the selection data failed. (This could happen
* for various reasons, in particular if the
* clipboard was empty or if the contents of the
* clipboard could not be converted into text form.)
* Return value: (array length=length) (transfer full): a
* newly-allocated binary block of data which must be
* freed with g_free(), or %NULL if retrieving the
* selection data failed. (This could happen for various
* reasons, in particular if the clipboard was empty or
* if the contents of the clipboard could not be
* converted into text form.)
*
* Since: 2.10
**/
......@@ -1730,8 +1731,9 @@ gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard)
/**
* gtk_clipboard_wait_for_targets
* @clipboard: a #GtkClipboard
* @targets: location to store an array of targets. The result
* stored here must be freed with g_free().
* @targets: (out) (array length=n_targets) (transfer container): location
* to store an array of targets. The result stored here must
* be freed with g_free().
* @n_targets: location to store number of items in @targets.
*
* Returns a list of targets that are present on the clipboard, or %NULL
......@@ -1932,9 +1934,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
......
......@@ -2650,7 +2650,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.
**/
......@@ -2802,7 +2802,7 @@ gtk_color_selection_set_previous_rgba (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_previous_rgba:
* @colorsel: a #GtkColorSelection.
* @rgba: a #GdkRGBA to fill in with the original color value.
* @rgba: (out): a #GdkRGBA to fill in with the original color value.
*
* Fills @rgba in with the original color value.
*
......@@ -2881,7 +2881,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
......@@ -2966,7 +2967,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.
......
......@@ -1218,10 +1218,11 @@ gtk_container_class_find_child_property (GObjectClass *cclass,
/**
* gtk_container_class_list_child_properties:
* @cclass: a #GtkContainerClass
* @cclass: (type GtkContainerClass): a #GtkContainerClass
* @n_properties: location to return the number of child properties found
* @returns: a newly allocated %NULL-terminated array of #GParamSpec*.
* The array must be freed with g_free().
* @returns: (array length=n_properties) (transfer container): a newly
* allocated %NULL-terminated array of #GParamSpec*. The
* array must be freed with g_free().
*
* Returns all child properties of a container class.
*/
......
......@@ -1323,7 +1323,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,
......
......@@ -113,10 +113,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
......
......@@ -6814,7 +6814,7 @@ gtk_entry_set_buffer (GtkEntry *entry,
/**
* gtk_entry_get_text_area:
* @entry: a #GtkEntry
* @text_area: Return location for the text area.
* @text_area: (out): Return location for the text area.
*
* Gets the area where the entry's text is drawn. This function is
* useful when drawing something to the entry in a draw callback.
......@@ -7485,8 +7485,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
......@@ -8293,7 +8293,7 @@ gtk_entry_get_current_icon_drag_source (GtkEntry *entry)
* gtk_entry_get_icon_area:
* @entry: A #GtkEntry
* @icon_pos: Icon position
* @icon_area: Return location for the icon's area
* @icon_area: (out): Return location for the icon's area
*
* Gets the area where entry's icon at @icon_pos is drawn.
* This function is useful when drawing something to the
......
......@@ -522,8 +522,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().
......
......@@ -1330,9 +1330,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.
......@@ -1400,8 +1400,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.
*
......@@ -1457,9 +1457,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;
......@@ -1496,9 +1496,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