From dd94a219a2ba4d86f5e60416ecdedf8ac51bcb22 Mon Sep 17 00:00:00 2001 From: shenmengjing Date: Tue, 9 Jul 2024 14:51:31 +0800 Subject: [PATCH] docs: Update the application example in adc_oneshot --- docs/en/api-reference/peripherals/adc_oneshot.rst | 2 +- docs/zh_CN/api-reference/peripherals/adc_oneshot.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/peripherals/adc_oneshot.rst b/docs/en/api-reference/peripherals/adc_oneshot.rst index bec0bee186..5a879115ec 100644 --- a/docs/en/api-reference/peripherals/adc_oneshot.rst +++ b/docs/en/api-reference/peripherals/adc_oneshot.rst @@ -229,7 +229,7 @@ Kconfig Options Application Examples -------------------- -* ADC oneshot mode example: :example:`peripherals/adc/oneshot_read`. +* :example:`peripherals/adc/oneshot_read` demonstrates how to obtain a one-shot ADC reading from a GPIO pin using the ADC one-shot mode driver and how to use the ADC Calibration functions to obtain a calibrated result in mV on {IDF_TARGET_NAME}. API Reference diff --git a/docs/zh_CN/api-reference/peripherals/adc_oneshot.rst b/docs/zh_CN/api-reference/peripherals/adc_oneshot.rst index 7c8687b480..282e40b066 100644 --- a/docs/zh_CN/api-reference/peripherals/adc_oneshot.rst +++ b/docs/zh_CN/api-reference/peripherals/adc_oneshot.rst @@ -229,7 +229,7 @@ Kconfig 选项 应用示例 -------------------- -* ADC 单次转换模式示例：:example:`peripherals/adc/oneshot_read`。 +* :example:`peripherals/adc/oneshot_read` 演示了如何使用 ADC 单次模式驱动程序从 GPIO 管脚获取单次 ADC 数值，并展示了如何使用 ADC 校准功能在 {IDF_TARGET_NAME} 上获得校准后的结果，单位为毫伏。 API 参考