Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: fix description of timer_get_alarm_value()

Browse source 
Replace c&p text with an actual description.

Merges https://github.com/espressif/esp-idf/pull/1740
This commit is contained in:
Stefan Tauner 2018-03-18 18:28:38 +01:00 committed by Ivan Grokhotkov
parent 86a1d579ff
commit 38daa1e716
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
components/driver/include/driver/timer.h
View file

@ -238,7 +238,7 @@ esp_err_t timer_set_alarm_value(timer_group_t group_num, timer_idx_t timer_num,
esp_err_t timer_get_alarm_value(timer_group_t group_num, timer_idx_t timer_num, uint64_t* alarm_value); esp_err_t timer_get_alarm_value(timer_group_t group_num, timer_idx_t timer_num, uint64_t* alarm_value);
/** /**
* @brief Get timer alarm value. * @brief Enable or disable generation of timer alarm events.
* *
* @param group_num Timer group, 0 for TIMERG0 or 1 for TIMERG1 * @param group_num Timer group, 0 for TIMERG0 or 1 for TIMERG1
* @param timer_num Timer index, 0 for hw_timer[0] & 1 for hw_timer[1] * @param timer_num Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]