Changeset 1b5ba76 in rtems


Ignore:
Timestamp:
Apr 17, 2019, 3:51:55 PM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
4a693e7
Parents:
bded63fc
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/17/19 15:51:55)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rbded63fc r1b5ba76  
    11/**
    2  *  @file
     2 * @file
    33 *
    4  *  @brief Helpers for Manipulating Timestamps
     4 * @ingroup SuperCoreTimeStamp
    55 *
    6  *  This include file contains helpers for manipulating timestamps.
     6 * @brief Helpers for Manipulating Timestamps
     7 *
     8 * This include file contains helpers for manipulating timestamps.
    79 */
    810
     
    2022
    2123/**
    22  *  @defgroup SuperCoreTimeStamp Score Timestamp
     24 * @defgroup SuperCoreTimeStamp Score Timestamp
    2325 *
    24  *  @ingroup RTEMSScore
     26 * @ingroup RTEMSScore
    2527 *
    26  *  This handler encapsulates functionality related to manipulating
    27  *  SuperCore Timestamps.  SuperCore Timestamps may be used to
    28  *  represent time of day, uptime, or intervals.
     28 * @brief Score Timestamp
    2929 *
    30  *  The key attribute of the SuperCore Timestamp handler is that it
    31  *  is a completely opaque handler.  There can be multiple implementations
    32  *  of the required functionality and with a recompile, RTEMS can use
    33  *  any implementation.  It is intended to be a simple wrapper.
     30 * This handler encapsulates functionality related to manipulating
     31 * SuperCore Timestamps.  SuperCore Timestamps may be used to
     32 * represent time of day, uptime, or intervals.
    3433 *
    35  *  This handler can be implemented as either struct timespec or
    36  *  unsigned64 bit numbers.  The use of a wrapper class allows the
    37  *  the implementation of timestamps to change on a per architecture
    38  *  basis.  This is an important option as the performance of this
    39  *  handler is critical.
     34 * The key attribute of the SuperCore Timestamp handler is that it
     35 * is a completely opaque handler.  There can be multiple implementations
     36 * of the required functionality and with a recompile, RTEMS can use
     37 * any implementation.  It is intended to be a simple wrapper.
     38 *
     39 * This handler can be implemented as either struct timespec or
     40 * unsigned64 bit numbers.  The use of a wrapper class allows the
     41 * the implementation of timestamps to change on a per architecture
     42 * basis.  This is an important option as the performance of this
     43 * handler is critical.
     44 *
     45 * @{
    4046 */
    41 /**@{*/
    4247
    4348#include <rtems/score/timespec.h>
     
    5661#endif
    5762
    58 /**@}*/
     63/** @} */
    5964
    6065#endif
Note: See TracChangeset for help on using the changeset viewer.