[rtems commit] doxygen: score: adjust doc in timestamp.h to doxygen guidelines

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    1b5ba76d0347cbf2d6011e4ad45612e13c82e489
Changeset: http://git.rtems.org/rtems/commit/?id=1b5ba76d0347cbf2d6011e4ad45612e13c82e489

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Wed Apr 17 17:51:55 2019 +0200

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

Update #3706.

---

 cpukit/include/rtems/score/timestamp.h | 43 +++++++++++++++++++---------------
 1 file changed, 24 insertions(+), 19 deletions(-)

diff --git a/cpukit/include/rtems/score/timestamp.h b/cpukit/include/rtems/score/timestamp.h
index 2645c51..69c31a6 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 */