luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 15:36:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'wip/rishi/docs-garray' into 'master'

Browse Source 
Documentation tweaks for g_array_free

See merge request GNOME/glib!348
This commit is contained in:
Philip Withnall 2018-09-28 13:06:04 +00:00
commit c824ffd377
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
glib/garray.c
View File

@ -318,15 +318,15 @@ g_array_get_element_size (GArray *array)
* @free_segment: if %TRUE the actual element data is freed as well
*
* Frees the memory allocated for the #GArray. If @free_segment is
* %TRUE it frees the memory block holding the elements as well and
* also each element if @array has a @element_free_func set. Pass
* %TRUE it frees the memory block holding the elements as well. Pass
* %FALSE if you want to free the #GArray wrapper but preserve the
* underlying array for use elsewhere. If the reference count of @array
* is greater than one, the #GArray wrapper is preserved but the size
* of @array will be set to zero.
* underlying array for use elsewhere. If the reference count of
* @array is greater than one, the #GArray wrapper is preserved but
* the size of @array will be set to zero.
*
* If array elements contain dynamically-allocated memory, they should
* be freed separately.
* If array contents point to dynamically-allocated memory, they should
* be freed separately if @free_seg is %TRUE and no @clear_func
* function has been set for @array.
*
* This function is not thread-safe. If using a #GArray from multiple
* threads, use only the atomic g_array_ref() and g_array_unref()