[gtk+] [GI] Fixes of existing incorrect annotations

From: Pavel Holejsovsky <pholejs src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtk+] [GI] Fixes of existing incorrect annotations
Date: Thu, 20 Jan 2011 13:10:00 +0000 (UTC)
commit 3c8fc21e9b3e035b86ae0715b62dd88085ec08a8
Author: Pavel Holejsovsky <pholejs src gnome org>
Date:   Tue Jan 18 10:14:33 2011 +0100

    [GI] Fixes of existing incorrect annotations

 gdk/gdkdevice.c          |    6 +++---
 gdk/gdkkeys.c            |    5 +++--
 gdk/gdkvisual.c          |    5 +++--
 gtk/gtkaction.c          |    9 +++++----
 gtk/gtkcellrenderer.c    |    2 +-
 gtk/gtkfilechooser.c     |   17 +++++++++--------
 gtk/gtkicontheme.c       |    8 ++++----
 gtk/gtkiconview.c        |    2 +-
 gtk/gtkmain.c            |    3 ++-
 gtk/gtkradiobutton.c     |    4 ++--
 gtk/gtkradiomenuitem.c   |    6 +++---
 gtk/gtkradiotoolbutton.c |    4 ++--
 gtk/gtkselection.c       |    2 +-
 gtk/gtkstylecontext.c    |    2 +-
 gtk/gtkthemingengine.c   |    2 +-
 gtk/gtktreemodel.c       |    2 +-
 gtk/gtktreeview.c        |    3 ++-
 gtk/gtkwidget.c          |    2 +-
 gtk/gtkwidgetpath.c      |   12 ++++++------
 19 files changed, 51 insertions(+), 45 deletions(-)
---
diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c
index e6ee01d..a911923 100644
--- a/gdk/gdkdevice.c
+++ b/gdk/gdkdevice.c
@@ -498,7 +498,7 @@ gdk_device_get_window_at_position (GdkDevice  *device,
  * @window: the window with respect to which which the event coordinates will be reported
  * @start: starting timestamp for range of events to return
  * @stop: ending timestamp for the range of events to return
- * @events: (array length=n_events) (out) (transfer none): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
+ * @events: (array length=n_events) (out) (transfer full): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
  * @n_events: location to store the length of @events, or %NULL
  *
  * Obtains the motion history for a pointer device; given a starting and
@@ -554,8 +554,8 @@ _gdk_device_allocate_history (GdkDevice *device,
 }
 
 /**
- * gdk_device_free_history:
- * @events: (inout) (transfer none): an array of #GdkTimeCoord.
+ * gdk_device_free_history: (skip)
+ * @events: an array of #GdkTimeCoord.
  * @n_events: the length of the array.
  *
  * Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
diff --git a/gdk/gdkkeys.c b/gdk/gdkkeys.c
index 74993d6..59f8784 100644
--- a/gdk/gdkkeys.c
+++ b/gdk/gdkkeys.c
@@ -366,8 +366,9 @@ gdk_keymap_get_num_lock_state (GdkKeymap *keymap)
  * gdk_keymap_get_entries_for_keyval:
  * @keymap: a #GdkKeymap
  * @keyval: a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
- * @keys: (out): return location for an array of #GdkKeymapKey
- * @n_keys: (out): return location for number of elements in returned array
+ * @keys: (out) (array length=n_keys) (transfer full): return location
+ *     for an array of #GdkKeymapKey
+ * @n_keys: return location for number of elements in returned array
  *
  * Obtains a list of keycode/group/level combinations that will
  * generate @keyval. Groups and levels are two kinds of keyboard mode;
diff --git a/gdk/gdkvisual.c b/gdk/gdkvisual.c
index c1b0160..4a25402 100644
--- a/gdk/gdkvisual.c
+++ b/gdk/gdkvisual.c
@@ -219,8 +219,9 @@ gdk_visual_get_best_with_both (gint          depth,
 
 /**
  * gdk_query_depths:
- * @depths: (out) (array): return location for available depths
- * @count: (out): return location for number of available depths
+ * @depths: (out) (array length=count) (transfer none): return
+ *     location for available depths
+ * @count: return location for number of available depths
  *
  * This function returns the available bit depths for the default
  * screen. It's equivalent to listing the visuals
diff --git a/gtk/gtkaction.c b/gtk/gtkaction.c
index c9a6441..002a352 100644
--- a/gtk/gtkaction.c
+++ b/gtk/gtkaction.c
@@ -874,7 +874,7 @@ gtk_action_unblock_activate (GtkAction *action)
  * This function is intended for use by action implementations to
  * create icons displayed in the proxy widgets.
  *
- * Returns: (transfer full): a widget that displays the icon for this action.
+ * Returns: (transfer none): a widget that displays the icon for this action.
  *
  * Since: 2.4
  */
@@ -900,7 +900,7 @@ gtk_action_create_icon (GtkAction *action, GtkIconSize icon_size)
  *
  * Creates a menu item widget that proxies for the given action.
  *
- * Returns: (transfer full): a menu item connected to the action.
+ * Returns: (transfer none): a menu item connected to the action.
  *
  * Since: 2.4
  */
@@ -925,7 +925,7 @@ gtk_action_create_menu_item (GtkAction *action)
  *
  * Creates a toolbar item widget that proxies for the given action.
  *
- * Returns: (transfer full): a toolbar item connected to the action.
+ * Returns: (transfer none): a toolbar item connected to the action.
  *
  * Since: 2.4
  */
@@ -1812,7 +1812,8 @@ gtk_action_disconnect_accelerator (GtkAction *action)
  * item or the toolbar item it creates, this function returns an
  * instance of that menu.
  *
- * Return value: (transfer full): the menu item provided by the action, or %NULL.
+ * Return value: (transfer none): the menu item provided by the
+ *               action, or %NULL.
  *
  * Since: 2.12
  */
diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c
index b5e738a..36a6120 100644
--- a/gtk/gtkcellrenderer.c
+++ b/gtk/gtkcellrenderer.c
@@ -772,7 +772,7 @@ gtk_cell_renderer_activate (GtkCellRenderer      *cell,
  *
  * Passes an activate event to the cell renderer for possible processing.
  *
- * Return value: (transfer full): A new #GtkCellEditable, or %NULL
+ * Return value: (transfer none): A new #GtkCellEditable, or %NULL
  **/
 GtkCellEditable *
 gtk_cell_renderer_start_editing (GtkCellRenderer      *cell,
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
index da9d7c5..9243612 100644
--- a/gtk/gtkfilechooser.c
+++ b/gtk/gtkfilechooser.c
@@ -1698,9 +1698,10 @@ gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
  * Lists all the selected files and subfolders in the current folder of @chooser
  * as #GFile. An internal function, see gtk_file_chooser_get_uris().
  *
- * Return value: (element-type utf8) (transfer full): a #GSList containing a #GFile for each selected
- *   file and subfolder in the current folder.  Free the returned list
- *   with g_slist_free(), and the files with g_object_unref().
+ * Return value: (element-type GFile) (transfer full): a #GSList
+ *   containing a #GFile for each selected file and subfolder in the
+ *   current folder.  Free the returned list with g_slist_free(), and
+ *   the files with g_object_unref().
  *
  * Since: 2.14
  **/
@@ -1988,7 +1989,7 @@ gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser)
  * Gets the #GFile that should be previewed in a custom preview
  * Internal function, see gtk_file_chooser_get_preview_uri().
  *
- * Return value: (transfer none): the #GFile for the file to preview,
+ * Return value: (transfer full): the #GFile for the file to preview,
  *     or %NULL if no file is selected. Free with g_object_unref().
  *
  * Since: 2.14
@@ -2208,10 +2209,10 @@ gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
  * Lists the current set of user-selectable filters; see
  * gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
  *
- * Return value: (element-type utf8) (transfer container): a #GSList containing the current set of
- *  user selectable filters. The contents of the list are
- *  owned by GTK+, but you must free the list itself with
- *  g_slist_free() when you are done with it.
+ * Return value: (element-type GtkFileFilter) (transfer container): a
+ *  #GSList containing the current set of user selectable filters. The
+ *  contents of the list are owned by GTK+, but you must free the list
+ *  itself with g_slist_free() when you are done with it.
  *
  * Since: 2.4
  **/
diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
index 705cc12..62b8429 100644
--- a/gtk/gtkicontheme.c
+++ b/gtk/gtkicontheme.c
@@ -1731,10 +1731,10 @@ add_key_to_list (gpointer  key,
  * but will typically include such values as "Applications" and
  * "MimeTypes".
  *
- * Return value: (element-type utf8) (transfer none): a #GList list holding the names of all the
- *  icons in the theme. You must first free each element
- *  in the list with g_free(), then free the list itself
- *  with g_list_free().
+ * Return value: (element-type utf8) (transfer full): a #GList list
+ *  holding the names of all the icons in the theme. You must first
+ *  free each element in the list with g_free(), then free the list
+ *  itself with g_list_free().
  *
  * Since: 2.4
  **/
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index 9f89851..ee9be8b 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -6816,7 +6816,7 @@ gtk_icon_view_get_dest_item_at_pos (GtkIconView              *icon_view,
  * Creates a #cairo_surface_t representation of the item at @path.  
  * This image is used for a drag icon.
  *
- * Return value: (transfer full) a newly-allocated surface of the drag icon.
+ * Return value: (transfer full): a newly-allocated surface of the drag icon.
  * 
  * Since: 2.8
  **/
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 799db27..ae6980f 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -1036,7 +1036,8 @@ gtk_init_with_args (gint                 *argc,
 /**
  * gtk_parse_args:
  * @argc: (inout): a pointer to the number of command line arguments
- * @argv: (array) (inout): a pointer to the array of command line arguments
+ * @argv: (array length=argc) (inout): a pointer to the array of
+ *     command line arguments
  *
  * Parses command line arguments, and initializes global
  * attributes of GTK+, but does not actually open a connection
diff --git a/gtk/gtkradiobutton.c b/gtk/gtkradiobutton.c
index b6546ff..75fa843 100644
--- a/gtk/gtkradiobutton.c
+++ b/gtk/gtkradiobutton.c
@@ -488,7 +488,7 @@ gtk_radio_button_new_with_mnemonic (GSList      *group,
  * @radio_group_member. As with gtk_radio_button_new(), a widget
  * should be packed into the radio button.
  *
- * Returns: (transfer full): a new radio button.
+ * Returns: (transfer none): a new radio button.
  */
 GtkWidget*
 gtk_radio_button_new_from_widget (GtkRadioButton *radio_group_member)
@@ -529,7 +529,7 @@ gtk_radio_button_new_with_label_from_widget (GtkRadioButton *radio_group_member,
  * will be created using gtk_label_new_with_mnemonic(), so underscores
  * in @label indicate the mnemonic for the button.
  *
- * Returns: (transfer full): a new #GtkRadioButton
+ * Returns: (transfer none): a new #GtkRadioButton
  **/
 GtkWidget*
 gtk_radio_button_new_with_mnemonic_from_widget (GtkRadioButton *radio_group_member,
diff --git a/gtk/gtkradiomenuitem.c b/gtk/gtkradiomenuitem.c
index 78cfea7..8da604d 100644
--- a/gtk/gtkradiomenuitem.c
+++ b/gtk/gtkradiomenuitem.c
@@ -251,7 +251,7 @@ gtk_radio_menu_item_new_with_mnemonic (GSList *group,
  *
  * Creates a new #GtkRadioMenuItem adding it to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
@@ -280,7 +280,7 @@ gtk_radio_menu_item_new_from_widget (GtkRadioMenuItem *group)
  *
  * The new #GtkRadioMenuItem is added to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
@@ -306,7 +306,7 @@ gtk_radio_menu_item_new_with_mnemonic_from_widget (GtkRadioMenuItem *group,
  * Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
  * The new #GtkRadioMenuItem is added to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
diff --git a/gtk/gtkradiotoolbutton.c b/gtk/gtkradiotoolbutton.c
index 9a37c18..6ca5853 100644
--- a/gtk/gtkradiotoolbutton.c
+++ b/gtk/gtkradiotoolbutton.c
@@ -167,7 +167,7 @@ gtk_radio_tool_button_new_from_stock (GSList      *group,
  *
  * Creates a new #GtkRadioToolButton adding it to the same group as @gruup
  *
- * Return value: (transfer full): The new #GtkRadioToolButton
+ * Return value: (transfer none): The new #GtkRadioToolButton
  *
  * Since: 2.4
  **/
@@ -193,7 +193,7 @@ gtk_radio_tool_button_new_from_widget (GtkRadioToolButton *group)
  * The new #GtkRadioToolButton will contain an icon and label from the
  * stock item indicated by @stock_id.
  *
- * Return value: (transfer full): A new #GtkRadioToolButton
+ * Return value: (transfer none): A new #GtkRadioToolButton
  *
  * Since: 2.4
  **/
diff --git a/gtk/gtkselection.c b/gtk/gtkselection.c
index 2385c96..9665a98 100644
--- a/gtk/gtkselection.c
+++ b/gtk/gtkselection.c
@@ -1294,7 +1294,7 @@ gtk_selection_data_get_display (const GtkSelectionData *selection_data)
  * @selection_data: a pointer to a #GtkSelectionData structure.
  * @type: the type of selection data
  * @format: format (number of bits in a unit)
- * @data: (array) (element-type guchar): pointer to the data (will be copied)
+ * @data: (array length=length): pointer to the data (will be copied)
  * @length: length of the data
  * 
  * Stores new data into a #GtkSelectionData object. Should
diff --git a/gtk/gtkstylecontext.c b/gtk/gtkstylecontext.c
index 0f30fcd..4af7a2a 100644
--- a/gtk/gtkstylecontext.c
+++ b/gtk/gtkstylecontext.c
@@ -2387,7 +2387,7 @@ _gtk_style_context_peek_style_property (GtkStyleContext *context,
  * gtk_style_context_get_style_property:
  * @context: a #GtkStyleContext
  * @property_name: the name of the widget style property
- * @value: (out) (transfer full): Return location for the property value
+ * @value: Return location for the property value
  *
  * Gets the value for a widget style property.
  *
diff --git a/gtk/gtkthemingengine.c b/gtk/gtkthemingengine.c
index 80b02b0..5d406c2 100644
--- a/gtk/gtkthemingengine.c
+++ b/gtk/gtkthemingengine.c
@@ -473,7 +473,7 @@ gtk_theming_engine_get (GtkThemingEngine *engine,
  * gtk_theming_engine_get_style_property:
  * @engine: a #GtkThemingEngine
  * @property_name: the name of the widget style property
- * @value: (out) (transfer full): Return location for the property value, free with
+ * @value: Return location for the property value, free with
  *         g_value_unset() after use.
  *
  * Gets the value for a widget style property.
diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c
index d990676..67310d6 100644
--- a/gtk/gtktreemodel.c
+++ b/gtk/gtktreemodel.c
@@ -1404,7 +1404,7 @@ gtk_tree_model_iter_previous_default (GtkTreeModel *tree_model,
 /**
  * gtk_tree_model_iter_previous:
  * @tree_model: a #GtkTreeModel
- * @iter: (inout): the #GtkTreeIter
+ * @iter: (in): the #GtkTreeIter
  *
  * Sets @iter to point to the previous node at the current level.
  *
diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c
index d0311b4..b3f6c6f 100644
--- a/gtk/gtktreeview.c
+++ b/gtk/gtktreeview.c
@@ -14193,7 +14193,8 @@ gtk_tree_view_enable_model_drag_source (GtkTreeView              *tree_view,
 /**
  * gtk_tree_view_enable_model_drag_dest:
  * @tree_view: a #GtkTreeView
- * @targets: (array): the table of targets that the drag will support
+ * @targets: (array length=n_targets): the table of targets that
+ *           the drag will support
  * @n_targets: the number of items in @targets
  * @actions: the bitmask of possible actions for a drag from this
  *    widget
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 40ec604..cd408cc 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -4719,7 +4719,7 @@ gtk_widget_queue_shallow_draw (GtkWidget *widget)
 /**
  * gtk_widget_size_allocate:
  * @widget: a #GtkWidget
- * @allocation: (inout): position and size to be allocated to @widget
+ * @allocation: position and size to be allocated to @widget
  *
  * This function is only used by #GtkContainer subclasses, to assign a size
  * and position to their child widgets.
diff --git a/gtk/gtkwidgetpath.c b/gtk/gtkwidgetpath.c
index f0ae30e..40f1cac 100644
--- a/gtk/gtkwidgetpath.c
+++ b/gtk/gtkwidgetpath.c
@@ -599,9 +599,9 @@ gtk_widget_path_iter_clear_classes (GtkWidgetPath *path,
  * Returns a list with all the class names defined for the widget
  * at position @pos in the hierarchy defined in @path.
  *
- * Returns: (transfer container) (type utf8): The list of classes,
- *          This is a list of strings, the #GSList contents are
- *          owned by GTK+, but you should use g_slist_free() to
+ * Returns: (transfer container) (element-type utf8): The list of
+ *          classes, This is a list of strings, the #GSList contents
+ *          are owned by GTK+, but you should use g_slist_free() to
  *          free the list itself.
  *
  * Since: 3.0
@@ -836,9 +836,9 @@ gtk_widget_path_iter_clear_regions (GtkWidgetPath *path,
  * Returns a list with all the region names defined for the widget
  * at position @pos in the hierarchy defined in @path.
  *
- * Returns: (transfer container) (type utf8): The list of regions,
- *          This is a list of strings, the #GSList contents are
- *          owned by GTK+, but you should use g_slist_free() to
+ * Returns: (transfer container) (element-type utf8): The list of
+ *          regions, This is a list of strings, the #GSList contents
+ *          are owned by GTK+, but you should use g_slist_free() to
  *          free the list itself.
  *
  * Since: 3.0
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]