diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-11-30 15:34:17 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-30 15:35:36 -0600 |
commit | e0f91da505b5c907b545016645c07a3132696236 (patch) | |
tree | a3cbe53af4f52687425266b19082eb42ce34218b /cpukit/score/include/rtems/score/schedulerpriority.h | |
parent | sparc cpu.h: Correct spacing (diff) | |
download | rtems-e0f91da505b5c907b545016645c07a3132696236.tar.bz2 |
score misc: Score misc: Clean up Doxygen #9 (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/7977211
Diffstat (limited to 'cpukit/score/include/rtems/score/schedulerpriority.h')
-rw-r--r-- | cpukit/score/include/rtems/score/schedulerpriority.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h index b8dee43fc1..f959c0e174 100644 --- a/cpukit/score/include/rtems/score/schedulerpriority.h +++ b/cpukit/score/include/rtems/score/schedulerpriority.h @@ -70,7 +70,7 @@ void _Scheduler_priority_Initialize(void); /** * @brief Scheduler priority Block - * + * * This routine removes @a the_thread from the scheduling decision, * that is, removes it from the ready queue. It performs * any necessary scheduling operations including the selection of @@ -103,6 +103,8 @@ void * _Scheduler_priority_Allocate( ); /** + * @brief Free Scheduler Priority + * * This routine frees @a the_thread->scheduler. * * @param[in] the_thread is the thread whose scheduler specific information @@ -113,7 +115,7 @@ void _Scheduler_priority_Free( ); /** - * @brief Update Scheduler priority + * @brief Update Scheduler priority * This routine updates @a the_thread->scheduler based on @a the_scheduler * structures and thread state. * @@ -126,7 +128,7 @@ 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. @@ -149,7 +151,7 @@ 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 @@ -157,6 +159,8 @@ void _Scheduler_priority_Unblock( void _Scheduler_priority_Yield( void ); /** + * @brief Scheduler Priority Enqueue + * * This routine puts @a the_thread on to the priority-based ready queue. * * @param[in] the_thread will be enqueued at the TAIL of its priority. @@ -179,7 +183,7 @@ void _Scheduler_priority_Enqueue_first( ); /** - * @brief Removes a specific thread from scheduler + * @brief Removes a specific thread from scheduler * * This routine removes a specific thread from the scheduler's set * of ready threads. |