[rtems commit] todimpl.h: Add missing Doxygen

Joel Sherrill joel at rtems.org
Thu Jul 24 21:43:48 UTC 2014


Module:    rtems
Branch:    master
Commit:    9113798c830ae122c591fd8600c7bf1be49ed1e7
Changeset: http://git.rtems.org/rtems/commit/?id=9113798c830ae122c591fd8600c7bf1be49ed1e7

Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
Date:      Wed Jul 23 15:39:17 2014 -0500

todimpl.h: Add missing Doxygen

---

 cpukit/score/include/rtems/score/todimpl.h |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/cpukit/score/include/rtems/score/todimpl.h b/cpukit/score/include/rtems/score/todimpl.h
index 68a2d15..ad5ed39 100644
--- a/cpukit/score/include/rtems/score/todimpl.h
+++ b/cpukit/score/include/rtems/score/todimpl.h
@@ -334,6 +334,11 @@ void _TOD_Adjust(
   const Timestamp_Control timestamp
 );
 
+/**
+ * @brief Install the BSP's nanoseconds since clock tick handler
+ *
+ * @param[in] routine is the BSP's nanoseconds since clock tick method 
+ */
 RTEMS_INLINE_ROUTINE void _TOD_Set_nanoseconds_since_last_tick_handler(
   TOD_Nanoseconds_since_last_tick_routine routine
 )
@@ -341,6 +346,11 @@ RTEMS_INLINE_ROUTINE void _TOD_Set_nanoseconds_since_last_tick_handler(
   _TOD.nanoseconds_since_last_tick = routine;
 }
 
+/**
+ * @brief Check if the TOD is Set
+ *
+ * @return TRUE is the time is set. FALSE otherwise.
+ */
 RTEMS_INLINE_ROUTINE bool _TOD_Is_set( void )
 {
   return _TOD.is_set;



More information about the vc mailing list