rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 04:36:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

eng: Add brief description to header file items

Browse Source 
Update #3715.
This commit is contained in:
Sebastian Huber 2020-07-27 15:37:47 +02:00
parent fd2fc509a3
commit f12cae140e
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
eng/req/items.rst
View File

@ -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`