Score misc: Clean up Doxygen #8 (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/7970221

4 files changed, 25 insertions, 11 deletions

diff --git a/cpukit/score/include/rtems/score/chain.h b/cpukit/score/include/rtems/score/chain.h
index 53976e6d78..ebb0f24e8c 100644
--- a/cpukit/score/include/rtems/score/chain.h
+++ b/cpukit/score/include/rtems/score/chain.h
@@ -162,8 +162,9 @@ Chain_Node *_Chain_Get(
  *
  *  This routine inserts @a the_node on a chain immediately following
  *  @a after_node.
- *  
- *  @param[in] after_node is the pointer to the node in chain to be inserted after
+ *
+ *  @param[in] after_node is the pointer to the node in chain to be
+ *             inserted after
  *  @param[in] node is the pointer to the node to be inserted
  *
  *  @note It disables interrupts to ensure the atomicity
@@ -244,6 +245,9 @@ bool _Chain_Prepend_with_empty_check(
  *
  * @retval true The chain is empty now.
  * @retval false The chain contains at least one node now.
+ *
+ *  - INTERRUPT LATENCY:
+ *    + single case
  */
 bool _Chain_Get_with_empty_check(
   Chain_Control *the_chain,
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 178458681e..29c98a8183 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -448,12 +448,12 @@ void _Objects_Extend_information(
 
 /**
  *  @brief Shrink an object class information record
- * 
+ *
  *  This function shrink an object class information record.
  *  The object's name and object space are released. The local_table
  *  etc block does not shrink. The InActive list needs to be scanned
  *  to find the objects are remove them.
- *  
+ *
  *  @param[in] information points to an object class information block.
  */
 void _Objects_Shrink_information(
@@ -462,7 +462,7 @@ void _Objects_Shrink_information(
 
 /**
  *  @brief Initialize object Information
- * 
+ *
  *  This function initializes an object class information record.
  *  SUPPORTS_GLOBAL is true if the object class supports global
  *  objects, and false otherwise.  Maximum indicates the number
@@ -516,6 +516,8 @@ unsigned int _Objects_API_maximum_class(
  *  This function allocates a object control block from
  *  the inactive chain of free object control blocks.
  *
+ *  @brief Allocate Object
+ *
  *  @param[in] information points to an object class information block.
  */
 Objects_Control *_Objects_Allocate(
@@ -604,6 +606,8 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
 
 #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)
 /**
+ *  @brief Object ID to Name
+ *
  *  This method converts an object name to an Id.  It performs a look up
  *  using the object information block for this object class.
  *
@@ -675,7 +679,7 @@ 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
@@ -709,7 +713,7 @@ 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
@@ -759,7 +763,7 @@ Objects_Control *_Objects_Get_next(
 
 /**
  *  @brief Get Object Information
- * 
+ *
  *  This function return the information structure given
  *  an the API and Class.  This can be done independent of
  *  the existence of any objects created by the API.
@@ -790,7 +794,7 @@ Objects_Information *_Objects_Get_information_id(
 
 /**
  *  @brief _Objects_Get_name_as_string
- *  
+ *
  *  This method objects the name of an object and returns its name
  *  in the form of a C string.  It attempts to be careful about
  *  overflowing the user's string and about returning unprintable characters.
@@ -809,6 +813,8 @@ char *_Objects_Get_name_as_string(
 );
 
 /**
+ *  @brief Set Objects Name
+ *
  *  This method sets the object name to either a copy of a string
  *  or up to the first four characters of the string based upon
  *  whether this object class uses strings for names.
diff --git a/cpukit/score/include/rtems/score/scheduler.h b/cpukit/score/include/rtems/score/scheduler.h
index dbda8b2d67..117f86a37a 100644
--- a/cpukit/score/include/rtems/score/scheduler.h
+++ b/cpukit/score/include/rtems/score/scheduler.h
@@ -129,6 +129,8 @@ extern Scheduler_Control  _Scheduler;
   (_Scheduler_Priority_compare(_p1,_p2) > 0)
 
 /**
+ *  @brief Scheduler is priority higher than
+ *
  *  This routine initializes the scheduler to the policy chosen by the user
  *  through confdefs, or to the priority scheduler with ready chains by
  *  default.
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index c15114c6c8..6716383205 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -64,6 +64,8 @@ void _Scheduler_simple_Initialize( void );
 void _Scheduler_simple_Schedule( void );
 
 /**
+ *  @brief Simple Schedule
+ *
  *  This routine is invoked when a thread wishes to voluntarily
  *  transfer control of the processor to another thread in the queue.
  *  It will remove the running THREAD from the scheduler.informaiton
@@ -126,7 +128,7 @@ 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.
  *
@@ -166,7 +168,7 @@ void _Scheduler_simple_Update(
 );
 
 /**
- *  @brief Stub for schedule free 
+ *  @brief Stub for schedule free
  *
  *  This routine does nothing, and is used as a stub for Schedule free
  *  The overhead of a function call will still be imposed.