summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2012-12-09 14:06:56 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2012-12-09 14:06:56 +0100
commit50dd75a4eb5c85577955d156f54ed1872bb81545 (patch)
treee80dfb4a6dce379d7523514f62df88effdfb4312
parentlibcsupport: Doxygen Enhancement Task #3 (diff)
downloadrtems-50dd75a4eb5c85577955d156f54ed1872bb81545.tar.bz2
sapi: Revert documentation change
-rw-r--r--cpukit/sapi/include/rtems/fatal.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/cpukit/sapi/include/rtems/fatal.h b/cpukit/sapi/include/rtems/fatal.h
index 7b7c5b1925..64344b36b8 100644
--- a/cpukit/sapi/include/rtems/fatal.h
+++ b/cpukit/sapi/include/rtems/fatal.h
@@ -57,7 +57,9 @@ static inline void rtems_exception_frame_print(
* @brief Invokes the internal error handler with a source of
* INTERNAL_ERROR_RTEMS_API and is internal set to false.
*
- * @param[in] the_error is a 32-bit fatal error code.
+ * @param[in] the_error A 32-bit fatal error code.
+ *
+ * @return This function will not return.
*
* @see _Internal_error_Occurred().
*/
@@ -68,8 +70,10 @@ void rtems_fatal_error_occurred(
/**
* @brief Invokes the internal error handler with is internal set to false.
*
- * @param[in] source is the fatal source.
- * @param[in] error is the fatal code.
+ * @param[in] source The fatal source.
+ * @param[in] error The fatal code.
+ *
+ * @return This function will not return.
*
* @see _Internal_error_Occurred().
*/
@@ -81,7 +85,7 @@ void rtems_fatal(
/**
* @brief Returns a description for an internal error code.
*
- * @param[in] error is the error code.
+ * @param[in] error The error code.
*
* @return The error code description or "?" in case the passed error code is
* invalid.