diff options
Diffstat (limited to 'spec/rtems/object/if/build-name.yml')
| -rw-r--r-- | spec/rtems/object/if/build-name.yml | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/spec/rtems/object/if/build-name.yml b/spec/rtems/object/if/build-name.yml index 2fb730c5..7a28b24a 100644 --- a/spec/rtems/object/if/build-name.yml +++ b/spec/rtems/object/if/build-name.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Builds the object name composed of the four characters. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -7,7 +8,10 @@ definition: default: | ${/score/object/if/build-name:/name}( ${.:/params[0]/name}, ${.:/params[1]/name}, ${.:/params[2]/name}, ${.:/params[3]/name} ) variants: [] -description: null +description: | + This directive takes the four characters provided as arguments and composes a + 32-bit object name with ``${.:params[0]/name}`` in the most significant + 8-bits and ``${.:params[3]/name}`` in the least significant 8-bits. enabled-by: true index-entries: [] interface-type: macro @@ -17,21 +21,27 @@ links: - role: interface-ingroup uid: group name: rtems_build_name -notes: null +notes: | + This directive is strictly local and does not impact task scheduling. params: -- description: '%' +- description: | + is the first character of the name. dir: null - name: _C1 -- description: '%' + name: _c1 +- description: | + is the second character of the name. dir: null - name: _C2 -- description: '%' + name: _c2 +- description: | + is the third character of the name. dir: null - name: _C3 -- description: '%' + name: _c3 +- description: | + is the fourth character of the name. dir: null - name: _C4 + name: _c4 return: - return: null + return: | + Returns the object name composed of the four characters. return-values: [] type: interface |