Skip to content

Commit 8e68826

Browse files
mnikapl954Rbb666
authored andcommitted
[drivers][adc] Fix misleading doxygen for rt_adc_voltage
1 parent 108a958 commit 8e68826

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

  • components/drivers/include/drivers

‎components/drivers/include/drivers/adc.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,10 @@ rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
135135
rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
136136

137137
/**
138-
* @brief get the adc resolution
138+
* @brief get the converted voltage value from an ADC channel
139139
* @param dev adc device
140140
* @param channel adc channel
141-
* @return rt_int16_t adc resolution
141+
* @return rt_int16_t voltage value (implementation-defined unit, typically mV)
142142
* @ingroup group_drivers_adc
143143
*/
144144
rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);

0 commit comments

Comments
 (0)