X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2e4f7439b31d1a92f0ebb8f2082d3108a79e13cf..215ed67257173f5e26c9489ec96c4ced08d1614a:/include/xbt/set.h
diff --git a/include/xbt/set.h b/include/xbt/set.h
index 47a4cc47fe..c62a835667 100644
--- a/include/xbt/set.h
+++ b/include/xbt/set.h
@@ -15,7 +15,13 @@
SG_BEGIN_DECL()
/** @addtogroup XBT_set
+ * @brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
*
+ *
Top | [\ref index]::[\ref XBT_API]
+ * |
Prev | [\ref XBT_dict]
+ * |
Next | [\ref XBT_fifo]
+ * |
Down | [\ref XBT_set_cons] |
+ *
* The elements stored in such a data structure can be retrieve both by
* name and by ID. For this to work, the first fields of the structures
* stored must begin with:
@@ -29,11 +35,15 @@ SG_BEGIN_DECL()
* Such a datastructure was necessary/useful to store the GRAS type
* descriptions, but it should be reworked to become generic.
*
- * @{
-*/
+ */
-/** @name 1. Set and set elements, constructor/destructor
+/** @defgroup XBT_set_cons Set and set elements, constructor/destructor
+ * @ingroup XBT_set
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_set]
+ * |
Prev |
+ * |
Next | [\ref XBT_set_basic] |
*
* @{
*/
@@ -53,7 +63,12 @@ void xbt_set_free(xbt_set_t *set);
/** @} */
typedef struct xbt_set_elm_ s_xbt_set_elm_t;
typedef struct xbt_set_elm_ * xbt_set_elm_t;
-/** @name 2. Main functions
+/** @defgroup XBT_set_basic Sets basic usage
+ * @ingroup XBT_set
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_set]
+ * |
Prev | [\ref XBT_set_cons]
+ * |
Next | [\ref XBT_set_curs] |
*
* @{
*/
@@ -65,7 +80,12 @@ xbt_set_elm_t xbt_set_get_by_name_ext(xbt_set_t set, const char *key, int key_le
xbt_set_elm_t xbt_set_get_by_id (xbt_set_t set, int id);
/** @} */
-/** @name 3. Cursors
+/** @defgroup XBT_set_curs Sets cursors
+ * @ingroup XBT_set
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_set]
+ * |
Prev | [\ref XBT_set_basic]
+ * |
Next | |
*
* \warning Don't add or remove entries to the cache while traversing
*
@@ -89,7 +109,6 @@ int xbt_set_cursor_get_or_free (xbt_set_cursor_t *cursor,
xbt_set_cursor_get_or_free(&(cursor),(xbt_set_elm_t*)&(elm)); \
xbt_set_cursor_step(cursor) )
-/* @} */
/* @} */
SG_END_DECL()