2011-11-10 Sebastian Huber <sebastian.huber@embedded-brains.de>

	* rtems/include/rtems/rtems/event.h,
	rtems/include/rtems/rtems/eventset.h,
	rtems/inline/rtems/rtems/eventset.inl: Documentation.

1 files changed, 59 insertions, 51 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h
index 679934f22b..2a86ebb070 100644
--- a/cpukit/rtems/include/rtems/rtems/eventset.h
+++ b/cpukit/rtems/include/rtems/rtems/eventset.h
@@ -19,108 +19,118 @@
 #ifndef _RTEMS_RTEMS_EVENTSET_H
 #define _RTEMS_RTEMS_EVENTSET_H
 
-/**
- *  @defgroup ClassicEventSet Event Sets
- *
- *  @ingroup ClassicRTEMS
- *
- *  This encapsulates functionality related to Classic API
- *  Event Sets.  These are used by the Classic API Event Manager.
- */
-/**@{*/
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- *  The following defines the type used to control event sets.
+ *  @defgroup ClassicEventSet Event Set
+ *
+ *  @ingroup ClassicEvent
+ *
+ *  @{
  */
-typedef uint32_t   rtems_event_set;
 
 /**
- *  The following constant is used to receive the set of currently pending
- *  events.
+ *  @brief Integer type to hold an event set of up to 32 events represented as
+ *  a bit field.
  */
-#define RTEMS_PENDING_EVENTS      0
+typedef uint32_t   rtems_event_set;
 
 /**
- *  The following constant is used when you wish to send or receive all
- *  events.
+ *  @brief Constant used to send or receive all events.
  */
 #define RTEMS_ALL_EVENTS  0xFFFFFFFF
 
-/** This defines the bit in the event set associated with event 0. */
+/** @brief Defines the bit in the event set associated with event 0. */
 #define RTEMS_EVENT_0     0x00000001
-/** This defines the bit in the event set associated with event 1. */
+/** @brief Defines the bit in the event set associated with event 1. */
 #define RTEMS_EVENT_1     0x00000002
-/** This defines the bit in the event set associated with event 2. */
+/** @brief Defines the bit in the event set associated with event 2. */
 #define RTEMS_EVENT_2     0x00000004
-/** This defines the bit in the event set associated with event 3. */
+/** @brief Defines the bit in the event set associated with event 3. */
 #define RTEMS_EVENT_3     0x00000008
-/** This defines the bit in the event set associated with event 4. */
+/** @brief Defines the bit in the event set associated with event 4. */
 #define RTEMS_EVENT_4     0x00000010
-/** This defines the bit in the event set associated with event 5. */
+/** @brief Defines the bit in the event set associated with event 5. */
 #define RTEMS_EVENT_5     0x00000020
-/** This defines the bit in the event set associated with event 6. */
+/** @brief Defines the bit in the event set associated with event 6. */
 #define RTEMS_EVENT_6     0x00000040
-/** This defines the bit in the event set associated with event 7. */
+/** @brief Defines the bit in the event set associated with event 7. */
 #define RTEMS_EVENT_7     0x00000080
-/** This defines the bit in the event set associated with event 8. */
+/** @brief Defines the bit in the event set associated with event 8. */
 #define RTEMS_EVENT_8     0x00000100
-/** This defines the bit in the event set associated with event 9. */
+/** @brief Defines the bit in the event set associated with event 9. */
 #define RTEMS_EVENT_9     0x00000200
-/** This defines the bit in the event set associated with event 10. */
+/** @brief Defines the bit in the event set associated with event 10. */
 #define RTEMS_EVENT_10    0x00000400
-/** This defines the bit in the event set associated with event 11. */
+/** @brief Defines the bit in the event set associated with event 11. */
 #define RTEMS_EVENT_11    0x00000800
-/** This defines the bit in the event set associated with event 12. */
+/** @brief Defines the bit in the event set associated with event 12. */
 #define RTEMS_EVENT_12    0x00001000
-/** This defines the bit in the event set associated with event 13. */
+/** @brief Defines the bit in the event set associated with event 13. */
 #define RTEMS_EVENT_13    0x00002000
-/** This defines the bit in the event set associated with event 14. */
+/** @brief Defines the bit in the event set associated with event 14. */
 #define RTEMS_EVENT_14    0x00004000
-/** This defines the bit in the event set associated with event 15. */
+/** @brief Defines the bit in the event set associated with event 15. */
 #define RTEMS_EVENT_15    0x00008000
-/** This defines the bit in the event set associated with event 16. */
+/** @brief Defines the bit in the event set associated with event 16. */
 #define RTEMS_EVENT_16    0x00010000
-/** This defines the bit in the event set associated with event 17. */
+/** @brief Defines the bit in the event set associated with event 17. */
 #define RTEMS_EVENT_17    0x00020000
-/** This defines the bit in the event set associated with event 18. */
+/** @brief Defines the bit in the event set associated with event 18. */
 #define RTEMS_EVENT_18    0x00040000
-/** This defines the bit in the event set associated with event 19. */
+/** @brief Defines the bit in the event set associated with event 19. */
 #define RTEMS_EVENT_19    0x00080000
-/** This defines the bit in the event set associated with event 20. */
+/** @brief Defines the bit in the event set associated with event 20. */
 #define RTEMS_EVENT_20    0x00100000
-/** This defines the bit in the event set associated with event 21. */
+/** @brief Defines the bit in the event set associated with event 21. */
 #define RTEMS_EVENT_21    0x00200000
-/** This defines the bit in the event set associated with event 22. */
+/** @brief Defines the bit in the event set associated with event 22. */
 #define RTEMS_EVENT_22    0x00400000
-/** This defines the bit in the event set associated with event 23. */
+/** @brief Defines the bit in the event set associated with event 23. */
 #define RTEMS_EVENT_23    0x00800000
-/** This defines the bit in the event set associated with event 24. */
+/** @brief Defines the bit in the event set associated with event 24. */
 #define RTEMS_EVENT_24    0x01000000
-/** This defines the bit in the event set associated with event 25. */
+/** @brief Defines the bit in the event set associated with event 25. */
 #define RTEMS_EVENT_25    0x02000000
-/** This defines the bit in the event set associated with event 26. */
+/** @brief Defines the bit in the event set associated with event 26. */
 #define RTEMS_EVENT_26    0x04000000
-/** This defines the bit in the event set associated with event 27. */
+/** @brief Defines the bit in the event set associated with event 27. */
 #define RTEMS_EVENT_27    0x08000000
-/** This defines the bit in the event set associated with event 29. */
+/** @brief Defines the bit in the event set associated with event 29. */
 #define RTEMS_EVENT_28    0x10000000
-/** This defines the bit in the event set associated with event 29. */
+/** @brief Defines the bit in the event set associated with event 29. */
 #define RTEMS_EVENT_29    0x20000000
-/** This defines the bit in the event set associated with event 30. */
+/** @brief Defines the bit in the event set associated with event 30. */
 #define RTEMS_EVENT_30    0x40000000
-/** This defines the bit in the event set associated with event 31. */
+/** @brief Defines the bit in the event set associated with event 31. */
 #define RTEMS_EVENT_31    0x80000000
 
+/** @} */
+
+/**
+ *  @brief Constant used to receive the set of currently pending events in
+ *  rtems_event_receive().
+ *
+ *  @ingroup ClassicEvent
+ */
+#define RTEMS_PENDING_EVENTS      0
+
+/**
+ *  @addtogroup ScoreEvent
+ *
+ *  @{
+ */
+
 /**
  *  The following constant is the value of an event set which
  *  has no events pending.
  */
 #define EVENT_SETS_NONE_PENDING 0
 
+/** @} */
+
 #ifndef __RTEMS_APPLICATION__
 #include <rtems/rtems/eventset.inl>
 #endif
@@ -129,7 +139,5 @@ typedef uint32_t   rtems_event_set;
 }
 #endif
 
-/**@}*/
-
 #endif
 /* end of include file */