score: Doxygen Clean Up Task #2

1 files changed, 16 insertions, 14 deletions

diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h
index eb743b737a..6213e51da5 100644
--- a/cpukit/score/include/rtems/score/tod.h
+++ b/cpukit/score/include/rtems/score/tod.h
@@ -1,6 +1,8 @@
 /**
  *  @file  rtems/score/tod.h
  *
+ *  @brief Constants and Structures Associated with the Time of Day Handler.
+ *
  *  This include file contains all the constants and structures associated
  *  with the Time of Day Handler.
  */
@@ -105,7 +107,7 @@ extern "C" {
   (4 * TOD_SECONDS_PER_DAY))
 
 /**
- *  @brief RTEMS Epoch Year
+ *  @brief Earliest year to which an time of day can be initialized.
  *
  *  The following constant define the earliest year to which an
  *  time of day can be initialized.  This is considered the
@@ -157,7 +159,7 @@ typedef struct {
 SCORE_EXTERN TOD_Control _TOD;
 
 /**
- *  @brief Seconds Since RTEMS Epoch
+ *  @brief Number of seconds Since RTEMS epoch.
  *
  *  The following contains the number of seconds from 00:00:00
  *  January 1, TOD_BASE_YEAR until the current time of day.
@@ -166,14 +168,14 @@ SCORE_EXTERN TOD_Control _TOD;
   _Timestamp_Get_seconds(&_TOD.now)
 
 /**
- *  @brief Initializes the Time of Day Handler
+ *  @brief Initializes the time of day handler.
  *
  *  Performs the initialization necessary for the Time Of Day handler.
  */
 void _TOD_Handler_initialization(void);
 
 /**
- *  @brief Sets the time of day from timestamp
+ *  @brief Sets the time of day from timestamp.
  *
  *  The @a tod_as_timestamp timestamp represents the time since UNIX epoch.
  *  The watchdog seconds chain will be adjusted.
@@ -206,7 +208,7 @@ static inline void _TOD_Set(
  *  @param[out] snapshot The snapshot.
  *  @param[in] source The clock.
  *
- *  @return The snapshot.
+ *  @retval The snapshot.
  */
 Timestamp_Control *_TOD_Get_with_nanoseconds(
   Timestamp_Control *snapshot,
@@ -226,7 +228,7 @@ static inline void _TOD_Get(
 }
 
 /**
- *  @brief _TOD_Get_uptime
+ *  @brief Gets the system uptime with potential accuracy to the nanosecond.
  *
  *  This routine returns the system uptime with potential accuracy
  *  to the nanosecond.
@@ -241,7 +243,7 @@ static inline void _TOD_Get_uptime(
 }
 
 /**
- *  @brief _TOD_Get_uptime_as_timespec
+ *  @brief Gets the system uptime with potential accuracy to the nanosecond.
  *
  *  This routine returns the system uptime with potential accuracy
  *  to the nanosecond.
@@ -253,7 +255,7 @@ void _TOD_Get_uptime_as_timespec(
 );
 
 /**
- *  @brief Increments time of day at each clock tick
+ *  @brief Increments time of day at each clock tick.
  *
  *  This routine increments the ticks field of the current time of
  *  day at each clock tick.
@@ -261,7 +263,7 @@ void _TOD_Get_uptime_as_timespec(
 void _TOD_Tickle_ticks( void );
 
 /**
- *  @brief TOD_MILLISECONDS_TO_MICROSECONDS
+ *  @brief Converts an interval expressed in milliseconds to microseconds.
  *
  *  This routine converts an interval expressed in milliseconds to microseconds.
  *
@@ -270,7 +272,7 @@ void _TOD_Tickle_ticks( void );
 #define TOD_MILLISECONDS_TO_MICROSECONDS(_ms) ((uint32_t)(_ms) * 1000L)
 
 /**
- *  @brief Converts microseconds to ticks
+ *  @brief Converts an interval expressed in microseconds to ticks.
  *
  *  This routine converts an interval expressed in microseconds to ticks.
  *
@@ -281,7 +283,7 @@ uint32_t TOD_MICROSECONDS_TO_TICKS(
 );
 
 /**
- *  @brief TOD_MILLISECONDS_TO_TICKS
+ *  @brief Converts an interval expressed in milliseconds to ticks.
  *
  *  This routine converts an interval expressed in milliseconds to ticks.
  *
@@ -292,7 +294,7 @@ uint32_t TOD_MILLISECONDS_TO_TICKS(
 );
 
 /**
- *  @brief How many ticks in a second?
+ *  @brief Gets number of ticks in a second.
  *
  *  This method returns the number of ticks in a second.
  *
@@ -302,7 +304,7 @@ uint32_t TOD_MILLISECONDS_TO_TICKS(
 uint32_t TOD_TICKS_PER_SECOND_method(void);
 
 /**
- *  @brief Method to return number of ticks in a second
+ *  @brief Gets number of ticks in a second.
  *
  *  This method exists to hide the fact that TOD_TICKS_PER_SECOND can not
  *  be implemented as a macro in a .h file due to visibility issues.
@@ -322,4 +324,4 @@ uint32_t TOD_TICKS_PER_SECOND_method(void);
 /**@}*/
 
 #endif
-/* end of include file */
+/* end of include file */
\ No newline at end of file