From 1b4758602f55e215f02e384d459c3319c6e1abab Mon Sep 17 00:00:00 2001 From: Christopher Kerl Date: Thu, 29 Nov 2012 13:39:17 -0600 Subject: 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 --- cpukit/score/include/rtems/score/schedulercbs.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 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 1751ad13f9..f4494d0360 100644 --- a/cpukit/score/include/rtems/score/schedulercbs.h +++ b/cpukit/score/include/rtems/score/schedulercbs.h @@ -259,9 +259,13 @@ int _Scheduler_CBS_Get_remaining_budget ( ); /** - * @brief _Scheduler_CBS_Get_execution_time + * @brief Get relative time info * - * Retrieve time info relative to the current server. + * Retrieve time info relative to @a server_id. The server status code is returned. + * + * @param[in] server_id is the server to get the status code from. + * @param[in] exec_time is the execution time. + * @param[in] abs_time is not apparently used. * * @return status code. */ -- cgit v1.2.3