Score misc: Clean up Doxygen #4 (GCI 2012)

This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.

http://www.google-melange.com/gci/task/view/google/gci2012/7985215

1 files changed, 7 insertions, 24 deletions

diff --git a/cpukit/score/src/interr.c b/cpukit/score/src/interr.c
index 3e5eb79d6c..1b895d6fac 100644
--- a/cpukit/score/src/interr.c
+++ b/cpukit/score/src/interr.c
@@ -1,6 +1,11 @@
-/*
- *  Internal Error Handler
+/**
+ * @file
  *
+ * @brief Initiates system termination
+ * @ingroup ScoreIntErr
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -21,28 +26,6 @@ System_state_Codes _System_state_Current;
 
 Internal_errors_Information _Internal_errors_What_happened;
 
-/*
- *  _Internal_error_Occurred
- *
- *  This routine will invoke the fatal error handler supplied by the user
- *  followed by the the default one provided by the executive.  The default
- *  error handler assumes no hardware is present to help inform the user
- *  of the problem.  Halt stores the error code in a known register,
- *  disables interrupts, and halts the CPU.  If the CPU does not have a
- *  halt instruction, it will loop to itself.
- *
- *  Input parameters:
- *    the_source  - what subsystem the error originated in
- *    is_internal - if the error was internally generated
- *    the_error   - fatal error status code
- *
- *  Output parameters:
- *    As much information as possible is stored in a CPU dependent fashion.
- *    See the CPU dependent code for more information.
- *
- *  NOTE: The the_error is not necessarily a directive status code.
- */
-
 void _Internal_error_Occurred(
   Internal_errors_Source  the_source,
   bool                    is_internal,