pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Fix broken or incorrect link roles to IDF files & directories

Browse Source
This commit is contained in:
Angus Gratton
2020-02-10 19:52:41 +11:00
committed by Angus Gratton
parent a825985283
commit 99cdddeb63
36 changed files with 125 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/peripherals/uart.rst
+1 -1
View File
@@ -238,7 +238,7 @@ By default, the :cpp:func:`uart_driver_install` function installs the driver's i
The API provides a convenient way to handle specific interrupts discussed in this document by wrapping them into dedicated functions:
- **Event detection**: There are several events defined in :cpp:type:`uart_event_type_t` that may be reported to a user application using the FreeRTOS queue functionality. You can enable this functionality when calling :cpp:func:`uart_driver_install` described in :ref:`uart-api-driver-installation`. An example of using Event detection can be found in :example:`peripherals/uart_events`.
- **Event detection**: There are several events defined in :cpp:type:`uart_event_type_t` that may be reported to a user application using the FreeRTOS queue functionality. You can enable this functionality when calling :cpp:func:`uart_driver_install` described in :ref:`uart-api-driver-installation`. An example of using Event detection can be found in :example:`peripherals/uart/uart_events`.
- **FIFO space threshold or transmission timeout reached**: The Tx and Rx FIFO buffers can trigger an interrupt when they are filled with a specific number of characters, or on a timeout of sending or receiving data. To use these interrupts, do the following: