diff options
author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-01-10 17:06:06 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-01-10 17:06:47 -0600 |
commit | e858f7049c6407648e624cb43a1819237541fd84 (patch) | |
tree | ec6a688ecef9bd271eab37ca652dc172935acb1d /cpukit/score/include/rtems/score/coremsg.h | |
parent | devfs: Doxygen Warning Removal and Cleanup (diff) | |
download | rtems-e858f7049c6407648e624cb43a1819237541fd84.tar.bz2 |
cpukit: Fix many Doxygen warnings
Diffstat (limited to 'cpukit/score/include/rtems/score/coremsg.h')
-rw-r--r-- | cpukit/score/include/rtems/score/coremsg.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h index 7363060c13..d022391182 100644 --- a/cpukit/score/include/rtems/score/coremsg.h +++ b/cpukit/score/include/rtems/score/coremsg.h @@ -450,15 +450,18 @@ CORE_message_queue_Status _CORE_message_queue_Submit( * It is used when unblocking a remote thread. * @param[in] buffer is the starting address of the message buffer to * to be filled in with a message - * @param[in] size is the size of the @a buffer and indicates the maximum - * size message that the caller can receive. + * @param[in] size_p is a pointer to the size of the @a buffer and + * indicates the maximum size message that the caller can receive. * @param[in] wait indicates whether the calling thread is willing to block * if the message queue is empty. * @param[in] timeout is the maximum number of clock ticks that the calling * thread is willing to block if the message queue is empty. * - * @retval indication of the successful completion or reason for failure - * @note Returns message priority via return are in TCB. + * @retval indication of the successful completion or reason for failure. + * On success, the location pointed to @a size_p will contain the + * size of the received message. + * + * @note Returns message priority via return area in TCB. * * - INTERRUPT LATENCY: * + available |