[doc] Suggest C++ alternatives to xbt containers

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

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 0c758e9..3fe2951 100644 (file)
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -15,13 +15,14 @@ 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.
+ *
  *  @{
  */
 /* @brief heap datatype */
 typedef struct xbt_heap *xbt_heap_t;
 
-XBT_PUBLIC(xbt_heap_t) xbt_heap_new(int init_size,
-                                    void_f_pvoid_t const free_func);
+XBT_PUBLIC(xbt_heap_t) xbt_heap_new(int init_size, void_f_pvoid_t const free_func);
 XBT_PUBLIC(void) xbt_heap_free(xbt_heap_t H);
 XBT_PUBLIC(int) xbt_heap_size(xbt_heap_t H);
 
@@ -31,13 +32,11 @@ XBT_PUBLIC(void) xbt_heap_rm_elm(xbt_heap_t H, void *content, double key);
 
 XBT_PUBLIC(double) xbt_heap_maxkey(xbt_heap_t H);
 XBT_PUBLIC(void *) xbt_heap_maxcontent(xbt_heap_t H);
-XBT_PUBLIC(void) xbt_heap_set_update_callback(xbt_heap_t H,
-                                              void (*update_callback) (void
-                                                                       *,
-                                                                       int));
+XBT_PUBLIC(void) xbt_heap_set_update_callback(xbt_heap_t H, void (*update_callback) (void*, int));
 XBT_PUBLIC(void *) xbt_heap_remove(xbt_heap_t H, int i);
 XBT_PUBLIC(void ) xbt_heap_update(xbt_heap_t H, int i, double key);
 
 /* @} */
 SG_END_DECL()
+
 #endif                          /* _XBT_HEAP_H */