score: Doxygen Clean Up Task #2

1 files changed, 30 insertions, 28 deletions

diff --git a/cpukit/score/include/rtems/score/timestamp.h b/cpukit/score/include/rtems/score/timestamp.h
index 951c37413d..fb297da06d 100644
--- a/cpukit/score/include/rtems/score/timestamp.h
+++ b/cpukit/score/include/rtems/score/timestamp.h
@@ -1,6 +1,8 @@
 /**
  *  @file  rtems/score/timestamp.h
  *
+ *  @brief Helpers for Manipulating Timestamps
+ *
  *  This include file contains helpers for manipulating timestamps.
  */
 
@@ -73,7 +75,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Set Timestamp to Specified Seconds and Nanoseconds
+ *  @brief Set timestamp to specified seconds and nanoseconds.
  *
  *  This method sets the timestamp to the specified @a _seconds and @a _nanoseconds
  *  value.
@@ -91,7 +93,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Zero Timestamp
+ *  @brief Sets the timestamp to zero.
  *
  *  This method sets the timestamp to zero.
  *  value.
@@ -107,13 +109,13 @@ extern "C" {
 #endif
 
 /**
- *  @brief Is Timestamp Valid
+ *  @brief Determines the validity of a timestamp.
  *
  *  This method determines the validity of a timestamp.
  *
  *  @param[in] _time points to the timestamp instance to validate.
  *
- *  @return This method returns true if @a time is valid and
+ *  @retval This method returns true if @a time is valid and
  *          false otherwise.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
@@ -125,14 +127,14 @@ extern "C" {
 #endif
 
 /**
- *  @brief Timestamp Less Than Operator
+ *  @brief Less than operator for timestamps.
  *
  *  This method is the less than operator for timestamps.
  *
  *  @param[in] _lhs points to the left hand side timestamp
  *  @param[in] _rhs points to the right hand side timestamp
  *
- *  @return This method returns true if @a _lhs is less than the @a _rhs and
+ *  @retval This method returns true if @a _lhs is less than the @a _rhs and
  *          false otherwise.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
@@ -144,28 +146,28 @@ extern "C" {
 #endif
 
 /**
- *  @brief Timestamp Greater Than Operator
+ *  @brief Greater than operator for timestamps.
  *
  *  This method is the greater than operator for timestamps.
  *
  *  @param[in] _lhs points to the left hand side timestamp
  *  @param[in] _rhs points to the right hand side timestamp
  *
- *  @return This method returns true if @a _lhs is greater than the @a _rhs and
+ *  @retval This method returns true if @a _lhs is greater than the @a _rhs and
  *          false otherwise.
  */
 #define _Timestamp_Greater_than( _lhs, _rhs ) \
   _Timestamp_Less_than( _rhs, _lhs )
 
 /**
- *  @brief Timestamp equal to Operator
+ *  @brief Equal to than operator for timestamps.
  *
  *  This method is the is equal to than operator for timestamps.
  *
  *  @param[in] _lhs points to the left hand side timestamp
  *  @param[in] _rhs points to the right hand side timestamp
  *
- *  @return This method returns true if @a _lhs is equal to  @a _rhs and
+ *  @retval This method returns true if @a _lhs is equal to  @a _rhs and
  *          false otherwise.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
@@ -177,7 +179,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Add to a Timestamp
+ *  @brief Adds two timestamps.
  *
  *  This routine adds two timestamps.  The second argument is added
  *  to the first.
@@ -185,7 +187,7 @@ extern "C" {
  *  @param[in] _time points to the base time to be added to
  *  @param[in] _add points to the timestamp to add to the first argument
  *
- *  @return This method returns the number of seconds @a time increased by.
+ *  @retval This method returns the number of seconds @a time increased by.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_Add_to( _time, _add ) \
@@ -196,14 +198,14 @@ extern "C" {
 #endif
 
 /**
- *  @brief Convert Timestamp to Number of Ticks
+ *  @brief Convert timestamp to number of clock ticks.
  *
  *  This routine convert the @a time timestamp to the corresponding number
  *  of clock ticks.
  *
  *  @param[in] _time points to the time to be converted
  *
- *  @return This method returns the number of ticks computed.
+ *  @retval This method returns the number of ticks computed.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_To_ticks( _time ) \
@@ -214,7 +216,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Convert Ticks to Timestamp
+ *  @brief Converts the @a _ticks value to timestamp format.
  *
  *  This routine converts the @a _ticks value to the corresponding
  *  timestamp format @a _time.
@@ -231,7 +233,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Subtract Two Timestamp
+ *  @brief Subtracts two timestamps.
  *
  *  This routine subtracts two timestamps.  @a result is set to
  *  @a end - @a start.
@@ -241,7 +243,7 @@ extern "C" {
  *  @param[in] _result points to the difference between
  *             starting and ending time.
  *
- *  @return This method fills in @a _result.
+ *  @retval This method fills in @a _result.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_Subtract( _start, _end, _result ) \
@@ -252,7 +254,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Divide Timestamp By Integer
+ *  @brief Divides a timestamp by an integer value.
  *
  *  This routine divides a timestamp by an integer value.  The expected
  *  use is to assist in benchmark calculations where you typically
@@ -262,7 +264,7 @@ extern "C" {
  *  @param[in] _iterations is the number of iterations
  *  @param[in] _result points to the average time.
  *
- *  @return This method fills in @a result.
+ *  @retval This method fills in @a result.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_Divide_by_integer( _time, _iterations, _result ) \
@@ -273,7 +275,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Divide Timestamp
+ *  @brief Divides a timestamp by another timestamp.
  *
  *  This routine divides a timestamp by another timestamp.  The
  *  intended use is for calculating percentages to three decimal points.
@@ -283,7 +285,7 @@ extern "C" {
  *  @param[in] _ival_percentage points to the integer portion of the average
  *  @param[in] _fval_percentage points to the thousandths of percentage
  *
- *  @return This method fills in @a result.
+ *  @retval This method fills in @a result.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_Divide( _lhs, _rhs, _ival_percentage, _fval_percentage ) \
@@ -294,13 +296,13 @@ extern "C" {
 #endif
 
 /**
- *  @brief Get Seconds Portion of Timestamp
+ *  @brief Get seconds portion of timestamp.
  *
  *  This method returns the seconds portion of the specified timestamp
  *
  *  @param[in] _time points to the timestamp
  *
- *  @return The seconds portion of @a _time.
+ *  @retval The seconds portion of @a _time.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_Get_seconds( _time ) \
@@ -311,13 +313,13 @@ extern "C" {
 #endif
 
 /**
- *  @brief Get Nanoseconds Portion of Timestamp
+ *  @brief Get nanoseconds portion of timestamp.
  *
  *  This method returns the nanoseconds portion of the specified timestamp
  *
  *  @param[in] _time points to the timestamp
  *
- *  @return The nanoseconds portion of @a _time.
+ *  @retval The nanoseconds portion of @a _time.
  */
 #if CPU_TIMESTAMP_USE_STRUCT_TIMESPEC == TRUE
   #define _Timestamp_Get_nanoseconds( _time ) \
@@ -328,7 +330,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Convert Timestamp to Struct Timespec
+ *  @brief Convert timestamp to struct timespec.
  *
  *  This method returns the seconds portion of the specified @a _timestamp.
  *
@@ -345,7 +347,7 @@ extern "C" {
 #endif
 
 /**
- *  @brief Convert Timestamp to struct timeval
+ *  @brief Convert timestamp to struct timeval.
  *
  *  @param[in] _timestamp points to the timestamp
  *  @param[in] _timeval points to the timeval
@@ -368,4 +370,4 @@ extern "C" {
 /**@}*/
 
 #endif
-/* end of include file */
+/* end of include file */
\ No newline at end of file