michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: netowrking: split API reference

Browse source 
Split API reference into smaller pages per group.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-02-01 10:11:18 -05:00
commit 13d10b843f
35 changed files with 490 additions and 212 deletions
Download patch file Download diff file Expand all files Collapse all files

211
doc/api/networking.rst
View file

@ -1,211 +0,0 @@
.. _networking_api:
Networking API
##############
.. contents::
:depth: 2
: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 configuration library
*****************************
.. doxygengroup:: net_config
:project: Zephyr
Network long timeout support
****************************
.. doxygengroup:: net_timeout
:project: Zephyr
Network offloading support
**************************
.. doxygengroup:: net_offload
:project: Zephyr
Network statistics
******************
.. doxygengroup:: net_stats
:project: Zephyr
Precision Time Protocol time
****************************
.. doxygengroup:: ptp_time
:project: Zephyr
Promiscuous mode support
************************
.. doxygengroup:: promiscuous
:project: Zephyr
Trickle timer support
*********************
.. doxygengroup:: trickle
:project: Zephyr
UDP
***
.. doxygengroup:: udp
:project: Zephyr
Hostname Configuration Library
******************************
.. doxygengroup:: net_hostname
:project: Zephyr
generic Precision Time Protocol (gPTP)
**************************************
.. doxygengroup:: gptp
:project: Zephyr
Network technologies
********************
Ethernet
========
.. doxygengroup:: ethernet
:project: Zephyr
Ethernet Management
===================
.. doxygengroup:: ethernet_mgmt
:project: Zephyr
Virtual LAN definitions and helpers
===================================
.. doxygengroup:: vlan
:project: Zephyr
Link Layer Discovery Protocol definitions and helpers
=====================================================
.. doxygengroup:: lldp
:project: Zephyr
IEEE 802.15.4
=============
.. doxygengroup:: ieee802154
:project: Zephyr
IEEE 802.15.4 Management
========================
.. doxygengroup:: ieee802154_mgmt
:project: Zephyr
Network and application libraries
*********************************
DHCPv4
======
.. doxygengroup:: dhcpv4
:project: Zephyr
MQTT 3.1.1
==========
.. doxygengroup:: mqtt_socket
:project: Zephyr
CoAP
====
.. doxygengroup:: coap
:project: Zephyr
DNS Resolve
===========
.. doxygengroup:: dns_resolve
:project: Zephyr
TLS credentials
***************
.. doxygengroup:: tls_credentials
:project: Zephyr

14
doc/api/networking/bsd_sockets.rst Normal file
View file

@ -0,0 +1,14 @@
.. _bsd_sockets_interface:
BSD Sockets
###########
Overview
********
API Reference
*************
.. doxygengroup:: bsd_sockets
:project: Zephyr

14
doc/api/networking/coap.rst Normal file
View file

@ -0,0 +1,14 @@
.. _coap_sock_interface:
CoAP
#####
Overview
********
API Reference
*************
.. doxygengroup:: coap
:project: Zephyr

14
doc/api/networking/dhcpv4.rst Normal file
View file

@ -0,0 +1,14 @@
.. _dhcpv4_interface:
DHCP v4
#######
Overview
********
API Reference
*************
.. doxygengroup:: dhcpv4
:project: Zephyr

14
doc/api/networking/dns_resolve.rst Normal file
View file

@ -0,0 +1,14 @@
.. _dns_resolve_interface:
DNS Resolve
###########
Overview
********
API Reference
*************
.. doxygengroup:: dns_resolve
:project: Zephyr

14
doc/api/networking/ethernet.rst Normal file
View file

@ -0,0 +1,14 @@
.. _ethernet_interface:
Ethernet
########
Overview
********
API Reference
*************
.. doxygengroup:: ethernet
:project: Zephyr

14
doc/api/networking/ethernet_mgmt.rst Normal file
View file

@ -0,0 +1,14 @@
.. _ethernet_mgmt_interface:
Ethernet Management
###################
Overview
********
API Reference
*************
.. doxygengroup:: ethernet_mgmt
:project: Zephyr

14
doc/api/networking/gptp.rst Normal file
View file

@ -0,0 +1,14 @@
.. _gptp_interface:
generic Precision Time Protocol (gPTP)
######################################
Overview
********
API Reference
*************
.. doxygengroup:: gptp
:project: Zephyr

23
doc/api/networking/ieee802154.rst Normal file
View file

@ -0,0 +1,23 @@
.. _ieee802154_interface:
IEEE802154
##########
Overview
********
API Reference
*************
IEEE 802.15.4
=============
.. doxygengroup:: ieee802154
:project: Zephyr
IEEE 802.15.4 Management
========================
.. doxygengroup:: ieee802154_mgmt
:project: Zephyr

34
doc/api/networking/index.rst Normal file
View file

@ -0,0 +1,34 @@
.. _networking:
Networking
##########
.. toctree::
:maxdepth: 1
bsd_sockets.rst
dhcpv4.rst
dns_resolve.rst
gptp.rst
ieee802154.rst
ip_4_6.rst
net_buf.rst
net_config.rst
net_context.rst
net_core.rst
net_hostname.rst
net_if.rst
net_l2.rst
net_linkaddr.rst
net_mgmt.rst
net_offload.rst
net_pkt.rst
net_stats.rst
net_tech.rst
net_timeout.rst
promiscuous.rst
protocols.rst
ptp_time.rst
tls_credentials.rst
trickle.rst
udp.rst

14
doc/api/networking/ip_4_6.rst Normal file
View file

@ -0,0 +1,14 @@
.. _ip_4_6_interface:
IPv4/IPv6 Primitives and Helpers
################################
Overview
********
API Reference
*************
.. doxygengroup:: ip_4_6
:project: Zephyr

14
doc/api/networking/lldp.rst Normal file
View file

@ -0,0 +1,14 @@
.. _lldp_interface:
LLDP
####
Overview
********
API Reference
*************
.. doxygengroup:: lldp
:project: Zephyr

14
doc/api/networking/mqtt.rst Normal file
View file

@ -0,0 +1,14 @@
.. _mqtt_socket_interface:
MQTT
#####
Overview
********
API Reference
*************
.. doxygengroup:: mqtt_socket
:project: Zephyr

14
doc/api/networking/net_buf.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_buf_interface:
Network Buffer
##############
Overview
********
API Reference
*************
.. doxygengroup:: net_buf
:project: Zephyr

14
doc/api/networking/net_config.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_config_interface:
Configuration Library
######################
Overview
********
API Reference
*************
.. doxygengroup:: net_config
:project: Zephyr

14
doc/api/networking/net_context.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_context_interface:
Networking Context
##################
Overview
********
API Reference
*************
.. doxygengroup:: net_context
:project: Zephyr

14
doc/api/networking/net_core.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_core_interface:
Core Helpers
#############
Overview
********
API Reference
*************
.. doxygengroup:: net_core
:project: Zephyr

14
doc/api/networking/net_hostname.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_hostname_interface:
Hostname Configuration
######################
Overview
********
API Reference
*************
.. doxygengroup:: net_hostname
:project: Zephyr

14
doc/api/networking/net_if.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_if_interface:
Network Interface
#################
Overview
********
API Reference
*************
.. doxygengroup:: net_if
:project: Zephyr

14
doc/api/networking/net_l2.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_l2_interface:
L2 Layer Management
###################
Overview
********
API Reference
*************
.. doxygengroup:: net_l2
:project: Zephyr

14
doc/api/networking/net_linkaddr.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_linkaddr_interface:
Link Adreess
############
Overview
********
API Reference
*************
.. doxygengroup:: net_linkaddr
:project: Zephyr

14
doc/api/networking/net_mgmt.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_mgmt_interface:
Network Management
##################
Overview
********
API Reference
*************
.. doxygengroup:: net_mgmt
:project: Zephyr

14
doc/api/networking/net_offload.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_offload_interface:
Network Offloding
#################
Overview
********
API Reference
*************
.. doxygengroup:: net_offload
:project: Zephyr

14
doc/api/networking/net_pkt.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_pkt_interface:
Packet Management
#################
Overview
********
API Reference
*************
.. doxygengroup:: net_pkt
:project: Zephyr

14
doc/api/networking/net_stats.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_stats_interface:
Network Statistics
##################
Overview
********
API Reference
*************
.. doxygengroup:: net_stats
:project: Zephyr

13
doc/api/networking/net_tech.rst Normal file
View file

@ -0,0 +1,13 @@
.. _net_tech:
Networking Technologies
########################
.. toctree::
:maxdepth: 1
ethernet.rst
ethernet_mgmt
vlan
lldp

14
doc/api/networking/net_timeout.rst Normal file
View file

@ -0,0 +1,14 @@
.. _net_timeout_interface:
Network Timeout
###############
Overview
********
API Reference
*************
.. doxygengroup:: net_timeout
:project: Zephyr

14
doc/api/networking/promiscuous.rst Normal file
View file

@ -0,0 +1,14 @@
.. _promiscuous_interface:
Promiscuous Mode
################
Overview
********
API Reference
*************
.. doxygengroup:: promiscuous
:project: Zephyr

12
doc/api/networking/protocols.rst Normal file
View file

@ -0,0 +1,12 @@
.. _net_protocols:
Protocols
##########
.. toctree::
:maxdepth: 1
coap
mqtt

15
doc/api/networking/ptp_time.rst Normal file
View file

@ -0,0 +1,15 @@
.. _ptp_time_interface:
Precision Time Protocol (PTP) time
##################################
Overview
********
API Reference
*************
.. doxygengroup:: ptp_time
:project: Zephyr

14
doc/api/networking/tls_credentials.rst Normal file
View file

@ -0,0 +1,14 @@
.. _tls_credentials_interface:
TLS Credentials
###############
Overview
********
API Reference
*************
.. doxygengroup:: tls_credentials
:project: Zephyr

14
doc/api/networking/trickle.rst Normal file
View file

@ -0,0 +1,14 @@
.. _trickle_interface:
Trickle Timer Support
#####################
Overview
********
API Reference
*************
.. doxygengroup:: trickle
:project: Zephyr

14
doc/api/networking/udp.rst Normal file
View file

@ -0,0 +1,14 @@
.. _udp_interface:
UDP
###
Overview
********
API Reference
*************
.. doxygengroup:: udp
:project: Zephyr

14
doc/api/networking/vlan.rst Normal file
View file

@ -0,0 +1,14 @@
.. _vlan_interface:
VLAN
####
Overview
********
API Reference
*************
.. doxygengroup:: vlan
:project: Zephyr

2
doc/reference.rst
View file

@ -14,7 +14,7 @@ API Reference
kernel/kernel.rst
subsystems/logging/index
api/misc_api
api/networking.rst
api/networking/index
api/peripherals/index.rst
subsystems/power_management.rst
subsystems/shell/shell