mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-15 13:45:23 +00:00
621ac8f84b
Some API material (from doxygen comments) wasn't included in the generated documentation because there was no doxygengroup Sphinx directive to display them. This PR add content into appropriate places in existing documentation (e.g., Bluetooth Cryptography APIs into the Bluetooth API doc) and creates two new collections for Display and Miscellaneous APIs. Comments added to the .rst files to mention doxygengroups that are intentionally excluded (because they're organizational groups containing subgroups that are included). Sorted the Bluetooth API list, mostly. Fixed a couple doxygen group titles defined in the include files, and added a few patterns to filter new "expected" errors from the document generation process. Legacy and deprecated APIs remain left out, as intended: http_legacy (net/http_legacy.h) spi_interface_legacy (spi_legacy.h) zoap (net/zoap.h) fixes: Issue #5051 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
102 lines
1.6 KiB
ReStructuredText
102 lines
1.6 KiB
ReStructuredText
.. _io_interfaces:
|
|
|
|
Input / Output Driver APIs
|
|
###########################
|
|
|
|
.. contents::
|
|
:depth: 1
|
|
:local:
|
|
:backlinks: top
|
|
|
|
.. comment
|
|
not documenting
|
|
.. doxygengroup:: io_interfaces
|
|
|
|
ADC Interface
|
|
*************
|
|
|
|
.. doxygengroup:: adc_interface
|
|
:project: Zephyr
|
|
|
|
DMA Interface
|
|
*************
|
|
|
|
.. doxygengroup:: DMA_interface
|
|
:project: Zephyr
|
|
|
|
GPIO Interface
|
|
**************
|
|
|
|
.. doxygengroup:: gpio_interface
|
|
:project: Zephyr
|
|
|
|
I2C Interface
|
|
*************
|
|
|
|
.. doxygengroup:: i2c_interface
|
|
:project: Zephyr
|
|
|
|
I2S Interface
|
|
*************
|
|
|
|
The I2S (Inter-IC Sound) API provides support for the standard I2S interface
|
|
as well as common non-standard extensions such as PCM Short/Long Frame Sync
|
|
and Left/Right Justified Data Formats.
|
|
|
|
.. doxygengroup:: i2s_interface
|
|
:project: Zephyr
|
|
|
|
IPM Interface
|
|
*************
|
|
|
|
.. doxygengroup:: ipm_interface
|
|
:project: Zephyr
|
|
|
|
PWM Interface
|
|
*************
|
|
|
|
.. doxygengroup:: pwm_interface
|
|
:project: Zephyr
|
|
|
|
Pinmux Interface
|
|
****************
|
|
|
|
.. doxygengroup:: pinmux_interface
|
|
:project: Zephyr
|
|
|
|
SPI Interface
|
|
*************
|
|
|
|
.. doxygengroup:: spi_interface
|
|
:project: Zephyr
|
|
|
|
Entropy Interface
|
|
*****************
|
|
|
|
.. doxygengroup:: entropy_interface
|
|
:project: Zephyr
|
|
|
|
UART Interface
|
|
**************
|
|
|
|
.. doxygengroup:: uart_interface
|
|
:project: Zephyr
|
|
|
|
Flash Interface
|
|
***************
|
|
|
|
.. doxygengroup:: flash_interface
|
|
:project: Zephyr
|
|
|
|
Sensor Interface
|
|
****************
|
|
|
|
.. doxygengroup:: sensor_interface
|
|
:project: Zephyr
|
|
|
|
Counter Interface
|
|
*****************
|
|
|
|
.. doxygengroup:: counter_interface
|
|
:project: Zephyr
|