mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-14 00:51:57 +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>
164 lines
2.4 KiB
ReStructuredText
164 lines
2.4 KiB
ReStructuredText
.. _networking_api:
|
|
|
|
Networking API
|
|
##############
|
|
|
|
.. contents::
|
|
:depth: 1
|
|
:local:
|
|
:backlinks: top
|
|
|
|
This is the full set of networking public APIs. Their exposure
|
|
depends on relevant Kconfig options. For instance IPv6 related
|
|
APIs will not be present if :option:`CONFIG_NET_IPV6` has not
|
|
been selected.
|
|
|
|
.. comment
|
|
not documenting
|
|
.. doxygengroup:: networking
|
|
.. doxygengroup:: arp
|
|
|
|
Network core helpers
|
|
********************
|
|
|
|
.. doxygengroup:: net_core
|
|
:project: Zephyr
|
|
|
|
Network buffers
|
|
***************
|
|
|
|
.. doxygengroup:: net_buf
|
|
:project: Zephyr
|
|
|
|
Network packet management
|
|
*************************
|
|
|
|
.. doxygengroup:: net_pkt
|
|
:project: Zephyr
|
|
|
|
IPv4/IPv6 primitives and helpers
|
|
********************************
|
|
|
|
.. doxygengroup:: ip_4_6
|
|
:project: Zephyr
|
|
|
|
Network interface
|
|
*****************
|
|
|
|
.. doxygengroup:: net_if
|
|
:project: Zephyr
|
|
|
|
Network Management
|
|
******************
|
|
|
|
.. doxygengroup:: net_mgmt
|
|
:project: Zephyr
|
|
|
|
Network layer 2 management
|
|
**************************
|
|
|
|
.. doxygengroup:: net_l2
|
|
:project: Zephyr
|
|
|
|
Network link address
|
|
********************
|
|
|
|
.. doxygengroup:: net_linkaddr
|
|
:project: Zephyr
|
|
|
|
Application network context
|
|
***************************
|
|
|
|
.. doxygengroup:: net_context
|
|
:project: Zephyr
|
|
|
|
BSD Sockets compatible API
|
|
**************************
|
|
|
|
.. doxygengroup:: bsd_sockets
|
|
:project: Zephyr
|
|
|
|
Network offloading support
|
|
**************************
|
|
|
|
.. doxygengroup:: net_offload
|
|
:project: Zephyr
|
|
|
|
Network statistics
|
|
******************
|
|
|
|
.. doxygengroup:: net_stats
|
|
:project: Zephyr
|
|
|
|
Trickle timer support
|
|
*********************
|
|
|
|
.. doxygengroup:: trickle
|
|
:project: Zephyr
|
|
|
|
UDP
|
|
***
|
|
|
|
.. doxygengroup:: udp
|
|
:project: Zephyr
|
|
|
|
Hostname Configuration Library
|
|
******************************
|
|
|
|
.. doxygengroup:: net_hostname
|
|
:project: Zephyr
|
|
|
|
Network technologies
|
|
********************
|
|
|
|
Ethernet
|
|
========
|
|
|
|
.. doxygengroup:: ethernet
|
|
:project: Zephyr
|
|
|
|
IEEE 802.15.4
|
|
=============
|
|
|
|
.. doxygengroup:: ieee802154
|
|
:project: Zephyr
|
|
|
|
Network and application libraries
|
|
*********************************
|
|
|
|
Network application
|
|
===================
|
|
|
|
.. doxygengroup:: net_app
|
|
:project: Zephyr
|
|
|
|
DHCPv4
|
|
======
|
|
|
|
.. doxygengroup:: dhcpv4
|
|
:project: Zephyr
|
|
|
|
MQTT 3.1.1
|
|
==========
|
|
|
|
.. doxygengroup:: mqtt
|
|
:project: Zephyr
|
|
|
|
CoAP
|
|
====
|
|
|
|
.. doxygengroup:: coap
|
|
:project: Zephyr
|
|
|
|
DNS Resolve
|
|
===========
|
|
|
|
.. doxygengroup:: dns_resolve
|
|
:project: Zephyr
|
|
|
|
HTTP
|
|
====
|
|
|
|
.. doxygengroup:: http
|
|
:project: Zephyr
|