From ea577d60d451bc7102695046fb1c3f80fb3e1769 Mon Sep 17 00:00:00 2001 From: Pavel Holejsovsky Date: Sun, 19 Dec 2010 10:39:36 +0100 Subject: Add GI annotations to GValue and GValueArray. --- gobject/gvaluearray.c | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) (limited to 'gobject/gvaluearray.c') diff --git a/gobject/gvaluearray.c b/gobject/gvaluearray.c index 3bc6787f8..e2a752e43 100644 --- a/gobject/gvaluearray.c +++ b/gobject/gvaluearray.c @@ -58,7 +58,7 @@ * * Return a pointer to the value at @index_ containd in @value_array. * - * Returns: pointer to a value at @index_ in @value_array + * Returns: (transfer none): pointer to a value at @index_ in @value_array */ GValue* g_value_array_get_nth (GValueArray *value_array, @@ -158,7 +158,7 @@ g_value_array_free (GValueArray *value_array) * Construct an exact copy of a #GValueArray by duplicating all its * contents. * - * Returns: Newly allocated copy of #GValueArray + * Returns: (transfer full): Newly allocated copy of #GValueArray */ GValueArray* g_value_array_copy (const GValueArray *value_array) @@ -187,13 +187,13 @@ g_value_array_copy (const GValueArray *value_array) /** * g_value_array_prepend: * @value_array: #GValueArray to add an element to - * @value: #GValue to copy into #GValueArray, or %NULL + * @value: (allow-none): #GValue to copy into #GValueArray, or %NULL * * Insert a copy of @value as first element of @value_array. If @value is * %NULL, an uninitialized value is prepended. * * - * Returns: the #GValueArray passed in as @value_array + * Returns: (transfer none): the #GValueArray passed in as @value_array */ GValueArray* g_value_array_prepend (GValueArray *value_array, @@ -207,12 +207,12 @@ g_value_array_prepend (GValueArray *value_array, /** * g_value_array_append: * @value_array: #GValueArray to add an element to - * @value: #GValue to copy into #GValueArray, or %NULL + * @value: (allow-none): #GValue to copy into #GValueArray, or %NULL * * Insert a copy of @value as last element of @value_array. If @value is * %NULL, an uninitialized value is appended. * - * Returns: the #GValueArray passed in as @value_array + * Returns: (transfer none): the #GValueArray passed in as @value_array */ GValueArray* g_value_array_append (GValueArray *value_array, @@ -227,12 +227,12 @@ g_value_array_append (GValueArray *value_array, * g_value_array_insert: * @value_array: #GValueArray to add an element to * @index_: insertion position, must be <= value_array->n_values - * @value: #GValue to copy into #GValueArray, or %NULL + * @value: (allow-none): #GValue to copy into #GValueArray, or %NULL * * Insert a copy of @value at specified position into @value_array. If @value * is %NULL, an uninitialized value is inserted. * - * Returns: the #GValueArray passed in as @value_array + * Returns: (transfer none): the #GValueArray passed in as @value_array */ GValueArray* g_value_array_insert (GValueArray *value_array, @@ -265,7 +265,7 @@ g_value_array_insert (GValueArray *value_array, * * Remove the value at position @index_ from @value_array. * - * Returns: the #GValueArray passed in as @value_array + * Returns: (transfer none): the #GValueArray passed in as @value_array */ GValueArray* g_value_array_remove (GValueArray *value_array, @@ -290,14 +290,14 @@ g_value_array_remove (GValueArray *value_array, /** * g_value_array_sort: * @value_array: #GValueArray to sort - * @compare_func: function to compare elements + * @compare_func: (scope call): function to compare elements * * Sort @value_array using @compare_func to compare the elements accoring to * the semantics of #GCompareFunc. * * The current implementation uses Quick-Sort as sorting algorithm. * - * Returns: the #GValueArray passed in as @value_array + * Returns: (transfer none): the #GValueArray passed in as @value_array */ GValueArray* g_value_array_sort (GValueArray *value_array, @@ -316,15 +316,16 @@ g_value_array_sort (GValueArray *value_array, /** * g_value_array_sort_with_data: * @value_array: #GValueArray to sort - * @compare_func: function to compare elements - * @user_data: extra data argument provided for @compare_func + * @compare_func: (scope call): function to compare elements + * @user_data: (closure): extra data argument provided for @compare_func * * Sort @value_array using @compare_func to compare the elements accoring * to the semantics of #GCompareDataFunc. * * The current implementation uses Quick-Sort as sorting algorithm. * - * Returns: the #GValueArray passed in as @value_array + * Rename to: g_value_array_sort + * Returns: (transfer none): the #GValueArray passed in as @value_array */ GValueArray* g_value_array_sort_with_data (GValueArray *value_array, -- cgit v1.2.1