doc: net: group all networking APIs in doxygen

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2017-11-17 11:43:53 -05:00 committed by Anas Nashif
commit ca9285d1bb
26 changed files with 34 additions and 1 deletions

View file

@ -24,6 +24,7 @@ extern "C" {
/** /**
* @brief Address resolution (ARP) library * @brief Address resolution (ARP) library
* @defgroup arp ARP Library * @defgroup arp ARP Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -22,6 +22,7 @@ extern "C" {
/** /**
* @brief Network buffer library * @brief Network buffer library
* @defgroup net_buf Network Buffer Library * @defgroup net_buf Network Buffer Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -26,7 +26,8 @@ extern "C" {
/** /**
* @brief COAP library * @brief COAP library
* @defgroup COAP Library * @defgroup coap COAP Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -18,6 +18,7 @@ extern "C" {
/** /**
* @brief DHCPv4 * @brief DHCPv4
* @defgroup dhcpv4 DHCPv4 * @defgroup dhcpv4 DHCPv4
* @ingroup networking
* @{ * @{
*/ */

View file

@ -23,6 +23,7 @@ extern "C" {
/** /**
* @brief DNS resolving library * @brief DNS resolving library
* @defgroup dns_resolve DNS Resolve Library * @defgroup dns_resolve DNS Resolve Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -27,6 +27,7 @@ extern "C" {
/** /**
* @brief Ethernet support functions * @brief Ethernet support functions
* @defgroup ethernet Ethernet Support Functions * @defgroup ethernet Ethernet Support Functions
* @ingroup networking
* @{ * @{
*/ */

View file

@ -18,6 +18,7 @@ extern "C" {
/** /**
* @brief Network hostname configuration library * @brief Network hostname configuration library
* @defgroup net_hostname Network Hostname Library * @defgroup net_hostname Network Hostname Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -39,6 +39,7 @@ extern "C" {
/** /**
* @brief HTTP client and server library * @brief HTTP client and server library
* @defgroup http HTTP Library * @defgroup http HTTP Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -16,6 +16,7 @@ extern "C" {
/** /**
* @brief HTTP client and server library * @brief HTTP client and server library
* @defgroup http_legacy HTTP Library * @defgroup http_legacy HTTP Library
* @ingroup networking
* @deprecated This library is deprecated. * @deprecated This library is deprecated.
* @{ * @{
*/ */

View file

@ -22,6 +22,7 @@ extern "C" {
/** /**
* @brief IEEE 802.15.4 library * @brief IEEE 802.15.4 library
* @defgroup ieee802154 IEEE 802.15.4 Library * @defgroup ieee802154 IEEE 802.15.4 Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -18,6 +18,7 @@ extern "C" {
/** /**
* @brief MQTT library * @brief MQTT library
* @defgroup mqtt MQTT library * @defgroup mqtt MQTT library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -51,6 +51,7 @@ extern "C" {
/** /**
* @brief Network application library * @brief Network application library
* @defgroup net_app Network Application Library * @defgroup net_app Network Application Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -16,6 +16,7 @@
/** /**
* @brief Application network context * @brief Application network context
* @defgroup net_context Application network context * @defgroup net_context Application network context
* @ingroup networking
* @{ * @{
*/ */

View file

@ -17,9 +17,17 @@
extern "C" { extern "C" {
#endif #endif
/**
* @brief Networking
* @defgroup networking Networking
* @{
* @}
*/
/** /**
* @brief Network core library * @brief Network core library
* @defgroup net_core Network Core Library * @defgroup net_core Network Core Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -15,6 +15,7 @@
/** /**
* @brief Network Interface abstraction layer * @brief Network Interface abstraction layer
* @defgroup net_if Network Interface abstraction layer * @defgroup net_if Network Interface abstraction layer
* @ingroup networking
* @{ * @{
*/ */

View file

@ -16,6 +16,7 @@
/** /**
* @brief IPv4/IPv6 primitives and helpers * @brief IPv4/IPv6 primitives and helpers
* @defgroup ip_4_6 IPv4/IPv6 primitives and helpers * @defgroup ip_4_6 IPv4/IPv6 primitives and helpers
* @ingroup networking
* @{ * @{
*/ */

View file

@ -21,6 +21,7 @@ extern "C" {
/** /**
* @brief Network Layer 2 abstraction layer * @brief Network Layer 2 abstraction layer
* @defgroup net_l2 Network L2 Abstraction Layer * @defgroup net_l2 Network L2 Abstraction Layer
* @ingroup networking
* @{ * @{
*/ */

View file

@ -23,6 +23,7 @@ extern "C" {
/** /**
* @brief Network link address library * @brief Network link address library
* @defgroup net_linkaddr Network Link Address Library * @defgroup net_linkaddr Network Link Address Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -19,6 +19,7 @@ extern "C" {
/** /**
* @brief Network Management * @brief Network Management
* @defgroup net_mgmt Network Management * @defgroup net_mgmt Network Management
* @ingroup networking
* @{ * @{
*/ */

View file

@ -15,6 +15,7 @@
/** /**
* @brief Network offloading interface * @brief Network offloading interface
* @defgroup net_offload Network Offloading Interface * @defgroup net_offload Network Offloading Interface
* @ingroup networking
* @{ * @{
*/ */

View file

@ -34,6 +34,7 @@ extern "C" {
/** /**
* @brief Network packet management library * @brief Network packet management library
* @defgroup net_pkt Network Packet Library * @defgroup net_pkt Network Packet Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -23,6 +23,7 @@ extern "C" {
/** /**
* @brief Network statistics library * @brief Network statistics library
* @defgroup net_stats Network Statistics Library * @defgroup net_stats Network Statistics Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -17,6 +17,7 @@
/** /**
* @brief BSD Sockets compatible API * @brief BSD Sockets compatible API
* @defgroup bsd_sockets BSD Sockets compatible API * @defgroup bsd_sockets BSD Sockets compatible API
* @ingroup networking
* @{ * @{
*/ */

View file

@ -26,6 +26,7 @@ extern "C" {
/** /**
* @brief Trickle algorithm library * @brief Trickle algorithm library
* @defgroup trickle Trickle Algorithm Library * @defgroup trickle Trickle Algorithm Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -24,6 +24,7 @@ extern "C" {
/** /**
* @brief UDP library * @brief UDP library
* @defgroup udp UDP Library * @defgroup udp UDP Library
* @ingroup networking
* @{ * @{
*/ */

View file

@ -27,6 +27,7 @@ extern "C" {
/** /**
* @brief COAP library * @brief COAP library
* @defgroup zoap COAP Library * @defgroup zoap COAP Library
* @ingroup networking
* @{ * @{
*/ */