diff options
| author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-11-29 13:39:17 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-29 13:39:17 -0600 |
| commit | 1b4758602f55e215f02e384d459c3319c6e1abab (patch) | |
| tree | 8305bbedfdfec434394affeb87b86584320ea2e1 /cpukit/score/src/coremsgsubmit.c | |
| parent | score misc: Score misc: Clean up Doxygen #5 (diff) | |
| download | rtems-1b4758602f55e215f02e384d459c3319c6e1abab.tar.bz2 | |
score misc: Score misc: Clean up Doxygen #6 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
http://www.google-melange.com/gci/task/view/google/gci2012/7976215
Diffstat (limited to 'cpukit/score/src/coremsgsubmit.c')
| -rw-r--r-- | cpukit/score/src/coremsgsubmit.c | 37 |
1 files changed, 7 insertions, 30 deletions
diff --git a/cpukit/score/src/coremsgsubmit.c b/cpukit/score/src/coremsgsubmit.c index 1ce496ed88..8f6ffa31d5 100644 --- a/cpukit/score/src/coremsgsubmit.c +++ b/cpukit/score/src/coremsgsubmit.c @@ -1,12 +1,12 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: +/** + * @file * - * This package is the implementation of the CORE Message Queue Handler. - * This core object provides task synchronization and communication functions - * via messages passed to queue objects. + * @brief CORE Message Queue Submit * + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * @@ -28,29 +28,6 @@ #include <rtems/score/thread.h> #include <rtems/score/wkspace.h> -/* - * _CORE_message_queue_Submit - * - * This routine implements the send and urgent message functions. It - * processes a message that is to be submitted to the designated - * message queue. The message will either be processed as a - * send message which it will be inserted at the rear of the queue - * or it will be processed as an urgent message which will be inserted - * at the front of the queue. - * - * Input parameters: - * the_message_queue - message is submitted to this message queue - * buffer - pointer to message buffer - * size - size in bytes of message to send - * id - id of message queue - * api_message_queue_mp_support - api specific mp support callout - * submit_type - send or urgent message - * - * Output parameters: - * CORE_MESSAGE_QUEUE_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - CORE_message_queue_Status _CORE_message_queue_Submit( CORE_message_queue_Control *the_message_queue, const void *buffer, |