summaryrefslogtreecommitdiffstats
path: root/spec/rtems/status/if/is-successful.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 09:09:18 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 09:16:49 +0100
commitf0d19f9749d813e8c2bbdab6383c4669a0829c4a (patch)
tree32e8db4c61d687d76d487c72a3eaf4b3d3134b7d /spec/rtems/status/if/is-successful.yml
parentspec: Fix typo (diff)
downloadrtems-central-f0d19f9749d813e8c2bbdab6383c4669a0829c4a.tar.bz2
spec: Review status codes API
Diffstat (limited to 'spec/rtems/status/if/is-successful.yml')
-rw-r--r--spec/rtems/status/if/is-successful.yml7
1 files changed, 4 insertions, 3 deletions
diff --git a/spec/rtems/status/if/is-successful.yml b/spec/rtems/status/if/is-successful.yml
index 52bfe520..579e6e7c 100644
--- a/spec/rtems/status/if/is-successful.yml
+++ b/spec/rtems/status/if/is-successful.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the status code is equal to ${successful:/name}, otherwise
- returns false.
+ Checks if the status code is ${successful:/name}.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
@@ -30,6 +29,8 @@ params:
dir: null
name: status_code
return:
- return: null
+ return: |
+ Returns true, if the status code is equal to ${successful:/name}, otherwise
+ false.
return-values: []
type: interface