diff options
author | Andreas Dachsberger <andreas.dachsberger@embedded-brains.de> | 2019-04-18 08:58:48 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-05-13 07:42:05 +0200 |
commit | eb84cc3fe78e411bba20b4202dcc10aeb08e6aeb (patch) | |
tree | e11ad677fb26aaaf073b27594a7973714daac90c | |
parent | doxygen: score: adjust doc in userextimpl.h to doxygen guidelines (diff) | |
download | rtems-eb84cc3fe78e411bba20b4202dcc10aeb08e6aeb.tar.bz2 |
doxygen: score: adjust doc in watchdog.h to doxygen guidelines
Update #3706.
-rw-r--r-- | cpukit/include/rtems/score/watchdog.h | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/cpukit/include/rtems/score/watchdog.h b/cpukit/include/rtems/score/watchdog.h index 5f7d6fa3f3..cd792a7b42 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 } |