diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/score/inline/rtems/score/stack.inl | 39 |
1 files changed, 17 insertions, 22 deletions
diff --git a/cpukit/score/inline/rtems/score/stack.inl b/cpukit/score/inline/rtems/score/stack.inl index 5bfd3c1622..e02da4fbe0 100644 --- a/cpukit/score/inline/rtems/score/stack.inl +++ b/cpukit/score/inline/rtems/score/stack.inl @@ -1,9 +1,12 @@ -/* stack.inl +/** + * @file stack.inl * * This file contains the static inline implementation of the inlined * routines from the Stack Handler. - * - * 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 __STACK_inl #define __STACK_inl -/*PAGE - * - * _Stack_Initialize - * - * DESCRIPTION: - * +/** + * @addtogroup ScoreStack + * @{ + */ + +/** * This routine initializes the_stack record to indicate that * size bytes of memory starting at starting_address have been * reserved for a stack. @@ -37,12 +40,7 @@ RTEMS_INLINE_ROUTINE void _Stack_Initialize ( the_stack->size = size; } -/*PAGE - * - * _Stack_Is_enough - * - * DESCRIPTION: - * +/** * This function returns TRUE if size bytes is enough memory for * a valid stack area on this processor, and FALSE otherwise. */ @@ -54,17 +52,12 @@ RTEMS_INLINE_ROUTINE boolean _Stack_Is_enough ( return ( size >= STACK_MINIMUM_SIZE ); } -/*PAGE - * - * _Stack_Adjust_size - * - * DESCRIPTION: - * +/** * This function increases the stack size to insure that the thread * has the desired amount of stack space after the initial stack * pointer is determined based on alignment restrictions. * - * NOTE: + * @note * * The amount of adjustment for alignment is CPU dependent. */ @@ -76,5 +69,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Stack_Adjust_size ( return size + CPU_STACK_ALIGNMENT; } +/**@}*/ + #endif /* end of include file */ |