aboutsummaryrefslogtreecommitdiffstats
path: root/src/chmsg.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-11 11:28:32 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-11 11:28:32 +0000
commit382151cf63ff5ef3144fc38bb87490d33da7b2d3 (patch)
treea1ebbe48fe92cc5fa9f6a0493812269820747b9d /src/chmsg.c
parent36c9110259212470667c7cc95bb99ca577945d87 (diff)
downloadChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.tar.gz
ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.tar.bz2
ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@619 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chmsg.c')
-rw-r--r--src/chmsg.c20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/chmsg.c b/src/chmsg.c
index d960f44e8..f53e84030 100644
--- a/src/chmsg.c
+++ b/src/chmsg.c
@@ -26,11 +26,11 @@
#ifdef CH_USE_MESSAGES
/**
* Sends a message to the specified thread. The client is stopped until the
- * server executes a \p chMsgRelease() after receiving the message.
+ * server executes a @p chMsgRelease() after receiving the message.
*
* @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) {
@@ -55,16 +55,16 @@ msg_t chMsgSend(Thread *tp, msg_t msg) {
#ifdef CH_USE_MESSAGES_EVENT
/**
* Sends a message to the specified thread and atomically triggers an event.
- * The client is stopped until the server executes a \p chMsgRelease()
+ * The client is stopped until the server executes a @p chMsgRelease()
* after receiving the message.
*
* @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 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 chEvtWaitXXX().
+ * a @p chMsgWait(). The use case is that the server thread is waiting
+ * for both messages AND events while waiting into @p chEvtWaitXXX().
*/
msg_t chMsgSendWithEvent(Thread *tp, msg_t msg, EventSource *esp) {
@@ -93,7 +93,7 @@ msg_t chMsgSendWithEvent(Thread *tp, msg_t msg, EventSource *esp) {
* @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
+ * you invoke @p chMsgRelease() because the sending thread is
* suspended until then.
*/
msg_t chMsgWait(void) {
@@ -114,9 +114,9 @@ msg_t chMsgWait(void) {
*
* @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.
+ * If the queue is empty then @p NULL is returned.
* @note You can assume that the data pointed by the message is stable until
- * you invoke \p chMsgRelease() because the sending thread is
+ * you invoke @p chMsgRelease() because the sending thread is
* suspended until then. Always remember that the message data is not
* copied between the sender and the receiver, just a pointer is passed.
*/
@@ -137,7 +137,7 @@ msg_t chMsgGet(void) {
* @param 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
+ * Exiting from the @p chMsgWait() ensures you have at least one
* message in the queue so it is not a big deal.<br>
* The condition is only tested in debug mode in order to make this code
* as fast as possible.