From 696ddf3dbb27a18c89787eae16a2fa1665ef57f6 Mon Sep 17 00:00:00 2001 From: Benjamin Valentin Date: Sun, 13 Sep 2020 19:04:44 +0200 Subject: [PATCH] drivers/periph/timer: amend documentation for timer_set_periodic() The function needs the `periph_timer_periodic` feature. Add a `@note` about that to the documentation. --- drivers/include/periph/timer.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/drivers/include/periph/timer.h b/drivers/include/periph/timer.h index 2603035f4c..f52306cbb3 100644 --- a/drivers/include/periph/timer.h +++ b/drivers/include/periph/timer.h @@ -160,12 +160,14 @@ int timer_set(tim_t dev, int channel, unsigned int timeout); int timer_set_absolute(tim_t dev, int channel, unsigned int value); /** - * @brief Set an absolute timeout value for the given channel of the given timer - * The timeout will be called periodically for each iteration + * @brief Set an absolute timeout value for the given channel of the given timer. + * The timeout will be called periodically for each iteration. * * @note Only one channel with `TIM_FLAG_RESET_ON_MATCH` can be active. * Some platforms (Atmel) only allow to use the first channel as TOP value. * + * @note Needs to be enabled with `FEATURES_REQUIRED += periph_timer_periodic`. + * * @param[in] dev the timer device to set * @param[in] channel the channel to set * @param[in] value the absolute compare value when the callback will be