Skip to content

Commit a415e44

Browse files
committed
Watchdog: add docs update about intention one vs multiple Watchdogs
VirtualWatchdog - multiple timers in the system - most used watchdog Watchdog - simple driver for one system timer in the app - bootloader or similar
1 parent 1acd3d3 commit a415e44

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

drivers/VirtualWatchdog.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ namespace mbed {
3636

3737
/** \addtogroup drivers */
3838

39-
/** A system timer that will reset the system in the case of system failures or
39+
/** VirtualWatchdog should be used for applications where you use multiple services requiring watchdog functionality.
40+
* Use `Watchdog` driver for simple uses cases like bootloader.
41+
*
42+
* A system timer that will reset the system in the case of system failures or
4043
* malfunctions.
4144
*
4245
* Example:

drivers/Watchdog.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace mbed {
3131

3232
/** \addtogroup drivers */
3333
/** Hardware system timer that will reset the system in the case of system failures or
34-
* malfunctions. There is only one instance in the system.
34+
* malfunctions. There is only one instance in the system (for multiple system timers, see VirtualWatchdog driver).
3535
*
3636
* Example:
3737
* @code

0 commit comments

Comments
 (0)