summaryrefslogtreecommitdiff
path: root/components
diff options
context:
space:
mode:
authormnikapl954 <[email protected]>2026-07-22 16:34:25 +0800
committerRbb666 <[email protected]>2026-07-22 20:57:55 +0800
commit8e68826dc3dd14b484d4038cb03bc5cbaec17b9b (patch)
treef0df8396b0c938b646e063b5fb3f53b7e4c81cbf /components
parent108a958a9d9289e6930010f1e53ad9cf229ad79b (diff)
[drivers][adc] Fix misleading doxygen for rt_adc_voltage
Diffstat (limited to 'components')
-rw-r--r--components/drivers/include/drivers/adc.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/components/drivers/include/drivers/adc.h b/components/drivers/include/drivers/adc.h
index b95988cb2f..0a7d2a5eee 100644
--- a/components/drivers/include/drivers/adc.h
+++ b/components/drivers/include/drivers/adc.h
@@ -135,10 +135,10 @@ rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
/**
- * @brief get the adc resolution
+ * @brief get the converted voltage value from an ADC channel
* @param dev adc device
* @param channel adc channel
- * @return rt_int16_t adc resolution
+ * @return rt_int16_t voltage value (implementation-defined unit, typically mV)
* @ingroup group_drivers_adc
*/
rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);