score misc: Score misc: Clean up Doxygen #5

9 files changed, 66 insertions, 6 deletions

diff --git a/cpukit/score/include/rtems/bspsmp.h b/cpukit/score/include/rtems/bspsmp.h
index 05dc9d16b8..9c040efeda 100644
--- a/cpukit/score/include/rtems/bspsmp.h
+++ b/cpukit/score/include/rtems/bspsmp.h
@@ -143,6 +143,8 @@ int   bsp_smp_processor_id( void );
 void bsp_smp_secondary_cpu_initialize(int cpu);
 
 /**
+ *  @brief RTEMS SMP Secondary CPU Initialize
+ *
  *  This method is the C entry point which secondary CPUs should
  *  arrange to call.  It performs OS initialization for the secondary
  *  CPU and coordinates bring it to a useful state.
@@ -162,6 +164,8 @@ void rtems_smp_secondary_cpu_initialize(void);
 void rtems_smp_initialize_per_cpu(int cpu);
 
 /**
+ *  @brief RTEMS SMP Proccess Interrupt
+ *
  *  This is the method called by the BSP's interrupt handler
  *  to process the incoming interprocessor request. 
  */
diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h
index c864685689..fccebbf57c 100644
--- a/cpukit/score/include/rtems/score/coremsg.h
+++ b/cpukit/score/include/rtems/score/coremsg.h
@@ -288,6 +288,11 @@ bool _CORE_message_queue_Initialize(
 
 /**
  *  @brief Close 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 function closes a message by returning all allocated space and
  *  flushing @a the_message_queue's task wait queue.
@@ -306,6 +311,11 @@ void _CORE_message_queue_Close(
 
 /**
  *  @brief Flush Pending Messages
+ * 
+ *  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 function flushes @a the_message_queue's pending message queue.  The
  *  number of messages flushed from the queue is returned.
@@ -349,6 +359,11 @@ uint32_t   _CORE_message_queue_Flush_support(
 
 /**
  *  @brief Broadcast a Message to the 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 function sends a message for every thread waiting on the queue and
  *  returns the number of threads made ready by the message.
@@ -412,6 +427,11 @@ CORE_message_queue_Status _CORE_message_queue_Submit(
 
 /**
  *  @brief Size a Message from the 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 kernel routine dequeues a message, copies the message buffer to
  *  a given destination buffer, and frees the message buffer to the
@@ -432,6 +452,10 @@ CORE_message_queue_Status _CORE_message_queue_Submit(
  *
  *  @return indication of the successful completion or reason for failure
  *  @note Returns message priority via return are in TCB.
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + available
+ *    + wait
  */
 void _CORE_message_queue_Seize(
   CORE_message_queue_Control      *the_message_queue,
diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index c8d7deb703..243d0093a2 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -189,6 +189,13 @@ CORE_semaphore_Status _CORE_semaphore_Surrender(
 );
 
 /**
+ *  @brief Core Semaphore Flush
+ * 
+ *  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 assists in the deletion of a semaphore by flushing the
  *  associated wait queue.
  *
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 1dec9930d1..56dedd9812 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -752,6 +752,8 @@ 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.
diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h
index a70f55b27b..1751ad13f9 100644
--- a/cpukit/score/include/rtems/score/schedulercbs.h
+++ b/cpukit/score/include/rtems/score/schedulercbs.h
@@ -175,7 +175,7 @@ void _Scheduler_CBS_Release_job (
 int _Scheduler_CBS_Initialize(void);
 
 /**
- *  @brief _Scheduler_CBS_Attach_thread
+ *  @brief Attach Scheduler CBS Thread
  *
  *  Attach a task to an already existing server.
  *
@@ -284,7 +284,7 @@ int _Scheduler_CBS_Get_parameters (
 );
 
 /**
- *  @brief _Scheduler_CBS_Get_server_id
+ *  @brief Scheduler CBS Get Server id
  *
  *  Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not
  *  attached to any server.
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index 844d043eb4..0e4d52eec5 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -136,6 +136,8 @@ void _Scheduler_priority_Unblock(
 );
 
 /**
+ *  @brief Scheduler Priority Yield
+ *
  *  This routine is invoked when a thread wishes to voluntarily
  *  transfer control of the processor to another thread in the queue.
  *
@@ -145,6 +147,10 @@ void _Scheduler_priority_Unblock(
  *  reset is true and this is the only thread on the queue then the
  *  timeslice counter is reset.  The heir THREAD will be updated if the
  *  running is also the currently the heir.
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + ready chain
+ *    + select heir
  */
 void _Scheduler_priority_Yield( void );
 
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index 1c8723f70a..966867a1d3 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -510,6 +510,8 @@ SCORE_EXTERN struct _reent **_Thread_libc_reent;
 void _Thread_Handler_initialization(void);
 
 /**
+ *  @brief Create Idle Thread
+ *
  *  This routine creates the idle thread.
  *
  *  @warning No thread should be created before this one.
@@ -517,9 +519,16 @@ void _Thread_Handler_initialization(void);
 void _Thread_Create_idle(void);
 
 /**
+ *  @brief Start Thread Multitasking
+ *
  *  This routine initiates multitasking.  It is invoked only as
  *  part of initialization and its invocation is the last act of
  *  the non-multitasking part of the system initialization.
+ * 
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + ready chain
+ *    + select heir
  */
 void _Thread_Start_multitasking( void );
 
@@ -560,6 +569,8 @@ size_t _Thread_Stack_Allocate(
 );
 
 /**
+ *  @brief Deallocate Thread Stack
+ * 
  *  Deallocate the Thread's stack.
  */
 void _Thread_Stack_Free(
@@ -655,9 +666,15 @@ void _Thread_Ready(
 );
 
 /**
+ *  @brief Clear Thread state
+ *
  *  This routine clears the indicated STATES for @a the_thread.  It performs
  *  any necessary scheduling operations including the selection of
  *  a new heir thread.
+ * 
+ *  - INTERRUPT LATENCY:
+ *    + priority map
+ *    + select heir
  */
 void _Thread_Clear_state(
   Thread_Control *the_thread,
diff --git a/cpukit/score/include/rtems/score/threadmp.h b/cpukit/score/include/rtems/score/threadmp.h
index 4814098b70..eba713ca57 100644
--- a/cpukit/score/include/rtems/score/threadmp.h
+++ b/cpukit/score/include/rtems/score/threadmp.h
@@ -32,7 +32,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief _Thread_MP_Handler_initialization
+ *  @brief MP Thread Handler Initialization
  *
  *  This routine initializes the multiprocessing portion of the Thread Handler.
  */
@@ -41,7 +41,7 @@ void _Thread_MP_Handler_initialization (
 );
 
 /**
- *  @brief _Thread_MP_Allocate_proxy
+ *  @brief MP Thread Proxy Allocate
  *
  *  This  allocates a proxy control block from
  *  the inactive chain of free proxy control blocks.
@@ -54,7 +54,7 @@ Thread_Control *_Thread_MP_Allocate_proxy (
 );
 
 /**
- *  @brief _Thread_MP_Find_proxy
+ *  @brief MP Thread Proxy Find
  *
  *  This function removes the proxy control block for the specified
  *  id from the active chain of proxy control blocks.
diff --git a/cpukit/score/include/rtems/score/timespec.h b/cpukit/score/include/rtems/score/timespec.h
index 39394ff3da..4e0c6e8e1c 100644
--- a/cpukit/score/include/rtems/score/timespec.h
+++ b/cpukit/score/include/rtems/score/timespec.h
@@ -103,7 +103,7 @@ bool _Timespec_Is_valid(
 );
 
 /**
- * @brief Timespec Less Than Operator
+ *  @brief Timespec Less Than Operator
  *
  *  This method is the less than operator for timespecs.
  *