X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=bertos%2Fkern%2Fmsg.h;h=6cbcc444e371a98bb540a46bbca97af60f157fe8;hb=350223735c1c49b541d69f283fb71782ce374eea;hp=32232c56e018d3e2d487bddfb318fc840a50a96c;hpb=47d5e292509c20d22adfc608f412bdbe7209decb;p=bertos.git

diff --git a/bertos/kern/msg.h b/bertos/kern/msg.h
index 32232c56..6cbcc444 100644
--- a/bertos/kern/msg.h
+++ b/bertos/kern/msg.h
@@ -32,16 +32,14 @@
  * -->
  *
  *
- * This module implements a common system for executing
- * a user defined action calling a hook function.
- *
- * \version $Id$
- *
- * \author Bernie Innocenti <bernie@codewiz.org>
+ * \defgroup kern_msg Message box IPC
+ * \ingroup kern
+ * \{
  *
  * \brief Simple inter-process messaging system
  *
- * Handle queues of messages associated an action.
+ * This module implements a common system for executing
+ * a user defined action calling a hook function.
  *
  * A message port is an abstraction used to exchange information
  * asynchronously between processes or other entities such as
@@ -67,6 +65,11 @@
  * receiver wakes up, it usually invokes msg_get() to pick
  * the next message from the port.
  *
+ * \note
+ * When you put a message into a port, such message becomes
+ * unavailable until you retrieve it using msg_get(), eg.
+ * you must not delete it or put it into another port.
+ *
  * Message ports can hold any number of pending messages,
  * and receivers usually process them in FIFO order.
  * Other scheduling policies are possible, but not implemented
@@ -175,6 +178,8 @@
  *	}
  * \endcode
  *
+ * \author Bernie Innocenti <bernie@codewiz.org>
+ *
  * $WIZ$ module_name = "msg"
  * $WIZ$ module_depends = "event", "signal", "kernel"
  */
@@ -286,6 +291,8 @@ INLINE void msg_reply(Msg *msg)
 	msg_put(msg->replyPort, msg);
 }
 
+/** \} */ //defgroup kern_msg
+
 int msg_testRun(void);
 int msg_testSetup(void);
 int msg_testTearDown(void);