X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2e4f7439b31d1a92f0ebb8f2082d3108a79e13cf..215ed67257173f5e26c9489ec96c4ced08d1614a:/include/xbt/dynar.h
diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index 2b5fa44ac3..2cc56aa135 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -14,7 +14,15 @@
SG_BEGIN_DECL()
-/** \addtogroup XBT_dynar
+/** @addtogroup XBT_dynar
+ * @brief DynArr are dynamically sized vector which may contain any type of variables.
+ *
+ *
Top | [\ref index]::[\ref XBT_API]
+ * |
Prev | [\ref XBT_config]
+ * |
Next | [\ref XBT_dict]
+ * |
Down | [\ref XBT_dynar_cons] |
+ *
+ * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
*
* For performance concerns, the content of DynArr must be homogeneous (in
* contrary to dictionnaries -- see the \ref XBT_dict section). You thus
@@ -47,10 +55,16 @@ SG_BEGIN_DECL()
* \until dynar_free
* \skip xbt_exit
* \until }
- * @{
+ *
*/
-/** @name 1. Constructor/destructor
+/** @defgroup XBT_dynar_cons Dynar constructor and destructor
+ * @ingroup XBT_dynar
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
+ * |
Prev |
+ * |
Next | [\ref XBT_dynar_array] |
+ *
* @{
*/
/** \brief Dynar data type (opaque type) */
@@ -68,7 +82,13 @@ SG_BEGIN_DECL()
void xbt_dynar_dump(xbt_dynar_t dynar);
/** @} */
-/** @name 2. regular array functions
+/** @defgroup XBT_dynar_array Dynar as a regular array
+ * @ingroup XBT_dynar
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
+ * |
Prev | [\ref XBT_dynar_cons]
+ * |
Next | [\ref XBT_dynar_perl] |
+ *
* @{
*/
@@ -81,7 +101,13 @@ SG_BEGIN_DECL()
void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void * const dst);
/** @} */
-/** @name 2. Perl-like functions
+/** @defgroup XBT_dynar_perl Perl-like use of dynars
+ * @ingroup XBT_dynar
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
+ * |
Prev | [\ref XBT_dynar_array]
+ * |
Next | [\ref XBT_dynar_ctn] |
+ *
* @{
*/
@@ -92,7 +118,12 @@ SG_BEGIN_DECL()
void xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t *op);
/** @} */
-/** @name 3. Manipulating pointers to the content
+/** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
+ * @ingroup XBT_dynar
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
+ * |
Prev | [\ref XBT_dynar_perl]
+ * |
Next | [\ref XBT_dynar_speed] |
*
* Those functions do not retrive the content, but only their address.
*
@@ -105,7 +136,12 @@ SG_BEGIN_DECL()
void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
/** @} */
-/** @name 4. Speed optimized functions for scalars
+/** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
+ * @ingroup XBT_dynar
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
+ * |
Prev | [\ref XBT_dynar_ctn]
+ * |
Next | [\ref XBT_dynar_cursor] |
*
* While the other functions use a memcpy to retrive the content into the
* user provided area, those ones use a regular affectation. It only works
@@ -132,7 +168,12 @@ SG_BEGIN_DECL()
*(type*)xbt_dynar_pop_ptr(dynar)
/** @} */
-/** @name 5. Cursors on DynArr
+/** @defgroup XBT_dynar_cursor Cursors on dynar
+ * @ingroup XBT_dynar
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
+ * |
Prev | [\ref XBT_dynar_speed]
+ * |
Next | |
*
* Cursors are used to iterate over the structure. Never add elements to the
* DynArr during the traversal. To remove elements, use the
@@ -171,8 +212,8 @@ xbt_dynar_foreach (dyn,cpt,str) {
xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
xbt_dynar_cursor_step(_dynar,&(_cursor)) )
+/** @} */
SG_END_DECL()
-/* @} */
#endif /* _XBT_DYNAR_H */