summaryrefslogtreecommitdiffstats
path: root/cpukit/libcsupport/include/rtems/error.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/libcsupport/include/rtems/error.h')
-rw-r--r--cpukit/libcsupport/include/rtems/error.h14
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;
/*