further improve the MSG doc by documenting the examples

[simgrid.git] / examples / msg / sendrecv / sendrecv.c

diff --git a/examples/msg/sendrecv/sendrecv.c b/examples/msg/sendrecv/sendrecv.c
index 56bd375..a59aa54 100644 (file)
--- a/examples/msg/sendrecv/sendrecv.c
+++ b/examples/msg/sendrecv/sendrecv.c
@@ -13,6 +13,13 @@
 #include "xbt/log.h"
 #include "xbt/asserts.h"
 
+/** @addtogroup MSG_examples
+ * 
+ *  - <b>sendrecv/sendrecv.c: Ping-pong example</b>. It's hard to
+ *    think of a simpler example. The tesh files laying in the
+ *    directory are instructive concerning the way to pass options to the simulators (as described in \ref options).
+ */
+
 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test,
                              "Messages specific for this msg example");