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

Update #3706.
This commit is contained in:
Andreas Dachsberger
2019-04-18 08:58:48 +02:00
committed by Sebastian Huber
parent 7d2cc98b9c
commit eb84cc3fe7

View File

@@ -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 * This include file contains all the constants and structures associated
* with watchdog timers. This Handler provides mechanisms which can be * with watchdog timers. This Handler provides mechanisms which can be
* used to initialize and manipulate watchdog timers. * used to initialize and manipulate watchdog timers.
*/ */
/* /*
@@ -33,17 +33,20 @@ extern "C" {
#endif #endif
/** /**
* @defgroup RTEMSScoreWatchdog Watchdog Handler * @defgroup RTEMSScoreWatchdog Watchdog Handler
* *
* @ingroup RTEMSScore * @ingroup RTEMSScore
* *
* This handler encapsulates functionality related to the scheduling of * @brief Watchdog Handler
* watchdog functions to be called at specific times in the future.
* *
* @note This handler does not have anything to do with hardware watchdog * This handler encapsulates functionality related to the scheduling of
* timers. * 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; typedef struct Watchdog_Control Watchdog_Control;
@@ -114,7 +117,7 @@ struct Watchdog_Control {
uint64_t expire; uint64_t expire;
}; };
/**@}*/ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }