mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-25 15:06:14 +01:00
ghash: Fix the documentation of GHRFunc
This function type isn't only used by g_hash_table_foreach_remove(), and what happens to the data when we return TRUE depends on the calling function. Includes a port to modern gi-docgen syntax by Emmanuele Bassi. Signed-off-by: Adrien Plazas <adrien.plazas@codethink.co.uk>
This commit is contained in:
parent
02ffe6a779
commit
46ec058d2a
19
glib/ghash.c
19
glib/ghash.c
@ -124,16 +124,21 @@
|
||||
* GHRFunc:
|
||||
* @key: a key
|
||||
* @value: the value associated with the key
|
||||
* @user_data: user data passed to g_hash_table_remove()
|
||||
* @user_data: user data passed to the calling function
|
||||
*
|
||||
* Specifies the type of the function passed to
|
||||
* g_hash_table_foreach_remove(). It is called with each key/value
|
||||
* pair, together with the @user_data parameter passed to
|
||||
* g_hash_table_foreach_remove(). It should return %TRUE if the
|
||||
* key/value pair should be removed from the #GHashTable.
|
||||
* [func@GLib.HashTable.find], [func@GLib.HashTable.foreach_remove], and
|
||||
* [func@GLib.HashTable.foreach_steal].
|
||||
*
|
||||
* The function is called with each key/value pair, together with
|
||||
* the @user_data parameter passed to the calling function.
|
||||
*
|
||||
* The function should return true if the key/value pair should be
|
||||
* selected, meaning it has been found or it should be removed from the
|
||||
* [struct@GLib.HashTable], depending on the calling function.
|
||||
*
|
||||
* Returns: %TRUE if the key/value pair should be removed from the
|
||||
* #GHashTable
|
||||
* Returns: true if the key/value pair should be selected, and
|
||||
* false otherwise
|
||||
*/
|
||||
|
||||
/**
|
||||
|
Loading…
Reference in New Issue
Block a user