[gtk+] Add missing introspection annotations
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Add missing introspection annotations
- Date: Tue, 10 Sep 2013 21:26:48 +0000 (UTC)
commit 59c4fb9d6af4b39b258c1abc0e6ed0d2d2c9780f
Author: Phil Clayton <phil clayton lineone net>
Date: Thu Sep 5 01:08:41 2013 +0100
Add missing introspection annotations
https://bugzilla.gnome.org/show_bug.cgi?id=707519
gtk/gtkaccelgroup.c | 9 ++++++---
gtk/gtkcellarea.c | 2 +-
gtk/gtkclipboard.c | 4 ++--
gtk/gtkrecentchooser.c | 3 ++-
gtk/gtkselection.c | 4 ++--
gtk/gtktextbufferrichtext.c | 6 +++---
gtk/gtktreemodel.c | 2 +-
gtk/gtkwidget.c | 2 +-
8 files changed, 18 insertions(+), 14 deletions(-)
---
diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index 60bd1ee..96316b3 100644
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -818,7 +818,7 @@ _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
+ * @n_entries: (out) (allow-none): location to return the number
* of entries found, or %NULL
*
* Queries an accelerator group for all entries matching @accel_key
@@ -1173,8 +1173,8 @@ is_keycode (const gchar *string)
* @accelerator: string representing an accelerator
* @accelerator_key: (out) (allow-none): return location for accelerator
* keyval, or %NULL
- * @accelerator_codes: (out) (allow-none): return location for accelerator
- * keycodes, or %NULL
+ * @accelerator_codes: (out) (array zero-terminated=1) (transfer full) (allow-none):
+ * return location for accelerator keycodes, or %NULL
* @accelerator_mods: (out) (allow-none): return location for accelerator
* modifier mask, %NULL
*
@@ -1183,6 +1183,9 @@ is_keycode (const gchar *string)
* useful for system-level components, applications should use
* gtk_accelerator_parse() instead.
*
+ * If @accelerator_codes is given and the result stored in it is non-%NULL,
+ * the result must be freed with g_free().
+ *
* If a keycode is present in the accelerator and no @accelerator_codes
* is given, the parse will fail.
*
diff --git a/gtk/gtkcellarea.c b/gtk/gtkcellarea.c
index b7bad3d..9bd4e10 100644
--- a/gtk/gtkcellarea.c
+++ b/gtk/gtkcellarea.c
@@ -2457,7 +2457,7 @@ gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
/**
* gtk_cell_area_class_list_cell_properties:
* @aclass: a #GtkCellAreaClass
- * @n_properties: location to return the number of cell properties found
+ * @n_properties: (out): location to return the number of cell properties found
*
* Returns all cell properties of a cell area class.
*
diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c
index a460e47..e2c0ace 100644
--- a/gtk/gtkclipboard.c
+++ b/gtk/gtkclipboard.c
@@ -1490,7 +1490,7 @@ clipboard_rich_text_received_func (GtkClipboard *clipboard,
* @clipboard: a #GtkClipboard
* @buffer: a #GtkTextBuffer
* @format: (out): return location for the format of the returned data
- * @length: return location for the length of the returned data
+ * @length: (out): 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,
@@ -1818,7 +1818,7 @@ gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard)
* @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.
+ * @n_targets: (out): location to store number of items in @targets.
*
* Returns a list of targets that are present on the clipboard, or %NULL
* if there aren't any targets available. The returned list must be
diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c
index f10790d..05b284c 100644
--- a/gtk/gtkrecentchooser.c
+++ b/gtk/gtkrecentchooser.c
@@ -845,7 +845,8 @@ gtk_recent_chooser_get_items (GtkRecentChooser *chooser)
/**
* gtk_recent_chooser_get_uris:
* @chooser: a #GtkRecentChooser
- * @length: (allow-none): return location for a the length of the URI list, or %NULL
+ * @length: (out) (allow-none): return location for a the length of the
+ * URI list, or %NULL
*
* Gets the URI of the recently used resources.
*
diff --git a/gtk/gtkselection.c b/gtk/gtkselection.c
index 67a774f..84bba6d 100644
--- a/gtk/gtkselection.c
+++ b/gtk/gtkselection.c
@@ -558,8 +558,8 @@ gtk_target_list_remove (GtkTargetList *list,
* gtk_target_list_find:
* @list: a #GtkTargetList
* @target: an interned atom representing the target to search for
- * @info: a pointer to the location to store application info for target,
- * or %NULL
+ * @info: (out) (allow-none): a pointer to the location to store
+ * application info for target, or %NULL
*
* Looks up a given target in a #GtkTargetList.
*
diff --git a/gtk/gtktextbufferrichtext.c b/gtk/gtktextbufferrichtext.c
index 2bad3ca..8da9605 100644
--- a/gtk/gtktextbufferrichtext.c
+++ b/gtk/gtktextbufferrichtext.c
@@ -400,7 +400,7 @@ gtk_text_buffer_deserialize_get_can_create_tags (GtkTextBuffer *buffer,
/**
* gtk_text_buffer_get_serialize_formats:
* @buffer: a #GtkTextBuffer
- * @n_formats: return location for the number of formats
+ * @n_formats: (out): return location for the number of formats
*
* This function returns the rich text serialize formats registered
* with @buffer using gtk_text_buffer_register_serialize_format() or
@@ -428,7 +428,7 @@ gtk_text_buffer_get_serialize_formats (GtkTextBuffer *buffer,
/**
* gtk_text_buffer_get_deserialize_formats:
* @buffer: a #GtkTextBuffer
- * @n_formats: return location for the number of formats
+ * @n_formats: (out): return location for the number of formats
*
* This function returns the rich text deserialize formats registered
* with @buffer using gtk_text_buffer_register_deserialize_format() or
@@ -460,7 +460,7 @@ gtk_text_buffer_get_deserialize_formats (GtkTextBuffer *buffer,
* @format: the rich text format to use for serializing
* @start: start of block of text to serialize
* @end: end of block of test to serialize
- * @length: return location for the length of the serialized data
+ * @length: (out): return location for the length of the serialized data
*
* This function serializes the portion of text between @start
* and @end in the rich text format represented by @format.
diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c
index b4f8ef0..6e40444 100644
--- a/gtk/gtktreemodel.c
+++ b/gtk/gtktreemodel.c
@@ -841,7 +841,7 @@ gtk_tree_path_get_indices (GtkTreePath *path)
/**
* gtk_tree_path_get_indices_with_depth:
* @path: a #GtkTreePath
- * @depth: (allow-none): return location for number of elements
+ * @depth: (out) (allow-none): return location for number of elements
* returned in the integer array, or %NULL
*
* Returns the current indices of @path.
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 67185f2..213a3fe 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -12353,7 +12353,7 @@ gtk_widget_class_find_style_property (GtkWidgetClass *klass,
/**
* gtk_widget_class_list_style_properties:
* @klass: a #GtkWidgetClass
- * @n_properties: location to return the number of style properties found
+ * @n_properties: (out): location to return the number of style properties found
*
* Returns all style properties of a widget class.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]