diff options
author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-12-01 09:47:07 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-01 09:47:07 -0500 |
commit | f839bf5ae259fe53353a00046adf2c9413df502a (patch) | |
tree | e636813af9a1b5af09df27c1a9a07873cb56a565 /cpukit/score/include/rtems/score/schedulercbs.h | |
parent | Print MCSR and ESR. (diff) | |
download | rtems-f839bf5ae259fe53353a00046adf2c9413df502a.tar.bz2 |
score misc: Score misc: Clean up Doxygen #10 (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/7983216
Diffstat (limited to 'cpukit/score/include/rtems/score/schedulercbs.h')
-rw-r--r-- | cpukit/score/include/rtems/score/schedulercbs.h | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h index f4494d0360..d0bc5ee109 100644 --- a/cpukit/score/include/rtems/score/schedulercbs.h +++ b/cpukit/score/include/rtems/score/schedulercbs.h @@ -131,18 +131,17 @@ typedef struct { extern Scheduler_CBS_Server **_Scheduler_CBS_Server_list; /** - * @brief Scheduler CBS Unblock + * @brief Unblocks a Thread from the Queue * * 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. + * variables, for example the heir thread. It is checked whether the + * remaining budget is sufficient. If not, the thread continues as a + * new job in order to protect concurrent threads. * - * It is checked whether the remaining budget is sufficient. If not, the - * thread continues as a new job in order to protect concurrent threads. + * @param[in] the_thread will be unblocked. * * @note This has to be asessed as missed deadline of the current job. - * - * @param[in] the_thread will be unblocked. */ void _Scheduler_CBS_Unblock( Thread_Control *the_thread @@ -301,10 +300,13 @@ int _Scheduler_CBS_Get_server_id ( ); /** - * @brief _Scheduler_CBS_Set_parameters + * @brief Set Parameters for CBS Scheduling * * Change CBS scheduling parameters. * + * @param[in] server_id is the ID of the server. + * @param[in] parameters are the parameters to set. + * * @return status code. */ int _Scheduler_CBS_Set_parameters ( |