mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-14 19:52:44 +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>
28 lines
619 B
ReStructuredText
28 lines
619 B
ReStructuredText
.. _api:
|
|
|
|
API Documentation
|
|
#################
|
|
|
|
Welcome to the Zephyr Project's :abbr:`API (Application Programing Interface)`
|
|
documentation.
|
|
|
|
This section contains the API documentation automatically extracted from the
|
|
code. If you are looking for a specific API, enter it on the search box.
|
|
The search results display all sections containing information
|
|
about that API.
|
|
|
|
The Zephyr APIs are used the same way on all SoCs and boards.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
kernel_api.rst
|
|
device.rst
|
|
bluetooth.rst
|
|
networking.rst
|
|
io_interfaces.rst
|
|
power_management_api
|
|
file_system
|
|
display_api
|
|
misc_api
|