From f839bf5ae259fe53353a00046adf2c9413df502a Mon Sep 17 00:00:00 2001 From: Christopher Kerl Date: Sat, 1 Dec 2012 09:47:07 -0500 Subject: 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 --- cpukit/score/include/rtems/score/schedulercbs.h | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'cpukit/score/include/rtems/score/schedulercbs.h') 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 ( -- cgit v1.2.3