diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-31 08:04:11 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-04-01 07:49:15 +0200 |
| commit | 6f0bc56893aa73de85c4dbd483dc7d6a6fe4a2a2 (patch) | |
| tree | 2f47aa0c19334b5c8ff9d991890adeb3931fb1ab /eng/req-eng.rst | |
| parent | c-user: Document all configuration options (diff) | |
| download | rtems-docs-6f0bc56893aa73de85c4dbd483dc7d6a6fe4a2a2.tar.bz2 | |
eng: Add glossary terms
Define the following terms:
* assembler language
* C language
* ELF
* interrupt service
* software component
* software unit
Clarify:
* task
Update #3715.
Diffstat (limited to '')
| -rw-r--r-- | eng/req-eng.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/eng/req-eng.rst b/eng/req-eng.rst index 61b82be..a5e615d 100644 --- a/eng/req-eng.rst +++ b/eng/req-eng.rst @@ -934,9 +934,9 @@ program may be provided to place Doxygen markup in assembler files. The software architecture is documented via Doxygen groups. Each Doxygen group name should have a project-specific name and the name should be unique within the project, e.g. RTEMSTopLevel\ MidLevel\ LowLevel. The link from a Doxygen -group to its parent group is realized through the `@ingroup` special command. -The link from a Doxygen group or software component to the corresponding -requirement is realized through a `@satisfy{req}` +group to its parent group is realized through the ``@ingroup`` special command. +The link from a Doxygen group or :term:`software component` to the +corresponding requirement is realized through a ``@satisfy{req}`` `custom command <http://www.doxygen.nl/manual/custcmd.html>`_ which needs the identifier of the requirement as its one and only parameter. Only links to parents are explicitly given in the Doxygen markup. The links |