diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-04-28 14:29:57 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-04-28 14:29:57 +0000 |
| commit | fc1588e68475c356a215a49850874e9142010111 (patch) | |
| tree | edd9f43b7e7dd66468c410c35e817876f9c7fe11 /os/rt | |
| parent | 770087b130c3c2dfd675c0845ed5efa682c3144f (diff) | |
| download | ChibiOS-fc1588e68475c356a215a49850874e9142010111.tar.gz ChibiOS-fc1588e68475c356a215a49850874e9142010111.tar.bz2 ChibiOS-fc1588e68475c356a215a49850874e9142010111.zip | |
Minor documentation improvement.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11969 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/rt')
| -rw-r--r-- | os/rt/src/chmsg.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/os/rt/src/chmsg.c b/os/rt/src/chmsg.c index ca56c5f84..3018070d6 100644 --- a/os/rt/src/chmsg.c +++ b/os/rt/src/chmsg.c @@ -111,8 +111,10 @@ msg_t chMsgSend(thread_t *tp, msg_t msg) { * @note If the message is a pointer then you can assume that the data
* pointed by the message is stable until you invoke @p chMsgRelease()
* because the sending thread is suspended until then.
+ * @note The reference counter of the sender thread is not increased, the
+ * returned pointer is a temporary reference.
*
- * @return A reference to the thread carrying the message.
+ * @return A pointer to the thread carrying the message.
*
* @api
*/
|