X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a4b5bbd4e14f566c45013b6da710460f8a110893..6fb81dc07673c304971a87e3d96d2c89f12c6e37:/src/msg/msg_mailbox.c

diff --git a/src/msg/msg_mailbox.c b/src/msg/msg_mailbox.c
index 1edc135eba..8461bf9318 100644
--- a/src/msg/msg_mailbox.c
+++ b/src/msg/msg_mailbox.c
@@ -56,6 +56,17 @@ msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
   return mailbox;
 }
 
+/** \ingroup msg_mailbox_management
+ * \brief Set the mailbox to receive in asynchronous mode
+ *
+ * All messages sent to this mailbox will be transferred to 
+ * the receiver without waiting for the receive call. 
+ * The receive call will still be necessary to use the received data.
+ * If there is a need to receive some messages asynchronously, and some not, 
+ * two different mailboxes should be used.
+ *
+ * \param alias The name of the mailbox 
+ */
 void MSG_mailbox_set_async(const char *alias){
   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);