michaelh/zephyr
1
0
Fork 0
Code Releases Activity

api: counter: Improve documentation of counter_set_alarm().

Browse source 
Previous description of counter_set_alarm() was insufficient and
could be ambiguously interpreted.

Signed-off-by: Michał Kruszewski <michal.kruszewski@nordicsemi.no>
This commit is contained in:
Michał Kruszewski 2017-09-15 17:07:44 +02:00 • committed by Anas Nashif
commit 7dbbb6fb5a
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/counter.h
View file

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