diff options
| author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-12-07 09:49:54 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-07 09:49:54 -0500 |
| commit | 4c98a3ea294f3eb0cbaae4153c47eb45728613ac (patch) | |
| tree | 897abe1cfe7b6a78859f77810c16a8a24fcd0456 /cpukit/sapi/include/rtems/fatal.h | |
| parent | bsps/powerpc: Use explicit compiler options (diff) | |
| download | rtems-4c98a3ea294f3eb0cbaae4153c47eb45728613ac.tar.bz2 | |
sapi misc: Clean up Doxygen GCI task #1
http://www.google-melange.com/gci/task/view/google/gci2012/8011204
Diffstat (limited to '')
| -rw-r--r-- | cpukit/sapi/include/rtems/fatal.h | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/cpukit/sapi/include/rtems/fatal.h b/cpukit/sapi/include/rtems/fatal.h index 64344b36b8..7b7c5b1925 100644 --- a/cpukit/sapi/include/rtems/fatal.h +++ b/cpukit/sapi/include/rtems/fatal.h @@ -57,9 +57,7 @@ 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 A 32-bit fatal error code. - * - * @return This function will not return. + * @param[in] the_error is a 32-bit fatal error code. * * @see _Internal_error_Occurred(). */ @@ -70,10 +68,8 @@ void rtems_fatal_error_occurred( /** * @brief Invokes the internal error handler with is internal set to false. * - * @param[in] source The fatal source. - * @param[in] error The fatal code. - * - * @return This function will not return. + * @param[in] source is the fatal source. + * @param[in] error is the fatal code. * * @see _Internal_error_Occurred(). */ @@ -85,7 +81,7 @@ void rtems_fatal( /** * @brief Returns a description for an internal error code. * - * @param[in] error The error code. + * @param[in] error is the error code. * * @return The error code description or "?" in case the passed error code is * invalid. |