Merge branch 'bugfix/gpio_timer_doc_fixes' into 'master'

Minor fixes of GPIO and timer group driver docs

See merge request idf/esp-idf!2081

components/driver/include/driver/gpio.h

@@ -302,6 +302,8 @@ esp_err_t gpio_set_level(gpio_num_t gpio_num, uint32_t level);
 /**
  * @brief  GPIO get input level
  *
+ * @warning If the pad is not configured for input (or input and output) the returned value is always 0.
+ *
  * @param  gpio_num GPIO number. If you want to get the logic level of e.g. pin GPIO16, gpio_num should be GPIO_NUM_16 (16);
  *
  * @return

components/driver/include/driver/timer.h

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

docs/en/api-reference/peripherals/timer.rst

@@ -67,7 +67,8 @@ After the alarm is enabled and the timer reaches the alarm value, depending on c
 
 .. note::
 
-    The alarm will be triggered immediately, if an alarm value is set and the timer has already passed this value.
+    * The alarm will be triggered immediately, if an alarm value is set and the timer has already passed this value.
+    * Once triggered the alarm will be disabled automatically and needs to be re-armed to trigger again.
 
 To check what alarm value has been set up, call :cpp:func:`timer_get_alarm_value`.