score misc: Clean up Doxygen #3 (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/7982215

7 files changed, 34 insertions, 1 deletions

diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h
index cb8ce98475..c864685689 100644
--- a/cpukit/score/include/rtems/score/coremsg.h
+++ b/cpukit/score/include/rtems/score/coremsg.h
@@ -257,8 +257,15 @@ typedef struct {
 
 /**
  *  @brief Initialize a Message Queue
+ * 
+ *  DESCRIPTION:
+ *
+ *  This package is the implementation of the CORE Message Queue Handler.
+ *  This core object provides task synchronization and communication functions
+ *  via messages passed to queue objects.
  *
- *  This routine initializes @a the_message_queue based on the parameters passed.
+ *  This routine initializes @a the_message_queue 
+ *      based on the parameters passed.
  *
  *  @param[in] the_message_queue points to the message queue to initialize
  *  @param[in] the_message_queue_attributes points to the attributes that
diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index fc4d0baa34..c8d7deb703 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -127,6 +127,14 @@ typedef struct {
 }   CORE_semaphore_Control;
 
 /**
+ *  @brief Core Semaphore Initialize
+ * 
+ *  DESCRIPTION:
+ *
+ *  This package is the implementation of the CORE Semaphore Handler.
+ *  This core object utilizes standard Dijkstra counting semaphores to provide
+ *  synchronization and mutual exclusion capabilities.
+ * 
  *  This routine initializes the semaphore based on the parameters passed.
  *
  *  @param[in] the_semaphore is the semaphore to initialize
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index e8ee057368..c9176e7e5b 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -697,6 +697,8 @@ Objects_Control *_Objects_Get_isr_disable(
 );
 
 /**
+ *  @brief  Get No protection Object
+ * 
  *  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
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index 21239683a9..63e36696cd 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -121,6 +121,8 @@ void _Scheduler_priority_Update(
 );
 
 /**
+ *  @brief Scheduler Priority Unblock
+ * 
  *  This routine adds @a the_thread to the scheduling decision,
  *  that is, adds it to the ready queue and
  *  updates any appropriate scheduling variables, for example the heir thread.
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index 6237e5c4a1..97b571d6a6 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -119,6 +119,8 @@ void _Scheduler_simple_Enqueue(
 );
 
 /**
+ *  @brief Scheduler simple Enqueue first
+ *  
  *  This routine puts @a the_thread to the head of the ready queue.
  *  The thread will be the first thread at its priority level.
  *
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index fdacd41564..fd49b8c340 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -708,6 +708,8 @@ void _Thread_Change_priority (
 );
 
 /**
+ *  @brief Set Thread Priority
+ *  
  *  This routine updates the priority related fields in the_thread
  *  control block to indicate the current priority is now new_priority.
  */
diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h
index db832f4860..1999ea14ff 100644
--- a/cpukit/score/include/rtems/score/threadq.h
+++ b/cpukit/score/include/rtems/score/threadq.h
@@ -109,6 +109,9 @@ void _Thread_queue_Enqueue_with_handler(
  *  the_thread is removed from the_thread_queue and reinserted using
  *  its new priority.  This method has no impact on the state of the_thread
  *  or of any timeouts associated with this blocking.
+ * 
+ *  @param[in] the_thread_queue pointer to a threadq header
+ *  @param[in] the_thread pointer to a thread control block
  */
 void _Thread_queue_Requeue(
   Thread_queue_Control *the_thread_queue,
@@ -254,6 +257,13 @@ Thread_Control *_Thread_queue_Dequeue_fifo(
  *  This routine enqueues the currently executing thread on
  *  the_thread_queue with an optional timeout using the
  *  FIFO discipline.
+ * 
+ *    @param[in] the_thread_queue pointer to threadq
+ *    @param[in] the_thread pointer to the thread to block
+ *    @param[in] level_p interrupt level in case the operation blocks actually
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + single case
  */
 Thread_blocking_operation_States _Thread_queue_Enqueue_fifo (
   Thread_queue_Control *the_thread_queue,