[rtems commit] doc: Improve description of rtems_status_text for ToC

Joel Sherrill joel at rtems.org
Tue Mar 11 23:59:21 UTC 2014


Module:    rtems
Branch:    master
Commit:    2aeeaa00f915a4c11144441081e68333d6b99227
Changeset: http://git.rtems.org/rtems/commit/?id=2aeeaa00f915a4c11144441081e68333d6b99227

Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
Date:      Mon Mar 10 09:47:06 2014 -0500

doc: Improve description of rtems_status_text for ToC

---

 doc/ada_user/example.texi |    2 +-
 doc/user/dirstat.t        |    7 +++----
 doc/user/example.texi     |    4 ++--
 3 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/doc/ada_user/example.texi b/doc/ada_user/example.texi
index 7456767..f682b37 100644
--- a/doc/ada_user/example.texi
+++ b/doc/ada_user/example.texi
@@ -3,7 +3,7 @@
 @c  On-Line Applications Research Corporation (OAR).
 @c  All rights reserved.
 
- at node Example Application, Glossary, Directive Status Codes STATUS_CODE_DESCRIPTION - Returns a description for a status code, Top
+ at node Example Application, Glossary, Directive Status Codes STATUS_TEXT - Returns the enumeration name for a status code, Top
 @chapter Example Application
 
 @example
diff --git a/doc/user/dirstat.t b/doc/user/dirstat.t
index 4d51e2e..d9cf77e 100644
--- a/doc/user/dirstat.t
+++ b/doc/user/dirstat.t
@@ -40,7 +40,7 @@
 @section Directives
 
 @page
- at subsection STATUS_TEXT - Returns a text for a status code
+ at subsection STATUS_TEXT - Returns the enumeration name for a status code
 
 @subheading CALLING SEQUENCE:
 
@@ -55,9 +55,8 @@ const char *rtems_status_text(
 
 @subheading DIRECTIVE STATUS CODES
 
-The status code text or "?" in case the passed status code is invalid.
+The status code enumeration name or "?" in case the status code is invalid.
 
 @subheading DESCRIPTION:
 
-Returns a text for a status code.  The text for each status code is the
-enumerator constant.
+Returns the enumeration name for the specified status code.
diff --git a/doc/user/example.texi b/doc/user/example.texi
index 00923c0..157247e 100644
--- a/doc/user/example.texi
+++ b/doc/user/example.texi
@@ -1,9 +1,9 @@
 @c
- at c  COPYRIGHT (c) 1989-2011.
+ at c  COPYRIGHT (c) 1989-2014.
 @c  On-Line Applications Research Corporation (OAR).
 @c  All rights reserved.
 
- at node Example Application, Glossary, Directive Status Codes STATUS_TEXT - Returns a text for a status code, Top
+ at node Example Application, Glossary, Directive Status Codes STATUS_TEXT - Returns the enumeration name for a status code, Top
 @chapter Example Application
 
 @example




More information about the vc mailing list