Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the old crufty navigation bars
[simgrid.git] / include / xbt / heap.h
index 2b44138..27afafc 100644 (file)
@@ -9,10 +9,14 @@
 #define _XBT_HEAP_H
 
 #include "xbt/misc.h"
-
-/** \brief Heap data type 
-    \ingroup XBT_heap
-*/
+#include "xbt/dynar.h" /* void_f_pvoid_t */
+
+/** @addtogroup XBT_heap
+ *  @brief This section describes the API to generic heap with O(log(n)) access.
+ *
+ *  @{
+ */
+/* @brief heap datatype */
 typedef struct xbt_heap *xbt_heap_t;
 
 xbt_heap_t xbt_heap_new(int num, void_f_pvoid_t free_func);
@@ -25,4 +29,5 @@ void *xbt_heap_pop(xbt_heap_t H);
 double xbt_heap_maxkey(xbt_heap_t H);
 void *xbt_heap_maxcontent(xbt_heap_t H);
 
+/* @} */
 #endif                         /* _XBT_HEAP_H */