From 17348a216907a911be1ff551533ff2884cc74685 Mon Sep 17 00:00:00 2001
From: Martin Quinson <martin.quinson@loria.fr>
Date: Wed, 13 Feb 2013 01:02:54 +0100
Subject: [PATCH] document that it's safe to interrupt a foreach with a break
 or return statement

---
 include/xbt/dynar.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index d70677816f..735b62549f 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -267,7 +267,7 @@ _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
  *  @param _data
  *  @hideinitializer
  *
- * \note An example of usage:
+ * Here is an example of usage:
  * \code
 xbt_dynar_t dyn;
 unsigned int cpt;
@@ -276,6 +276,10 @@ xbt_dynar_foreach (dyn,cpt,str) {
   printf("Seen %s\n",str);
 }
 \endcode
+ * 
+ * Note that underneath, that's a simple for loop with no real black
+ * magic involved. It's perfectly safe to interrupt a foreach with a
+ * break or a return statement. 
  */
 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
        for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
-- 
2.20.1