source: rtems-central/spec/spec/interface-header-file.yml @ c970d63

Last change on this file since c970d63 was 3e303ed, checked in by Sebastian Huber <sebastian.huber@…>, on 07/28/20 at 04:57:22

spec: Clarify and use interface brief
  • Property mode set to 100644
File size: 1.2 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2copyrights:
3- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
4enabled-by: true
5links:
6- role: spec-member
7  uid: root
8- role: spec-refinement
9  spec-key: interface-type
10  spec-value: header-file
11  uid: interface
12spec-description: null
13spec-example: null
14spec-info:
15  dict:
16    attributes:
17      brief:
18        description: null
19        spec-type: interface-brief
20      path:
21        description: |
22          It shall be the path used to include the header file.  For example
23          :file:`rtems/confdefs.h`.
24        spec-type: str
25      prefix:
26        description: |
27          It shall be the prefix directory path to the header file in the
28          interface domain.  For example :file:`cpukit/include`.
29        spec-type: str
30    description: |
31      This set of attributes specifies a header file.  The item shall have
32      exactly one link with the ${interface-placement:/spec-name} to an
33      ${interface-domain:/spec-name} item.  This link defines the interface
34      domain of the header file.
35    mandatory-attributes: all
36spec-name: Interface Header File Item Type
37spec-type: interface-header-file
38type: spec
Note: See TracBrowser for help on using the repository browser.