X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/25d6952dcf52e6ffc1e4a402af0e2d3c17ac3935..94d82f305aa8f28f405ab9b70dd2d5280a1ab3d9:/src/xbt/heap.c

diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index c5d1649aa8..1357fce1da 100644
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -12,17 +12,12 @@
 #include "heap_private.h"
 
 
-/** \defgroup XBT_heap A generic heap data structure
+/** @addtogroup XBT_heap 
  *  \brief This section describes the API to generic heap with O(log(n)) access.
  */
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(heap, xbt, "Heap");
-
-/** \name Functions 
- *  \ingroup XBT_heap
- */
-/* @{ */
 /**
+ * @brief Creates a new heap.
  * \param init_size initial size of the heap
  * \param free_func function to call on each element when you want to free
  *             the whole heap (or NULL if nothing to do).
@@ -40,9 +35,8 @@ xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t * const free_func)
 }
 
 /**
- * \param H poor victim
- *
- * kilkil a heap and its content
+ * @brief kilkil a heap and its content
+ * @param H poor victim
  */
 void xbt_heap_free(xbt_heap_t H)
 {
@@ -56,8 +50,9 @@ void xbt_heap_free(xbt_heap_t H)
 }
 
 /**
- * \param H the heap we're working on
- * \return the number of elements in the heap
+ * @brief returns the number of elements in the heap
+ * @param H the heap we're working on
+ * @return the number of elements in the heap
  */
 int xbt_heap_size(xbt_heap_t H)
 {
@@ -65,12 +60,12 @@ int xbt_heap_size(xbt_heap_t H)
 }
 
 /**
+ * @brief Add an element into the heap.
  * \param H the heap we're working on
  * \param content the object you want to add to the heap
  * \param key the key associated to this object
  *
- * Add an element int the heap. The element with the smallest key is
- * automatically moved at the top of the heap.
+ * The element with the smallest key is automatically moved at the top of the heap.
  */
 void xbt_heap_push(xbt_heap_t H, void *content, double key)
 {
@@ -91,6 +86,7 @@ void xbt_heap_push(xbt_heap_t H, void *content, double key)
 }
 
 /**
+ * @brief Extracts from the heap and returns the element with the smallest key.
  * \param H the heap we're working on
  * \return the element with the smallest key
  *
@@ -120,6 +116,7 @@ void *xbt_heap_pop(xbt_heap_t H)
 }
 
 /**
+ * @brief returns the smallest key in the heap (heap unchanged)
  * \param H the heap we're working on
  *
  * \return the smallest key in the heap without modifying the heap.
@@ -131,6 +128,7 @@ double xbt_heap_maxkey(xbt_heap_t H)
 }
 
 /**
+ * @brief returns the value associated to the smallest key in the heap (heap unchanged)
  * \param H the heap we're working on
  *
  * \return the value associated to the smallest key in the heap
@@ -186,4 +184,3 @@ static void xbt_heap_increaseKey(xbt_heap_t H, int i)
   }
   return;
 }
-/* @} */