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/include/rtems/score/interr.h | 32 +++++++++++++++++--------------
 1 file changed, 18 insertions(+), 14 deletions(-)

(limited to 'cpukit/score/include/rtems/score/interr.h')

diff --git a/cpukit/score/include/rtems/score/interr.h b/cpukit/score/include/rtems/score/interr.h
index 536e30bef0..eb5c2b499c 100644
--- a/cpukit/score/include/rtems/score/interr.h
+++ b/cpukit/score/include/rtems/score/interr.h
@@ -1,10 +1,12 @@
-/*  interr.h
+/** 
+ *  @file interr.h
  *
  *  This include file contains constants and prototypes related
  *  to the Internal Error 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
@@ -17,15 +19,22 @@
 #ifndef __RTEMS_INTERNAL_ERROR_h
 #define __RTEMS_INTERNAL_ERROR_h
 
+/**
+ *  @defgroup ScoreIntErr Internal Error Handler
+ *
+ *  This group contains functionality which provides the foundation
+ *  Semaphore services used in all of the APIs supported by RTEMS.
+ */
+/**@{*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/*
+/**
  *  This type lists the possible sources from which an error
  *  can be reported.
  */
-
 typedef enum {
   INTERNAL_ERROR_CORE,
   INTERNAL_ERROR_RTEMS_API,
@@ -36,7 +45,6 @@ typedef enum {
 /*
  *  A list of errors which are generated internally by the executive core.
  */
-
 typedef enum {
   INTERNAL_ERROR_NO_CONFIGURATION_TABLE,
   INTERNAL_ERROR_NO_CPU_TABLE,
@@ -60,7 +68,6 @@ typedef enum {
 /*
  *  This type holds the fatal error information.
  */
-
 typedef struct {
   Internal_errors_Source  the_source;
   boolean                 is_internal;
@@ -70,18 +77,13 @@ typedef struct {
 /*
  *  When a fatal error occurs, the error information is stored here.
  */
-
 SCORE_EXTERN Internal_errors_Information Internal_errors_What_happened;
 
-/*
- *  _Internal_error_Occurred
- *
- *  DESCRIPTION:
+/** @brief  Internal error Occurred
  *
  *  This routine is invoked when the application or the executive itself
  *  determines that a fatal error has occurred.
  */
-
 void volatile _Internal_error_Occurred(
   Internal_errors_Source  the_source,
   boolean                 is_internal,
@@ -92,5 +94,7 @@ void volatile _Internal_error_Occurred(
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */
-- 
cgit v1.2.3