[rtems commit] score: Documentation

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    f8ac52f21cf8ed042c61666f7e463a4610ab61a4
Changeset: http://git.rtems.org/rtems/commit/?id=f8ac52f21cf8ed042c61666f7e463a4610ab61a4

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Nov 29 15:07:12 2012 +0100

score: Documentation

---

 cpukit/score/include/rtems/score/interr.h |   19 +++++++------------
 1 files changed, 7 insertions(+), 12 deletions(-)

diff --git a/cpukit/score/include/rtems/score/interr.h b/cpukit/score/include/rtems/score/interr.h
index 6198dbd..522e157 100644
--- a/cpukit/score/include/rtems/score/interr.h
+++ b/cpukit/score/include/rtems/score/interr.h
@@ -172,19 +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
  * - a valid stack pointer and enough stack space,
  * - a valid code memory, and
  * - valid read-only data.
+ *
  * For the initial extensions the read-write data (including BSS segment) is
  * not required.
  *
@@ -198,11 +192,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.
+ * @param[in] the_source The fatal source indicating the subsystem the fatal
+ * condition originated in.
+ * @param[in] is_internal Indicates if the fatal condition was generated
+ * internally to the executive.
+ * @param[in] the_error The fatal error code.  This value must be interpreted
+ * with respect to the source.
  *
  * @see rtems_fatal_error_occurred() and rtems_fatal().
  */