further improve the MSG doc by documenting the examples

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

diff --git a/examples/msg/migration/migration.c b/examples/msg/migration/migration.c
index cd2b65d..f0ec596 100644 (file)
--- a/examples/msg/migration/migration.c
+++ b/examples/msg/migration/migration.c
@@ -12,6 +12,13 @@
 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test,
                              "Messages specific for this msg example");
 
+/** @addtogroup MSG_examples
+ *  
+ *  - <b>migration/migration.c</b> Demonstrates how to use the @ref
+ *    MSG_process_migrate function to let processes change the host they 
+ *    run on after their start. 
+ */
+
 xbt_mutex_t mutex = NULL;
 xbt_cond_t cond = NULL;
 static m_process_t process_to_migrate = NULL;