diff options
Diffstat (limited to 'spec/rtems/object/if/id-api-maximum.yml')
| -rw-r--r-- | spec/rtems/object/if/id-api-maximum.yml | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/spec/rtems/object/if/id-api-maximum.yml b/spec/rtems/object/if/id-api-maximum.yml index 45c8238c..f09c0bf5 100644 --- a/spec/rtems/object/if/id-api-maximum.yml +++ b/spec/rtems/object/if/id-api-maximum.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Gets the highest valid value for the API component of an 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,9 +17,14 @@ links: - role: interface-ingroup uid: group name: rtems_object_id_api_maximum -notes: null +notes: | + This directive is strictly local and does not impact task scheduling. + + A body is also provided. params: [] return: - return: null + return: | + Returns the highest valid value for the API component of an object + identifier. return-values: [] type: interface |