docs: Clarify that g_array_unref() works like g_ptr_array_unref().

This makes the documentation for this function more consistent with that
of g_ptr_array_unref(), which makes it clear that it acts like
g_(ptr_)array_free with free_segment=TRUE.
This commit is contained in:
Logan Rathbone 2025-01-22 13:29:50 -05:00
parent 26bc1d08ec
commit 14adec6a54

View File

@ -448,9 +448,9 @@ static gchar *array_free (GRealArray *, ArrayFreeFlags);
* @array: A #GArray
*
* Atomically decrements the reference count of @array by one. If the
* reference count drops to 0, all memory allocated by the array is
* released. This function is thread-safe and may be called from any
* thread.
* reference count drops to 0, the effect is the same as calling
* g_array_free() with @free_segment set to %TRUE. This function is
* thread-safe and may be called from any thread.
*
* Since: 2.22
*/