diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-29 18:45:05 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-02-01 06:22:19 +0100 |
commit | 76eec484e599e36f7c03a59b630369be17f6f935 (patch) | |
tree | f628278d0cb3558acf216fb3cb309c041ebd59a9 /cpukit/include/rtems/score/threadimpl.h | |
parent | bsps/aarch64: Add missing include (diff) | |
download | rtems-76eec484e599e36f7c03a59b630369be17f6f935.tar.bz2 |
score: Rename _Thread_Get_objects_information()
Rename _Thread_Get_objects_information() in
_Thread_Get_objects_information_by_id() to emphasize that this thread
method uses an object identifier and not a thread control.
Diffstat (limited to 'cpukit/include/rtems/score/threadimpl.h')
-rw-r--r-- | cpukit/include/rtems/score/threadimpl.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/cpukit/include/rtems/score/threadimpl.h b/cpukit/include/rtems/score/threadimpl.h index 52945b407c..d5381c9871 100644 --- a/cpukit/include/rtems/score/threadimpl.h +++ b/cpukit/include/rtems/score/threadimpl.h @@ -814,14 +814,18 @@ RTEMS_INLINE_ROUTINE Priority_Control _Thread_Priority_highest( } /** - * @brief Gets object information for the object id. + * @brief Gets the thread object information for the API of the object + * identifier. * - * @param id The id of the object information. + * @param id is an object identifier which defines the API to get the + * associated thread objects information. * - * @retval pointer The object information for this id. - * @retval NULL The object id is not valid. + * @retval NULL The object identifier had an invalid API. + * + * @return Returns the thread object information associated with the API of the + * object identifier. */ -RTEMS_INLINE_ROUTINE Objects_Information *_Thread_Get_objects_information( +RTEMS_INLINE_ROUTINE Objects_Information *_Thread_Get_objects_information_by_id( Objects_Id id ) { |