diff options
Diffstat (limited to 'cpukit/sapi/inline/rtems/timespec.inl')
-rw-r--r-- | cpukit/sapi/inline/rtems/timespec.inl | 165 |
1 files changed, 82 insertions, 83 deletions
diff --git a/cpukit/sapi/inline/rtems/timespec.inl b/cpukit/sapi/inline/rtems/timespec.inl index 9874b65153..659c39fd35 100644 --- a/cpukit/sapi/inline/rtems/timespec.inl +++ b/cpukit/sapi/inline/rtems/timespec.inl @@ -1,9 +1,7 @@ /** - * @file rtems/sapi/timespec.inl + * @file * - * @ingroup - * - * @brief Timespec API. + * @brief Timespec API */ /* @@ -31,14 +29,14 @@ */ /** - * @brief Is Timespec Valid + * @brief Is timespec valid * - * This method determines the validity of a timespec. + * This method determines the validity of a timespec. * - * @param[in] time is the timespec instance to validate. + * @param[in] time is the timespec instance to validate. * - * @return This method returns true if @a time is valid and - * false otherwise. + * @retval true The timespec is valid. + * @retval false The timespec is not valid. */ RTEMS_INLINE_ROUTINE bool rtems_timespec_is_valid( const struct timespec *time @@ -48,15 +46,16 @@ RTEMS_INLINE_ROUTINE bool rtems_timespec_is_valid( } /** - * @brief Timespec Less Than Operator + * @brief Timespec less than operator. * - * This method is the less than operator for timespecs. + * This method is the less than operator for timespecs. * - * @param[in] lhs is the left hand side timespec - * @param[in] rhs is the right hand side timespec + * @param[in] lhs is the left hand side timespec + * @param[in] rhs is the right hand side timespec * - * @return This method returns true if @a lhs is less than the @a rhs and - * false otherwise. + * @retval true @a lhs is less than @a rhr. + * @retval false @a lhs is not less than @a rhr. + * */ RTEMS_INLINE_ROUTINE bool rtems_timespec_less_than( const struct timespec *lhs, @@ -67,15 +66,15 @@ RTEMS_INLINE_ROUTINE bool rtems_timespec_less_than( } /** - * @brief Add to a Timespec + * @brief Add to a timespec. * - * This routine adds two timespecs. The second argument is added - * to the first. + * This routine adds two timespecs. The second argument is added + * to the first. * - * @param[in] time is the base time to be added to - * @param[in] add is the timespec to add to the first argument + * @param[in] time is the base time to be added to + * @param[in] add is the timespec to add to the first argument * - * @return This method returns the number of seconds @a time increased by. + * @return This method returns the number of seconds @a time increased by. */ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_add_to( struct timespec *time, @@ -86,14 +85,14 @@ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_add_to( } /** - * @brief Convert Timespec to Number of Ticks + * @brief Convert timespec to number of ticks. * - * This routine convert the @a time timespec to the corresponding number - * of clock ticks. + * This routine convert the @a time timespec to the corresponding number + * of clock ticks. * - * @param[in] time is the time to be converted + * @param[in] time is the time to be converted * - * @return This method returns the number of ticks computed. + * @return This method returns the number of ticks computed. */ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_to_ticks( const struct timespec *time @@ -103,13 +102,13 @@ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_to_ticks( } /** - * @brief Convert Ticks to Timespec + * @brief Convert ticks to timespec. * - * This routine converts the @a ticks value to the corresponding - * timespec format @a time. + * This routine converts the @a ticks value to the corresponding + * timespec format @a time. * - * @param[in] time is the timespec format time result - * @param[in] ticks is the number of ticks to convert + * @param[in] time is the timespec format time result + * @param[in] ticks is the number of ticks to convert */ RTEMS_INLINE_ROUTINE void rtems_timespec_from_ticks( @@ -121,16 +120,16 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_from_ticks( } /** - * @brief Subtract Two Timespec + * @brief Subtract two timespec. * - * This routine subtracts two timespecs. @a result is set to - * @a end - @a start. + * This routine subtracts two timespecs. @a result is set to + * @a end - @a start. * - * @param[in] start is the starting time - * @param[in] end is the ending time - * @param[in] result is the difference between starting and ending time. + * @param[in] start is the starting time + * @param[in] end is the ending time + * @param[in] result is the difference between starting and ending time. * - * @return This method fills in @a result. + * @return This method fills in @a result. */ RTEMS_INLINE_ROUTINE void rtems_timespec_subtract( const struct timespec *start, @@ -142,17 +141,17 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_subtract( } /** - * @brief Divide Timespec By Integer + * @brief Divide timespec by integer. * - * This routine divides a timespec by an integer value. The expected - * use is to assist in benchmark calculations where you typically - * divide a duration by a number of iterations. + * This routine divides a timespec by an integer value. The expected + * use is to assist in benchmark calculations where you typically + * divide a duration by a number of iterations. * - * @param[in] time is the total - * @param[in] iterations is the number of iterations - * @param[in] result is the average time. + * @param[in] time is the total + * @param[in] iterations is the number of iterations + * @param[in] result is the average time. * - * @return This method fills in @a result. + * @return This method fills in @a result. */ RTEMS_INLINE_ROUTINE void rtems_timespec_divide_by_integer( const struct timespec *time, @@ -164,17 +163,17 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_divide_by_integer( } /** - * @brief Divide Timespec + * @brief Divide timespec. * - * This routine divides a timespec by another timespec. The - * intended use is for calculating percentages to three decimal points. + * This routine divides a timespec by another timespec. The + * intended use is for calculating percentages to three decimal points. * - * @param[in] lhs is the left hand number - * @param[in] rhs is the right hand number - * @param[in] ival_percentage is the integer portion of the average - * @param[in] fval_percentage is the thousandths of percentage + * @param[in] lhs is the left hand number + * @param[in] rhs is the right hand number + * @param[in] ival_percentage is the integer portion of the average + * @param[in] fval_percentage is the thousandths of percentage * - * @return This method fills in @a result. + * @return This method fills in @a result. */ RTEMS_INLINE_ROUTINE void rtems_timespec_divide( const struct timespec *lhs, @@ -187,14 +186,14 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_divide( } /** - * @brief Set Timespec to Seconds Nanosecond + * @brief Set timespec to seconds nanosecond. * - * This method sets the timespec to the specified seconds and nanoseconds - * value. + * This method sets the timespec to the specified seconds and nanoseconds + * value. * - * @param[in] _time points to the timespec instance to validate. - * @param[in] _seconds is the seconds portion of the timespec - * @param[in] _nanoseconds is the nanoseconds portion of the timespec + * @param[in] _time points to the timespec instance to validate. + * @param[in] _seconds is the seconds portion of the timespec + * @param[in] _nanoseconds is the nanoseconds portion of the timespec */ RTEMS_INLINE_ROUTINE void rtems_timespec_set( struct timespec *_time, @@ -206,12 +205,12 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_set( } /** - * @brief Zero Timespec + * @brief Zero timespec. * - * This method sets the timespec to zero. - * value. + * This method sets the timespec to zero. + * value. * - * @param[in] _time points to the timespec instance to zero. + * @param[in] _time points to the timespec instance to zero. */ RTEMS_INLINE_ROUTINE void rtems_timespec_zero( struct timespec *_time @@ -221,13 +220,13 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_zero( } /** - * @brief Get Seconds Portion of Timespec + * @brief Get seconds portion of timespec. * - * This method returns the seconds portion of the specified timespec + * This method returns the seconds portion of the specified timespec * - * @param[in] _time points to the timespec + * @param[in] _time points to the timespec * - * @return The seconds portion of @a _time. + * @return The seconds portion of @a _time. */ RTEMS_INLINE_ROUTINE time_t rtems_timespec_get_seconds( struct timespec *_time @@ -237,13 +236,13 @@ RTEMS_INLINE_ROUTINE time_t rtems_timespec_get_seconds( } /** - * @brief Get Nanoseconds Portion of Timespec + * @brief Get nanoseconds portion of timespec. * - * This method returns the nanoseconds portion of the specified timespec + * This method returns the nanoseconds portion of the specified timespec * - * @param[in] _time points to the timespec + * @param[in] _time points to the timespec * - * @return The nanoseconds portion of @a _time. + * @return The nanoseconds portion of @a _time. */ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_get_nanoseconds( struct timespec *_time @@ -254,15 +253,15 @@ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_get_nanoseconds( /** - * @brief Timespec Greater Than Operator + * @brief Timespec greater than operator. * - * This method is the greater than operator for timespecs. + * This method is the greater than operator for timespecs. * - * @param[in] lhs is the left hand side timespec - * @param[in] rhs is the right hand side timespec + * @param[in] lhs is the left hand side timespec + * @param[in] rhs is the right hand side timespec * - * @return This method returns true if @a lhs is greater than the @a rhs and - * false otherwise. + * @retval true @a lhs is greater than @a rhr. + * @retval false @a lhs is not greater than @a rhr. */ RTEMS_INLINE_ROUTINE bool rtems_timespec_greater_than( const struct timespec *_lhs, @@ -274,13 +273,13 @@ RTEMS_INLINE_ROUTINE bool rtems_timespec_greater_than( /** * @brief Timespec equal to Operator * - * This method is the is equal to than operator for timespecs. + * This method is the is equal to than operator for timespecs. * - * @param[in] lhs is the left hand side timespec - * @param[in] rhs is the right hand side timespec + * @param[in] lhs is the left hand side timespec + * @param[in] rhs is the right hand side timespec * - * @return This method returns true if @a lhs is equal to @a rhs and - * false otherwise. + * @retval true @a lhs is equal to @a rhr. + * @retval false @a lhs is not equal to @a rhr. */ RTEMS_INLINE_ROUTINE bool rtems_timespec_equal_to( const struct timespec *lhs, |