diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-02 10:03:09 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 10:03:09 -0600 |
| commit | 52adc808422cf415027c07c54910086227bcb973 (patch) | |
| tree | 74d6da54a3d4ca2cc9f41dd93bf482f9c44a77ef /cpukit/rtems/include/rtems/rtems/timer.h | |
| parent | score misc: Score misc: Clean up Doxygen #11 (GCI 2012) (diff) | |
| download | rtems-52adc808422cf415027c07c54910086227bcb973.tar.bz2 | |
score misc: Clean up Doxygen #12 (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/8025203
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/timer.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index c0e1e5ba86..ea09bc09d4 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -383,10 +383,16 @@ typedef struct { } rtems_timer_information; /** - * @brief rtems_timer_get_information + * @brief RTEMS Get Timer Information * * This routine implements the rtems_timer_get_information directive. * This directive returns information about the timer. + * + * @param[in] id is the timer id + * @param[in] the_info is the pointer to timer information block + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and + * *the_info region information block filled in */ rtems_status_code rtems_timer_get_information( rtems_id id, |