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

docs: Use the correct terminology for g_array_free

Browse Source 
GArray uses the term clear_func (eg., g_array_set_clear_func), while
element_free_func comes from GPtrArray.

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

10
glib/garray.c
View File

@ -319,11 +319,11 @@ g_array_get_element_size (GArray *array)
* *
* Frees the memory allocated for the #GArray. If @free_segment is * Frees the memory allocated for the #GArray. If @free_segment is
* %TRUE it frees the memory block holding the elements as well and * %TRUE it frees the memory block holding the elements as well and
* also each element if @array has a @element_free_func set. Pass * also each element if @array has a @clear_func set. Pass %FALSE if
* %FALSE if you want to free the #GArray wrapper but preserve the * you want to free the #GArray wrapper but preserve the underlying
* underlying array for use elsewhere. If the reference count of @array * array for use elsewhere. If the reference count of @array is
* is greater than one, the #GArray wrapper is preserved but the size * greater than one, the #GArray wrapper is preserved but the size of
* of @array will be set to zero. * @array will be set to zero.
* *
* If array elements contain dynamically-allocated memory, they should * If array elements contain dynamically-allocated memory, they should
* be freed separately. * be freed separately.