summaryrefslogtreecommitdiff
path: root/spec/spec/interface-function-definition.yml
blob: 11463487adad44cb4585ed812fe217d062e0687c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020, 2022 embedded brains GmbH & Co. KG
enabled-by: true
links:
- role: spec-member
  uid: root
spec-description: null
spec-example: null
spec-info:
  none: null
  dict:
    attributes:
      attributes:
        description: |
          If the value is present, then it shall be the function attributes.
          On the attributes a context-sensitive substitution of item variables
          is performed.  A function attribute is for example the indication
          that the function does not return to the caller.
        spec-type: optional-str
      body:
        description: |
          If the value is present, then it shall be the definition of a static
          inline function.  On the function definition a context-sensitive
          substitution of item variables is performed.  If no value is present,
          then the function is declared as an external function.
        spec-type: optional-str
      params:
        description: |
          It shall be the list of parameter declarations of the function.  On
          the function parameter declarations a context-sensitive substitution
          of item variables is performed.
        spec-type: list-str
      return:
        description: |
          If the value is present, then it shall be the function return type.
          On the return type a context-sensitive substitution of item variables
          is performed.
        spec-type: optional-str
    description: |
      This set of attributes specifies a function definition.
    mandatory-attributes: all
spec-name: Interface Function or Macro Definition
spec-type: interface-function-definition
type: spec