summaryrefslogtreecommitdiffstats
path: root/cpukit/score/inline/rtems/score/sysstate.inl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--cpukit/score/inline/rtems/score/sysstate.inl72
1 files changed, 21 insertions, 51 deletions
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 */