Changeset 4a693e7 in rtems


Ignore:
Timestamp:
Apr 18, 2019, 6:12:07 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
5c91b54b
Parents:
1b5ba76
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/18/19 06:12:07)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

doxygen: score: adjust doc in timestampimpl.h to doxygen guidelines

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/timestampimpl.h

    r1b5ba76 r4a693e7  
    11/**
    2  *  @file
    3  *
    4  *  @brief Helpers for Manipulating Timestamps
    5  *
    6  *  This include file contains helpers for manipulating timestamps.
     2 * @file
     3 *
     4 * @ingroup SuperCoreTimeStamp
     5 *
     6 * @brief Helpers for Manipulating Timestamps
     7 *
     8 * This include file contains helpers for manipulating timestamps.
    79 */
    810
     
    3537
    3638/**
    37  *  @brief Set timestamp to specified seconds and nanoseconds.
    38  *
    39  *  This method sets the timestamp to the specified @a _seconds and @a _nanoseconds
    40  *  value.
    41  *
    42  *  @param[in] _time points to the timestamp instance to validate.
    43  *  @param[in] _seconds is the seconds portion of the timestamp
    44  *  @param[in] _nanoseconds is the nanoseconds portion of the timestamp
     39 * @brief Sets timestamp to specified seconds and nanoseconds.
     40 *
     41 * This method sets the timestamp to the specified @a _seconds and @a _nanoseconds
     42 * value.
     43 *
     44 * @param[out] _time The timestamp instance to set.
     45 * @param _seconds The seconds portion of the timestamp.
     46 * @param _nanoseconds The nanoseconds portion of the timestamp.
    4547 */
    4648RTEMS_INLINE_ROUTINE void _Timestamp_Set(
     
    5961
    6062/**
    61  *  @brief Sets the timestamp to zero.
    62  *
    63  *  This method sets the timestamp to zero.
    64  *  value.
    65  *
    66  *  @param[in] _time points to the timestamp instance to zero.
     63 * @brief Sets the timestamp to zero.
     64 *
     65 * This method sets the timestamp to zero.
     66 * value.
     67 *
     68 * @param[out] _time The timestamp instance to zero.
    6769 */
    6870
     
    7577
    7678/**
    77  *  @brief Less than operator for timestamps.
    78  *
    79  *  This method is the less than operator for timestamps.
    80  *
    81  *  @param[in] _lhs points to the left hand side timestamp
    82  *  @param[in] _rhs points to the right hand side timestamp
    83  *
    84  *  @retval This method returns true if @a _lhs is less than the @a _rhs and
    85  *          false otherwise.
     79 * @brief Checks if the left hand side timestamp is less than the right one.
     80 *
     81 * This method is the less than operator for timestamps.
     82 *
     83 * @param _lhs The left hand side timestamp.
     84 * @param _rhs The right hand side timestamp.
     85 *
     86 * @retval true @a _lhs is less than the @a _rhs.
     87 * @retval false @a _lhs is greater or equal than @a rhs.
    8688 */
    8789
     
    9597
    9698/**
    97  *  @brief Greater than operator for timestamps.
    98  *
    99  *  This method is the greater than operator for timestamps.
    100  *
    101  *  @param[in] _lhs points to the left hand side timestamp
    102  *  @param[in] _rhs points to the right hand side timestamp
    103  *
    104  *  @retval This method returns true if @a _lhs is greater than the @a _rhs and
    105  *          false otherwise.
     99 * @brief Checks if the left hand side timestamp is greater than the right one.
     100 *
     101 * This method is the greater than operator for timestamps.
     102 *
     103 * @param _lhs The left hand side timestamp.
     104 * @param _rhs The right hand side timestamp.
     105 *
     106 * @retval true @a _lhs is greater than the @a _rhs.
     107 * @retval false @a _lhs is less or equal than @a _rhs.
    106108 */
    107109
     
    115117
    116118/**
    117  *  @brief Equal to than operator for timestamps.
    118  *
    119  *  This method is the is equal to than operator for timestamps.
    120  *
    121  *  @param[in] _lhs points to the left hand side timestamp
    122  *  @param[in] _rhs points to the right hand side timestamp
    123  *
    124  *  @retval This method returns true if @a _lhs is equal to  @a _rhs and
    125  *          false otherwise.
     119 * @brief Checks if the timestamps are equal.
     120 *
     121 * This method is the is equal to than operator for timestamps.
     122 *
     123 * @param _lhs The left hand side timestamp.
     124 * @param _rhs The right hand side timestamp.
     125 *
     126 * @retval true @a _lhs is equal to  @a _rhs
     127 * @retval false @a _lhs is not equal to @a _rhs.
    126128 */
    127129
     
    135137
    136138/**
    137  *  @brief Adds two timestamps.
    138  *
    139  *  This routine adds two timestamps.  The second argument is added
    140  *  to the first.
    141  *
    142  *  @param[in] _time points to the base time to be added to
    143  *  @param[in] _add points to the timestamp to add to the first argument
     139 * @brief Adds two timestamps.
     140 *
     141 * This routine adds two timestamps.  The second argument is added
     142 * to the first.
     143 *
     144 * @param[in, out] _time The base time to be added to.
     145 * @param _add points The timestamp to add to the first argument.
    144146 */
    145147RTEMS_INLINE_ROUTINE void _Timestamp_Add_to(
     
    152154
    153155/**
    154  *  @brief Subtracts two timestamps.
    155  *
    156  *  This routine subtracts two timestamps.  @a result is set to
    157  *  @a end - @a start.
    158  *
    159  *  @param[in] _start points to the starting time
    160  *  @param[in] _end points to the ending time
    161  *  @param[in] _result points to the difference between
    162  *             starting and ending time.
    163  *
    164  *  @retval This method fills in @a _result.
     156 * @brief Subtracts two timestamps.
     157 *
     158 * This routine subtracts two timestamps.  @a result is set to
     159 * @a end - @a start.
     160 *
     161 * @param _start The starting time.
     162 * @param _end The ending time.
     163 * @param[out] _result Contains the difference between starting and ending
     164 *      time after the method call.
    165165 */
    166166RTEMS_INLINE_ROUTINE void _Timestamp_Subtract(
     
    174174
    175175/**
    176  *  @brief Divides a timestamp by another timestamp.
    177  *
    178  *  This routine divides a timestamp by another timestamp.  The
    179  *  intended use is for calculating percentages to three decimal points.
    180  *
    181  *  @param[in] _lhs points to the left hand number
    182  *  @param[in] _rhs points to the right hand number
    183  *  @param[in] _ival_percentage points to the integer portion of the average
    184  *  @param[in] _fval_percentage points to the thousandths of percentage
    185  *
    186  *  @retval This method fills in @a result.
     176 * @brief Divides a timestamp by another timestamp.
     177 *
     178 * This routine divides a timestamp by another timestamp.  The
     179 * intended use is for calculating percentages to three decimal points.
     180 *
     181 * @param _lhs The left hand number.
     182 * @param _rhs The right hand number.
     183 * @param[out] _ival_percentage The integer portion of the average.
     184 * @param[out] _fval_percentage The thousandths of percentage.
    187185 */
    188186RTEMS_INLINE_ROUTINE void _Timestamp_Divide(
     
    208206
    209207/**
    210  *  @brief Get seconds portion of timestamp.
    211  *
    212  *  This method returns the seconds portion of the specified timestamp
    213  *
    214  *  @param[in] _time points to the timestamp
    215  *
    216  *  @retval The seconds portion of @a _time.
     208 * @brief Gets seconds portion of timestamp.
     209 *
     210 * This method returns the seconds portion of the specified timestamp.
     211 *
     212 * @param _time The timestamp.
     213 *
     214 * @return The seconds portion of @a _time.
    217215 */
    218216RTEMS_INLINE_ROUTINE time_t _Timestamp_Get_seconds(
     
    224222
    225223/**
    226  *  @brief Get nanoseconds portion of timestamp.
    227  *
    228  *  This method returns the nanoseconds portion of the specified timestamp
    229  *
    230  *  @param[in] _time points to the timestamp
    231  *
    232  *  @retval The nanoseconds portion of @a _time.
     224 * @brief Gets nanoseconds portion of timestamp.
     225 *
     226 * This method returns the nanoseconds portion of the specified timestamp.
     227 *
     228 * @param _time The timestamp.
     229 *
     230 * @return The nanoseconds portion of @a _time.
    233231 */
    234232RTEMS_INLINE_ROUTINE uint32_t _Timestamp_Get_nanoseconds(
     
    244242
    245243/**
    246  *  @brief Get the timestamp as nanoseconds.
    247  *
    248  *  This method returns the timestamp as nanoseconds.
    249  *
    250  *  @param[in] _time points to the timestamp
    251  *
    252  *  @retval The time in nanoseconds.
     244 * @brief Gets the timestamp as nanoseconds.
     245 *
     246 * This method returns the timestamp as nanoseconds.
     247 *
     248 * @param _time The timestamp.
     249 *
     250 * @return The time in nanoseconds.
    253251 */
    254252RTEMS_INLINE_ROUTINE uint64_t _Timestamp_Get_as_nanoseconds(
     
    264262
    265263/**
    266  *  @brief Convert timestamp to struct timespec.
    267  *
    268  *  This method returns the seconds portion of the specified @a _timestamp.
    269  *
    270  *  @param[in] _timestamp points to the timestamp
    271  *  @param[in] _timespec points to the timespec
     264 * @brief Converts timestamp to struct timespec.
     265 *
     266 * @param _timestamp The timestamp.
     267 * @param[out] _timespec The timespec to be filled in by the method.
    272268 */
    273269RTEMS_INLINE_ROUTINE void _Timestamp_To_timespec(
     
    280276
    281277/**
    282  *  @brief Convert timestamp to struct timeval.
    283  *
    284  *  @param[in] _timestamp points to the timestamp
    285  *  @param[in] _timeval points to the timeval
     278 * @brief Converts timestamp to struct timeval.
     279 *
     280 * @param _timestamp The timestamp.
     281 * @param[out] _timeval The timeval to be filled in by the method.
    286282 */
    287283RTEMS_INLINE_ROUTINE void _Timestamp_To_timeval(
     
    297293#endif
    298294
    299 /**@}*/
     295/** @} */
    300296
    301297#endif
Note: See TracChangeset for help on using the changeset viewer.