diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-24 12:25:31 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-24 12:25:31 +0200 |
| commit | 4ad78f2e66e79bcc4d46d71af79a59a2314bb713 (patch) | |
| tree | 521a3e074fa03ddfb9bea789358715c5a0ba169f /rtemsspec | |
| parent | config: Generate event manager documentation (diff) | |
| download | rtems-central-4ad78f2e66e79bcc4d46d71af79a59a2314bb713.tar.bz2 | |
spec: Add header file brief descriptions
Diffstat (limited to 'rtemsspec')
| -rw-r--r-- | rtemsspec/interface.py | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/spec-interface/h.yml | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/spec-interface/h2.yml | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/spec-interface/h3.yml | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/spec-interface/h4.yml | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/spec-interface/math.yml | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/spec-interface/stdint.yml | 1 | ||||
| -rw-r--r-- | rtemsspec/tests/test_interface.py | 2 |
8 files changed, 9 insertions, 0 deletions
diff --git a/rtemsspec/interface.py b/rtemsspec/interface.py index 13cab4b6..09325f22 100644 --- a/rtemsspec/interface.py +++ b/rtemsspec/interface.py @@ -513,6 +513,7 @@ class _HeaderFile: self._content.prepend_spdx_license_identifier() with self._content.file_block(): self._content.add_ingroup(_get_group_identifiers(self._ingroups)) + self._content.add_brief_description(self._item["brief"]) self._content.add_copyrights_and_licenses() with self._content.header_guard(self._item["path"]): exp_mapper = _HeaderExpressionMapper(self._item, diff --git a/rtemsspec/tests/spec-interface/h.yml b/rtemsspec/tests/spec-interface/h.yml index 0733837a..55485b60 100644 --- a/rtemsspec/tests/spec-interface/h.yml +++ b/rtemsspec/tests/spec-interface/h.yml @@ -1,4 +1,5 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines X. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: [] diff --git a/rtemsspec/tests/spec-interface/h2.yml b/rtemsspec/tests/spec-interface/h2.yml index 194e182e..088e5216 100644 --- a/rtemsspec/tests/spec-interface/h2.yml +++ b/rtemsspec/tests/spec-interface/h2.yml @@ -1,4 +1,5 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines X. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: diff --git a/rtemsspec/tests/spec-interface/h3.yml b/rtemsspec/tests/spec-interface/h3.yml index fc61a1a5..cf758f55 100644 --- a/rtemsspec/tests/spec-interface/h3.yml +++ b/rtemsspec/tests/spec-interface/h3.yml @@ -1,4 +1,5 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines X. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true diff --git a/rtemsspec/tests/spec-interface/h4.yml b/rtemsspec/tests/spec-interface/h4.yml index 6233efe5..2e86aa80 100644 --- a/rtemsspec/tests/spec-interface/h4.yml +++ b/rtemsspec/tests/spec-interface/h4.yml @@ -1,4 +1,5 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines X. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true diff --git a/rtemsspec/tests/spec-interface/math.yml b/rtemsspec/tests/spec-interface/math.yml index 020449fa..1d545415 100644 --- a/rtemsspec/tests/spec-interface/math.yml +++ b/rtemsspec/tests/spec-interface/math.yml @@ -1,4 +1,5 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines X. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true diff --git a/rtemsspec/tests/spec-interface/stdint.yml b/rtemsspec/tests/spec-interface/stdint.yml index 559202c3..3482c710 100644 --- a/rtemsspec/tests/spec-interface/stdint.yml +++ b/rtemsspec/tests/spec-interface/stdint.yml @@ -1,4 +1,5 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines X. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true diff --git a/rtemsspec/tests/test_interface.py b/rtemsspec/tests/test_interface.py index c6aa625b..a08c5213 100644 --- a/rtemsspec/tests/test_interface.py +++ b/rtemsspec/tests/test_interface.py @@ -56,6 +56,8 @@ def test_interface(tmpdir): * @ingroup GroupA * @ingroup GroupB * @ingroup GroupC + * + * @brief This header file defines X. */ /* |