diff options
| author | Alexandre Devienne <deviennealexandre@gmail.com> | 2012-11-28 14:14:50 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-28 14:14:50 -0600 |
| commit | bf54252a053b6bdedb01ca71bacba5a661ea6215 (patch) | |
| tree | e7c08891d1204507c7aa2f6df58add7e0390b9ac /cpukit/score/include/rtems/score/threadq.h | |
| parent | score misc: Clean up Doxygen #3 (GCI 2012) (diff) | |
| download | rtems-bf54252a053b6bdedb01ca71bacba5a661ea6215.tar.bz2 | |
Score misc: Clean up Doxygen #4 (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/7985215
Diffstat (limited to 'cpukit/score/include/rtems/score/threadq.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/threadq.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h index 1999ea14ff..5a6e710a8b 100644 --- a/cpukit/score/include/rtems/score/threadq.h +++ b/cpukit/score/include/rtems/score/threadq.h @@ -180,9 +180,16 @@ void _Thread_queue_Initialize( /** * @brief Thread Queue Dequeue priority * - * This function returns a pointer to the highest priority - * thread waiting on the_thread_queue. If no threads are waiting - * on the_thread_queue, then NULL is returned. + * This routine removes a thread from the specified PRIORITY based + * threadq, unblocks it, and cancels its timeout timer. + * + * - INTERRUPT LATENCY: + * + single case + * + * @param[in] the_thread_queue is a pointer to a thread queue + * + * @retval thread dequeued + * @retval NULL if no thread are waiting on the_thread_queue */ Thread_Control *_Thread_queue_Dequeue_priority( Thread_queue_Control *the_thread_queue |