diff options
Diffstat (limited to 'spec/rtems/object/if/build-id.yml')
| -rw-r--r-- | spec/rtems/object/if/build-id.yml | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/spec/rtems/object/if/build-id.yml b/spec/rtems/object/if/build-id.yml index daff0341..0b65c5a3 100644 --- a/spec/rtems/object/if/build-id.yml +++ b/spec/rtems/object/if/build-id.yml @@ -1,5 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Builds the object identifier from the API, class, MPCI node, and index + components. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -17,21 +19,28 @@ links: - role: interface-ingroup uid: group name: rtems_build_id -notes: null +notes: | + This directive is strictly local and does not impact task scheduling. params: -- description: '%' +- description: | + is the API of the object identifier to build. dir: null name: _api -- description: '%' +- description: | + is the class of the object identifier to build. dir: null name: _class -- description: '%' +- description: | + is the MPCI node of the object identifier to build. dir: null name: _node -- description: '%' +- description: | + is the index of the object identifier to build. dir: null name: _index return: - return: null + return: | + Returns the object identifier built from the API, class, MPCI node, and + index components. return-values: [] type: interface |