diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/message.h | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index 10da6023d6..8c376c52e1 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -142,11 +142,11 @@ rtems_status_code rtems_message_queue_create( * extent of the search for the ID of the message queue named name. * The search can be limited to a particular node or allowed to * encompass all nodes. - * + * * @param[in] name is the user defined message queue name * @param[in] node is the node(s) to be searched * @param[in] id is the pointer to message queue id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * *id filled with the message queue id */ @@ -161,9 +161,9 @@ rtems_status_code rtems_message_queue_ident( * * This routine implements the rtems_message_queue_delete directive. The * message queue indicated by ID is deleted. - * + * * @param[in] id is the queue id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_message_queue_delete( @@ -173,6 +173,8 @@ rtems_status_code rtems_message_queue_delete( /** * @brief rtems_message_queue_send * + * Message Queue Manager - rtems_message_queue_send + * * This routine implements the rtems_message_queue_send directive. * This directive sends the message buffer to the message queue * indicated by ID. If one or more tasks is blocked waiting @@ -197,11 +199,11 @@ rtems_status_code rtems_message_queue_send( * except that if no tasks are waiting, the message buffer will * be placed at the FRONT of the chain of pending messages rather * than at the REAR. - * + * * @param[in] id is the pointer to message queue * @param[in] buffer is the pointer to message buffer * @param[in] size is the size of message to send urgently - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_message_queue_urgent( @@ -217,14 +219,14 @@ rtems_status_code rtems_message_queue_urgent( * This directive sends the message buffer to all of the tasks blocked * waiting for a message on the message queue indicated by ID. * If no tasks are waiting, then the message buffer will not be queued. - * + * * @param[in] id is the pointer to message queue * @param[in] buffer is the pointer to message buffer * @param[in] size is the size of message to broadcast * @param[in] count pointer to area to store number of threads made ready - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and - * *count filled in with number of threads made ready + * *count filled in with number of threads made ready */ rtems_status_code rtems_message_queue_broadcast( rtems_id id, @@ -269,6 +271,8 @@ rtems_status_code rtems_message_queue_receive( * This directive takes all outstanding messages for the message * queue indicated by ID and returns them to the inactive message * chain. The number of messages flushed is returned in COUNT. + * + * Message Queue Manager */ rtems_status_code rtems_message_queue_flush( rtems_id id, |