From 1dbbc0c3b19c9113a2fbf4a511b4cff84dd6aa8e Mon Sep 17 00:00:00 2001
From: Mathew Kallada <matkallada@gmail.com>
Date: Sat, 29 Dec 2012 10:27:48 -0600
Subject: score: Doxygen Clean Up Task #1

---
 cpukit/score/include/rtems/score/corebarrier.h | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

(limited to 'cpukit/score/include/rtems/score/corebarrier.h')

diff --git a/cpukit/score/include/rtems/score/corebarrier.h b/cpukit/score/include/rtems/score/corebarrier.h
index 8072ec1e39..cab782ce29 100644
--- a/cpukit/score/include/rtems/score/corebarrier.h
+++ b/cpukit/score/include/rtems/score/corebarrier.h
@@ -1,5 +1,7 @@
 /**
- *  @file  rtems/score/corebarrier.h
+ *  @file rtems/score/corebarrier.h
+ *
+ *  @brief Constants and Structures Associated with the Barrier Handler
  *
  *  This include file contains all the constants and structures associated
  *  with the Barrier Handler.
@@ -82,7 +84,7 @@ typedef enum {
 }   CORE_barrier_Status;
 
 /**
- *  @brief Core Barrier Last Status
+ *  @brief Core barrier last status value.
  *
  *  This is the last status value.
  */
@@ -121,7 +123,7 @@ typedef struct {
 }   CORE_barrier_Control;
 
 /**
- *  @brief Initialize CORE Barrier
+ *  @brief Initialize core barrier.
  *
  *  This routine initializes the barrier based on the parameters passed.
  *
@@ -134,7 +136,8 @@ void _CORE_barrier_Initialize(
 );
 
 /**
- *  @brief Wait For The Barrier
+ *  @brief Wait for the barrier.
+ *
  *  This routine wait for the barrier to be released.  If the barrier
  *  is set to automatic and this is the appropriate thread, then it returns
  *  immediately.  Otherwise, the calling thread is blocked until the barrier
@@ -159,7 +162,7 @@ void _CORE_barrier_Wait(
 );
 
 /**
- *  @brief Manually releases the barrier
+ *  @brief Manually release the barrier.
  *
  *  This routine manually releases the barrier.  All of the threads waiting
  *  for the barrier will be readied.
@@ -169,7 +172,7 @@ void _CORE_barrier_Wait(
  *  @param[in] api_barrier_mp_support is the routine to invoke if the
  *         thread unblocked is remote
  *
- *  @return the number of unblocked threads
+ *  @retval the number of unblocked threads
  */
 uint32_t _CORE_barrier_Release(
   CORE_barrier_Control                *the_barrier,
@@ -204,4 +207,4 @@ uint32_t _CORE_barrier_Release(
 /**@}*/
 
 #endif
-/*  end of include file */
+/*  end of include file */
\ No newline at end of file
-- 
cgit v1.2.3