From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Tue, 19 Jul 2016 10:32:23 +0000 (+0200)
Subject: [doc] @deprecate XBT structures
X-Git-Tag: v3_14~742
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/66c35960bb3e0a056156f22f7defeaf8c08a74f4

[doc] @deprecate XBT structures
---

diff --git a/include/xbt/dict.h b/include/xbt/dict.h
index b3cfd35ef3..59eb624420 100644
--- a/include/xbt/dict.h
+++ b/include/xbt/dict.h
@@ -21,7 +21,7 @@ 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.
+ *  @deprecated If you are using C++, you might want to use `std::unordered_map` instead.
  *
  *  Here is a little example of use:
 
diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index 874eb46f5b..fa25a74140 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -25,7 +25,7 @@ SG_BEGIN_DECL()
   * \ref XBT_dict section). You thus have to provide the function which will be used to free the content at
   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
   *
-  *  If you are using C++, you might want to use `std::vector` instead.
+  * @deprecated If you are using C++, you might want to use `std::vector` instead.
   *
   * \section XBT_dynar_exscal Example with scalar
   * \dontinclude dynar.cpp
diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h
index 5f6432b458..66ccf3d1ec 100644
--- a/include/xbt/fifo.h
+++ b/include/xbt/fifo.h
@@ -17,8 +17,8 @@ SG_BEGIN_DECL()
  * These functions provide the same kind of functionality as dynamic arrays
  * but in time O(1). However these functions use malloc/free way too much often.
  *
- *  If you are using C++, you might want to used std::list, std::deque or
- *  std::queue instead.
+ *  @deprecated If you are using C++, you might want to used `std::list`,
+ *  `std::deque` or `std::queue instead`.
  */
  
 /** @defgroup XBT_fifo_cons Fifo constructor and destructor
diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 3fe2951540..89ee7d125e 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -15,7 +15,8 @@ SG_BEGIN_DECL()
 /** @addtogroup XBT_heap
  *  @brief This section describes the API to generic heap with O(log(n)) access.
  *
- *  If you are using C++ you might want to use std::priority_queue instead.
+ *  @deprecated If you are using C++ you might want to use `std::priority_queue`
+ *  instead.
  *
  *  @{
  */
diff --git a/include/xbt/swag.h b/include/xbt/swag.h
index 318be64069..a0f6b3e759 100644
--- a/include/xbt/swag.h
+++ b/include/xbt/swag.h
@@ -24,7 +24,8 @@ SG_BEGIN_DECL()
  *  It is basically a fifo but with restrictions so that it can be used as a set. Any operation (add, remove, belongs)
  *  is O(1) and no call to malloc/free is done.
  *
- *  If you are using C++, you might want to use boost::intrusive::set instead.
+ *  @deprecated If you are using C++, you might want to use
+ *  `boost::intrusive::set` instead.
  */
 /** @defgroup XBT_swag_type Swag types
     @ingroup XBT_swag