summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/coremsgflushwait.c
diff options
context:
space:
mode:
authorChristopher Kerl <zargyyoyo@gmail.com>2012-12-01 09:47:07 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-01 09:47:07 -0500
commitf839bf5ae259fe53353a00046adf2c9413df502a (patch)
treee636813af9a1b5af09df27c1a9a07873cb56a565 /cpukit/score/src/coremsgflushwait.c
parentPrint MCSR and ESR. (diff)
downloadrtems-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/coremsgflushwait.c')
-rw-r--r--cpukit/score/src/coremsgflushwait.c26
1 files changed, 7 insertions, 19 deletions
diff --git a/cpukit/score/src/coremsgflushwait.c b/cpukit/score/src/coremsgflushwait.c
index 58de174cea..f2b1f088b8 100644
--- a/cpukit/score/src/coremsgflushwait.c
+++ b/cpukit/score/src/coremsgflushwait.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 Waiting Threads.
*
+ * @ingroup ScoreMessageQueue
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -29,18 +29,6 @@
#include <rtems/score/wkspace.h>
#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
- /*
- * _CORE_message_queue_Flush_waiting_threads
- *
- * This function flushes the message_queue's task wait queue. The number
- * of messages flushed from the queue is returned.
- *
- * Input parameters:
- * the_message_queue - the message_queue to be flushed
- *
- * Output parameters:
- * returns - the number of messages flushed from the queue
- */
void _CORE_message_queue_Flush_waiting_threads(
CORE_message_queue_Control *the_message_queue