source: rtems-central/spec/rtems/object/if/build-name.yml @ 0500b9a

Last change on this file since 0500b9a was 0500b9a, checked in by Sebastian Huber <sebastian.huber@…>, on 12/01/20 at 13:23:41

interface/interfacedoc: Format parameter names

  • Property mode set to 100644
File size: 1.4 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Builds the object name composed of the four characters.
4copyrights:
5- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
6- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
7definition:
8  default: |
9    ${/score/object/if/build-name:/name}( ${.:/params[0]/name}, ${.:/params[1]/name}, ${.:/params[2]/name}, ${.:/params[3]/name} )
10  variants: []
11description: |
12  This directive takes the four characters provided as arguments and composes a
13  32-bit object name with ${.:/params[0]/name} in the most significant
14  8-bits and ${.:/params[3]/name} in the least significant 8-bits.
15enabled-by: true
16index-entries: []
17interface-type: macro
18links:
19- role: interface-placement
20  uid: header
21- role: interface-ingroup
22  uid: group
23name: rtems_build_name
24notes: |
25  This directive is strictly local and does not impact task scheduling.
26params:
27- description: |
28    is the first character of the name.
29  dir: null
30  name: _c1
31- description: |
32    is the second character of the name.
33  dir: null
34  name: _c2
35- description: |
36    is the third character of the name.
37  dir: null
38  name: _c3
39- description: |
40    is the fourth character of the name.
41  dir: null
42  name: _c4
43return:
44  return: |
45    Returns the object name composed of the four characters.
46  return-values: []
47type: interface
Note: See TracBrowser for help on using the repository browser.