diff options
| author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-01-10 13:20:34 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-01-10 17:06:47 -0600 |
| commit | a15eaaf9fdba8a9311623ae44711d17701a19d30 (patch) | |
| tree | eb6f4439e820390ad8b0f8ed5a10ed6835461548 /cpukit/libcsupport/include/rtems/error.h | |
| parent | score: Doxygen Clean Up Task #14 (diff) | |
| download | rtems-a15eaaf9fdba8a9311623ae44711d17701a19d30.tar.bz2 | |
cpukit: Doxygen group fixes and many warnings addressed
The output of the modules.html is much improved. Most
filesystem and POSIX API related groups are properly nested.
Some formatting issues were addressed as were multiple
inconsistencies.
Diffstat (limited to 'cpukit/libcsupport/include/rtems/error.h')
| -rw-r--r-- | cpukit/libcsupport/include/rtems/error.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h index 31a37e025b..4eae14f912 100644 --- a/cpukit/libcsupport/include/rtems/error.h +++ b/cpukit/libcsupport/include/rtems/error.h @@ -20,27 +20,32 @@ * It can also include a rtems_status value which can be OR'd * with the above flags. * * - * EXAMPLE + * Example 1: + * @code * #include <rtems.h> * #include <rtems/error.h> * rtems_error(0, "stray interrupt %d", intr); + * @endcode * - * EXAMPLE + * Example 2: + * @code * if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL) * { * rtems_error(status | RTEMS_ERROR_ABORT, * "could not create task"); * } + * @endcode * - * EXAMPLE + * Example 3: + * @code * if ((fd = open(pathname, O_RDNLY)) < 0) * { * rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname); * goto failed; * } + * @endcode */ - #ifndef _RTEMS_RTEMS_ERROR_H #define _RTEMS_RTEMS_ERROR_H @@ -59,7 +64,6 @@ extern "C" { * @brief Defines and externs for rtems error reporting * */ - typedef Internal_errors_t rtems_error_code_t; /* |