[gtk+] gtk: fix several out argument annotations
- From: Evan Nemerson <evann src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] gtk: fix several out argument annotations
- Date: Wed, 28 May 2014 04:25:16 +0000 (UTC)
commit 9db729f5a6b992168400f818e3fde6ffafc7cc04
Author: Evan Nemerson <evan nemerson com>
Date: Mon May 26 09:37:13 2014 -0700
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
gtk/deprecated/gtkstyle.c | 8 ++++----
gtk/gtktreeview.c | 36 ++++++++++++++++++++++--------------
gtk/gtktreeviewcolumn.c | 8 ++++----
3 files changed, 30 insertions(+), 22 deletions(-)
---
diff --git a/gtk/deprecated/gtkstyle.c b/gtk/deprecated/gtkstyle.c
index 03e27e8..5c1ef7a 100644
--- a/gtk/deprecated/gtkstyle.c
+++ b/gtk/deprecated/gtkstyle.c
@@ -1118,7 +1118,7 @@ gtk_style_real_init_from_rc (GtkStyle *style,
* @style: a #GtkStyle
* @widget_type: the #GType of a descendant of #GtkWidget
* @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
*
* Queries the value of a style property corresponding to a
@@ -4663,11 +4663,11 @@ gtk_widget_path (GtkWidget *widget,
/**
* gtk_widget_class_path:
* @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
- * @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
- * @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
*
* Same as gtk_widget_path(), but always uses the name of a widget’s type,
diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c
index 524e5ef..fa90787 100644
--- a/gtk/gtktreeview.c
+++ b/gtk/gtktreeview.c
@@ -13222,8 +13222,10 @@ gtk_tree_view_real_set_cursor (GtkTreeView *tree_view,
/**
* gtk_tree_view_get_cursor:
* @tree_view: A #GtkTreeView
- * @path: (out) (transfer full) (allow-none): A pointer to be filled with the current cursor path, or %NULL
- * @focus_column: (out) (transfer none) (allow-none): A pointer to be filled with the current focus column,
or %NULL
+ * @path: (out) (transfer full) (optional) (nullable): A pointer to be
+ * 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
* the cursor isn’t 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.
* @x: The x 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
- * @column: (out) (transfer none) (allow-none): A pointer to a #GtkTreeViewColumn 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
- * @cell_y: (out) (allow-none): A pointer where the Y coordinate relative to the cell can be placed, or %NULL
+ * @path: (out) (optional) (nullable): A pointer to a #GtkTreePath
+ * pointer to be filled in, or %NULL
+ * @column: (out) (transfer none) (optional) (nullable): A pointer to
+ * 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
* (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:
* @tree_view: a #GtkTreeView
- * @path: (out) (allow-none): Return location for the path of the highlighted row, or %NULL.
- * @pos: (out) (allow-none): Return location for the drop position, or %NULL
+ * @path: (out) (optional) (nullable): Return location for the path of the highlighted row, or %NULL.
+ * @pos: (out) (optional): Return location for the drop position, or %NULL
*
* 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
* @drag_x: 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.
- * @pos: (out) (allow-none): Return location for the drop position, or %NULL
+ * @path: (out) (optional) (nullable): Return location for the path of
+ * 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
* @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)
* @y: (inout): the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not
- * @model: (out) (allow-none) (transfer none): a pointer to receive a
- * #GtkTreeModel or %NULL
- * @path: (out) (allow-none): a pointer to receive a #GtkTreePath or %NULL
- * @iter: (out) (allow-none): a pointer to receive a #GtkTreeIter or %NULL
+ * @model: (out) (optional) (nullable) (transfer none): a pointer to
+ * receive a #GtkTreeModel or %NULL
+ * @path: (out) (optional): a pointer to receive a #GtkTreePath 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
* signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values
diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index 64429fa..5001217 100644
--- a/gtk/gtktreeviewcolumn.c
+++ b/gtk/gtktreeviewcolumn.c
@@ -2874,10 +2874,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: (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
+ * @x_offset: (out) (optional): location to return x 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) (optional): location to return width 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
* primarily by the #GtkTreeView.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]