doc: API Reference - examples & fixes

diff --git a/docs/api/bt.rst b/docs/api/bt.rst
index 0ab17b2aa5d6c4e1b129e3f515d8bdfbfea1ac04..1824bc454a4253de1bcc46a91cdbca813291e81c 100644 (file)
--- a/docs/api/bt.rst
+++ b/docs/api/bt.rst
@@ -9,15 +9,19 @@ Overview
 Application Example
 -------------------
 
-`Instructions`_
+Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
 
-API Reference
--------------
+`05_ble_adv <https://github.com/espressif/esp-idf/blob/master/examples/05_ble_adv/main/app_bt.c>`_ 
+
+  This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising.
 
 `Instructions`_
 
 .. _Instructions: template.html
 
+API Reference
+-------------
+
 Header Files
 ^^^^^^^^^^^^
 
@@ -35,4 +39,3 @@ Functions
 .. doxygenfunction:: API_vhci_host_register_callback
 .. doxygenfunction:: API_vhci_host_send_packet
 .. doxygenfunction:: bt_controller_init
-

diff --git a/docs/api/ledc.rst b/docs/api/ledc.rst
index f379e9d00823a5518f72d9efd150c6826bc74439..855f8221633555e07f1197478ffa9c00dcec763b 100644 (file)
--- a/docs/api/ledc.rst
+++ b/docs/api/ledc.rst
@@ -27,7 +27,10 @@ Data Structures
 ^^^^^^^^^^^^^^^
 
 .. doxygenstruct:: ledc_channel_config_t
+   :members:
+
 .. doxygenstruct:: ledc_timer_config_t
+   :members:
 
 Macros
 ^^^^^^

diff --git a/docs/api/nvs_flash.rst b/docs/api/nvs_flash.rst
index 5d36343552cb31c9f30f04d6224f67afa5dc4f66..a765f7608e0cc68e23fbf697b7e2a8c80397ab16 100644 (file)
--- a/docs/api/nvs_flash.rst
+++ b/docs/api/nvs_flash.rst
@@ -5,8 +5,23 @@ Application Example
 
 Two examples are provided in ESP-IDF examples directory:
 
-- `07_nvs_rw_value <https://github.com/espressif/esp-idf/tree/master/examples/07_nvs_rw_value>`_ demostrates how to read and write integer values
-- `08_nvs_rw_blob <https://github.com/espressif/esp-idf/tree/master/examples/08_nvs_rw_blob>`_ demostrates how to read and write variable length binary values
+`07_nvs_rw_value <https://github.com/espressif/esp-idf/blob/master/examples/07_nvs_rw_value/main/nvs_rw_value.c>`_
+
+  Demonstrates how to read and write a single integer value using NVS.
+
+  The value holds the number of ESP32 module restarts. Since it is written to NVS, the value is preserved between restarts.
+
+  Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way.
+
+`08_nvs_rw_blob <https://github.com/espressif/esp-idf/blob/master/examples/08_nvs_rw_blob/main/nvs_rw_blob.c>`_
+
+  Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts.
+
+    * value - tracks number of ESP32 module soft and hard restarts.
+    * blob - contains a table with module run times. The table is read from NVS to dynamically allocated RAM. New run time is added to the table on each manually triggered soft restart and written back to NVS. Triggering is done by pulling down GPIO0.
+
+  Example also shows how to implement diagnostics if read / write operation was successful.
+
 
 API Reference
 -------------

diff --git a/docs/api/vfs.rst b/docs/api/vfs.rst
index df6cd03f6727fcb3b024aa3f64d562628e9f062b..798aac549242fd72f5cbca75cc2a620a176d7105 100644 (file)
--- a/docs/api/vfs.rst
+++ b/docs/api/vfs.rst
@@ -25,6 +25,7 @@ Structures
 ^^^^^^^^^^
 
 .. doxygenstruct:: esp_vfs_t
+   :members:
 
 Functions
 ^^^^^^^^^