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
pull/10857/head
Martin Kojtal 2019-07-01 12:30:30 +01:00
parent 89c0ab793e
commit dc2e8ab35e
2 changed files with 5 additions and 2 deletions

View File

@ -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:

View File

@ -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