diff options
author | Andreas Dachsberger <andreas.dachsberger@embedded-brains.de> | 2019-04-17 17:51:55 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-05-13 07:42:05 +0200 |
commit | 1b5ba76d0347cbf2d6011e4ad45612e13c82e489 (patch) | |
tree | 07ca2b9a97de6af7ce39505b76bcedef8decd273 /cpukit/include | |
parent | doxygen: score: adjust doc in timespec.h to doxygen guidelines (diff) | |
download | rtems-1b5ba76d0347cbf2d6011e4ad45612e13c82e489.tar.bz2 |
doxygen: score: adjust doc in timestamp.h to doxygen guidelines
Update #3706.
Diffstat (limited to 'cpukit/include')
-rw-r--r-- | cpukit/include/rtems/score/timestamp.h | 43 |
1 files changed, 24 insertions, 19 deletions
diff --git a/cpukit/include/rtems/score/timestamp.h b/cpukit/include/rtems/score/timestamp.h index 2645c51a11..69c31a67bb 100644 --- a/cpukit/include/rtems/score/timestamp.h +++ b/cpukit/include/rtems/score/timestamp.h @@ -1,9 +1,11 @@ /** - * @file + * @file * - * @brief Helpers for Manipulating Timestamps + * @ingroup SuperCoreTimeStamp * - * This include file contains helpers for manipulating timestamps. + * @brief Helpers for Manipulating Timestamps + * + * This include file contains helpers for manipulating timestamps. */ /* @@ -19,26 +21,29 @@ #define _RTEMS_SCORE_TIMESTAMP_H /** - * @defgroup SuperCoreTimeStamp Score Timestamp + * @defgroup SuperCoreTimeStamp Score Timestamp + * + * @ingroup RTEMSScore + * + * @brief Score Timestamp * - * @ingroup RTEMSScore + * This handler encapsulates functionality related to manipulating + * SuperCore Timestamps. SuperCore Timestamps may be used to + * represent time of day, uptime, or intervals. * - * This handler encapsulates functionality related to manipulating - * SuperCore Timestamps. SuperCore Timestamps may be used to - * represent time of day, uptime, or intervals. + * The key attribute of the SuperCore Timestamp handler is that it + * is a completely opaque handler. There can be multiple implementations + * of the required functionality and with a recompile, RTEMS can use + * any implementation. It is intended to be a simple wrapper. * - * The key attribute of the SuperCore Timestamp handler is that it - * is a completely opaque handler. There can be multiple implementations - * of the required functionality and with a recompile, RTEMS can use - * any implementation. It is intended to be a simple wrapper. + * This handler can be implemented as either struct timespec or + * unsigned64 bit numbers. The use of a wrapper class allows the + * the implementation of timestamps to change on a per architecture + * basis. This is an important option as the performance of this + * handler is critical. * - * This handler can be implemented as either struct timespec or - * unsigned64 bit numbers. The use of a wrapper class allows the - * the implementation of timestamps to change on a per architecture - * basis. This is an important option as the performance of this - * handler is critical. + * @{ */ -/**@{*/ #include <rtems/score/timespec.h> @@ -55,7 +60,7 @@ typedef int64_t Timestamp_Control; } #endif -/**@}*/ +/** @} */ #endif /* end of include file */ |