diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-04-04 09:54:27 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-04-05 07:46:46 +0200 |
| commit | 8a8b95aa1d6932ba9d2acd7a785100f7d0919205 (patch) | |
| tree | a92d0114535e4cf029ac0d0ee59114bea11041c3 | |
| parent | doxygen: Rename Score* groups in RTEMSScore* (diff) | |
| download | rtems-8a8b95aa1d6932ba9d2acd7a785100f7d0919205.tar.bz2 | |
doxygen: Update _Objects_Build_name()
This is intended as an example in the RTEMS Software Engineering manual.
Update #3704.
| -rw-r--r-- | cpukit/include/rtems/score/object.h | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/cpukit/include/rtems/score/object.h b/cpukit/include/rtems/score/object.h index 3f3e1b84dd..b387410c3c 100644 --- a/cpukit/include/rtems/score/object.h +++ b/cpukit/include/rtems/score/object.h @@ -298,16 +298,14 @@ RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Get_index( } /** - * This function builds an object's id from the processor node and index - * values specified. + * @brief Builds an object ID from its components. * - * @param[in] the_api indicates the API associated with this Id. - * @param[in] the_class indicates the class of object. - * It is specific to @a the_api. - * @param[in] node is the node where this object resides. - * @param[in] index is the instance number of this object. + * @param the_api The object API. + * @param the_class The object API class. + * @param node The object node. + * @param index The object index. * - * @return This method returns an object Id constructed from the arguments. + * @return Returns the object ID constructed from the arguments. */ #define _Objects_Build_id( the_api, the_class, node, index ) \ ( (Objects_Id) ( (Objects_Id) the_api << OBJECTS_API_START_BIT ) | \ |