[doc] Suggest C++ alternatives to xbt containers

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

diff --git a/include/xbt/dict.h b/include/xbt/dict.h
index 4a03727..b3cfd35 100644 (file)
--- a/include/xbt/dict.h
+++ b/include/xbt/dict.h
@@ -21,6 +21,8 @@ SG_BEGIN_DECL()
  *  This section describes the API to a dictionary structure that  associates as string to a void* key. It provides the
  *  same functionality than an hash table.
  *
+ *  If you are using C++, you might want to use `std::unordered_map` instead.
+ *
  *  Here is a little example of use:
 
 \verbatim
@@ -33,7 +35,6 @@ SG_BEGIN_DECL()
  sprintf(buff,"another good stuff");
  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
 \endverbatim
- *
  */
 
 /** @defgroup XBT_dict_cons Dict constructor and destructor
@@ -173,4 +174,5 @@ xbt_dict_foreach(head, cursor, key, data) {
 /** @} */
 
 SG_END_DECL()
+
 #endif                          /* _XBT_DICT_H */