* @a: a #GArray.
* @t: the type of the elements.
* @i: the index of the element to return.
- * @Returns: the element of the #GArray at the index given by @i.
*
* Returns the element of a #GArray at the given index. The return
* value is cast to the given type.
* event = &g_array_index (events, EDayViewEvent, 3);
* </programlisting>
* </example>
+ *
+ * Returns: the element of the #GArray at the index given by @i.
**/
#define g_array_elt_len(array,i) ((array)->elt_size * (i))
* @clear_: %TRUE if #GArray elements should be automatically cleared
* to 0 when they are allocated.
* @element_size: the size of each element in bytes.
- * @Returns: the new #GArray.
*
* Creates a new #GArray with a reference count of 1.
+ *
+ * Returns: the new #GArray.
**/
GArray*
g_array_new (gboolean zero_terminated,
* allocation.
* @element_size: size of each element in the array.
* @reserved_size: number of elements preallocated.
- * @Returns: the new #GArray.
*
* Creates a new #GArray with @reserved_size elements preallocated and
* a reference count of 1. This avoids frequent reallocation, if you
* are going to add many elements to the array. Note however that the
* size of the array is still 0.
+ *
+ * Returns: the new #GArray.
**/
GArray* g_array_sized_new (gboolean zero_terminated,
gboolean clear,
* g_array_free:
* @array: a #GArray.
* @free_segment: if %TRUE the actual element data is freed as well.
- * @Returns: the element data if @free_segment is %FALSE, otherwise
- * %NULL. The element data should be freed using g_free().
*
* Frees the memory allocated for the #GArray. If @free_segment is
* %TRUE it frees the memory block holding the elements as well and
*
* <note><para>If array elements contain dynamically-allocated memory,
* they should be freed separately.</para></note>
+ *
+ * Returns: the element data if @free_segment is %FALSE, otherwise
+ * %NULL. The element data should be freed using g_free().
**/
gchar*
g_array_free (GArray *farray,
* @array: a #GArray.
* @data: a pointer to the elements to append to the end of the array.
* @len: the number of elements to append.
- * @Returns: the #GArray.
*
* Adds @len elements onto the end of the array.
+ *
+ * Returns: the #GArray.
**/
/**
* g_array_append_val:
* @a: a #GArray.
* @v: the value to append to the #GArray.
- * @Returns: the #GArray.
*
* Adds the value on to the end of the array. The array will grow in
* size automatically if necessary.
* <note><para>g_array_append_val() is a macro which uses a reference
* to the value parameter @v. This means that you cannot use it with
* literal values such as "27". You must use variables.</para></note>
+ *
+ * Returns: the #GArray.
**/
GArray*
g_array_append_vals (GArray *farray,
* @data: a pointer to the elements to prepend to the start of the
* array.
* @len: the number of elements to prepend.
- * @Returns: the #GArray.
*
* Adds @len elements onto the start of the array.
*
* This operation is slower than g_array_append_vals() since the
* existing elements in the array have to be moved to make space for
* the new elements.
+ *
+ * Returns: the #GArray.
**/
/**
* g_array_prepend_val:
* @a: a #GArray.
* @v: the value to prepend to the #GArray.
- * @Returns: the #GArray.
*
* Adds the value on to the start of the array. The array will grow in
* size automatically if necessary.
* <note><para>g_array_prepend_val() is a macro which uses a reference
* to the value parameter @v. This means that you cannot use it with
* literal values such as "27". You must use variables.</para></note>
+ *
+ * Returns: the #GArray.
**/
GArray*
g_array_prepend_vals (GArray *farray,
* @index_: the index to place the elements at.
* @data: a pointer to the elements to insert.
* @len: the number of elements to insert.
- * @Returns: the #GArray.
*
* Inserts @len elements into a #GArray at the given index.
+ *
+ * Returns: the #GArray.
**/
/**
* g_array_insert_val:
* @a: a #GArray.
* @i: the index to place the element at.
* @v: the value to insert into the array.
- * @Returns: the #GArray.
*
* Inserts an element into an array at the given index.
*
* <note><para>g_array_insert_val() is a macro which uses a reference
* to the value parameter @v. This means that you cannot use it with
* literal values such as "27". You must use variables.</para></note>
+ *
+ * Returns: the #GArray.
**/
GArray*
g_array_insert_vals (GArray *farray,
* g_array_set_size:
* @array: a #GArray.
* @length: the new size of the #GArray.
- * @Returns: the #GArray.
*
* Sets the size of the array, expanding it if necessary. If the array
* was created with @clear_ set to %TRUE, the new elements are set to 0.
+ *
+ * Returns: the #GArray.
**/
GArray*
g_array_set_size (GArray *farray,
* g_array_remove_index:
* @array: a #GArray.
* @index_: the index of the element to remove.
- * @Returns: the #GArray.
*
* Removes the element at the given index from a #GArray. The following
* elements are moved down one place.
+ *
+ * Returns: the #GArray.
**/
GArray*
g_array_remove_index (GArray *farray,
* g_array_remove_index_fast:
* @array: a @GArray.
* @index_: the index of the element to remove.
- * @Returns: the #GArray.
*
* Removes the element at the given index from a #GArray. The last
* element in the array is used to fill in the space, so this function
* does not preserve the order of the #GArray. But it is faster than
* g_array_remove_index().
+ *
+ * Returns: the #GArray.
**/
GArray*
g_array_remove_index_fast (GArray *farray,
* @array: a @GArray.
* @index_: the index of the first element to remove.
* @length: the number of elements to remove.
- * @Returns: the #GArray.
*
* Removes the given number of elements starting at the given index
* from a #GArray. The following elements are moved to close the gap.
*
+ * Returns: the #GArray.
+ *
* Since: 2.4
**/
GArray*
* g_ptr_array_index:
* @array: a #GPtrArray.
* @index_: the index of the pointer to return.
- * @Returns: the pointer at the given index.
*
* Returns the pointer at the given index of the pointer array.
+ *
+ * Returns: the pointer at the given index.
**/
static void g_ptr_array_maybe_expand (GRealPtrArray *array,
/**
* g_ptr_array_new:
- * @Returns: the new #GPtrArray.
*
* Creates a new #GPtrArray with a reference count of 1.
+ *
+ * Returns: the new #GPtrArray.
**/
GPtrArray*
g_ptr_array_new (void)
/**
* g_ptr_array_sized_new:
* @reserved_size: number of pointers preallocated.
- * @Returns: the new #GPtrArray.
*
* Creates a new #GPtrArray with @reserved_size pointers preallocated
* and a reference count of 1. This avoids frequent reallocation, if
* you are going to add many pointers to the array. Note however that
* the size of the array is still 0.
+ *
+ * Returns: the new #GPtrArray.
**/
GPtrArray*
g_ptr_array_sized_new (guint reserved_size)
/**
* g_ptr_array_new_with_free_func:
- * @element_free_func: A function to free elements with destroy @array or %NULL.
+ * @element_free_func: (allow-none): A function to free elements with destroy @array or %NULL.
*
* Creates a new #GPtrArray with a reference count of 1 and use @element_free_func
* for freeing each element when the array is destroyed either via
/**
* g_ptr_array_new_full:
* @reserved_size: number of pointers preallocated.
- * @element_free_func: A function to free elements with destroy @array or %NULL.
+ * @element_free_func: (allow-none): A function to free elements with destroy @array or %NULL.
*
* Creates a new #GPtrArray with @reserved_size pointers preallocated
* and a reference count of 1. This avoids frequent reallocation, if
/**
* g_ptr_array_set_free_func:
* @array: A #GPtrArray.
- * @element_free_func: A function to free elements with destroy @array or %NULL.
+ * @element_free_func: (allow-none): A function to free elements with destroy @array or %NULL.
*
* Sets a function for freeing each element when @array is destroyed
* either via g_ptr_array_unref(), when g_ptr_array_free() is called
/**
* g_ptr_array_ref:
- * @array: A #GArray.
+ * @array: a #GPtrArray
*
- * Atomically increments the reference count of @array by one. This
- * function is MT-safe and may be called from any thread.
+ * Atomically increments the reference count of @array by one.
+ * This function is thread-safe and may be called from any thread.
*
- * Returns: The passed in #GPtrArray.
+ * Returns: The passed in #GPtrArray
*
* Since: 2.22
- **/
+ */
GPtrArray *
g_ptr_array_ref (GPtrArray *array)
{
* g_ptr_array_free:
* @array: a #GPtrArray.
* @free_seg: if %TRUE the actual pointer array is freed as well.
- * @Returns: the pointer array if @free_seg is %FALSE, otherwise %NULL.
- * The pointer array should be freed using g_free().
*
* Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE
* it frees the memory block holding the elements as well. Pass %FALSE
* <note><para>If array contents point to dynamically-allocated
* memory, they should be freed separately if @free_seg is %TRUE and no
* #GDestroyNotify function has been set for @array.</para></note>
+ *
+ * Returns: the pointer array if @free_seg is %FALSE, otherwise %NULL.
+ * The pointer array should be freed using g_free().
**/
gpointer*
g_ptr_array_free (GPtrArray *farray,
* g_ptr_array_remove_index:
* @array: a #GPtrArray.
* @index_: the index of the pointer to remove.
- * @Returns: the pointer which was removed.
*
* Removes the pointer at the given index from the pointer array. The
* following elements are moved down one place. If @array has a
* non-%NULL #GDestroyNotify function it is called for the removed
* element.
+ *
+ * Returns: the pointer which was removed.
**/
gpointer
g_ptr_array_remove_index (GPtrArray *farray,
* g_ptr_array_remove_index_fast:
* @array: a #GPtrArray.
* @index_: the index of the pointer to remove.
- * @Returns: the pointer which was removed.
*
* Removes the pointer at the given index from the pointer array. The
* last element in the array is used to fill in the space, so this
* function does not preserve the order of the array. But it is faster
* than g_ptr_array_remove_index(). If @array has a non-%NULL
* #GDestroyNotify function it is called for the removed element.
+ *
+ * Returns: the pointer which was removed.
**/
gpointer
g_ptr_array_remove_index_fast (GPtrArray *farray,
* g_ptr_array_remove:
* @array: a #GPtrArray.
* @data: the pointer to remove.
- * @Returns: %TRUE if the pointer is removed. %FALSE if the pointer is
- * not found in the array.
*
* Removes the first occurrence of the given pointer from the pointer
* array. The following elements are moved down one place. If @array
*
* It returns %TRUE if the pointer was removed, or %FALSE if the
* pointer was not found.
+ *
+ * Returns: %TRUE if the pointer is removed. %FALSE if the pointer is
+ * not found in the array.
**/
gboolean
g_ptr_array_remove (GPtrArray *farray,
* g_ptr_array_remove_fast:
* @array: a #GPtrArray.
* @data: the pointer to remove.
- * @Returns: %TRUE if the pointer was found in the array.
*
* Removes the first occurrence of the given pointer from the pointer
* array. The last element in the array is used to fill in the space,
*
* It returns %TRUE if the pointer was removed, or %FALSE if the
* pointer was not found.
+ *
+ * Returns: %TRUE if the pointer was found in the array.
**/
gboolean
g_ptr_array_remove_fast (GPtrArray *farray,
/**
* g_byte_array_new:
- * @Returns: the new #GByteArray.
*
* Creates a new #GByteArray with a reference count of 1.
+ *
+ * Returns: (transfer full): the new #GByteArray.
**/
GByteArray* g_byte_array_new (void)
{
/**
* g_byte_array_new_take:
- * @data: (array length=len): byte data for the array
+ * @data: (transfer full) (array length=len): byte data for the array
* @len: length of @data
*
* Create byte array containing the data. The data will be owned by the array
/**
* g_byte_array_sized_new:
* @reserved_size: number of bytes preallocated.
- * @Returns: the new #GByteArray.
*
* Creates a new #GByteArray with @reserved_size bytes preallocated.
* This avoids frequent reallocation, if you are going to add many
* bytes to the array. Note however that the size of the array is still
* 0.
+ *
+ * Returns: the new #GByteArray.
**/
GByteArray* g_byte_array_sized_new (guint reserved_size)
{
* g_byte_array_free:
* @array: a #GByteArray.
* @free_segment: if %TRUE the actual byte data is freed as well.
- * @Returns: the element data if @free_segment is %FALSE, otherwise
- * %NULL. The element data should be freed using g_free().
*
* Frees the memory allocated by the #GByteArray. If @free_segment is
* %TRUE it frees the actual byte data. If the reference count of
* @array is greater than one, the #GByteArray wrapper is preserved but
* the size of @array will be set to zero.
+ *
+ * Returns: the element data if @free_segment is %FALSE, otherwise
+ * %NULL. The element data should be freed using g_free().
**/
guint8* g_byte_array_free (GByteArray *array,
gboolean free_segment)
* @array: a #GByteArray.
* @data: the byte data to be added.
* @len: the number of bytes to add.
- * @Returns: the #GByteArray.
*
* Adds the given bytes to the end of the #GByteArray. The array will
* grow in size automatically if necessary.
+ *
+ * Returns: the #GByteArray.
**/
GByteArray* g_byte_array_append (GByteArray *array,
const guint8 *data,
* @array: a #GByteArray.
* @data: the byte data to be added.
* @len: the number of bytes to add.
- * @Returns: the #GByteArray.
*
* Adds the given data to the start of the #GByteArray. The array will
* grow in size automatically if necessary.
+ *
+ * Returns: the #GByteArray.
**/
GByteArray* g_byte_array_prepend (GByteArray *array,
const guint8 *data,
* g_byte_array_set_size:
* @array: a #GByteArray.
* @length: the new size of the #GByteArray.
- * @Returns: the #GByteArray.
*
* Sets the size of the #GByteArray, expanding it if necessary.
+ *
+ * Returns: the #GByteArray.
**/
GByteArray* g_byte_array_set_size (GByteArray *array,
guint length)
* g_byte_array_remove_index:
* @array: a #GByteArray.
* @index_: the index of the byte to remove.
- * @Returns: the #GByteArray.
*
* Removes the byte at the given index from a #GByteArray. The
* following bytes are moved down one place.
+ *
+ * Returns: the #GByteArray.
**/
GByteArray* g_byte_array_remove_index (GByteArray *array,
guint index_)
* g_byte_array_remove_index_fast:
* @array: a #GByteArray.
* @index_: the index of the byte to remove.
- * @Returns: the #GByteArray.
*
* Removes the byte at the given index from a #GByteArray. The last
* element in the array is used to fill in the space, so this function
* does not preserve the order of the #GByteArray. But it is faster
* than g_byte_array_remove_index().
+ *
+ * Returns: the #GByteArray.
**/
GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
guint index_)
* @array: a @GByteArray.
* @index_: the index of the first byte to remove.
* @length: the number of bytes to remove.
- * @Returns: the #GByteArray.
*
* Removes the given number of bytes starting at the given index from a
* #GByteArray. The following elements are moved to close the gap.
*
+ * Returns: the #GByteArray.
+ *
* Since: 2.4
**/
GByteArray*
projects / platform / upstream / glib.git / blobdiff