diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-19 15:00:45 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-19 18:45:45 -0400 |
| commit | 58fb7e2e586acc0263c1a228290327d18fdd184b (patch) | |
| tree | a13e12438c2a9c7065c716739678da74092c4b0b /libmaple/iwdg.c | |
| parent | 44394fd34d98e356557c80da2e60b789870a4eeb (diff) | |
| download | librambutan-58fb7e2e586acc0263c1a228290327d18fdd184b.tar.gz librambutan-58fb7e2e586acc0263c1a228290327d18fdd184b.zip | |
iwdg: Doxygen comments
Diffstat (limited to 'libmaple/iwdg.c')
| -rw-r--r-- | libmaple/iwdg.c | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/libmaple/iwdg.c b/libmaple/iwdg.c index 3d67ee8..647cc15 100644 --- a/libmaple/iwdg.c +++ b/libmaple/iwdg.c @@ -32,10 +32,11 @@ /** * @brief Initialise and start the watchdog * - * The prescaler and reload set the timeout. A prescaler of 3 divides - * the 40 kHz clock by 32 and gives roughly 1 ms per reload. + * The prescaler and reload set the timeout. For example, a prescaler + * of IWDG_PRE_32 divides the 40 kHz clock by 32 and gives roughly 1 + * ms per reload. * - * @param prescaler Prescaler for the 40 KHz IWDG clock. + * @param prescaler Prescaler for the 40 kHz IWDG clock. * @param reload Independent watchdog counter reload value. */ void iwdg_init(iwdg_prescaler prescaler, uint16 reload) { |