diff options
| author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-11-29 13:39:17 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-29 13:39:17 -0600 |
| commit | 1b4758602f55e215f02e384d459c3319c6e1abab (patch) | |
| tree | 8305bbedfdfec434394affeb87b86584320ea2e1 /cpukit/score/include/rtems/score/tod.h | |
| parent | score misc: Score misc: Clean up Doxygen #5 (diff) | |
| download | rtems-1b4758602f55e215f02e384d459c3319c6e1abab.tar.bz2 | |
score misc: Score misc: Clean up Doxygen #6 (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/7976215
Diffstat (limited to 'cpukit/score/include/rtems/score/tod.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/tod.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h index 1f04801578..5d10a509e0 100644 --- a/cpukit/score/include/rtems/score/tod.h +++ b/cpukit/score/include/rtems/score/tod.h @@ -173,10 +173,12 @@ SCORE_EXTERN TOD_Control _TOD; void _TOD_Handler_initialization(void); /** - * @brief Sets the time of day according to @a tod_as_timestamp. + * @brief Sets the time of day from timestamp * * The @a tod_as_timestamp timestamp represents the time since UNIX epoch. * The watchdog seconds chain will be adjusted. + * + * @param[in] tod_as_timestamp is the constant of the time of day as a timestamp */ void _TOD_Set_with_timestamp( const Timestamp_Control *tod_as_timestamp @@ -251,6 +253,8 @@ void _TOD_Get_uptime_as_timespec( ); /** + * @brief Increments time of day at each clock tick + * * This routine increments the ticks field of the current time of * day at each clock tick. */ |