diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-05 18:16:48 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-05 18:16:48 -0500 |
commit | a6500136a9f30603f7dff766d7b98766851c7204 (patch) | |
tree | 852061b300cada7facff9025868b143565058dc2 /cpukit/rtems/include/rtems/rtems/timer.h | |
parent | rtems misc: Clean up Doxygen GCI Task #6 (diff) | |
download | rtems-a6500136a9f30603f7dff766d7b98766851c7204.tar.bz2 |
rtems misc: Clean up Doxygen GCI Task #7
http://www.google-melange.com/gci/task/view/google/gci2012/7950206
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/timer.h')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/timer.h | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index b7ab2e2743..5a908eb475 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -275,23 +275,38 @@ rtems_status_code rtems_timer_cancel( ); /** - * @brief rtems_timer_delete + * @brief RTEMS Delete Timer * * This routine implements the rtems_timer_delete directive. The * timer indicated by ID is deleted. + * + * @param[in] id is the timer id + * + * @return This method returns RTEMS_SUCCESSFUL if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ rtems_status_code rtems_timer_delete( rtems_id id ); /** - * @brief rtems_timer_fire_after + * @brief RTEMS Timer Fire After * * This routine implements the rtems_timer_fire_after directive. It * initiates the timer associated with ID to fire in ticks clock ticks. * When the timer fires, the routine will be invoked in the context * of the rtems_clock_tick directive which is normally invoked as * part of servicing a periodic interupt. + * + * @param[in] id is the timer id + * @param[in] ticks is the interval until routine is fired + * @param[in] routine is the routine to schedule + * @param[in] user_data is the passed as argument to routine when it is fired + * + * @return This method returns RTEMS_SUCCESSFUL if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ rtems_status_code rtems_timer_fire_after( rtems_id id, |