score misc: Score misc: Clean up Doxygen #7 (GCI 2012)

    This patch is a task from GCI 2012 which improves the Doxygen
    comments in the RTEMS source.

https://google-melange.appspot.com/gci/task/view/google/gci2012/7986214

7 files changed, 47 insertions, 4 deletions

diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 56dedd9812..178458681e 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -497,6 +497,8 @@ void _Objects_Initialize_information (
 );
 
 /**
+ *  @brief Object API Maximum Class
+ *
  *  This function returns the highest numeric value of a valid
  *  API for the specified @a api.
  *
@@ -509,6 +511,8 @@ unsigned int _Objects_API_maximum_class(
 );
 
 /**
+ *  @brief Allocate Object
+ *
  *  This function allocates a object control block from
  *  the inactive chain of free object control blocks.
  *
@@ -670,6 +674,8 @@ Objects_Control *_Objects_Get (
 );
 
 /**
+ *  @brief Object Get Isr Disable
+ *  
  *  This function maps object ids to object control blocks.
  *  If id corresponds to a local object, then it returns
  *  the_object control pointer which maps to id and location
@@ -831,6 +837,8 @@ void _Objects_Namespace_remove(
 );
 
 /**
+ *  @brief Close Object
+ *
  *  This function removes the_object control pointer and object name
  *  in the Local Pointer and Local Name Tables.
  *
diff --git a/cpukit/score/include/rtems/score/objectmp.h b/cpukit/score/include/rtems/score/objectmp.h
index c8e4bb8086..4748c61e2b 100644
--- a/cpukit/score/include/rtems/score/objectmp.h
+++ b/cpukit/score/include/rtems/score/objectmp.h
@@ -55,7 +55,7 @@ typedef struct {
 void _Objects_MP_Handler_initialization(void);
 
 /**
- *  @brief  Objects MP Handler Early initialization
+ *  @brief  Objects MP Handler Early Initialization
  *
  *  This routine intializes the global object node number
  *  used in the ID field of all objects.
diff --git a/cpukit/score/include/rtems/score/rbtree.h b/cpukit/score/include/rtems/score/rbtree.h
index 5f7a103d5e..5a03d7ca8d 100644
--- a/cpukit/score/include/rtems/score/rbtree.h
+++ b/cpukit/score/include/rtems/score/rbtree.h
@@ -189,6 +189,11 @@ RBTree_Node name = RBTREE_NODE_INITIALIZER_EMPTY(name)
  *  This routine initializes @a the_rbtree structure to manage the
  *  contiguous array of @a number_nodes nodes which starts at
  *  @a starting_address.  Each node is of @a node_size bytes.
+ * 
+ *  @param[in] the_rbtree is the pointer to rbtree header
+ *  @param[in] starting_address is the starting address of first node
+ *  @param[in] number_nodes is the number of nodes in rbtree
+ *  @param[in] node_size is the size of node in bytes
  */
 void _RBTree_Initialize(
   RBTree_Control          *the_rbtree,
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index e04d29823f..b8dee43fc1 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -91,6 +91,8 @@ void _Scheduler_priority_Block(
 void _Scheduler_priority_Schedule(void);
 
 /**
+ *  @brief Allocate Scheduler Priority
+ *
  *  This routine allocates @a the_thread->scheduler.
  *
  *  @param[in] the_thread is the thread the scheduler is allocating
@@ -164,6 +166,8 @@ void _Scheduler_priority_Enqueue(
 );
 
 /**
+ *  @brief Scheduler Priority Enqueue First
+ *
  *  This routine puts @a the_thread to the head of the ready queue.
  *  For priority-based ready queues, the thread will be the first thread
  *  at its priority level.
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index d04dc6c6ff..c15114c6c8 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -190,7 +190,7 @@ void _Scheduler_simple_Ready_queue_enqueue(
 );
 
 /**
- *  _Scheduler_simple_Ready_queue_enqueue_first
+ *  @brief Scheduler Simple Ready Queue Enqueue First
  *
  *  This routine puts @a the_thread on to the ready queue
  *  at the beginning of its priority group.
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index 9f2060bfca..bb8fcb8368 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -647,6 +647,8 @@ void _Thread_Reset(
 );
 
 /**
+ *  @brief Thread Close
+ *
  *  This routine frees all memory associated with the specified
  *  thread and removes it from the local object table so no further
  *  operations on this thread are allowed.
@@ -657,9 +659,15 @@ void _Thread_Close(
 );
 
 /**
+ *  @brief Thread Ready
+ *
  *  This routine removes any set states for @a the_thread.  It performs
  *  any necessary scheduling operations including the selection of
  *  a new heir thread.
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + ready chain
+ *    + select heir
  */
 void _Thread_Ready(
   Thread_Control *the_thread
diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h
index 79de255c72..ee7801c4e3 100644
--- a/cpukit/score/include/rtems/score/threadq.h
+++ b/cpukit/score/include/rtems/score/threadq.h
@@ -149,6 +149,10 @@ bool _Thread_queue_Extract_with_proxy(
  *  This function returns a pointer to the "first" thread
  *  on the_thread_queue.  The "first" thread is selected
  *  based on the discipline of the_thread_queue.
+ *
+ *  @param[in] the_thread_queue pointer to thread queue
+ *
+ *  @return first thread or NULL
  */
 Thread_Control *_Thread_queue_First(
   Thread_queue_Control *the_thread_queue
@@ -172,6 +176,11 @@ void _Thread_queue_Flush(
  *  This routine initializes the_thread_queue based on the
  *  discipline indicated in attribute_set.  The state set on
  *  threads which block on the_thread_queue is state.
+ * 
+ *  @param[in] the_thread_queue is the pointer to a threadq header
+ *  @param[in] discipline is the queueing discipline
+ *  @param[in] state is the state of waiting threads
+ *  @param[in] timeout_status is the return on a timeout
  */
 void _Thread_queue_Initialize(
   Thread_queue_Control         *the_thread_queue,
@@ -199,11 +208,18 @@ Thread_Control *_Thread_queue_Dequeue_priority(
 );
 
 /**
- *  @brief Thread Queue Enqueue priority
+ *  @brief Thread Queue Enqueue Priority
  *
  *  This routine enqueues the currently executing thread on
  *  the_thread_queue with an optional timeout using the
  *  priority discipline.
+ *
+ *  @param[in] the_thread_queue is the pointer to threadq
+ *  @param[in] thread is the thread to insert
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + forward less than
+ *    + forward equal
  */
 Thread_blocking_operation_States _Thread_queue_Enqueue_priority (
   Thread_queue_Control *the_thread_queue,
@@ -307,13 +323,15 @@ Thread_Control *_Thread_queue_First_fifo(
 );
 
 /**
- *  @brief Thread Queue timeout
+ *  @brief Thread Queue Timeout
  *
  *  This routine is invoked when a task's request has not
  *  been satisfied after the timeout interval specified to
  *  enqueue.  The task represented by ID will be unblocked and
  *  its status code will be set in it's control block to indicate
  *  that a timeout has occurred.
+ * 
+ *  @param[in] id thread id
  */
 void _Thread_queue_Timeout (
   Objects_Id  id,