From baff4dafe1ff85d128a55e7b73780ca28f5c7faf Mon Sep 17 00:00:00 2001
From: Joel Sherrill <joel.sherrill@OARcorp.com>
Date: Mon, 1 Nov 2004 13:22:41 +0000
Subject: 2004-11-01	Joel Sherrill <joel@oarcorp.com>

	* 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/stack.inl | 39 ++++++++++++++-----------------
 1 file changed, 17 insertions(+), 22 deletions(-)

(limited to 'cpukit/score/inline/rtems/score/stack.inl')

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 */
-- 
cgit v1.2.3