From baff4dafe1ff85d128a55e7b73780ca28f5c7faf Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 1 Nov 2004 13:22:41 +0000 Subject: 2004-11-01 Joel Sherrill * score/cpu/no_cpu/rtems/score/cpu.h, score/include/rtems/debug.h, score/include/rtems/seterr.h, score/include/rtems/system.h, score/include/rtems/score/address.h, score/include/rtems/score/apiext.h, score/include/rtems/score/apimutex.h, score/include/rtems/score/bitfield.h, score/include/rtems/score/chain.h, score/include/rtems/score/context.h, score/include/rtems/score/copyrt.h, score/include/rtems/score/coremsg.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/coresem.h, score/include/rtems/score/heap.h, score/include/rtems/score/interr.h, score/include/rtems/score/isr.h, score/include/rtems/score/mpci.h, score/include/rtems/score/mppkt.h, score/include/rtems/score/objectmp.h, score/include/rtems/score/priority.h, score/include/rtems/score/stack.h, score/include/rtems/score/states.h, score/include/rtems/score/sysstate.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadmp.h, score/include/rtems/score/threadq.h, score/include/rtems/score/tod.h, score/include/rtems/score/tqdata.h, score/include/rtems/score/userext.h, score/include/rtems/score/watchdog.h, score/include/rtems/score/wkspace.h, score/inline/rtems/score/address.inl, score/inline/rtems/score/chain.inl, score/inline/rtems/score/coremsg.inl, score/inline/rtems/score/coremutex.inl, score/inline/rtems/score/coresem.inl, score/inline/rtems/score/heap.inl, score/inline/rtems/score/isr.inl, score/inline/rtems/score/mppkt.inl, score/inline/rtems/score/objectmp.inl, score/inline/rtems/score/priority.inl, score/inline/rtems/score/stack.inl, score/inline/rtems/score/states.inl, score/inline/rtems/score/sysstate.inl, score/inline/rtems/score/thread.inl, score/inline/rtems/score/threadmp.inl, score/inline/rtems/score/tod.inl, score/inline/rtems/score/tqdata.inl, score/inline/rtems/score/userext.inl, score/inline/rtems/score/watchdog.inl, score/inline/rtems/score/wkspace.inl: Add Doxygen comments -- working modifications which are not complete and may have broken code. Committing so work and testing can proceed. * score/Doxyfile, score/mainpage.h: New files. --- cpukit/score/inline/rtems/score/sysstate.inl | 72 ++++++++-------------------- 1 file changed, 21 insertions(+), 51 deletions(-) (limited to 'cpukit/score/inline/rtems/score/sysstate.inl') diff --git a/cpukit/score/inline/rtems/score/sysstate.inl b/cpukit/score/inline/rtems/score/sysstate.inl index 4aa3295efe..63cfe8cde4 100644 --- a/cpukit/score/inline/rtems/score/sysstate.inl +++ b/cpukit/score/inline/rtems/score/sysstate.inl @@ -1,9 +1,12 @@ -/* sysstates.inl +/** + * @file sysstate.inl * * This file contains the inline implementation of routines regarding the * system state. - * - * COPYRIGHT (c) 1989-1999. + */ + +/* + * COPYRIGHT (c) 1989-2004. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -16,12 +19,12 @@ #ifndef __SYSTEM_STATE_inl #define __SYSTEM_STATE_inl -/*PAGE - * - * _System_state_Handler_initialization - * - * DESCRIPTION: - * +/** + * @addtogroup ScoreSysState + * @{ + */ + +/** * This routine initializes the system state handler. */ @@ -33,12 +36,7 @@ RTEMS_INLINE_ROUTINE void _System_state_Handler_initialization ( _System_state_Is_multiprocessing = is_multiprocessing; } -/*PAGE - * - * _System_state_Set - * - * DESCRIPTION: - * +/** * This routine sets the current system state to that specified by * the called. */ @@ -50,12 +48,7 @@ RTEMS_INLINE_ROUTINE void _System_state_Set ( _System_state_Current = state; } -/*PAGE - * - * _System_state_Get - * - * DESCRIPTION: - * +/** * This function returns the current system state. */ @@ -64,12 +57,7 @@ RTEMS_INLINE_ROUTINE System_state_Codes _System_state_Get ( void ) return _System_state_Current; } -/*PAGE - * - * _System_state_Is_before_initialization - * - * DESCRIPTION: - * +/** * This function returns TRUE if the state is equal to the * "before initialization" state, and FALSE otherwise. */ @@ -81,12 +69,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_before_initialization ( return (state == SYSTEM_STATE_BEFORE_INITIALIZATION); } -/*PAGE - * - * _System_state_Is_before_multitasking - * - * DESCRIPTION: - * +/** * This function returns TRUE if the state is equal to the * "before multitasking" state, and FALSE otherwise. */ @@ -98,12 +81,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_before_multitasking ( return (state == SYSTEM_STATE_BEFORE_MULTITASKING); } -/*PAGE - * - * _System_state_Is_begin_multitasking - * - * DESCRIPTION: - * +/** * This function returns TRUE if the state is equal to the * "begin multitasking" state, and FALSE otherwise. */ @@ -115,12 +93,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_begin_multitasking ( return (state == SYSTEM_STATE_BEGIN_MULTITASKING); } -/*PAGE - * - * _System_state_Is_up - * - * DESCRIPTION: - * +/** * This function returns TRUE if the state is equal to the * "up" state, and FALSE otherwise. */ @@ -132,12 +105,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_up ( return (state == SYSTEM_STATE_UP); } -/*PAGE - * - * _System_state_Is_failed - * - * DESCRIPTION: - * +/** * This function returns TRUE if the state is equal to the * "failed" state, and FALSE otherwise. */ @@ -149,5 +117,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_failed ( return (state == SYSTEM_STATE_FAILED); } +/**@}*/ + #endif /* end of include file */ -- cgit v1.2.3