Merge pull request #302 from mpoquet/rename-s4u-synchro-examples

[simgrid.git] / include / xbt / dict.h

diff --git a/include/xbt/dict.h b/include/xbt/dict.h
index a4623bf..89aaba2 100644 (file)
--- a/include/xbt/dict.h
+++ b/include/xbt/dict.h
@@ -25,7 +25,7 @@ SG_BEGIN_DECL()
  *
  *  Here is a little example of use:
 
-\verbatim
+@verbatim
  xbt_dict_t mydict = xbt_dict_new_homogeneous(free);
  char buff[512];
 
@@ -34,7 +34,7 @@ SG_BEGIN_DECL()
 
  sprintf(buff,"another good stuff");
  xbt_dict_set(mydict,"my data", strdup(buff), NULL); // previous data gets erased (and freed) by second add
-\endverbatim
+@endverbatim
  */
 
 /** @defgroup XBT_dict_cons Dict constructor and destructor
@@ -43,7 +43,7 @@ SG_BEGIN_DECL()
  *  @{
  */
 
-  /** \brief Dictionary data type (opaque structure) */
+/** @brief Dictionary data type (opaque structure) */
 typedef struct s_xbt_dict *xbt_dict_t;
 typedef struct s_xbt_dictelm *xbt_dictelm_t;
 typedef struct s_xbt_dictelm {
@@ -73,19 +73,13 @@ XBT_PUBLIC void xbt_dict_set(xbt_dict_t dict, const char* key, void* data, void_
 XBT_PUBLIC void* xbt_dict_get(xbt_dict_t dict, const char* key);
 XBT_PUBLIC void* xbt_dict_get_or_null(xbt_dict_t dict, const char* key);
 XBT_PUBLIC char* xbt_dict_get_key(xbt_dict_t dict, const void* data);
-XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC
-    char* xbt_dict_get_elm_key(xbt_dictelm_t elem);
 XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm(xbt_dict_t dict, const char* key);
 XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm_or_null(xbt_dict_t dict, const char* key);
 
 XBT_PUBLIC void xbt_dict_remove(xbt_dict_t dict, const char* key);
 XBT_PUBLIC void xbt_dict_reset(xbt_dict_t dict);
 XBT_PUBLIC int xbt_dict_length(xbt_dict_t dict);
-XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC
-    void xbt_dict_dump_output_string(void* s);
 XBT_PUBLIC void xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
-XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC
-    void xbt_dict_dump_sizes(xbt_dict_t dict);
 XBT_PUBLIC int xbt_dict_is_empty(xbt_dict_t dict);
 
 /** @} */
@@ -117,15 +111,15 @@ struct s_xbt_dict_cursor {
  *
  *  Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
  *  xbt_dict_set was always a null-terminated char*):
-\verbatim xbt_dict_cursor_t cursor=NULL;
+@verbatim xbt_dict_cursor_t cursor=NULL;
  char *key,*data;
 
  xbt_dict_foreach(dict,cursor,key,data) {
     printf("   - Seen:  %s->%s\n",key,data);
- }\endverbatim
+ }@endverbatim
 
  *
- *  \warning Do not add or remove entries to the cache while traversing !!
+ *  @warning Do not add or remove entries to the cache while traversing !!
  *
  *  @{ */
 
@@ -143,21 +137,19 @@ XBT_PUBLIC void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 
 XBT_PUBLIC char* xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 XBT_PUBLIC void* xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
-XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC
-    void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void* data, void_f_pvoid_t free_ctn);
 
 XBT_PUBLIC void xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t* cursor);
 XBT_PUBLIC void xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 XBT_PUBLIC int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t* cursor, char** key, void** data);
 /** @def xbt_dict_foreach
- *  @param dict a \ref xbt_dict_t iterator
- *  @param cursor an \ref xbt_dict_cursor_t used as cursor
+ *  @param dict a @ref xbt_dict_t iterator
+ *  @param cursor an @ref xbt_dict_cursor_t used as cursor
  *  @param key a char*
  *  @param data a void** output
  *  @hideinitializer
  *
- * \note An example of usage:
- * \code
+ * @note An example of usage:
+ * @code
 xbt_dict_cursor_t cursor = NULL;
 char *key;
 char *data;
@@ -165,7 +157,7 @@ char *data;
 xbt_dict_foreach(head, cursor, key, data) {
  printf("Key %s with data %s\n",key,data);
 }
-\endcode
+@endcode
  */
 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \