From dc2e8ab35ef9a67624f70683fca75c4a2413d763 Mon Sep 17 00:00:00 2001 From: Martin Kojtal Date: Mon, 1 Jul 2019 12:30:30 +0100 Subject: [PATCH] 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 --- drivers/VirtualWatchdog.h | 5 ++++- drivers/Watchdog.h | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/drivers/VirtualWatchdog.h b/drivers/VirtualWatchdog.h index 2df91bc443..b300ba42ff 100644 --- a/drivers/VirtualWatchdog.h +++ b/drivers/VirtualWatchdog.h @@ -36,7 +36,10 @@ namespace mbed { /** \addtogroup drivers */ -/** A system timer that will reset the system in the case of system failures or +/** VirtualWatchdog should be used for applications where you use multiple services requiring watchdog functionality. + * Use `Watchdog` driver for simple uses cases like bootloader. + * + * A system timer that will reset the system in the case of system failures or * malfunctions. * * Example: diff --git a/drivers/Watchdog.h b/drivers/Watchdog.h index 2d94ab214b..1eedb25b55 100644 --- a/drivers/Watchdog.h +++ b/drivers/Watchdog.h @@ -31,7 +31,7 @@ namespace mbed { /** \addtogroup drivers */ /** Hardware system timer that will reset the system in the case of system failures or - * malfunctions. There is only one instance in the system. + * malfunctions. There is only one instance in the system (for multiple system timers, see VirtualWatchdog driver). * * Example: * @code