GHashTable: Explicitly document that _iter_remove() is safe while iterating

https://bugzilla.gnome.org/show_bug.cgi?id=723316

diff --git a/glib/ghash.c b/glib/ghash.c
index de05efd..23f4a44 100644 (file)
--- a/glib/ghash.c
+++ b/glib/ghash.c
@@ -809,6 +809,15 @@ iter_remove_or_steal (RealIter *ri, gboolean notify)
  * otherwise you have to make sure that any dynamically allocated
  * values are freed yourself.
  *
+ * It is safe to continue iterating the #GHashTable afterward:
+ * |[
+ * while (g_hash_table_iter_next (&iter, &key, &value))
+ *   {
+ *     if (condition)
+ *       g_hash_table_iter_remove (&iter);
+ *   }
+ * ]|
+ *
  * Since: 2.16
  */
 void