updating the doc

[simgrid.git] / examples / msg / messages.h

diff --git a/examples/msg/messages.h b/examples/msg/messages.h
index 02770d5..d203033 100644 (file)
--- a/examples/msg/messages.h
+++ b/examples/msg/messages.h
@@ -5,6 +5,12 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
+/** \file messages.h
+ *  \ingroup MSG_examples
+ *  \brief Convenient debuging functions that should be used in combination with 
+ *  the perl-script tools/MSG_visualization/colorize.pl.
+*/
+
 #ifndef MESSAGES_H
 #define MESSAGES_H
 
@@ -13,6 +19,11 @@
 #include "msg/datatypes.h"
 #include "xbt/error.h"
 
+/** just like an assert.
+ * This function is used to ensure that a condition is true. 
+ * If not, it prints an error message (with the virtual date and the
+ * PID of the #m_process_t that called it).
+ */
 static void ASSERT(int value, const char *fmt, ...)
 {
   m_process_t self = MSG_process_self();
@@ -31,6 +42,10 @@ static void ASSERT(int value, const char *fmt, ...)
   return;
 }
 
+/** Die
+ * Just like #ASSERT() except you already know that the condition does not hold 
+ * true.
+ */
 static void DIE(const char *fmt, ...)
 {
   m_process_t self = MSG_process_self();
@@ -47,6 +62,10 @@ static void DIE(const char *fmt, ...)
   return;
 }
 
+/** 
+ * Print a one-line message with the virtual date and the PID of the #m_process_t
+ * that called it
+ */
 static void PRINT_MESSAGE(const char *fmt, ...)
 {
 #ifdef VERBOSE
@@ -63,6 +82,9 @@ static void PRINT_MESSAGE(const char *fmt, ...)
   return;
 }
 
+/** 
+ * Just like #PRINT_MESSAGE() except that it prints DEBUG in front of the line.
+ */
 static void PRINT_DEBUG_MESSAGE(const char *fmt, ...)
 {
 #ifdef VERBOSE