diff options
author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-12-01 09:47:07 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-01 09:47:07 -0500 |
commit | f839bf5ae259fe53353a00046adf2c9413df502a (patch) | |
tree | e636813af9a1b5af09df27c1a9a07873cb56a565 /cpukit/score/src/coremsgflushsupp.c | |
parent | Print MCSR and ESR. (diff) | |
download | rtems-f839bf5ae259fe53353a00046adf2c9413df502a.tar.bz2 |
score misc: Score misc: Clean up Doxygen #10 (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/7983216
Diffstat (limited to 'cpukit/score/src/coremsgflushsupp.c')
-rw-r--r-- | cpukit/score/src/coremsgflushsupp.c | 31 |
1 files changed, 7 insertions, 24 deletions
diff --git a/cpukit/score/src/coremsgflushsupp.c b/cpukit/score/src/coremsgflushsupp.c index 77f56d6fe7..4ea071f74d 100644 --- a/cpukit/score/src/coremsgflushsupp.c +++ b/cpukit/score/src/coremsgflushsupp.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 Flush Messages Support Routine * + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -28,23 +28,6 @@ #include <rtems/score/thread.h> #include <rtems/score/wkspace.h> -/* - * _CORE_message_queue_Flush_support - * - * This message handler routine removes all messages from a message queue - * and returns them to the inactive message pool. The number of messages - * flushed from the queue is returned - * - * Input parameters: - * the_message_queue - pointer to message queue - * - * Output parameters: - * returns - number of messages placed on inactive chain - * - * INTERRUPT LATENCY: - * only case - */ - uint32_t _CORE_message_queue_Flush_support( CORE_message_queue_Control *the_message_queue ) |