diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-09 09:09:18 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-09 09:16:49 +0100 |
| commit | f0d19f9749d813e8c2bbdab6383c4669a0829c4a (patch) | |
| tree | 32e8db4c61d687d76d487c72a3eaf4b3d3134b7d /spec/rtems/status/if/text.yml | |
| parent | spec: Fix typo (diff) | |
| download | rtems-central-f0d19f9749d813e8c2bbdab6383c4669a0829c4a.tar.bz2 | |
spec: Review status codes API
Diffstat (limited to 'spec/rtems/status/if/text.yml')
| -rw-r--r-- | spec/rtems/status/if/text.yml | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/spec/rtems/status/if/text.yml b/spec/rtems/status/if/text.yml index ffa2864d..3647b311 100644 --- a/spec/rtems/status/if/text.yml +++ b/spec/rtems/status/if/text.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: Returns a text describing the specified status code. +brief: | + Maps the status code to a descriptive text. copyrights: - Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -27,8 +28,9 @@ params: dir: null name: status_code return: - return: Otherwise, a text describing the status code. + return: | + Returns a text describing the status code, if the status code is valid. return-values: - - description: The specified status code is invalid. + - description: The status code is invalid. value: '"?"' type: interface |