[gmime] Updated docs for g_mime_part_iter_remove()

[Jeffrey Stedfast <fejj src gnome org>]

commit 6d1dae2ed0be3bd57b07164a440bff611ae937d8
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sat Aug 13 18:55:16 2011 -0400

    Updated docs for g_mime_part_iter_remove()

 gmime/gmime-part-iter.c |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
---
diff --git a/gmime/gmime-part-iter.c b/gmime/gmime-part-iter.c
index cfea7cd..0d8da7d 100644
--- a/gmime/gmime-part-iter.c
+++ b/gmime/gmime-part-iter.c
@@ -571,7 +571,9 @@ g_mime_part_iter_replace (GMimePartIter *iter, GMimeObject *replacement)
  * g_mime_part_iter_remove:
  * @iter: a #GMimePartIter
  *
- * Removes the #GMimeObject at the current position from its parent.
+ * Removes the #GMimeObject at the current position from its
+ * parent. If successful, @iter is advanced to the next position
+ * (since the current position will become invalid).
  *
  * Returns: %TRUE if the part at the current position was removed or
  * %FALSE otherwise.