diff options
| author | Mathew Kallada <matkallada@gmail.com> | 2012-12-05 19:46:05 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-05 19:46:05 -0500 |
| commit | 4efe1955132708b2e88fd046b04eee00fdad0c38 (patch) | |
| tree | 301f1ef0121164b3fc3e180384594b91fffca1a7 /cpukit/rtems/include/rtems/rtems/ratemon.h | |
| parent | rtems misc: Clean up Doxygen GCI Task #7 (diff) | |
| download | rtems-4efe1955132708b2e88fd046b04eee00fdad0c38.tar.bz2 | |
rtems misc: Clean up Doxygen GCI Task #5
http://www.google-melange.com/gci/task/view/google/gci2012/8015207
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/ratemon.h | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 9b0d1de5f9..799ebbef08 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -50,6 +50,8 @@ * API calls. The statistics kept include minimum, maximum and average times * for both cpu usage and wall time. The statistics indicate the execution time * used by the owning thread between successive calls to rtems_rate_monotonic_period. + * + * Rate Monotonic Manager -- Reset Statistics for All Periods */ /**@{*/ @@ -312,12 +314,12 @@ rtems_status_code rtems_rate_monotonic_ident( * This routine implements the rtems_rate_monotonic_cancel directive. This * directive stops the period associated with ID from continuing to * run. - * + * * @param[in] id is the rate monotonic id - * + * * @return RTEMS_SUCCESSFUL if successful and caller is not the owning thread * or error code if unsuccessful - * + * */ rtems_status_code rtems_rate_monotonic_cancel( rtems_id id @@ -363,10 +365,10 @@ rtems_status_code rtems_rate_monotonic_get_status( * * This routine implements the rtems_rate_monotonic_get_statistics directive. * Statistics gathered from the use of this period are returned. - * + * * @param[in] id is the rate monotonic id * @param[in] statistics is the pointer to statistics control block - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_rate_monotonic_get_statistics( @@ -421,10 +423,10 @@ void rtems_rate_monotonic_report_statistics( void ); * length is non-zero, this directive initiates the period associated with * ID from continuing for a period of length. If length is zero, then * result is set to indicate the current state of the period. - * + * * @param[in] id is the rate monotonic id * @param[in] lenght is the length of period (in ticks) - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_rate_monotonic_period( @@ -441,7 +443,7 @@ rtems_status_code rtems_rate_monotonic_period( * period is restarted. If the owning thread is not waiting for the * period to expire, then the period is placed in the EXPIRED * state and not restarted. - * + * * @param[in] id is the period id */ void _Rate_monotonic_Timeout( |