diff options
author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-11-29 13:39:17 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-29 13:39:17 -0600 |
commit | 1b4758602f55e215f02e384d459c3319c6e1abab (patch) | |
tree | 8305bbedfdfec434394affeb87b86584320ea2e1 /cpukit/score/include/rtems/score/schedulersimple.h | |
parent | score misc: Score misc: Clean up Doxygen #5 (diff) | |
download | rtems-1b4758602f55e215f02e384d459c3319c6e1abab.tar.bz2 |
score misc: Score misc: Clean up Doxygen #6 (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/7976215
Diffstat (limited to 'cpukit/score/include/rtems/score/schedulersimple.h')
-rw-r--r-- | cpukit/score/include/rtems/score/schedulersimple.h | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h index 97b571d6a6..d04dc6c6ff 100644 --- a/cpukit/score/include/rtems/score/schedulersimple.h +++ b/cpukit/score/include/rtems/score/schedulersimple.h @@ -50,7 +50,9 @@ extern "C" { } /** - * This routine initializes the simple scheduler. + * @brief Initializes simple scheduler + * + * This routine initializes the simple scheduler. */ void _Scheduler_simple_Initialize( void ); @@ -100,6 +102,8 @@ void _Scheduler_simple_Unblock( ); /** + * @brief Removes a thread from a simple queue + * * This routine removes a specific thread from the specified * simple-based ready queue. * @@ -110,9 +114,11 @@ void _Scheduler_simple_Extract( ); /** + * @brief Puts thread onto the ready queue + * * This routine puts @a the_thread on to the ready queue. * - * @param[in] the_thread is the thread to be blocked + * @param[in] the_thread is the thread to be enqueued */ void _Scheduler_simple_Enqueue( Thread_Control *the_thread @@ -131,6 +137,8 @@ void _Scheduler_simple_Enqueue_first( ); /** + * @brief Returns empty placeholder for scheduler + * * This routine is a place holder for any memeory allocation needed * by the scheduler. For the simple scheduler the routine is an empty * place holder. @@ -146,9 +154,10 @@ void *_Scheduler_simple_Allocate( ); /** - * This routine does nothing, and is used as a stub for Schedule update + * @breif Stub for schedule update * - * The overhead of a function call will still be imposed. + * This routine does nothing, and is used as a stub for Schedule update + * The overhead of a function call will still be imposed. * * @param[in] the_thread is the thread to be blocked */ @@ -157,9 +166,10 @@ void _Scheduler_simple_Update( ); /** - * This routine does nothing, and is used as a stub for Schedule free + * @brief Stub for schedule free * - * The overhead of a function call will still be imposed. + * This routine does nothing, and is used as a stub for Schedule free + * The overhead of a function call will still be imposed. * * @param[in] the_thread is the thread to be blocked */ |