From 2cee7899d593350f9624e5eebf9fb480d689f5c4 Mon Sep 17 00:00:00 2001 From: Zhang Shuxian Date: Tue, 6 Aug 2024 18:51:52 +0800 Subject: [PATCH] docs: Update the application examples in gpio.rst --- docs/en/api-reference/peripherals/gpio.rst | 6 +++++- docs/zh_CN/api-reference/peripherals/gpio.rst | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/peripherals/gpio.rst b/docs/en/api-reference/peripherals/gpio.rst index 3efd331f07..c48a4fad5a 100644 --- a/docs/en/api-reference/peripherals/gpio.rst +++ b/docs/en/api-reference/peripherals/gpio.rst @@ -145,7 +145,11 @@ Do not rely on the default configurations values in the Technical Reference Manu Application Example ------------------- -* GPIO output and input interrupt example: :example:`peripherals/gpio/generic_gpio`. +.. list:: + + * :example:`peripherals/gpio/generic_gpio` demonstrates how to configure GPIO to generate pulses and use it with interruption. + :esp32s2: * :example:`peripherals/gpio/matrix_keyboard` demonstrates how to drive a common matrix keyboard using the dedicated GPIO APIs, including manipulating the level on a group of GPIOs, triggering edge interrupt, and reading level on a group of GPIOs. + API Reference - Normal GPIO --------------------------- diff --git a/docs/zh_CN/api-reference/peripherals/gpio.rst b/docs/zh_CN/api-reference/peripherals/gpio.rst index 99d6fcac03..a388d0e503 100644 --- a/docs/zh_CN/api-reference/peripherals/gpio.rst +++ b/docs/zh_CN/api-reference/peripherals/gpio.rst @@ -145,7 +145,11 @@ GPIO 驱动提供了一个函数 :cpp:func:`gpio_dump_io_configuration` 用来 应用示例 ------------------- -* GPIO 输出和输入中断示例：:example:`peripherals/gpio/generic_gpio`。 +.. list:: + + * :example:`peripherals/gpio/generic_gpio` 演示了如何配置 GPIO 以生成脉冲，触发中断。 + :esp32s2: * :example:`peripherals/gpio/matrix_keyboard` 演示了如何使用专用 GPIO API 驱动常见的矩阵键盘，包括控制一组 GPIO 的电平、触发边沿中断以及读取一组 GPIO 的电平。 + API 参考 - 普通 GPIO ---------------------------