summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/barrier.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/posix/include/rtems/posix/barrier.h')
-rw-r--r--cpukit/posix/include/rtems/posix/barrier.h51
1 files changed, 31 insertions, 20 deletions
diff --git a/cpukit/posix/include/rtems/posix/barrier.h b/cpukit/posix/include/rtems/posix/barrier.h
index ce75358d5e..73c63f7162 100644
--- a/cpukit/posix/include/rtems/posix/barrier.h
+++ b/cpukit/posix/include/rtems/posix/barrier.h
@@ -1,14 +1,16 @@
/**
- * @file rtems/posix/barrier.h
+ * @file
+ *
+ * @brief Constants and Structures Associated with the POSIX Barrier Manager
*
- * This include file contains all the constants and structures associated
- * with the POSIX Barrier Manager.
+ * This include file contains all the constants and structures associated
+ * with the POSIX Barrier Manager.
*
- * Directives provided are:
+ * Directives provided are:
*
- * - create a barrier
- * - delete a barrier
- * - wait for a barrier
+ * - create a barrier
+ * - delete a barrier
+ * - wait for a barrier
*/
/*
@@ -23,6 +25,17 @@
#ifndef _RTEMS_POSIX_BARRIER_H
#define _RTEMS_POSIX_BARRIER_H
+/**
+ * @defgroup POSIXBarrier POSIX Barriers
+ *
+ * @ingroup POSIXAPI
+ *
+ * This encapsulates functionality which implements the RTEMS API
+ * Barrier Manager.
+ *
+ */
+/**@{**/
+
#ifdef __cplusplus
extern "C" {
#endif
@@ -31,7 +44,7 @@ extern "C" {
#include <rtems/score/corebarrier.h>
/**
- * This type defines the control block used to manage each barrier.
+ * This type defines the control block used to manage each barrier.
*/
typedef struct {
@@ -49,26 +62,22 @@ typedef struct {
POSIX_EXTERN Objects_Information _POSIX_Barrier_Information;
/**
- * @brief _POSIX_Barrier_Manager_initialization
+ * @brief POSIX barrier manager initialization.
*
- * This routine performs the initialization necessary for this manager.
- *
- * @param[in] maximum_barriers is the total number of barriers allowed to
- * concurrently be active in the system.
+ * This routine performs the initialization necessary for this manager.
*/
void _POSIX_Barrier_Manager_initialization(void);
/**
- * @brief _POSIX_Barrier_Translate_core_barrier_return_code (
- *
- * This routine translates SuperCore Barrier status codes into the
- * corresponding POSIX ones.
+ * @brief POSIX translate barrier return code.
+ *
+ * This routine translates SuperCore Barrier status codes into the
+ * corresponding POSIX ones.
*
+ * @param[in] the_barrier_status is the SuperCore status.
*
- * @param[in] the_barrier_status is the SuperCore status.
- *
- * @return the corresponding POSIX status
+ * @return the corresponding POSIX status
*/
int _POSIX_Barrier_Translate_core_barrier_return_code(
CORE_barrier_Status the_barrier_status
@@ -78,6 +87,8 @@ int _POSIX_Barrier_Translate_core_barrier_return_code(
#include <rtems/posix/barrier.inl>
#endif
+/** @} */
+
#ifdef __cplusplus
}
#endif