summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/message.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-04 17:59:11 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-04 17:59:11 -0500
commitc18e0ba12799ea40693428b0a731bb561e61cab0 (patch)
tree20e76592df6ad8f0ae2efb5c27f0b6870a33086e /cpukit/rtems/include/rtems/rtems/message.h
parentcpukit: Clean up Doxygen #3 (GCI 2012) (diff)
downloadrtems-c18e0ba12799ea40693428b0a731bb561e61cab0.tar.bz2
rtems misc: Clean up Doxygen GCI Task #4
http://www.google-melange.com/gci/task/view/google/gci2012/7950205
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/message.h31
1 files changed, 23 insertions, 8 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index fa80862fb3..9990b146da 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/cpukit/rtems/include/rtems/rtems/message.h
@@ -97,21 +97,32 @@ typedef struct {
RTEMS_MESSAGE_EXTERN Objects_Information _Message_queue_Information;
/**
- * @brief Message_queue_Manager_initialization
+ * @brief Message Queue Manager Initialization
*
* This routine performs the initialization necessary for this manager.
*/
void _Message_queue_Manager_initialization(void);
/**
- * @brief rtems_message_queue_create
+ * @brief RTEMS Create Message Queue
*
* This routine implements the rtems_message_queue_create directive. The
- * message queue will have the name name. If the attribute_set indicates
+ * message queue will have the @a name. If the @a attribute_set indicates
* that the message queue is to be limited in the number of messages
- * that can be outstanding, then count indicates the maximum number of
+ * that can be outstanding, then @a count indicates the maximum number of
* messages that will be held. It returns the id of the created
- * message queue in ID.
+ * message queue in @a id.
+ *
+ * @param[in] name is the user defined queue name
+ * @param[in] count is the maximum message and reserved buffer count
+ * @param[in] max_message_size is the maximum size of each message
+ * @param[in] attribute_set is the process method
+ * @param[in] id is the pointer to queue
+ *
+ * @return This method returns RTEMS_SUCCESSFUL if there was not an
+ * error. Otherwise, a status code is returned indicating the
+ * source of the error. If successful, the @a id will
+ * be filled in with the queue id.
*/
rtems_status_code rtems_message_queue_create(
rtems_name name,
@@ -296,10 +307,14 @@ rtems_status_code _Message_queue_Submit(
Message_queue_Control *_Message_queue_Allocate (void);
/**
- * @brief Message_queue_Translate_core_message_queue_return_code
+ * @brief Message queue Translate Core Message Queue Return Code
*
- * This function returns a RTEMS status code based on the core message queue
- * status code specified.
+ * This function returns a RTEMS status code based on
+ * @a the_message_queue_status.
+ *
+ * @param[in] the_message_queue_status is the status code to translate
+ *
+ * @return translated RTEMS status code
*/
rtems_status_code _Message_queue_Translate_core_message_queue_return_code (
uint32_t the_message_queue_status