From: Christian Heinrich <franz-christian.heinrich@inria.fr>
Date: Fri, 12 Feb 2016 17:14:36 +0000 (+0100)
Subject: [XBT] Added some markup and "\see" to comment
X-Git-Tag: v3_13~746
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/945d569fe65ca218dd376cc402f095f5a36575c8?hp=133453b2a3fb74f9008cc77c415a4f53e37d7ce7

[XBT] Added some markup and "\see" to comment
---

diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index 7dfff27998..0a9e47f567 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -214,12 +214,14 @@ XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
                                      unsigned int *const cursor);
 
-/* do not use this structure internals directly, but use the public interface
- * This was made public to allow:
- *  - the inlining of the foreach elements
- *  - sending such beasts over the network
+/* 
+ * \warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
+ *          This was made public to allow:
+ *           - the inlining of the foreach elements
+ *           - sending such beasts over the network
+ *
+ * \see xbt_dynar_length()
  */
-
 typedef struct xbt_dynar_s {
   unsigned long size;
   unsigned long used;