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

Merge branch 'docs-hash-table-add' into 'master'

Browse Source 
ghash: Clarify that g_hash_table_add() always consumes the key

See merge request GNOME/glib!1348
This commit is contained in:
Philip Withnall 2020-01-31 14:24:07 +00:00
commit 84896e558d
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
glib/ghash.c
View File

@ -1651,12 +1651,16 @@ g_hash_table_replace (GHashTable *hash_table,
/** /**
* g_hash_table_add: * g_hash_table_add:
* @hash_table: a #GHashTable * @hash_table: a #GHashTable
* @key: a key to insert * @key: (transfer full): a key to insert
* *
* This is a convenience function for using a #GHashTable as a set. It * This is a convenience function for using a #GHashTable as a set. It
* is equivalent to calling g_hash_table_replace() with @key as both the * is equivalent to calling g_hash_table_replace() with @key as both the
* key and the value. * key and the value.
* *
* In particular, this means that if @key already exists in the hash table, then
* the old copy of @key in the hash table is freed and @key replaces it in the
* table.
*
* When a hash table only ever contains keys that have themselves as the * When a hash table only ever contains keys that have themselves as the
* corresponding value it is able to be stored more efficiently. See * corresponding value it is able to be stored more efficiently. See
* the discussion in the section description. * the discussion in the section description.