spec/spec/external-reference.yml


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

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links:
- role: spec-member
  uid: root
spec-description: null
spec-example: null
spec-info:
  dict:
    attributes:
      identifier:
        description: |
          It shall be the type-specific identifier of the referenced object.
          For *group* references use the Doxygen group identifier.  For *file*
          references use a file system path to the file.
        spec-type: str
      type:
        description: |
          It shall be the type of the referenced object.
        spec-type: name
    description: |
      This set of attributes specifies a reference to some object external to
      the specification.
    mandatory-attributes: all
spec-name: External Reference
spec-type: external-reference
type: spec