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

docs: Simplify the text for g_array_free

Browse Source 
The text about deallocation of GArrays with elements containing
dynamically-allocated memory was confusing. It initially mentioned
clear_func, but later said elements with dynamically allocated memory
"should be freed separately".

Clarify this by using the same structure as g_ptr_array_free —
highlight the need to set a clear_func by consolidating the text about
it in a separate paragraph.

https://gitlab.gnome.org/GNOME/glib/merge_requests/348
This commit is contained in:
Debarshi Ray 2018-09-24 16:03:46 +02:00
parent 30ccd6f01b
commit 0a8f3698a0
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
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 @clear_func set. 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.
* %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.
*
* 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()