X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/707e365f2ebe9132b004da4995f4a705df9e5582..addf1684268e6863fc702567a8b47a090400428f:/include/xbt/heap.h

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 377dbf21c1..eb0a285240 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -9,21 +9,25 @@
 #define _XBT_HEAP_H
 
 #include "xbt/misc.h"
-#include "xbt/dynar.h" /* void_f_pvoid_t */
-
-/** \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);
-void xbt_heap_free(xbt_heap_t H);
-int xbt_heap_size(xbt_heap_t H);
+XBT_PUBLIC(xbt_heap_t) xbt_heap_new(int num, 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);
 
-void xbt_heap_push(xbt_heap_t H, void *content, double key);
-void *xbt_heap_pop(xbt_heap_t H);
+XBT_PUBLIC(void) xbt_heap_push(xbt_heap_t H, void *content, double key);
+XBT_PUBLIC(void *) xbt_heap_pop(xbt_heap_t H);
 
-double xbt_heap_maxkey(xbt_heap_t H);
-void *xbt_heap_maxcontent(xbt_heap_t H);
+XBT_PUBLIC(double) xbt_heap_maxkey(xbt_heap_t H);
+XBT_PUBLIC(void *) xbt_heap_maxcontent(xbt_heap_t H);
 
-#endif				/* _XBT_HEAP_H */
+/* @} */
+#endif /* _XBT_HEAP_H */