[gtk+/gi-annotations: 5/30] Update GI annotations in 'Accelerator Groups and Maps'



commit a6b04a52a918c18f67326b52de1111d81f989101
Author: Pavel Holejsovsky <pholejs src gnome org>
Date:   Fri Jan 14 15:33:47 2011 +0100

    Update GI annotations in 'Accelerator Groups and Maps'

 gtk/gtkaccelgroup.c |   17 +++++++++++------
 gtk/gtkaccelgroup.h |    2 +-
 gtk/gtkaccelmap.c   |   13 +++++++------
 3 files changed, 19 insertions(+), 13 deletions(-)
---
diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index 9e43cca..a036005 100644
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -375,10 +375,11 @@ gtk_accel_groups_from_object (GObject *object)
 /**
  * gtk_accel_group_find:
  * @accel_group: a #GtkAccelGroup
- * @find_func: a function to filter the entries of @accel_group with
+ * @find_func: (scope call): a function to filter the entries
+ *    of @accel_group with
  * @data: data to pass to @find_func
- * @returns: the key of the first entry passing @find_func. The key is 
- * owned by GTK+ and must not be freed.
+ * @returns: (transfer none): the key of the first entry passing
+ *    @find_func. The key is owned by GTK+ and must not be freed.
  *
  * Finds the first entry in an accelerator group for which 
  * @find_func returns %TRUE and returns its #GtkAccelKey.
@@ -819,8 +820,11 @@ _gtk_accel_group_get_accelerables (GtkAccelGroup *accel_group)
  * @accel_group:      the accelerator group to query
  * @accel_key:        key value of the accelerator
  * @accel_mods:       modifier combination of the accelerator
- * @n_entries: (allow-none):        location to return the number of entries found, or %NULL
- * @returns: (allow-none):          an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed. 
+ * @n_entries: (allow-none): location to return the number of entries found,
+ *     or %NULL
+ * @returns: (transfer none) (array length=n_entries): an array of
+ *     @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is
+ *     owned by GTK+ and must not be freed.
  *
  * Queries an accelerator group for all entries matching @accel_key and 
  * @accel_mods.
@@ -847,7 +851,8 @@ gtk_accel_group_query (GtkAccelGroup  *accel_group,
 /**
  * gtk_accel_group_from_accel_closure:
  * @closure: a #GClosure
- * @returns: (allow-none): the #GtkAccelGroup to which @closure is connected, or %NULL.
+ * @returns: (transfer none): the #GtkAccelGroup to which @closure
+ *     is connected, or %NULL.
  *
  * Finds the #GtkAccelGroup to which @closure is connected; 
  * see gtk_accel_group_connect().
diff --git a/gtk/gtkaccelgroup.h b/gtk/gtkaccelgroup.h
index 5efe4fa..3195a91 100644
--- a/gtk/gtkaccelgroup.h
+++ b/gtk/gtkaccelgroup.h
@@ -71,7 +71,7 @@ typedef gboolean (*GtkAccelGroupActivate) (GtkAccelGroup  *accel_group,
  * GtkAccelGroupFindFunc:
  * @key: 
  * @closure: 
- * @data: 
+ * @data: (closure):
  * 
  * Since: 2.2
  */
diff --git a/gtk/gtkaccelmap.c b/gtk/gtkaccelmap.c
index 2b0fc3d..32d8c79 100644
--- a/gtk/gtkaccelmap.c
+++ b/gtk/gtkaccelmap.c
@@ -669,7 +669,7 @@ gtk_accel_map_load_fd (gint fd)
 
 /**
  * gtk_accel_map_load:
- * @file_name: a file containing accelerator specifications,
+ * @file_name: (type filename): a file containing accelerator specifications,
  *   in the GLib file name encoding
  *
  * Parses a file previously saved with gtk_accel_map_save() for
@@ -780,8 +780,8 @@ gtk_accel_map_save_fd (gint fd)
 
 /**
  * gtk_accel_map_save:
- * @file_name: the name of the file to contain accelerator specifications,
- *   in the GLib file name encoding
+ * @file_name: (type filename): the name of the file to contain
+ *   accelerator specifications, in the GLib file name encoding
  *
  * Saves current accelerator specifications (accelerator path, key
  * and modifiers) to @file_name.
@@ -807,8 +807,8 @@ gtk_accel_map_save (const gchar *file_name)
 /**
  * gtk_accel_map_foreach:
  * @data:         data to be passed into @foreach_func
- * @foreach_func: function to be executed for each accel map entry which
- *                is not filtered out
+ * @foreach_func: (scope call): function to be executed for each accel
+ *                map entry which is not filtered out
  *
  * Loops over the entries in the accelerator map whose accel path 
  * doesn't match any of the filters added with gtk_accel_map_add_filter(), 
@@ -844,7 +844,8 @@ gtk_accel_map_foreach (gpointer           data,
 /**
  * gtk_accel_map_foreach_unfiltered:
  * @data:         data to be passed into @foreach_func
- * @foreach_func: function to be executed for each accel map entry
+ * @foreach_func: (scope call): function to be executed for each accel
+ *                map entry
  *
  * Loops over all entries in the accelerator map, and execute
  * @foreach_func on each. The signature of @foreach_func is that of



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]