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.

1 files changed, 28 insertions, 17 deletions

diff --git a/cpukit/score/include/rtems/score/wkspace.h b/cpukit/score/include/rtems/score/wkspace.h
index aff79c78d5..dd3869df05 100644
--- a/cpukit/score/include/rtems/score/wkspace.h
+++ b/cpukit/score/include/rtems/score/wkspace.h
@@ -1,10 +1,13 @@
-/*  wkspace.h
+/** 
+ *  @file wkspace.h
  *
  *  This include file contains information related to the
  *  RAM Workspace.  This Handler provides mechanisms which can be used to
  *  define, initialize and manipulate the workspace.
- *
- *  COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2004.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -17,6 +20,13 @@
 #ifndef __WORKSPACE_h
 #define __WORKSPACE_h
 
+/**
+ *  @defgroup ScoreWorkspace Workspace Handler
+ *
+ *  This group contains functionality which XXX
+ */
+/**@{*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -24,36 +34,35 @@ extern "C" {
 #include <rtems/score/heap.h>
 #include <rtems/score/interr.h>
 
-/*
- *  The following is used to manage the Workspace.
+/** @brief Executive Workspace Control
  *
+ *  The is the heap control structure that used to manage the 
+ *  RTEMS Executive Workspace.
  */
-
 SCORE_EXTERN Heap_Control _Workspace_Area;  /* executive heap header */
 
-/*
- *  _Workspace_Handler_initialization
- *
- *  DESCRIPTION:
+/** @brief Workspace Handler Initialization
  *
  *  This routine performs the initialization necessary for this handler.
+ *
+ *  @param starting_address (in) is the base address of the RTEMS Executive
+ *         Workspace
+ *  @param size (in) is the number of bytes in the RTEMS Executive Workspace
  */
-
 void _Workspace_Handler_initialization(
   void       *starting_address,
   uint32_t    size
 );
 
-/*
- *  _Workspace_Allocate_or_fatal_error
+/** @brief Workspace Allocate or Fail with Fatal Error
  *
- *  DESCRIPTION:
- *
- *  This routine returns the address of a block of memory of size
+ *  This routine returns the address of a block of memory of @a size
  *  bytes.  If a block of the appropriate size cannot be allocated
  *  from the workspace, then the internal error handler is invoked.
+ *
+ *  @param size (in) is the desired number of bytes to allocate
+ *  @return If successful, the starting address of the allocated memory
  */
-
 void *_Workspace_Allocate_or_fatal_error(
   uint32_t     size
 );
@@ -66,5 +75,7 @@ void *_Workspace_Allocate_or_fatal_error(
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */