Use doxygen's section instead of my poor approximation; link to the list of all exist...

[simgrid.git] / src / xbt / error.c

diff --git a/src/xbt/error.c b/src/xbt/error.c
index d39050c..fccc88b 100644 (file)
--- a/src/xbt/error.c
+++ b/src/xbt/error.c
@@ -9,15 +9,17 @@
    under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/error.h"
+/** \defgroup  XBT_error Error tracking support.
+ *  \brief This section describes a set of macros used to handle errors easily.
+ */
 
 /**
- * xbt_error_name:
- * @errcode: 
- * @Returns: the printable name of an error code
+ * \brief Usefull to do nice error repporting messages.
+ * \ingroup XBT_error
+ * \param errcode 
+ * \return the printable name of an error code
  *
- * usefull to do nice error repporting messages
  */
-
 const char *xbt_error_name(xbt_error_t errcode)  {
 
    switch (errcode) {
@@ -34,9 +36,15 @@ const char *xbt_error_name(xbt_error_t errcode)  {
    }
 }
 
-XBT_LOG_EXTERNAL_CATEGORY(gras);
-XBT_LOG_DEFAULT_CATEGORY(gras);
+XBT_LOG_EXTERNAL_CATEGORY(xbt);
+XBT_LOG_DEFAULT_CATEGORY(xbt);
   
+/**
+ * \ingroup XBT_error
+ * \param msg 
+ *
+ * Things are so messed up that the only thing to do now, is to stop the program.
+ */
 void xbt_die (const char *msg) {
    CRITICAL1("%s",msg);
    xbt_abort();