From 8b90a25e740ad0f8014d77fafbe1ebe824e53f09 Mon Sep 17 00:00:00 2001
From: mquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Date: Sat, 22 Oct 2005 09:07:51 +0000
Subject: [PATCH] Sanitize the documentation of heap: group defined in
 module-xbt.doc, its content declared in header file and each elements
 documented in the C file

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1784 48e7efb5-ca39-0410-a469-dd3cf9ba447f
---
 doc/module-xbt.doc |  8 ++++++--
 include/xbt/heap.h |  9 ++++++---
 src/xbt/heap.c     | 25 ++++++++++++-------------
 3 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc
index 5946d976d2..5184e5ff35 100644
--- a/doc/module-xbt.doc
+++ b/doc/module-xbt.doc
@@ -89,9 +89,11 @@
     /** @defgroup XBT_swag A O(1) set datatype
      *  @brief a O(1) set based on linked lists
      */
+
 	  
-/**       \addtogroup XBT_heap
-          \ingroup XBT_API */
+    /** @defgroup XBT_heap A generic heap data structure
+     *  @brief This section describes the API to generic heap with O(log(n)) access. 
+     */
 
 /* ************************* *
  * * PORTABILITY-INTERNALS * *
@@ -107,3 +109,5 @@
   *
   *  You should use those mechanism instead.
   */
+
+/** @} */ End of XBT_API
diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 377dbf21c1..70dd7b7d0a 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -11,9 +11,11 @@
 #include "xbt/misc.h"
 #include "xbt/dynar.h" /* void_f_pvoid_t */
 
-/** \brief Heap data type 
-    \ingroup XBT_heap
-*/
+/** @addtogroup XBT_heap
+ *
+ *  @{
+ */
+/* @brief heap datatype */
 typedef struct xbt_heap *xbt_heap_t;
 
 xbt_heap_t xbt_heap_new(int num, void_f_pvoid_t free_func);
@@ -26,4 +28,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 */
diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index c5d1649aa8..05c0a7af44 100644
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -12,17 +12,14 @@
 #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 +37,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 +52,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 +62,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 +88,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 +118,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 +130,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 +186,3 @@ static void xbt_heap_increaseKey(xbt_heap_t H, int i)
   }
   return;
 }
-/* @} */
-- 
2.20.1