glib: document restrictions on various foreach() functions

Some foreach() functions allow you to modify the object they are
iterating, and others don't, but the docs were not generally clear
about this.

https://bugzilla.gnome.org/show_bug.cgi?id=724383
This commit is contained in:
Dan Winship
2014-02-14 16:03:49 -05:00
committed by Philip Withnall
parent 3cfac71d09
commit 42d3ed0013
7 changed files with 37 additions and 7 deletions

View File

@@ -294,7 +294,8 @@ g_sequence_free (GSequence *seq)
* @user_data: user data passed to @func
*
* Calls @func for each item in the range (@begin, @end) passing
* @user_data to the function.
* @user_data to the function. @func must not modify the sequence
* itself.
*
* Since: 2.14
*/
@@ -335,7 +336,7 @@ g_sequence_foreach_range (GSequenceIter *begin,
* @user_data: user data passed to @func
*
* Calls @func for each item in the sequence passing @user_data
* to the function.
* to the function. @func must not modify the sequence itself.
*
* Since: 2.14
*/