summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/tod.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-01-29 23:58:17 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-01-29 23:58:17 +0000
commit18ca4e8b7083e8229c0b628ba3d30778de6d8f9b (patch)
treea5b0295e8a604544545c4929bfbaa3fbb328e3e1 /cpukit/score/include/rtems/score/tod.h
parent2008-01-29 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-18ca4e8b7083e8229c0b628ba3d30778de6d8f9b.tar.bz2
2008-01-29 Joel Sherrill <joel.sherrill@oarcorp.com>
* score/Doxyfile: Update to latest Doxygen format. * score/include/rtems/score/apimutex.h, score/include/rtems/score/corebarrier.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/corerwlock.h, score/include/rtems/score/heap.h, score/include/rtems/score/object.h, score/include/rtems/score/protectedheap.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadsync.h, score/include/rtems/score/tod.h, score/inline/rtems/score/corerwlock.inl, score/inline/rtems/score/corespinlock.inl: Remove most doxygen warnings.
Diffstat (limited to 'cpukit/score/include/rtems/score/tod.h')
-rw-r--r--cpukit/score/include/rtems/score/tod.h25
1 files changed, 13 insertions, 12 deletions
diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h
index f98c2c49fd..93cd2cb514 100644
--- a/cpukit/score/include/rtems/score/tod.h
+++ b/cpukit/score/include/rtems/score/tod.h
@@ -6,7 +6,7 @@
*/
/*
- * COPYRIGHT (c) 1989-2007.
+ * COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,13 +19,6 @@
#ifndef _RTEMS_SCORE_TOD_H
#define _RTEMS_SCORE_TOD_H
-/**
- * @defgroup ScoreTOD Time Of Day (TOD) Handler
- *
- * This handler encapsulates functionality used to manage time of day.
- */
-/**@{*/
-
#ifdef __cplusplus
extern "C" {
#endif
@@ -34,7 +27,8 @@ extern "C" {
#include <time.h>
/** @defgroup ScoreTODConstants TOD Constants
- * The following constants are related to the time of day.
+ * The following constants are related to the time of day and are
+ * independent of RTEMS.
*/
/**@{*/
@@ -96,7 +90,9 @@ extern "C" {
*/
#define TOD_NANOSECONDS_PER_MICROSECOND (uint32_t)1000
-/*
+/**@}*/
+
+/**
* Seconds from January 1, 1970 to January 1, 1988. Used to account for
* differences between POSIX API and RTEMS core. The timespec format time
* is kept in POSIX compliant form.
@@ -105,8 +101,6 @@ extern "C" {
(((1987 - 1970 + 1) * TOD_SECONDS_PER_NON_LEAP_YEAR) + \
(4 * TOD_SECONDS_PER_DAY))
-/**@}*/
-
/** @brief Ticks per Second
*
* This macro calculates the number of ticks per second.
@@ -123,6 +117,13 @@ extern "C" {
*/
#define TOD_BASE_YEAR 1988
+/**
+ * @defgroup ScoreTOD Time Of Day (TOD) Handler
+ *
+ * This handler encapsulates functionality used to manage time of day.
+ */
+/**@{*/
+
/** @brief Is the Time Of Day Set
*
* This is TRUE if the application has set the current