luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-10-28 10:06:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'ghrfunc-doc' into 'main'

Browse Source 
ghash: Fix the documentation of GHRFunc

See merge request GNOME/glib!4192
This commit is contained in:
Philip Withnall 2024-08-15 10:22:07 +00:00
commit 67b4a27569
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
glib/ghash.c
View File

@ -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
*/
/**