document that it's safe to interrupt a foreach with a break or return statement

diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index d706778..735b625 100644 (file)
--- 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
  *
  *  @param _data
  *  @hideinitializer
  *

- * \note An example of usage:
+ * Here is an example of usage:

  * \code
 xbt_dynar_t dyn;
 unsigned int cpt;
  * \code
 xbt_dynar_t dyn;
 unsigned int cpt;


@@ -276,6 +276,10 @@ xbt_dynar_foreach (dyn,cpt,str) {
   printf("Seen %s\n",str);
 }
 \endcode
   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))      ; \
  */
 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
        for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \