summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/barrier.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
commit067a96ad0c3b0818d71d9aaadaee4b520d940de1 (patch)
treed04eed432a0534ebfb0830d6f7e49ce78ff098a4 /cpukit/rtems/include/rtems/rtems/barrier.h
parent2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-067a96ad0c3b0818d71d9aaadaee4b520d940de1.tar.bz2
2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/barriermp.h, rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h, rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h, rtems/include/rtems/rtems/eventmp.h, rtems/include/rtems/rtems/eventset.h, rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h, rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h, rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/options.h, rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h, rtems/include/rtems/rtems/ratemon.h, rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/regionmp.h, rtems/include/rtems/rtems/rtemsapi.h, rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h, rtems/include/rtems/rtems/signal.h, rtems/include/rtems/rtems/signalmp.h, rtems/include/rtems/rtems/status.h, rtems/include/rtems/rtems/support.h, rtems/include/rtems/rtems/taskmp.h, rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h, rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl, rtems/inline/rtems/rtems/attr.inl, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/dpmem.inl, rtems/inline/rtems/rtems/event.inl, rtems/inline/rtems/rtems/eventset.inl, rtems/inline/rtems/rtems/message.inl, rtems/inline/rtems/rtems/modes.inl, rtems/inline/rtems/rtems/options.inl, rtems/inline/rtems/rtems/part.inl, rtems/inline/rtems/rtems/ratemon.inl, rtems/inline/rtems/rtems/region.inl, rtems/inline/rtems/rtems/sem.inl, rtems/inline/rtems/rtems/status.inl, rtems/inline/rtems/rtems/support.inl, rtems/inline/rtems/rtems/tasks.inl, rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API header files to Doxygen. * rtems/Doxyfile: New file.
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/barrier.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/barrier.h33
1 files changed, 18 insertions, 15 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h
index 4d0a57398e..95264aba31 100644
--- a/cpukit/rtems/include/rtems/rtems/barrier.h
+++ b/cpukit/rtems/include/rtems/rtems/barrier.h
@@ -1,20 +1,19 @@
/**
* @file rtems/rtems/barrier.h
- */
-
-/*
+ *
* This include file contains all the constants and structures associated
* with the Barrier Manager.
*
* Directives provided are:
*
- * + create a barrier
- * + get an ID of a barrier
- * + delete a barrier
- * + wait for a barrier
- * + signal a barrier
- *
- * COPYRIGHT (c) 1989-2007.
+ * - create a barrier
+ * - get an ID of a barrier
+ * - delete a barrier
+ * - wait for a barrier
+ * - signal a barrier
+ */
+
+/* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -27,6 +26,13 @@
#ifndef _RTEMS_RTEMS_BARRIER_H
#define _RTEMS_RTEMS_BARRIER_H
+/**
+ * @defgroup ClassicBarrier Classic API Barrier
+ *
+ * This encapsulates functionality which XXX
+ */
+/**@{*/
+
#ifndef RTEMS_BARRIER_EXTERN
#define RTEMS_BARRIER_EXTERN extern
#endif
@@ -45,7 +51,6 @@ extern "C" {
/**
* This type defines the control block used to manage each barrier.
*/
-
typedef struct {
/** This is used to manage a barrier as an object. */
Objects_Control Object;
@@ -59,7 +64,6 @@ typedef struct {
* The following defines the information control block used to manage
* this class of objects.
*/
-
RTEMS_BARRIER_EXTERN Objects_Information _Barrier_Information;
/**
@@ -70,7 +74,6 @@ RTEMS_BARRIER_EXTERN Objects_Information _Barrier_Information;
* @param[in] maximum_barriers is the total number of barriers allowed to
* concurrently be active in the system.
*/
-
void _Barrier_Manager_initialization(
uint32_t maximum_barriers
);
@@ -92,7 +95,6 @@ void _Barrier_Manager_initialization(
*
* @return a status code indicating success or the reason for failure.
*/
-
rtems_status_code rtems_barrier_create(
rtems_name name,
rtems_attribute attribute_set,
@@ -116,7 +118,6 @@ rtems_status_code rtems_barrier_create(
*
* @return a status code indicating success or the reason for failure.
*/
-
rtems_status_code rtems_barrier_ident(
rtems_name name,
rtems_id *id
@@ -195,5 +196,7 @@ rtems_status_code _Barrier_Translate_core_barrier_return_code (
}
#endif
+/**@}*/
+
#endif
/* end of include file */