From 382151cf63ff5ef3144fc38bb87490d33da7b2d3 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sun, 11 Jan 2009 11:28:32 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@619 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- src/chmsg.c | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'src/chmsg.c') 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.
* The condition is only tested in debug mode in order to make this code * as fast as possible. -- cgit v1.2.3