spec/spec/interface-description.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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
spec-description: null
spec-example: null
spec-info:
  none: null
  str:
    description: |
      It shall be the description of the interface.  The description should be
      short and concentrate on the average case.  All special cases, usage
      notes, constraints, error conditions, configuration dependencies,
      references, etc. should be described in the
      ${interface-notes:/spec-name}.
spec-name: Interface Description
spec-type: interface-description
type: spec