From 067a96ad0c3b0818d71d9aaadaee4b520d940de1 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 18 Apr 2008 15:02:20 +0000 Subject: 2008-04-18 Joel Sherrill * 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. --- cpukit/rtems/inline/rtems/rtems/timer.inl | 72 +++++++++++-------------------- 1 file changed, 25 insertions(+), 47 deletions(-) (limited to 'cpukit/rtems/inline/rtems/rtems/timer.inl') diff --git a/cpukit/rtems/inline/rtems/rtems/timer.inl b/cpukit/rtems/inline/rtems/rtems/timer.inl index 6660af6e40..884e46e2b5 100644 --- a/cpukit/rtems/inline/rtems/rtems/timer.inl +++ b/cpukit/rtems/inline/rtems/rtems/timer.inl @@ -1,12 +1,11 @@ /** * @file rtems/rtems/timer.inl - */ - -/* + * * This file contains the static inline implementation of the inlined routines * from the Timer Manager. - * - * COPYRIGHT (c) 1989-1999. + */ + +/* COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -19,31 +18,28 @@ #ifndef _RTEMS_RTEMS_TIMER_INL #define _RTEMS_RTEMS_TIMER_INL -/*PAGE - * - * _Timer_Allocate - * - * DESCRIPTION: +/** + * @addtogroup ClassicTimer + * @{ + */ + +/** + * @brief Timer_Allocate * * This function allocates a timer control block from * the inactive chain of free timer control blocks. */ - RTEMS_INLINE_ROUTINE Timer_Control *_Timer_Allocate( void ) { return (Timer_Control *) _Objects_Allocate( &_Timer_Information ); } -/*PAGE - * - * _Timer_Free - * - * DESCRIPTION: +/** + * @brief Timer_Free * * This routine frees a timer control block to the * inactive chain of free timer control blocks. */ - RTEMS_INLINE_ROUTINE void _Timer_Free ( Timer_Control *the_timer ) @@ -51,11 +47,8 @@ RTEMS_INLINE_ROUTINE void _Timer_Free ( _Objects_Free( &_Timer_Information, &the_timer->Object ); } -/*PAGE - * - * _Timer_Get - * - * DESCRIPTION: +/** + * @brief Timer_Get * * This function maps timer IDs to timer control blocks. * If ID corresponds to a local timer, then it returns @@ -63,7 +56,6 @@ RTEMS_INLINE_ROUTINE void _Timer_Free ( * is set to OBJECTS_LOCAL. Otherwise, location is set * to OBJECTS_ERROR and the returned value is undefined. */ - RTEMS_INLINE_ROUTINE Timer_Control *_Timer_Get ( Objects_Id id, Objects_Locations *location @@ -73,16 +65,12 @@ RTEMS_INLINE_ROUTINE Timer_Control *_Timer_Get ( _Objects_Get( &_Timer_Information, id, location ); } -/*PAGE - * - * _Timer_Is_interval_class - * - * DESCRIPTION: +/** + * @brief Timer_Is_interval_class * * This function returns TRUE if the class is that of an INTERVAL * timer, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Timer_Is_interval_class ( Timer_Classes the_class ) @@ -90,16 +78,12 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_interval_class ( return (the_class == TIMER_INTERVAL) || (the_class == TIMER_INTERVAL_ON_TASK); } -/*PAGE - * - * _Timer_Is_time_of_day_class - * - * DESCRIPTION: +/** + * @brief Timer_Is_time_of_day_class * * This function returns TRUE if the class is that of an INTERVAL * timer, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Timer_Is_timer_of_day_class ( Timer_Classes the_class ) @@ -107,16 +91,12 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_timer_of_day_class ( return ( the_class == TIMER_TIME_OF_DAY ); } -/*PAGE - * - * _Timer_Is_dormant_class - * - * DESCRIPTION: +/** + * @brief Timer_Is_dormant_class * * This function returns TRUE if the class is that of a DORMANT * timer, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Timer_Is_dormant_class ( Timer_Classes the_class ) @@ -124,15 +104,11 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_dormant_class ( return ( the_class == TIMER_DORMANT ); } -/*PAGE - * - * _Timer_Is_null - * - * DESCRIPTION: +/** + * @brief Timer_Is_null * * This function returns TRUE if the_timer is NULL and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Timer_Is_null ( Timer_Control *the_timer ) @@ -140,5 +116,7 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_null ( return ( the_timer == NULL ); } +/**@}*/ + #endif /* end of include file */ -- cgit v1.2.3