From 7dbbb6fb5a2c8cb158680de7385168512fbba776 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Kruszewski?= Date: Fri, 15 Sep 2017 17:07:44 +0200 Subject: [PATCH] api: counter: Improve documentation of counter_set_alarm(). MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Previous description of counter_set_alarm() was insufficient and could be ambiguously interpreted. Signed-off-by: Michał Kruszewski --- include/counter.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/counter.h b/include/counter.h index a47d6760c3c..902532fe939 100644 --- a/include/counter.h +++ b/include/counter.h @@ -95,9 +95,10 @@ static inline u32_t counter_read(struct device *dev) /** * @brief Set an alarm. * @param dev Pointer to the device structure for the driver instance. - * @param callback Pointer to the callback function. if this is NULL, + * @param callback Pointer to the callback function. If this is NULL, * this function unsets the alarm. - * @param count Number of counter ticks. + * @param count Number of counter ticks. This is relative value, meaning + * an alarm will be triggered count ticks in the future. * @param user_data Pointer to user data. * * @retval 0 If successful.