score misc: Score misc: Clean up Doxygen #6 (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/7976215

1 files changed, 11 insertions, 5 deletions

diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h
index 5a6e710a8b..79de255c72 100644
--- a/cpukit/score/include/rtems/score/threadq.h
+++ b/cpukit/score/include/rtems/score/threadq.h
@@ -119,10 +119,13 @@ void _Thread_queue_Requeue(
 );
 
 /**
- *  @brief Thread Queue Extract
+ *  @brief Extracts Thread from Thread Queue
  *
- *  This routine removes the_thread from the_thread_queue
+ *  This routine removes @a the_thread from @a the_thread_queue
  *  and cancels any timeouts associated with this blocking.
+ * 
+ *  @param[in] the_thread_queue is the pointer to the ThreadQ header
+ *  @param[in] the_thread is the pointer to a thread control block that is to be removed
  */
 void _Thread_queue_Extract(
   Thread_queue_Control *the_thread_queue,
@@ -237,11 +240,14 @@ void _Thread_queue_Extract_priority_helper(
 
 
 /**
- *  @brief Thread Queue First priority
+ *  @brief Returns highest priority thread on the_thread_queue
  *
  *  This function returns a pointer to the "first" thread
- *  on the_thread_queue.  The "first" thread is the highest
- *  priority thread waiting on the_thread_queue.
+ *  on @a the_thread_queue.  The "first" thread is the highest
+ *  priority thread waiting on @a the_thread_queue.
+ *
+ *  @param[in] the_thread_queue is the pointer to the thread queue
+ *  @return first thread or NULL
  */
 Thread_Control *_Thread_queue_First_priority(
   Thread_queue_Control *the_thread_queue