diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-03-11 09:22:59 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-03-11 09:22:59 +0000 |
commit | 80a8621ec04e3fa9588ad09cbf0f1b6da1429776 (patch) | |
tree | 4e4cc8a942480df8e57312051d6484c155e17502 /src/chmsg.c | |
parent | 7dbc6a75678e6e06ec99786eb945d043b64e9721 (diff) | |
download | ChibiOS-80a8621ec04e3fa9588ad09cbf0f1b6da1429776.tar.gz ChibiOS-80a8621ec04e3fa9588ad09cbf0f1b6da1429776.tar.bz2 ChibiOS-80a8621ec04e3fa9588ad09cbf0f1b6da1429776.zip |
Documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@830 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chmsg.c')
-rw-r--r-- | src/chmsg.c | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/chmsg.c b/src/chmsg.c index 6744b7ac9..c506b6847 100644 --- a/src/chmsg.c +++ b/src/chmsg.c @@ -37,10 +37,10 @@ /**
* @brief Sends a message to the specified thread.
* @details The sender is stopped until the receiver executes a
- * @p chMsgRelease()after receiving the message.
+ * @p chMsgRelease()after receiving the message.
*
- * @param tp the pointer to the thread
- * @param msg the message
+ * @param[in] tp the pointer to the thread
+ * @param[in] msg the message
* @return The return message from @p chMsgRelease().
*/
msg_t chMsgSend(Thread *tp, msg_t msg) {
@@ -62,13 +62,13 @@ msg_t chMsgSend(Thread *tp, msg_t msg) { #if CH_USE_EVENTS && CH_USE_MESSAGES_EVENT
/**
* @brief Sends a message to the specified thread and atomically pends an
- * events set.
+ * events set.
* @details The sender is stopped until the receiver executes a
- * @p chMsgRelease() after receiving the message.
+ * @p chMsgRelease() after receiving the message.
*
- * @param tp the pointer to the thread
- * @param msg the message
- * @param mask the event flags set to be pended
+ * @param[in] tp the pointer to the thread
+ * @param[in] msg the message
+ * @param[in] mask the event flags set to be pended
* @return The return message from @p chMsgRelease().
* @note This function assumes that the receiving thread is not sleeping into
* a @p chMsgWait(). The use case is that the server thread is waiting
@@ -136,7 +136,7 @@ msg_t chMsgGet(void) { /**
* @brief Releases the thread waiting on top of the messages queue.
*
- * @param msg the message returned to the message sender
+ * @param[in] msg the message returned to the message sender
* @note You can call this function only if there is a message already in the
* queue else the result will be unpredictable (a crash most likely).
* Exiting from the @p chMsgWait() ensures you have at least one
|