diff options
Diffstat (limited to 'spec/rtems/object/if/api-class-information.yml')
| -rw-r--r-- | spec/rtems/object/if/api-class-information.yml | 27 |
1 files changed, 16 insertions, 11 deletions
diff --git a/spec/rtems/object/if/api-class-information.yml b/spec/rtems/object/if/api-class-information.yml index ae969bd2..17da71e3 100644 --- a/spec/rtems/object/if/api-class-information.yml +++ b/spec/rtems/object/if/api-class-information.yml @@ -1,46 +1,51 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + This structure is used to return information to the application about the + objects configured for a specific API/Class combination. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) definition: - default: brief: | - This member is + This member contains the minimum valid object identifier for this class. definition: ${../../type/if/id:/name} ${.:name} - description: '%' + description: null kind: member name: minimum_id variants: [] - default: brief: | - This member is + This member contains the maximum valid object identifier for this class. definition: ${../../type/if/id:/name} ${.:name} - description: '%' + description: null kind: member name: maximum_id variants: [] - default: brief: | - This member is + This member contains the maximum number of active objects configured + for this class. definition: ${/c/if/uint32_t:/name} ${.:name} - description: '%' + description: null kind: member name: maximum variants: [] - default: brief: | - This member is + This member is true, if this class is configured for automatic object + extension, otherwise it is false. definition: ${/c/if/bool:/name} ${.:name} - description: '%' + description: null kind: member name: auto_extend variants: [] - default: brief: | - This member is + This member contains the number of currently inactive objects of this + class. definition: ${/c/if/uint32_t:/name} ${.:name} - description: '%' + description: null kind: member name: unallocated variants: [] |