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

1 files changed, 15 insertions, 10 deletions

diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h
index fccebbf57c..0f468c83bf 100644
--- a/cpukit/score/include/rtems/score/coremsg.h
+++ b/cpukit/score/include/rtems/score/coremsg.h
@@ -336,22 +336,27 @@ uint32_t   _CORE_message_queue_Flush(
  *
  *  @param[in] the_message_queue points to the message queue to flush
  *
- *  @return This method returns the number of message pending messages flushed.
+ *  @return This method returns the number of pending messages flushed.
+ *
+ *  - INTERRUPT LATENCY:
+ *    + single case
  */
 uint32_t   _CORE_message_queue_Flush_support(
   CORE_message_queue_Control *the_message_queue
 );
 
 #if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
-  /**
-   *  @brief Flush Waiting Threads.
-   *
-   *  This function flushes the threads which are blocked on
-   *  @a the_message_queue's pending message queue.  They are
-   *  unblocked whether blocked sending or receiving.
-   *
-   *  @param[in] the_message_queue points to the message queue to flush
-   */
+/**
+ *  @brief Flush Waiting Threads.
+ *
+ *  This function flushes the threads which are blocked on
+ *  @a the_message_queue's pending message queue.  They are
+ *  unblocked whether blocked sending or receiving. It returns 
+ *  the number of messages flushed from the queue.
+ *
+ *  @param[in] the_message_queue points to the message queue to flush
+ *  @return number of messages flushed from the queue
+ */
   void _CORE_message_queue_Flush_waiting_threads(
     CORE_message_queue_Control *the_message_queue
   );