X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/494616a1d79ab04ce6f0309a5cbb29ee5876c379..c22474b6cb132c199c1708c093c9544418bacecc:/include/xbt/set.h diff --git a/include/xbt/set.h b/include/xbt/set.h index 47a4cc47fe..7af602a6a1 100644 --- a/include/xbt/set.h +++ b/include/xbt/set.h @@ -11,10 +11,12 @@ #define _XBT_SET_H #include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/function_types.h" SG_BEGIN_DECL() /** @addtogroup XBT_set + * @brief A data container consisting in \ref XBT_dict and \ref XBT_dynar * * 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 @@ -29,11 +31,11 @@ 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 * * @{ */ @@ -53,7 +55,8 @@ 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 * * @{ */ @@ -63,9 +66,13 @@ void xbt_set_add (xbt_set_t set, xbt_set_elm_t elm, void_f_pvoid_t *free_func); xbt_set_elm_t xbt_set_get_by_name (xbt_set_t set, const char *key); xbt_set_elm_t xbt_set_get_by_name_ext(xbt_set_t set, const char *key, int key_len); xbt_set_elm_t xbt_set_get_by_id (xbt_set_t set, int id); - + +unsigned long xbt_set_length (const xbt_set_t set); + + /** @} */ -/** @name 3. Cursors +/** @defgroup XBT_set_curs Sets cursors + * @ingroup XBT_set * * \warning Don't add or remove entries to the cache while traversing * @@ -89,7 +96,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()