diff options
| author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-11-28 13:31:53 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-28 13:31:53 -0600 |
| commit | d4d7899bb2730dc77331db202a2473818a7ea351 (patch) | |
| tree | fc3204f40c34ba4da1e6db310dbdf82c81c8c6a7 /cpukit/score/src/threadget.c | |
| parent | score misc: Clean up Doxygen (GCI 2012) (diff) | |
| download | rtems-d4d7899bb2730dc77331db202a2473818a7ea351.tar.bz2 | |
score misc: Clean up Doxygen #2 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
http://www.google-melange.com/gci/task/view/google/gci2012/7986213
Diffstat (limited to 'cpukit/score/src/threadget.c')
| -rw-r--r-- | cpukit/score/src/threadget.c | 27 |
1 files changed, 8 insertions, 19 deletions
diff --git a/cpukit/score/src/threadget.c b/cpukit/score/src/threadget.c index de3dea652a..4bef8681b2 100644 --- a/cpukit/score/src/threadget.c +++ b/cpukit/score/src/threadget.c @@ -1,6 +1,12 @@ -/* - * Thread Handler - Object Id to Thread Pointer +/** + * @file + * + * @brief Maps Thread IDs to TCB Pointer * + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -25,23 +31,6 @@ #include <rtems/score/thread.h> #include <rtems/score/threadq.h> - -/** - * This function maps thread IDs to thread control - * blocks. If ID corresponds to a local thread, then it - * returns the_thread control pointer which maps to ID - * and location is set to OBJECTS_LOCAL. If the thread ID is - * global and resides on a remote node, then location is set - * to OBJECTS_REMOTE, and the_thread is undefined. - * Otherwise, location is set to OBJECTS_ERROR and - * the_thread is undefined. - * - * @note The performance of many RTEMS services depends upon - * the quick execution of the "good object" path in this - * routine. If there is a possibility of saving a few - * cycles off the execution time, this routine is worth - * further optimization attention. - */ Thread_Control *_Thread_Get ( Objects_Id id, Objects_Locations *location |