gtk: fix several out argument annotations

These mostly just switch from allow-none to optional, nullable, or
both, as necessary.

https://bugzilla.gnome.org/show_bug.cgi?id=730745
This commit is contained in:
Evan Nemerson 2014-05-26 09:37:13 -07:00
parent a77765f172
commit 9db729f5a6
3 changed files with 30 additions and 22 deletions

View File

@ -1118,7 +1118,7 @@ gtk_style_real_init_from_rc (GtkStyle *style,
* @style: a #GtkStyle * @style: a #GtkStyle
* @widget_type: the #GType of a descendant of #GtkWidget * @widget_type: the #GType of a descendant of #GtkWidget
* @property_name: the name of the style property to get * @property_name: the name of the style property to get
* @value: a #GValue where the value of the property being * @value: (out): a #GValue where the value of the property being
* queried will be stored * queried will be stored
* *
* Queries the value of a style property corresponding to a * Queries the value of a style property corresponding to a
@ -4663,11 +4663,11 @@ gtk_widget_path (GtkWidget *widget,
/** /**
* gtk_widget_class_path: * gtk_widget_class_path:
* @widget: a #GtkWidget * @widget: a #GtkWidget
* @path_length: (out) (allow-none): location to store the length of the * @path_length: (out) (optional): location to store the length of the
* class path, or %NULL * class path, or %NULL
* @path: (out) (allow-none): location to store the class path as an * @path: (out) (optional): location to store the class path as an
* allocated string, or %NULL * allocated string, or %NULL
* @path_reversed: (out) (allow-none): location to store the reverse * @path_reversed: (out) (optional): location to store the reverse
* class path as an allocated string, or %NULL * class path as an allocated string, or %NULL
* *
* Same as gtk_widget_path(), but always uses the name of a widgets type, * Same as gtk_widget_path(), but always uses the name of a widgets type,

View File

@ -13222,8 +13222,10 @@ gtk_tree_view_real_set_cursor (GtkTreeView *tree_view,
/** /**
* gtk_tree_view_get_cursor: * gtk_tree_view_get_cursor:
* @tree_view: A #GtkTreeView * @tree_view: A #GtkTreeView
* @path: (out) (transfer full) (allow-none): A pointer to be filled with the current cursor path, or %NULL * @path: (out) (transfer full) (optional) (nullable): A pointer to be
* @focus_column: (out) (transfer none) (allow-none): A pointer to be filled with the current focus column, or %NULL * filled with the current cursor path, or %NULL
* @focus_column: (out) (transfer none) (optional) (nullable): A
* pointer to be filled with the current focus column, or %NULL
* *
* Fills in @path and @focus_column with the current path and focus column. If * Fills in @path and @focus_column with the current path and focus column. If
* the cursor isnt currently set, then *@path will be %NULL. If no column * the cursor isnt currently set, then *@path will be %NULL. If no column
@ -13381,10 +13383,14 @@ gtk_tree_view_get_bin_window (GtkTreeView *tree_view)
* @tree_view: A #GtkTreeView. * @tree_view: A #GtkTreeView.
* @x: The x position to be identified (relative to bin_window). * @x: The x position to be identified (relative to bin_window).
* @y: The y position to be identified (relative to bin_window). * @y: The y position to be identified (relative to bin_window).
* @path: (out) (allow-none): A pointer to a #GtkTreePath pointer to be filled in, or %NULL * @path: (out) (optional) (nullable): A pointer to a #GtkTreePath
* @column: (out) (transfer none) (allow-none): A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL * pointer to be filled in, or %NULL
* @cell_x: (out) (allow-none): A pointer where the X coordinate relative to the cell can be placed, or %NULL * @column: (out) (transfer none) (optional) (nullable): A pointer to
* @cell_y: (out) (allow-none): A pointer where the Y coordinate relative to the cell can be placed, or %NULL * a #GtkTreeViewColumn pointer to be filled in, or %NULL
* @cell_x: (out) (optional): A pointer where the X coordinate
* relative to the cell can be placed, or %NULL
* @cell_y: (out) (optional): A pointer where the Y coordinate
* relative to the cell can be placed, or %NULL
* *
* Finds the path at the point (@x, @y), relative to bin_window coordinates * Finds the path at the point (@x, @y), relative to bin_window coordinates
* (please see gtk_tree_view_get_bin_window()). * (please see gtk_tree_view_get_bin_window()).
@ -14342,8 +14348,8 @@ gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
/** /**
* gtk_tree_view_get_drag_dest_row: * gtk_tree_view_get_drag_dest_row:
* @tree_view: a #GtkTreeView * @tree_view: a #GtkTreeView
* @path: (out) (allow-none): Return location for the path of the highlighted row, or %NULL. * @path: (out) (optional) (nullable): Return location for the path of the highlighted row, or %NULL.
* @pos: (out) (allow-none): Return location for the drop position, or %NULL * @pos: (out) (optional): Return location for the drop position, or %NULL
* *
* Gets information about the row that is highlighted for feedback. * Gets information about the row that is highlighted for feedback.
**/ **/
@ -14376,8 +14382,10 @@ gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
* @tree_view: a #GtkTreeView * @tree_view: a #GtkTreeView
* @drag_x: the position to determine the destination row for * @drag_x: the position to determine the destination row for
* @drag_y: the position to determine the destination row for * @drag_y: the position to determine the destination row for
* @path: (out) (allow-none): Return location for the path of the highlighted row, or %NULL. * @path: (out) (optional) (nullable): Return location for the path of
* @pos: (out) (allow-none): Return location for the drop position, or %NULL * the highlighted row, or %NULL.
* @pos: (out) (optional): Return location for the drop position, or
* %NULL
* *
* Determines the destination row for a given position. @drag_x and * Determines the destination row for a given position. @drag_x and
* @drag_y are expected to be in widget coordinates. This function is only * @drag_y are expected to be in widget coordinates. This function is only
@ -16264,10 +16272,10 @@ gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view,
* @x: (inout): the x coordinate (relative to widget coordinates) * @x: (inout): the x coordinate (relative to widget coordinates)
* @y: (inout): the y coordinate (relative to widget coordinates) * @y: (inout): the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not * @keyboard_tip: whether this is a keyboard tooltip or not
* @model: (out) (allow-none) (transfer none): a pointer to receive a * @model: (out) (optional) (nullable) (transfer none): a pointer to
* #GtkTreeModel or %NULL * receive a #GtkTreeModel or %NULL
* @path: (out) (allow-none): a pointer to receive a #GtkTreePath or %NULL * @path: (out) (optional): a pointer to receive a #GtkTreePath or %NULL
* @iter: (out) (allow-none): a pointer to receive a #GtkTreeIter or %NULL * @iter: (out) (optional): a pointer to receive a #GtkTreeIter or %NULL
* *
* This function is supposed to be used in a #GtkWidget::query-tooltip * This function is supposed to be used in a #GtkWidget::query-tooltip
* signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values * signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values

View File

@ -2874,10 +2874,10 @@ gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
* gtk_tree_view_column_cell_get_size: * gtk_tree_view_column_cell_get_size:
* @tree_column: A #GtkTreeViewColumn. * @tree_column: A #GtkTreeViewColumn.
* @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
* @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL * @x_offset: (out) (optional): 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 * @y_offset: (out) (optional): 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 * @width: (out) (optional): 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 * @height: (out) (optional): location to return height needed to render a cell, or %NULL
* *
* Obtains the width and height needed to render the column. This is used * Obtains the width and height needed to render the column. This is used
* primarily by the #GtkTreeView. * primarily by the #GtkTreeView.