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/userext.inl | 53 +++++++++++------------------
 1 file changed, 19 insertions(+), 34 deletions(-)

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

diff --git a/cpukit/score/inline/rtems/score/userext.inl b/cpukit/score/inline/rtems/score/userext.inl
index 2aef8001ff..205968d5dc 100644
--- a/cpukit/score/inline/rtems/score/userext.inl
+++ b/cpukit/score/inline/rtems/score/userext.inl
@@ -1,9 +1,12 @@
-/*  userext.inl
+/** 
+ *  @file userext.inl
  *
  *  This file contains the macro implementation of the inlined routines
  *  from the User Extension 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
@@ -18,15 +21,15 @@
 
 #include <rtems/score/wkspace.h>
 
-/*PAGE
- *
- *  _User_extensions_Add_set
- *
- *  DESCRIPTION:
- *
+/**
+ *  @addtogroup ScoreUserExt 
+ *  @{
+ */
+
+/**
  *  This routine is used to add a user extension set to the active list.
  *
- *  NOTE: Must be before _User_extensions_Handler_initialization to
+ *  @note Must be before _User_extensions_Handler_initialization to
  *        ensure proper inlining.
  */
 
@@ -49,12 +52,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Add_set (
   }
 }
 
-/*PAGE
- *
- *  _User_extensions_Handler_initialization
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine performs the initialization necessary for this handler.
  */
 
@@ -88,12 +86,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Handler_initialization (
   }
 }
 
-/*PAGE
- *
- *  _User_extensions_Add_API_set
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine is used to add an API extension set to the active list.
  */
  
@@ -114,12 +107,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Add_API_set (
   }
 }
 
-/*PAGE
- *
- *  _User_extensions_Remove_set
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine is used to remove a user extension set from the active list.
  */
 
@@ -137,12 +125,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Remove_set (
     _Chain_Extract( &the_extension->Switch.Node );
 }
 
-/*PAGE
- *
- *  _User_extensions_Thread_switch
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine is used to invoke the user extension which
  *  is invoked when a context switch occurs.
  */
@@ -165,5 +148,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Thread_switch (
   }
 }
 
+/**@}*/
+
 #endif
 /* end of include file */
-- 
cgit v1.2.3