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/wkspace.inl | 30 ++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

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

diff --git a/cpukit/score/inline/rtems/score/wkspace.inl b/cpukit/score/inline/rtems/score/wkspace.inl
index baa6297220..d9bd16eed3 100644
--- a/cpukit/score/inline/rtems/score/wkspace.inl
+++ b/cpukit/score/inline/rtems/score/wkspace.inl
@@ -1,9 +1,12 @@
-/*  wkspace.inl
+/** 
+ *  @file wkspace.inl
  *
  *  This include file contains the bodies of the routines which contains
  *  information related to the RAM 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
@@ -16,12 +19,12 @@
 #ifndef __WORKSPACE_inl
 #define __WORKSPACE_inl
 
-/*PAGE
- *
- *  _Workspace_Allocate
- *
- *  DESCRIPTION:
- *
+/**
+ *  @addtogroup ScoreWorkspace 
+ *  @{
+ */
+
+/**
  *  This routine returns the address of a block of memory of size
  *  bytes.  If a block of the appropriate size cannot be allocated
  *  from the workspace, then NULL is returned.
@@ -34,12 +37,7 @@ RTEMS_INLINE_ROUTINE void *_Workspace_Allocate(
    return _Heap_Allocate( &_Workspace_Area, size );
 }
 
-/*PAGE
- *
- *  _Workspace_Free
- *
- *  DESCRIPTION:
- *
+/**
  *  This function frees the specified block of memory.  If the block
  *  belongs to the Workspace and can be successfully freed, then
  *  TRUE is returned.  Otherwise FALSE is returned.
@@ -52,5 +50,7 @@ RTEMS_INLINE_ROUTINE boolean _Workspace_Free(
    return _Heap_Free( &_Workspace_Area, block );
 }
 
+/**@}*/
+
 #endif
 /* end of include file */
-- 
cgit v1.2.3