Imagelibrary/rtems
1
0
Fork 1
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-12-27 06:58:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

doxygen: Update _Objects_Build_name()

Browse Source 
This is intended as an example in the RTEMS Software Engineering manual.

Update #3704.
This commit is contained in:
Sebastian Huber
2019-04-04 09:54:27 +02:00
parent 4c20da4be4
commit 8a8b95aa1d
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
cpukit/include/rtems/score/object.h
View File

@@ -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 ) | \