From b672002a5f427638598458282e4c38af6691fe54 Mon Sep 17 00:00:00 2001 From: Kirill Chalov Date: Mon, 29 Apr 2019 10:53:42 +0800 Subject: [PATCH] Doc/review api reference indexes --- docs/en/api-reference/bluetooth/index.rst | 6 +++--- docs/en/api-reference/network/esp_wifi.rst | 9 +++++---- docs/en/api-reference/network/index.rst | 14 ++++++++------ docs/en/api-reference/peripherals/index.rst | 2 +- docs/en/api-reference/protocols/index.rst | 4 ++-- docs/en/api-reference/provisioning/index.rst | 2 +- 6 files changed, 20 insertions(+), 17 deletions(-) diff --git a/docs/en/api-reference/bluetooth/index.rst b/docs/en/api-reference/bluetooth/index.rst index af7d3cfca..c96e0eccf 100644 --- a/docs/en/api-reference/bluetooth/index.rst +++ b/docs/en/api-reference/bluetooth/index.rst @@ -10,14 +10,14 @@ Bluetooth API Bluetooth Classic -To see the overview of the ESP32 Bluetooth stack architecture, follow links below: +For the overview of the ESP32 Bluetooth stack architecture, follow the links below: * `ESP32 Bluetooth Architecture (PDF) [English] `_ * `ESP32 Bluetooth Architecture (PDF) [中文] `_ -Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples. +Code examples for this API section are provided in the :example:`bluetooth` directory of ESP-IDF examples. -Several examples contain detailed description. To see them please follow links below: +The following examples contain detailed walkthroughs: * :example_file:`GATT Client Example Walkthrough ` * :example_file:`GATT Server Service Table Example Walkthrough ` diff --git a/docs/en/api-reference/network/esp_wifi.rst b/docs/en/api-reference/network/esp_wifi.rst index c8091e007..1bbbb4bc8 100644 --- a/docs/en/api-reference/network/esp_wifi.rst +++ b/docs/en/api-reference/network/esp_wifi.rst @@ -12,16 +12,17 @@ The WiFi libraries provide support for configuring and monitoring the ESP32 WiFi - Various security modes for the above (WPA, WPA2, WEP, etc.) - Scanning for access points (active & passive scanning). -- Promiscuous mode monitoring of IEEE802.11 WiFi packets. +- Promiscuous mode for monitoring of IEEE802.11 WiFi packets. + Application Examples -------------------- -See :example:`wifi` directory of ESP-IDF examples that contains the following applications: +The :example:`wifi` directory of ESP-IDF examples contains the following applications: -* Simple application showing how to connect ESP32 module to an Access Point - `esp-idf-template `_. +Code examples for Wi-Fi are provided in the :example:`wifi` directory of ESP-IDF examples. -* Using power save mode of Wi-Fi - :example:`wifi/power_save`. +In addition, there is a simple `esp-idf-template `_ application that shows how to connect ESP32 module to an Access Point. API Reference diff --git a/docs/en/api-reference/network/index.rst b/docs/en/api-reference/network/index.rst index 0c7f5ba5a..e313d7e5b 100644 --- a/docs/en/api-reference/network/index.rst +++ b/docs/en/api-reference/network/index.rst @@ -12,9 +12,10 @@ Wi-Fi ESP-NOW ESP Mesh -Example code for the Wi-Fi API is provided in :example:`wifi` directory of ESP-IDF examples. +Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples. + +Code examples for ESP-MESH are provided in the :example:`mesh` directory of ESP-IDF examples. -Example code for ESP Mesh is provided in :example:`mesh` directory of ESP-IDF examples. Ethernet ======== @@ -24,7 +25,8 @@ Ethernet Ethernet -Example code for the Ethernet API is provided in :example:`ethernet` directory of ESP-IDF examples. +Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples. + IP Network Layer ================ @@ -34,9 +36,9 @@ IP Network Layer TCP/IP Adapter -Example code for TCP/IP socket APIs is provided in :example:`protocols/sockets` directory of ESP-IDF examples. +Code examples for TCP/IP socket APIs are provided in the :example:`protocols/sockets` directory of ESP-IDF examples. -Application Layer +Application Layer  ================= -Documentation for application layer network protocols (above the IP network layer) is provided in :doc:`../protocols/index`. +Documentation for Application layer network protocols (above the IP Network layer) are provided in :doc:`../protocols/index`. diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst index c10254e81..a649b303a 100644 --- a/docs/en/api-reference/peripherals/index.rst +++ b/docs/en/api-reference/peripherals/index.rst @@ -24,4 +24,4 @@ Peripherals API Touch Sensor UART -Example code for this API section is provided in :example:`peripherals` directory of ESP-IDF examples. +Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples. diff --git a/docs/en/api-reference/protocols/index.rst b/docs/en/api-reference/protocols/index.rst index 9fd4d66f9..f8edf9e81 100644 --- a/docs/en/api-reference/protocols/index.rst +++ b/docs/en/api-reference/protocols/index.rst @@ -14,10 +14,10 @@ Application Protocols ESP-MQTT Modbus -Example code for this API section is provided in :example:`protocols` directory of ESP-IDF examples. +Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples. IP Network Layer ================ -Documentation for IP Network Layer protocols (below the Application Protocol layer) is provided in :doc:`../network/index`. +Documentation for IP Network Layer protocols (below the Application Protocol layer) are provided in :doc:`../network/index`. diff --git a/docs/en/api-reference/provisioning/index.rst b/docs/en/api-reference/provisioning/index.rst index cb064e30b..33e635ada 100644 --- a/docs/en/api-reference/provisioning/index.rst +++ b/docs/en/api-reference/provisioning/index.rst @@ -8,4 +8,4 @@ Provisioning API Protocol Communication Wi-Fi Provisioning -Example code for this API section is provided in :example:`provisioning` directory of ESP-IDF examples. +Code examples for this API section are provided in the :example:`provisioning` directory of ESP-IDF examples.