diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-27 17:21:23 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
commit | 9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch) | |
tree | 9f5d198e4af5ad22b96012a17ce0a23769acf01f /cpukit/include/rtems/score/threadqimpl.h | |
parent | rtems: Canonicalize Doxygen @file comments (diff) | |
download | rtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2 |
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions.
Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/threadqimpl.h')
-rw-r--r-- | cpukit/include/rtems/score/threadqimpl.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/cpukit/include/rtems/score/threadqimpl.h b/cpukit/include/rtems/score/threadqimpl.h index 24a2ba5e60..88aba49a68 100644 --- a/cpukit/include/rtems/score/threadqimpl.h +++ b/cpukit/include/rtems/score/threadqimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreThreadQueue * - * @brief Constants and Structures Associated with the Manipulation of Objects - * - * This include file contains all the constants and structures associated - * with the manipulation of objects. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreThreadQueue which are only used by the implementation. */ /* @@ -1078,7 +1076,11 @@ void _Thread_queue_Extract( Thread_Control *the_thread ); * * This routine extracts the_thread from the_thread_queue * and ensures that if there is a proxy for this task on - * another node, it is also dealt with. + * another node, it is also dealt with. A proxy is a data + * data that is on the thread queue on the remote node and + * acts as a proxy for the local thread. If the local thread + * was waiting on a remote operation, then the remote side + * of the operation must be cleaned up. * * @param[in, out] the_thread The pointer to a thread control block that * is to be removed |