diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-28 11:16:29 -0600 |
---|---|---|
committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2012-12-28 11:17:49 -0600 |
commit | c5782a26b304202546a073a036cbe9e00a789307 (patch) | |
tree | 49f7b4e2a29da7c9ea713465bfec36cee3f353b9 /cpukit/libcsupport/include/rtems/error.h | |
parent | barrier.h: Use POSIX API Doxygen group (diff) | |
download | rtems-c5782a26b304202546a073a036cbe9e00a789307.tar.bz2 |
Header File Doxygen Enhancement Task #7
Diffstat (limited to 'cpukit/libcsupport/include/rtems/error.h')
-rw-r--r-- | cpukit/libcsupport/include/rtems/error.h | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h index 056fb8f9c0..31a37e025b 100644 --- a/cpukit/libcsupport/include/rtems/error.h +++ b/cpukit/libcsupport/include/rtems/error.h @@ -1,10 +1,12 @@ /** * @file rtems/error.h * + * @brief RTEMS Error Reporting + * * Defines and externs for rtems error reporting - * + * * Currently just used by RTEMS monitor. - * + * * These routines provide general purpose error reporting. * rtems_error reports an error to stderr and allows use of * printf style formatting. A newline is appended to all messages. @@ -53,9 +55,9 @@ extern "C" { * @defgroup ErrorPanicSupport Error And Panic Support * * @ingroup libcsupport - * + * * @brief Defines and externs for rtems error reporting - * + * */ typedef Internal_errors_t rtems_error_code_t; @@ -82,13 +84,13 @@ const char *rtems_status_text(rtems_status_code sc); /** * @brief Report an Error - * + * * @param[in] error_code can be specified as any of the following: * RTEMS_ERROR_ERRNO -- include errno text in output * RTEMS_ERROR_PANIC -- halts local system after output * RTEMS_ERROR_ABORT -- abort after output - * - * @param[in] printf_format is a normal printf(3) format string, + * + * @param[in] printf_format is a normal printf(3) format string, * with its concommitant arguments * * @return the number of characters written. |