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

Sebastian Huber sebh at rtems.org
Mon May 13 05:52:28 UTC 2019


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Apr 18 08:58:48 2019 +0200

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

Update #3706.

---

 cpukit/include/rtems/score/watchdog.h | 31 +++++++++++++++++--------------
 1 file changed, 17 insertions(+), 14 deletions(-)

diff --git a/cpukit/include/rtems/score/watchdog.h b/cpukit/include/rtems/score/watchdog.h
index 5f7d6fa..cd792a7 100644
--- a/cpukit/include/rtems/score/watchdog.h
+++ b/cpukit/include/rtems/score/watchdog.h
@@ -1,13 +1,13 @@
 /**
- *  @file
+ * @file
  *
- *  @ingroup RTEMSScoreWatchdog
+ * @ingroup RTEMSScoreWatchdog
  *
- *  @brief Constants and Structures Associated with Watchdog Timers
+ * @brief Constants and Structures Associated with Watchdog Timers
  *
- *  This include file contains all the constants and structures associated
- *  with watchdog timers.   This Handler provides mechanisms which can be
- *  used to initialize and manipulate watchdog timers.
+ * This include file contains all the constants and structures associated
+ * with watchdog timers.   This Handler provides mechanisms which can be
+ * used to initialize and manipulate watchdog timers.
  */
 
 /*
@@ -33,17 +33,20 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup RTEMSScoreWatchdog Watchdog Handler
+ * @defgroup RTEMSScoreWatchdog Watchdog Handler
  *
- *  @ingroup RTEMSScore
+ * @ingroup RTEMSScore
  *
- *  This handler encapsulates functionality related to the scheduling of
- *  watchdog functions to be called at specific times in the future.
+ * @brief Watchdog Handler
  *
- *  @note This handler does not have anything to do with hardware watchdog
- *        timers.
+ * This handler encapsulates functionality related to the scheduling of
+ * watchdog functions to be called at specific times in the future.
+ *
+ * @note This handler does not have anything to do with hardware watchdog
+ *       timers.
+ *
+ * @{
  */
-/**@{*/
 
 typedef struct Watchdog_Control Watchdog_Control;
 
@@ -114,7 +117,7 @@ struct Watchdog_Control {
   uint64_t expire;
 };
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }




More information about the vc mailing list