summaryrefslogtreecommitdiff
path: root/spec/spec/interface.yml
blob: d0d193fc2c764629c9de560eb78adfdfe4c1f67b (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
enabled-by: true
links:
- role: spec-member
  uid: root
- role: spec-refinement
  spec-key: type
  spec-value: interface
  uid: root
spec-description: null
spec-example: null
spec-info:
  dict:
    attributes:
      index-entries:
        description: |
          It shall be a list of additional document index entries.  A document
          index entry derived from the interface name is added automatically.
        spec-type: list-str
      interface-type:
        description: |
          It shall be the interface item type.
        spec-type: name
    description: |
      This set of attributes specifies an interface specification item.
      Interface items shall specify the interface of the software product to
      other software products and the hardware.  Use
      ${interface-domain:/spec-name} items to specify interface domains, for
      example the ${/glossary/api:/term}, C language, compiler, interfaces to
      the implementation, and the hardware.
    mandatory-attributes: all
spec-name: Interface Item Type
spec-type: interface
type: spec