diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-11-28 13:57:31 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-28 13:57:31 -0600 |
| commit | 355ee7dbd52a1ea5fd7d8b32d31aeccd58ccb8c4 (patch) | |
| tree | 9a21764eba2821fee88b7c064c2ad44477ff1cc3 /cpukit/score/src/coremsg.c | |
| parent | score misc: Clean up Doxygen #2 (GCI 2012) (diff) | |
| download | rtems-355ee7dbd52a1ea5fd7d8b32d31aeccd58ccb8c4.tar.bz2 | |
score misc: Clean up Doxygen #3 (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/7982215
Diffstat (limited to 'cpukit/score/src/coremsg.c')
| -rw-r--r-- | cpukit/score/src/coremsg.c | 33 |
1 files changed, 7 insertions, 26 deletions
diff --git a/cpukit/score/src/coremsg.c b/cpukit/score/src/coremsg.c index c55d2d5a82..e02989b81d 100644 --- a/cpukit/score/src/coremsg.c +++ b/cpukit/score/src/coremsg.c @@ -1,12 +1,11 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: - * - * 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. +/** + * @file * + * @brief Initialize a Message Queue + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * @@ -49,24 +48,6 @@ static inline bool size_t_mult32_with_overflow( return true; } -/* - * _CORE_message_queue_Initialize - * - * This routine initializes a newly created message queue based on the - * specified data. - * - * Input parameters: - * the_message_queue - the message queue to initialize - * the_class - the API specific object class - * the_message_queue_attributes - the message queue's attributes - * maximum_pending_messages - maximum message and reserved buffer count - * maximum_message_size - maximum size of each message - * - * Output parameters: - * true - if the message queue is initialized - * false - if the message queue is NOT initialized - */ - bool _CORE_message_queue_Initialize( CORE_message_queue_Control *the_message_queue, CORE_message_queue_Attributes *the_message_queue_attributes, |