diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2008-10-17 18:33:35 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2008-10-17 18:33:35 +0000 |
commit | 1d23eb296156769cff3e41bd7026db1cd2538664 (patch) | |
tree | 512bbaa17560196c09dcce171bcb28a367838542 /src/chmsg.c | |
parent | 3d3e5728aa1d14444b99732426d36f6375013727 (diff) | |
download | ChibiOS-1d23eb296156769cff3e41bd7026db1cd2538664.tar.gz ChibiOS-1d23eb296156769cff3e41bd7026db1cd2538664.tar.bz2 ChibiOS-1d23eb296156769cff3e41bd7026db1cd2538664.zip |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@474 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chmsg.c')
-rw-r--r-- | src/chmsg.c | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/chmsg.c b/src/chmsg.c index 5a1ce4b15..51a126c0f 100644 --- a/src/chmsg.c +++ b/src/chmsg.c @@ -30,7 +30,7 @@ *
* @param tp the pointer to the thread
* @param msg the message, it can be a pointer to a complex structure
- * @return the return message from \p chMsgRelease()
+ * @return The return message from \p chMsgRelease().
*/
msg_t chMsgSend(Thread *tp, msg_t msg) {
@@ -61,8 +61,7 @@ msg_t chMsgSend(Thread *tp, msg_t msg) { * @param tp the pointer to the thread
* @param msg the message, it can be a pointer to a complex structure
* @param esp the event source to pulse while sending the message
- * @return the return message from \p chMsgRelease()
- * @return the message return status from \p chMsgRelease()
+ * @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
* for both messages AND events while waiting into \p chEvtWait().
@@ -91,7 +90,7 @@ msg_t chMsgSendWithEvent(Thread *tp, msg_t msg, EventSource *esp) { /**
* Suspends the thread and waits for an incoming message.
*
- * @return the pointer to the message structure. Note, it is always the
+ * @return The pointer to the message structure. Note, it is always the
* message associated to the thread on the top of the messages queue.
* @note You can assume that the data contained in the message is stable until
* you invoke \p chMsgRelease() because the sending thread is
@@ -113,7 +112,7 @@ msg_t chMsgWait(void) { /**
* Returns the next message in the queue.
*
- * @return the pointer to the message structure. Note, it is always the
+ * @return The pointer to the message structure. Note, it is always the
* message associated to the thread on the top of the messages queue.
* If the queue is empty then \p NULL is returned.
* @note You can assume that the data pointed by the message is stable until
|