diff options
Diffstat (limited to 'cpukit/rtems/inline/rtems/rtems/eventset.inl')
-rw-r--r-- | cpukit/rtems/inline/rtems/rtems/eventset.inl | 46 |
1 files changed, 18 insertions, 28 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/eventset.inl b/cpukit/rtems/inline/rtems/rtems/eventset.inl index dff78bdce0..917df94f89 100644 --- a/cpukit/rtems/inline/rtems/rtems/eventset.inl +++ b/cpukit/rtems/inline/rtems/rtems/eventset.inl @@ -1,11 +1,10 @@ /** * @file rtems/rtems/eventset.inl + * + * This include file contains the information pertaining to event sets. */ -/* - * This include file contains the information pertaining to event sets. - * - * COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -18,16 +17,17 @@ #ifndef _RTEMS_RTEMS_EVENTSET_INL #define _RTEMS_RTEMS_EVENTSET_INL -/*PAGE - * - * _Event_sets_Is_empty - * - * DESCRIPTION: +/** + * @addtogroup ClassicEventSet + * @{ + */ + +/** + * @brief Event_sets_Is_empty * * This function returns TRUE if on events are posted in the event_set, * and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Event_sets_Is_empty( rtems_event_set the_event_set ) @@ -35,16 +35,12 @@ RTEMS_INLINE_ROUTINE boolean _Event_sets_Is_empty( return ( the_event_set == 0 ); } -/*PAGE - * - * _Event_sets_Post - * - * DESCRIPTION: +/** + * @brief Event_sets_Post * * This routine posts the given new_events into the event_set * passed in. The result is returned to the user in event_set. */ - RTEMS_INLINE_ROUTINE void _Event_sets_Post( rtems_event_set the_new_events, rtems_event_set *the_event_set @@ -57,16 +53,12 @@ RTEMS_INLINE_ROUTINE void _Event_sets_Post( _ISR_Enable( level ); } -/*PAGE - * - * _Event_sets_Get - * - * DESCRIPTION: +/** + * @brief Event_sets_Get * * This function returns the events in event_condition which are * set in event_set. */ - RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Get( rtems_event_set the_event_set, rtems_event_set the_event_condition @@ -75,16 +67,12 @@ RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Get( return ( the_event_set & the_event_condition ); } -/*PAGE - * - * _Event_sets_Clear - * - * DESCRIPTION: +/** + * @brief Event_sets_Clear * * This function removes the events in mask from the event_set * passed in. The result is returned to the user in event_set. */ - RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Clear( rtems_event_set the_event_set, rtems_event_set the_mask @@ -93,5 +81,7 @@ RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Clear( return ( the_event_set & ~(the_mask) ); } +/**@}*/ + #endif /* end of include file */ |