diff options
Diffstat (limited to 'spec/rtems/object/if/id-get-class.yml')
| -rw-r--r-- | spec/rtems/object/if/id-get-class.yml | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/spec/rtems/object/if/id-get-class.yml b/spec/rtems/object/if/id-get-class.yml index ab3fae2a..3b091ac8 100644 --- a/spec/rtems/object/if/id-get-class.yml +++ b/spec/rtems/object/if/id-get-class.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Gets the class component of the object identifier. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -16,12 +17,20 @@ links: - role: interface-ingroup uid: group name: rtems_object_id_get_class -notes: null +notes: | + This directive is strictly local and does not impact task scheduling. + + This directive does not validate the object identifier provided in + ``${.:/params[0]/name}``. + + A body is also provided. params: -- description: '%' +- description: | + is the object identifier with the class component to get. dir: null name: _id return: - return: null + return: | + Returns the class component of the object identifier. return-values: [] type: interface |