]> granicus.if.org Git - esp-idf/commitdiff
docs: fix description of timer_get_alarm_value()
authorStefan Tauner <stefan.tauner@gmx.at>
Sun, 18 Mar 2018 17:28:38 +0000 (18:28 +0100)
committerIvan Grokhotkov <ivan@espressif.com>
Mon, 19 Mar 2018 03:56:57 +0000 (11:56 +0800)
Replace c&p text with an actual description.

Merges https://github.com/espressif/esp-idf/pull/1740

components/driver/include/driver/timer.h

index 6b43eb4704e65bc720c6203aa9f53e31b0434ebd..48e2b98908d318f8e18ff8d80f7e999200348bf8 100644 (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);
 
 /**
- * @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 timer_num Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]