diff --git a/.known-issues/doc/networking.conf b/.known-issues/doc/networking.conf index a853200f496..b1983411ece 100644 --- a/.known-issues/doc/networking.conf +++ b/.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[-._/\w]+/doc/api/networking.rst):(?P[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]*\^ diff --git a/doc/api/networking.rst b/doc/api/networking.rst index 72e00b17f90..e847bd9060f 100644 --- a/doc/api/networking.rst +++ b/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: diff --git a/include/net/dns_client.h b/include/net/dns_client.h index de9b246a82e..976a74a9741 100644 --- a/include/net/dns_client.h +++ b/include/net/dns_client.h @@ -10,6 +10,12 @@ #include #include +/** + * @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 diff --git a/include/net/mqtt.h b/include/net/mqtt.h index e432d3c576a..b05d34f37bc 100644 --- a/include/net/mqtt.h +++ b/include/net/mqtt.h @@ -10,6 +10,12 @@ #include #include +/** + * @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 diff --git a/include/net/mqtt_types.h b/include/net/mqtt_types.h index 96feae983c6..9bf275ef4d9 100644 --- a/include/net/mqtt_types.h +++ b/include/net/mqtt_types.h @@ -9,6 +9,12 @@ #include +/** + * @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 diff --git a/include/net/zoap.h b/include/net/zoap.h index e942197b9b2..04a0853b3cb 100644 --- a/include/net/zoap.h +++ b/include/net/zoap.h @@ -19,6 +19,12 @@ #include +/** + * @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__ */ diff --git a/include/net/zoap_link_format.h b/include/net/zoap_link_format.h index 47a39c0c1bb..670d4937053 100644 --- a/include/net/zoap_link_format.h +++ b/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__ */