Changeset 5791a3c in rtems


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

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

Update #3706.

File:
1 edited

Legend:

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

    r5c91b54b r5791a3c  
    3131
    3232/**
    33  *  @defgroup RTEMSScoreTOD Time of Day Handler
    34  *
    35  *  @ingroup RTEMSScore
    36  *
    37  *  The following constants are related to the time of day and are
    38  *  independent of RTEMS.
    39  */
    40 /**@{*/
     33 * @defgroup RTEMSScoreTOD Time of Day Handler
     34 *
     35 * @ingroup RTEMSScore
     36 *
     37 * @brief Time of Day Handler
     38 *
     39 * The following constants are related to the time of day and are
     40 * independent of RTEMS.
     41 *
     42 * @{
     43 */
    4144
    4245/**
     
    119122
    120123/**
    121  *  @addtogroup RTEMSScoreTOD
    122  *
    123  *  This handler encapsulates functionality used to manage time of day.
    124  */
    125 /**@{*/
     124 * @addtogroup RTEMSScoreTOD
     125 *
     126 * This handler encapsulates functionality used to manage time of day.
     127 *
     128 * @{
     129 */
    126130
    127131/**
     
    140144extern TOD_Control _TOD;
    141145
     146/**
     147 * @brief Locks the time of day mutex.
     148 */
    142149void _TOD_Lock( void );
    143150
     151/**
     152 * @brief Unlocks the time of day mutex.
     153 */
    144154void _TOD_Unlock( void );
    145155
     156/**
     157 * @brief Checks if api mutex is owner of the time of day mutex.
     158 *
     159 * @retval true It is owner of the time of day mutex.
     160 * @retval false It is not owner of the time of day mutex.
     161 */
    146162#if defined(RTEMS_DEBUG)
    147163bool _TOD_Is_owner( void );
    148164#endif
    149165
     166/**
     167 * @brief Acquires the lock context for the timecounter.
     168 *
     169 * @param lock_context The lock to acquire.
     170 */
    150171static inline void _TOD_Acquire( ISR_lock_Context *lock_context )
    151172{
     
    170191
    171192/**
    172  *  @brief Gets the current time in the timespec format.
    173  *
    174  *  @param[out] time is the value gathered by the request
     193 * @brief Gets the current time in the timespec format.
     194 *
     195 * @param[out] time The value gathered by the request.
    175196 */
    176197static inline void _TOD_Get(
     
    182203
    183204/**
    184  *  @brief Gets the system uptime with potential accuracy to the nanosecond.
    185  *
    186  *  This routine returns the system uptime with potential accuracy
    187  *  to the nanosecond.
    188  *
    189  *  The initial uptime value is undefined.
    190  *
    191  *  @param[in] time is a pointer to the uptime to be returned
     205 * @brief Gets the system uptime with potential accuracy to the nanosecond.
     206 *
     207 * This routine returns the system uptime with potential accuracy
     208 * to the nanosecond.
     209 *
     210 * The initial uptime value is undefined.
     211 *
     212 * @param[out] time Is a pointer to the uptime after the method call.
    192213 */
    193214static inline void _TOD_Get_uptime(
     
    199220
    200221/**
    201  *  @brief Gets the system uptime with potential accuracy to the nanosecond.
    202  *  to the nanosecond.
    203  *
    204  *  The initial uptime value is zero.
    205  *
    206  *  @param[in] time is a pointer to the uptime to be returned
     222 * @brief Gets the system uptime with potential accuracy to the nanosecond.
     223 *
     224 * The initial uptime value is zero.
     225 *
     226 * @param[out] time Is a pointer to the uptime after the method call.
    207227 */
    208228static inline void _TOD_Get_zero_based_uptime(
     
    214234
    215235/**
    216  *  @brief Gets the system uptime with potential accuracy to the nanosecond.
    217  *
    218  *  The initial uptime value is zero.
    219  *
    220  *  @param[in] time is a pointer to the uptime to be returned
     236 * @brief Gets the system uptime with potential accuracy to the nanosecond.
     237 *
     238 * The initial uptime value is zero.
     239 *
     240 * @param[out] time Is a pointer to the uptime after the method call.
    221241 */
    222242static inline void _TOD_Get_zero_based_uptime_as_timespec(
     
    229249
    230250/**
    231  *  @brief Number of seconds Since RTEMS epoch.
    232  *
    233  *  The following contains the number of seconds from 00:00:00
    234  *  January 1, TOD_BASE_YEAR until the current time of day.
     251 * @brief Returns Number of seconds Since RTEMS epoch.
     252 *
     253 * The following contains the number of seconds from 00:00:00
     254 * January 1, TOD_BASE_YEAR until the current time of day.
     255 *
     256 * @return The number of seconds since RTEMS epoch.
    235257 */
    236258static inline uint32_t _TOD_Seconds_since_epoch( void )
     
    240262
    241263/**
    242  *  @brief Gets number of ticks in a second.
    243  *
    244  *  This method returns the number of ticks in a second.
    245  *
    246  *  @note If the clock tick value does not multiply evenly into a second
    247  *        then this number of ticks will be slightly shorter than a second.
     264 * @brief Gets number of ticks in a second.
     265 *
     266 * This method returns the number of ticks in a second.
     267 *
     268 * @note If the clock tick value does not multiply evenly into a second
     269 *       then this number of ticks will be slightly shorter than a second.
     270 *
     271 * @return The number of ticks in a second.
    248272 */
    249273uint32_t TOD_TICKS_PER_SECOND_method(void);
     
    260284
    261285/**
    262  * This routine returns a timeval based upon the internal timespec format TOD.
    263  */
    264 
     286 * @brief This routine returns a timeval based upon the internal timespec
     287 *      format TOD.
     288 *
     289 * @param[out] time The timeval to be filled in by the method.
     290 */
    265291RTEMS_INLINE_ROUTINE void _TOD_Get_timeval(
    266292  struct timeval *time
     
    271297
    272298/**
    273  * @brief Adjust the Time of Time
     299 * @brief Adjusts the Time of Time.
    274300 *
    275301 * This method is used to adjust the current time of day by the
    276302 * specified amount.
    277303 *
    278  * @param[in] delta is the amount to adjust
     304 * @param delta is the amount to adjust.
    279305 */
    280306void _TOD_Adjust(
     
    285311 * @brief Check if the TOD is Set
    286312 *
    287  * @return TRUE is the time is set. FALSE otherwise.
     313 * @retval true The time is set.
     314 * @retval false The time is not set.
    288315 */
    289316RTEMS_INLINE_ROUTINE bool _TOD_Is_set( void )
     
    292319}
    293320
    294 /**@}*/
     321/** @} */
    295322
    296323#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.