summaryrefslogtreecommitdiffstats
path: root/c/src/exec/score/inline/tod.inl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--c/src/exec/score/inline/tod.inl14
1 files changed, 14 insertions, 0 deletions
diff --git a/c/src/exec/score/inline/tod.inl b/c/src/exec/score/inline/tod.inl
index dce8aca426..5ed1e76d8f 100644
--- a/c/src/exec/score/inline/tod.inl
+++ b/c/src/exec/score/inline/tod.inl
@@ -21,6 +21,10 @@
*
* _TOD_Is_set
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the application has set the current
+ * time of day, and FALSE otherwise.
*/
STATIC INLINE boolean _TOD_Is_set( void )
@@ -32,6 +36,10 @@ STATIC INLINE boolean _TOD_Is_set( void )
*
* _TOD_Tickle_ticks
*
+ * DESCRIPTION:
+ *
+ * This routine increments the ticks field of the current time of
+ * day at each clock tick.
*/
STATIC INLINE void _TOD_Tickle_ticks( void )
@@ -44,6 +52,9 @@ STATIC INLINE void _TOD_Tickle_ticks( void )
*
* _TOD_Deactivate
*
+ * DESCRIPTION:
+ *
+ * This routine deactivates updating of the current time of day.
*/
STATIC INLINE void _TOD_Deactivate( void )
@@ -55,6 +66,9 @@ STATIC INLINE void _TOD_Deactivate( void )
*
* _TOD_Activate
*
+ * DESCRIPTION:
+ *
+ * This routine activates updating of the current time of day.
*/
STATIC INLINE void _TOD_Activate(