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, 13 insertions, 0 deletions

diff --git a/cpukit/score/include/rtems/score/interr.h b/cpukit/score/include/rtems/score/interr.h
index e325e68d3b..6198dbd94a 100644
--- a/cpukit/score/include/rtems/score/interr.h
+++ b/cpukit/score/include/rtems/score/interr.h
@@ -172,6 +172,13 @@ extern Internal_errors_Information _Internal_errors_What_happened;
  * determines that a fatal error has occurred or a final system state is
  * reached (for example after exit()).
  *
+ * 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.
+ *
  * The first action of this function is to call the fatal handler of the user
  * extensions.  For the initial extensions the following conditions are
  * required
@@ -191,6 +198,12 @@ extern Internal_errors_Information _Internal_errors_What_happened;
  *
  * The final step is to call the CPU specific _CPU_Fatal_halt().
  *
+ * @param[in] the_source is what subsystem the error originated in
+ * @param[in] is_internal is if the error was internally generated
+ * @param[in] the_error is the fatal error status code
+ *
+ * @note The the_error is not necessarily a directive status code.
+ *
  * @see rtems_fatal_error_occurred() and rtems_fatal().
  */
 void _Internal_error_Occurred(