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/src/timergetinfo.c | |
| 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 'cpukit/rtems/src/timergetinfo.c')
| -rw-r--r-- | cpukit/rtems/src/timergetinfo.c | 26 |
1 files changed, 7 insertions, 19 deletions
diff --git a/cpukit/rtems/src/timergetinfo.c b/cpukit/rtems/src/timergetinfo.c index af24c7a0bd..c6088a1a66 100644 --- a/cpukit/rtems/src/timergetinfo.c +++ b/cpukit/rtems/src/timergetinfo.c @@ -1,7 +1,11 @@ -/* - * Timer Manager - rtems_timer_get_information directive - * +/** + * @file * + * @brief RTEMS Get Timer Information + * @ingroup ClassicTimer + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -23,22 +27,6 @@ #include <rtems/score/tod.h> #include <rtems/score/watchdog.h> -/* - * rtems_timer_get_information - * - * This directive allows a thread to obtain information about a timer. - * - * Input parameters: - * id - timer id - * the_info - pointer to timer information block - * - * Output parameters: - * *the_info - region information block filled in - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - * - */ - rtems_status_code rtems_timer_get_information( rtems_id id, rtems_timer_information *the_info |