summaryrefslogtreecommitdiffstats
path: root/spec/rtems/status/if/text.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/status/if/text.yml')
-rw-r--r--spec/rtems/status/if/text.yml32
1 files changed, 32 insertions, 0 deletions
diff --git a/spec/rtems/status/if/text.yml b/spec/rtems/status/if/text.yml
new file mode 100644
index 00000000..6e0c9e49
--- /dev/null
+++ b/spec/rtems/status/if/text.yml
@@ -0,0 +1,32 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: Returns a text describing the specified status code.
+copyrights:
+- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default:
+ body: null
+ params:
+ - ${code:/name} ${.:/params[0]/name}
+ return: const char *
+ variants: []
+description: |
+ The text for each status code is the enumerator constant.
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_status_text
+notes: null
+params:
+- description: is the status code.
+ dir: null
+ name: status_code
+return:
+ return: Otherwise, a text describing the status code.
+ return-values:
+ - description: The passed status code is invalid.
+ value: '"?"'
+type: interface