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

8 files changed, 25 insertions, 0 deletions

diff --git a/cpukit/score/include/rtems/score/corebarrier.h b/cpukit/score/include/rtems/score/corebarrier.h
index 7f9c5d8be5..8072ec1e39 100644
--- a/cpukit/score/include/rtems/score/corebarrier.h
+++ b/cpukit/score/include/rtems/score/corebarrier.h
@@ -134,6 +134,7 @@ void _CORE_barrier_Initialize(
 );
 
 /**
+ *  @brief Wait For The Barrier
  *  This routine wait for the barrier to be released.  If the barrier
  *  is set to automatic and this is the appropriate thread, then it returns
  *  immediately.  Otherwise, the calling thread is blocked until the barrier
diff --git a/cpukit/score/include/rtems/score/coremutex.h b/cpukit/score/include/rtems/score/coremutex.h
index 8076a376b0..9c0fce34cc 100644
--- a/cpukit/score/include/rtems/score/coremutex.h
+++ b/cpukit/score/include/rtems/score/coremutex.h
@@ -296,6 +296,7 @@ RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock_body(
 
 #if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__)
   /**
+   *  @brief Trylock CORE Mutex Seize Interrupt
    *  When doing test coverage analysis or trying to minimize the code
    *  space for RTEMS, it is often helpful to not inline this method
    *  multiple times.  It is fairly large and has a high branch complexity
diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h
index 6d97ab1f23..3b70d80701 100644
--- a/cpukit/score/include/rtems/score/corerwlock.h
+++ b/cpukit/score/include/rtems/score/corerwlock.h
@@ -138,6 +138,7 @@ void _CORE_RWLock_Initialize(
 );
 
 /**
+ *  @brief Obtain RWLock for reading
  *  This routine attempts to obtain the RWLock for read access.
  *
  *  @param[in] the_rwlock is the RWLock to wait for
@@ -150,6 +151,7 @@ void _CORE_RWLock_Initialize(
  *
  * @note Status is returned via the thread control block.
  */
+
 void _CORE_RWLock_Obtain_for_reading(
   CORE_RWLock_Control                 *the_rwlock,
   Objects_Id                           id,
diff --git a/cpukit/score/include/rtems/score/corespinlock.h b/cpukit/score/include/rtems/score/corespinlock.h
index 9a4d7af25d..dfa62ccb8f 100644
--- a/cpukit/score/include/rtems/score/corespinlock.h
+++ b/cpukit/score/include/rtems/score/corespinlock.h
@@ -123,6 +123,7 @@ void _CORE_spinlock_Initialize(
 );
 
 /**
+ *  @brief Wait for Spinlock
  *  This routine wait for the spinlock to be released.  If the spinlock
  *  is set to automatic and this is the appropriate thread, then it returns
  *  immediately.  Otherwise, the calling thread is blocked until the spinlock
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 274347bb0b..f2f4469368 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -583,6 +583,7 @@ typedef enum {
 #define OBJECTS_NAME_ERRORS_LAST  OBJECTS_INVALID_NODE
 
 /**
+ *  @brief Object Name To Id
  *  This method converts an object name to an Id.  It performs a look up
  *  using the object information block for this object class.
  *
@@ -627,6 +628,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
 #endif
 
 /**
+ *  @brief Object Id To Name
  *  This function implements the common portion of the object Id
  *  to name directives.  This function returns the name
  *  associated with object id.
@@ -647,6 +649,7 @@ Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
 );
 
 /**
+ *  @brief Get 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 f959c0e174..3432937062 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -64,6 +64,7 @@ typedef struct {
 } Scheduler_priority_Per_thread;
 
 /**
+ * @brief Initialize Scheduler Priority
  * This routine initializes the priority scheduler.
  */
 void _Scheduler_priority_Initialize(void);
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index 6716383205..66b4018b50 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -93,6 +93,7 @@ void _Scheduler_simple_Block(
 );
 
 /**
+ *  @brief Scheduler Simple Handler / 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/thread.h b/cpukit/score/include/rtems/score/thread.h
index 845b6e0723..623b56251f 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -578,6 +578,7 @@ void _Thread_Stack_Free(
 );
 
 /**
+ *  @brief Initialize Thread
  *  This routine initializes the specified the thread.  It allocates
  *  all memory associated with this thread.  It completes by adding
  *  the thread to the local object table so operations on this
@@ -745,11 +746,24 @@ void _Thread_Load_environment(
 );
 
 /**
+ *  @brief Thread Handler
  *  This routine is the wrapper function for all threads.  It is
  *  the starting point for all threads.  The user provided thread
  *  entry point is invoked by this routine.  Operations
  *  which must be performed immediately before and after the user's
  *  thread executes are found here.
+ *
+ *  NOTE:
+ *
+ *  On entry, it is assumed all interrupts are blocked and that this
+ *  routine needs to set the initial isr level.  This may or may not
+ *  actually be needed by the context switch routine and as a result
+ *  interrupts may already be at there proper level.  Either way,
+ *  setting the initial isr level properly here is safe.
+ *
+ *  Input parameters:   NONE
+ *
+ *  Output parameters:  NONE
  */
 void _Thread_Handler( void );
 
@@ -826,6 +840,7 @@ void *_Thread_Idle_body(
 typedef void (*rtems_per_thread_routine)( Thread_Control * );
 
 /**
+ *  @brief Iterates Over All Threads
  *  This routine iterates over all threads regardless of API and
  *  invokes the specified routine.
  */