summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/score/watchdog.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-27 17:21:23 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch)
tree9f5d198e4af5ad22b96012a17ce0a23769acf01f /cpukit/include/rtems/score/watchdog.h
parentrtems: Canonicalize Doxygen @file comments (diff)
downloadrtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/watchdog.h')
-rw-r--r--cpukit/include/rtems/score/watchdog.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/cpukit/include/rtems/score/watchdog.h b/cpukit/include/rtems/score/watchdog.h
index 7e8727f2f5..8e946866f6 100644
--- a/cpukit/include/rtems/score/watchdog.h
+++ b/cpukit/include/rtems/score/watchdog.h
@@ -3,11 +3,9 @@
*
* @ingroup RTEMSScoreWatchdog
*
- * @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.
+ * @brief This header file provides interfaces of the
+ * @ref RTEMSScoreWatchdog which are used by the implementation and the
+ * @ref RTEMSImplApplConfig.
*/
/*
@@ -40,7 +38,9 @@ extern "C" {
* @brief This group contains the Watchdog Handler implementation.
*
* This handler encapsulates functionality related to the scheduling of
- * watchdog functions to be called at specific times in the future.
+ * watchdog functions to be called at specific times in the future. It
+ * provides mechanisms which can be used to initialize and manipulate watchdog
+ * timers.
*
* @note This handler does not have anything to do with hardware watchdog
* timers.