summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/clock.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-05 18:16:48 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-05 18:16:48 -0500
commita6500136a9f30603f7dff766d7b98766851c7204 (patch)
tree852061b300cada7facff9025868b143565058dc2 /cpukit/rtems/include/rtems/rtems/clock.h
parentrtems misc: Clean up Doxygen GCI Task #6 (diff)
downloadrtems-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 '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/clock.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h
index c841d1a4f8..fc6a584ab9 100644
--- a/cpukit/rtems/include/rtems/rtems/clock.h
+++ b/cpukit/rtems/include/rtems/rtems/clock.h
@@ -243,7 +243,7 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime );
time_t rtems_clock_get_uptime_seconds( void );
/**
- * @brief _TOD_Validate
+ * @brief TOD Validate
*
* This support function returns true if @a the_tod contains
* a valid time of day, and false otherwise.
@@ -251,6 +251,8 @@ time_t rtems_clock_get_uptime_seconds( void );
* @param[in] the_tod is the TOD structure to validate
*
* @return This method returns true if the TOD is valid and false otherwise.
+ *
+ * @note This routine only works for leap-years through 2099.
*/
bool _TOD_Validate(
const rtems_time_of_day *the_tod