diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-04 17:59:11 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-04 17:59:11 -0500 |
| commit | c18e0ba12799ea40693428b0a731bb561e61cab0 (patch) | |
| tree | 20e76592df6ad8f0ae2efb5c27f0b6870a33086e /cpukit/rtems/src/clockget.c | |
| parent | cpukit: Clean up Doxygen #3 (GCI 2012) (diff) | |
| download | rtems-c18e0ba12799ea40693428b0a731bb561e61cab0.tar.bz2 | |
rtems misc: Clean up Doxygen GCI Task #4
http://www.google-melange.com/gci/task/view/google/gci2012/7950205
Diffstat (limited to 'cpukit/rtems/src/clockget.c')
| -rw-r--r-- | cpukit/rtems/src/clockget.c | 26 |
1 files changed, 7 insertions, 19 deletions
diff --git a/cpukit/rtems/src/clockget.c b/cpukit/rtems/src/clockget.c index 476d046fbd..45f4c299e1 100644 --- a/cpukit/rtems/src/clockget.c +++ b/cpukit/rtems/src/clockget.c @@ -1,6 +1,11 @@ -/* - * Clock Manager +/** + * @file * + * @brief Obtain Current Time of Day + * @ingroup ClassicClock + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * @@ -21,23 +26,6 @@ #include <rtems/score/tod.h> #include <rtems/score/watchdog.h> -/* - * rtems_clock_get - * - * This directive returns the current date and time. If the time has - * not been set by a tm_set then an error is returned. - * - * Input parameters: - * option - which value to return - * time_buffer - pointer to output buffer (a time and date structure - * or an interval) - * - * Output parameters: - * time_buffer - output filled in - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_clock_get( rtems_clock_get_options option, void *time_buffer |