[rtems-docs commit] eng: Add brief description to header file items
Sebastian Huber
sebh at rtems.org
Tue Jul 28 05:33:50 UTC 2020
Module: rtems-docs
Branch: master
Commit: f12cae140e78e426f8b6f93e225eb7ca2dfd1a36
Changeset: http://git.rtems.org/rtems-docs/commit/?id=f12cae140e78e426f8b6f93e225eb7ca2dfd1a36
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Mon Jul 27 15:37:47 2020 +0200
eng: Add brief description to header file items
Update #3715.
---
eng/req/items.rst | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/eng/req/items.rst b/eng/req/items.rst
index a033eac..f97afcc 100644
--- a/eng/req/items.rst
+++ b/eng/req/items.rst
@@ -1466,6 +1466,9 @@ the :ref:`SpecTypeInterfacePlacementLinkRole` to an
domain of the header file. All explicit attributes shall be specified. The
explicit attributes for this type are:
+brief
+ The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`.
+
path
The attribute value shall be a string. It shall be the path used to include
the header file. For example :file:`rtems/confdefs.h`.
@@ -3277,7 +3280,8 @@ A value of this type shall be of one of the following variants:
* There may by be no value (null).
* The value may be a string. It shall be the brief description of the
- interface.
+ interface. It should be a single sentence. The value shall not match with
+ the regular expression "``\n\n``".
This type is used by the following types:
@@ -3295,6 +3299,8 @@ This type is used by the following types:
* :ref:`SpecTypeInterfaceGroupItemType`
+* :ref:`SpecTypeInterfaceHeaderFileItemType`
+
* :ref:`SpecTypeInterfaceMacroItemType`
* :ref:`SpecTypeInterfaceTypedefItemType`
More information about the vc
mailing list