summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/tod.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:06 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:47 -0600
commite858f7049c6407648e624cb43a1819237541fd84 (patch)
treeec6a688ecef9bd271eab37ca652dc172935acb1d /cpukit/score/include/rtems/score/tod.h
parentdevfs: Doxygen Warning Removal and Cleanup (diff)
downloadrtems-e858f7049c6407648e624cb43a1819237541fd84.tar.bz2
cpukit: Fix many Doxygen warnings
Diffstat (limited to '')
-rw-r--r--cpukit/score/include/rtems/score/tod.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h
index cfbd00ba52..df73f95970 100644
--- a/cpukit/score/include/rtems/score/tod.h
+++ b/cpukit/score/include/rtems/score/tod.h
@@ -205,10 +205,11 @@ static inline void _TOD_Set(
*
* This function invokes the nanoseconds extension.
*
- * @param[out] snapshot The snapshot.
- * @param[in] source The clock.
+ * @param[out] snapshot points to an area that will contain the current
+ * TOD plus the BSP nanoseconds since last tick adjustment
+ * @param[in] clock contains the current TOD
*
- * @retval The snapshot.
+ * @retval @a snapshot
*/
Timestamp_Control *_TOD_Get_with_nanoseconds(
Timestamp_Control *snapshot,