From f2f39b62a284afefbf8f1840255602162a9b2a01 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 7 Jan 2013 16:01:45 +0100 Subject: sapi: Add rtems_fatal_source_description() --- doc/user/fatal.t | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'doc/user/fatal.t') diff --git a/doc/user/fatal.t b/doc/user/fatal.t index 1b725e89f4..20faa642ba 100644 --- a/doc/user/fatal.t +++ b/doc/user/fatal.t @@ -226,6 +226,33 @@ NONE Prints the exception frame via printk(). +@c +@c +@c +@page +@subsection FATAL_SOURCE_DESCRIPTION - Returns a description for a fatal source + +@cindex fatal error + +@subheading CALLING SEQUENCE: + +@ifset is-C +@findex rtems_fatal_source_description +@example +const char *rtems_fatal_source_description( + rtems_fatal_source source +); +@end example +@end ifset + +@subheading DIRECTIVE STATUS CODES + +The fatal source description or "?" in case the passed fatal source is invalid. + +@subheading DESCRIPTION: + +Returns a description for a fatal source. + @c @c @c -- cgit v1.2.3