Documentation fix for eina iterators.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@49951 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/lib/eina_iterator.c b/src/lib/eina_iterator.c
index c93aedf..1150cef 100644 (file)
--- a/src/lib/eina_iterator.c
+++ b/src/lib/eina_iterator.c
@@ -181,8 +181,9 @@ eina_iterator_next(Eina_Iterator *iterator, void **data)
  *
  * This function iterates over the elements pointed by @p iterator,
  * beginning from the current element. For Each element, the callback
- * @p cb is called with the data @p fdata.If @p iterator is @c NULL,
- * the function returns immediatly.
+ * @p cb is called with the data @p fdata. If @p iterator is @c NULL,
+ * the function returns immediatly. Also, if @p cb returns @c
+ * EINA_FALSE, the iteration stops at that point.
  */
 EAPI void
 eina_iterator_foreach(Eina_Iterator *iterator,