Added links to examples in API documentation

This commit is contained in:
krzychb 2017-01-17 19:12:48 +01:00
parent fb7b218091
commit 5ae9647667
6 changed files with 26 additions and 13 deletions

View file

@ -105,6 +105,11 @@ on the transmission. For received data, use ``rx_data`` and set ``SPI_USE_RXDATA
not touch the ``tx_buffer`` or ``rx_buffer`` members, because they use the same memory locations not touch the ``tx_buffer`` or ``rx_buffer`` members, because they use the same memory locations
as ``tx_data`` and ``rx_data``. as ``tx_data`` and ``rx_data``.
Application Example
-------------------
Display graphics on the ILI9341-based 320x240 LCD: `examples/peripherals/spi_master <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/spi_master>`_.
API Reference API Reference
------------- -------------

View file

@ -6,18 +6,16 @@ Overview
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------
`Instructions`_ Configure uart settings and install uart driver to read/write using UART0 and UART1 interfaces: `examples/peripherals/uart <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/uart>`_.
API Reference API Reference
------------- -------------
`Instructions`_
.. _Instructions: ../template.html
Header Files Header Files
^^^^^^^^^^^^ ^^^^^^^^^^^^

View file

@ -87,3 +87,8 @@ The following function can be used to enter deep sleep once wakeup sources are c
.. doxygenfunction:: esp_deep_sleep_start .. doxygenfunction:: esp_deep_sleep_start
Application Example
-------------------
Implementation of basic functionality of deep sleep is shown in `protocols/sntp <https://github.com/espressif/esp-idf/tree/master/examples/protocols/sntp>`_ example, where ESP module is periodically waken up to retrive time from NTP server.

View file

@ -3,9 +3,11 @@
Application Example Application Example
------------------- -------------------
`Instructions`_ Log library is commonly used by most of esp-idf components and examples. For demonstration of log functionality check `examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that among others, contains the following examples:
.. _Instructions: ../template.html * `system/ota <https://github.com/espressif/esp-idf/tree/master/examples/system/ota>`_
* `storage/sd_card <https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card>`_
* `protocols/https_request <https://github.com/espressif/esp-idf/tree/master/examples/protocols/https_request>`_
API Reference API Reference
------------- -------------

View file

@ -1,6 +1,11 @@
OTA OTA
=== ===
Application Example
-------------------
Demonstration of OTA (over the air) firmware update workflow: `examples/system/ota <https://github.com/espressif/esp-idf/tree/master/examples/system/ota>`_.
API Reference API Reference
------------- -------------

View file

@ -6,18 +6,16 @@ Overview
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------
`Instructions`_ Simple code showing how to connect ESP32 module to an Access Point: `esp-idf-template <https://github.com/espressif/esp-idf-template>`_.
API Reference API Reference
------------- -------------
`Instructions`_
.. _Instructions: ../template.html
Header Files Header Files
^^^^^^^^^^^^ ^^^^^^^^^^^^