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/schedulercbs.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/schedulercbs.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/schedulercbs.h | 8 |
1 files changed, 6 insertions, 2 deletions
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. */ |