Fix some warnings in doc

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

diff --git a/include/xbt/dict.h b/include/xbt/dict.h
index 05b34c8..80c6f80 100644 (file)
--- a/include/xbt/dict.h
+++ b/include/xbt/dict.h
@@ -24,7 +24,9 @@ SG_BEGIN_DECL()
  *  functionality than an hash table.
  *
  *  Here is a little example of use:
- *  \verbatim xbt_dict_t mydict = xbt_dict_new();
+
+\verbatim
+ xbt_dict_t mydict = xbt_dict_new();
  char buff[512];
 
  sprintf(buff,"some very precious data");
@@ -139,14 +141,32 @@ XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
 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
-      @hideinitializer */
+/** @def xbt_dict_foreach
+ *  @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
+xbt_dict_cursor_t cursor = NULL;
+char *key;
+char *data;
+
+xbt_dict_foreach(head, cursor, key, data) {
+ printf("Key %s with data %s\n",key,data);
+}
+\endcode
+ */
 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
          xbt_dict_cursor_step(cursor) )
 
 /** @} */
+
+#ifdef XBT_USE_DEPRECATED
 /** @defgroup XBT_dict_multi Multi-level dictionaries
  *  @ingroup XBT_dict
  *
@@ -183,6 +203,7 @@ XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict,
                                           xbt_dynar_t lens);
 
 /** @} */
+#endif
 
 SG_END_DECL()
 #endif                          /* _XBT_DICT_H */