doc/api/networking: Add existing network protocol libraries APIs

DHCPv4, MQTT, DNS client, ...

Change-Id: I5c5d7437bb53610678eba38d307c86694ac01da9
Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>

.known-issues/doc/networking.conf

@@ -35,3 +35,15 @@
 ^[ \t]*Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
 ^.*struct net_if __aligned\(32\)
 ^[- \t]*\^
+#
+# include/net/dns_client.h
+#
+^(?P<filename>[-._/\w]+/doc/api/networking.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
+^[ \t]*
+^[ \t]*\^
+^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
+^[ \t]*
+^[ \t]*\^
+^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+]
+^.*dns_context.address
+^[- \t]*\^

doc/api/networking.rst

@@ -14,7 +14,7 @@ APIs will not be present if :option:`CONFIG_NET_IPV6` has not
 been selected.
 
 IPv4/IPv6 primitives and helpers
-*************************************
+********************************
 
 .. doxygengroup:: ip_4_6
    :project: Zephyr
@@ -40,3 +40,27 @@ Application network context
 .. doxygengroup:: net_context
    :project: Zephyr
    :content-only:
+
+Network and application libraries
+*********************************
+
+DHCPv4
+======
+
+.. doxygengroup:: dhcpv4
+   :project: Zephyr
+   :content-only:
+
+MQTT 3.1.1
+==========
+
+.. doxygengroup:: mqtt
+   :project: Zephyr
+   :content-only:
+
+DNS Client
+==========
+
+.. doxygengroup:: dns_client
+   :project: Zephyr
+   :content-only:

include/net/dns_client.h

@@ -10,6 +10,12 @@
 #include <net/net_context.h>
 #include <net/net_ip.h>
 
+/**
+ * @brief DNS Client library
+ * @defgroup dns_client DNS Client Library
+ * @{
+ */
+
 enum dns_query_type {
 	DNS_QUERY_TYPE_A = 1,	 /* IPv4 */
 	DNS_QUERY_TYPE_AAAA = 28 /* IPv6 */
@@ -95,4 +101,8 @@ int dns_init(struct dns_context *ctx);
  */
 int dns_resolve(struct dns_context *ctx);
 
+/**
+ * @}
+ */
+
 #endif

include/net/mqtt.h

@@ -10,6 +10,12 @@
 #include <net/mqtt_types.h>
 #include <net/net_context.h>
 
+/**
+ * @brief MQTT library
+ * @defgroup mqtt MQTT library
+ * @{
+ */
+
 /**
  * @brief mqtt_app	MQTT application type
  */
@@ -392,4 +398,8 @@ int mqtt_rx_unsuback(struct mqtt_ctx *ctx, struct net_buf *rx);
  */
 int mqtt_rx_publish(struct mqtt_ctx *ctx, struct net_buf *rx);
 
+/**
+ * @}
+ */
+
 #endif

include/net/mqtt_types.h

@@ -9,6 +9,12 @@
 
 #include <stdint.h>
 
+/**
+ * @brief MQTT library
+ * @defgroup mqtt MQTT library
+ * @{
+ */
+
 /**
  * @brief	MQTT Packet Type enum
  * @details	See MQTT 2.2.1: MQTT Control Packet type
@@ -76,4 +82,8 @@ struct mqtt_publish_msg {
 	uint16_t msg_len;
 };
 
+/**
+ * @}
+ */
+
 #endif

include/net/zoap.h

@@ -19,6 +19,12 @@
 
 #include <misc/slist.h>
 
+/**
+ * @brief COAP library
+ * @defgroup zoap COAP Library
+ * @{
+ */
+
 /**
  * @brief Set of CoAP packet options we are aware of.
  *
@@ -554,4 +560,8 @@ static inline uint16_t zoap_next_id(void)
  */
 uint8_t *zoap_next_token(void);
 
+/**
+ * @}
+ */
+
 #endif /* __ZOAP_H__ */

include/net/zoap_link_format.h

@@ -13,6 +13,12 @@
 #ifndef __LINK_FORMAT_H__
 #define __LINK_FORMAT_H__
 
+/**
+ * @brief COAP library
+ * @defgroup zoap COAP Library
+ * @{
+ */
+
 #define _ZOAP_WELL_KNOWN_CORE_PATH \
 	((const char * const[]) { ".well-known", "core", NULL })
 
@@ -39,4 +45,8 @@ struct zoap_core_metadata {
 	void *user_data;
 };
 
+/**
+ * @}
+ */
+
 #endif /* __LINK_FORMAT_H__ */