Merge branch 'fix/esp_netif_docs_v5.4' into 'release/v5.4'

fix(docs): Remove esp_netif doxygen groups (v5.4)

See merge request espressif/esp-idf!42778

Author: Jiang Jiang Jian

components/esp_netif/include/esp_netif.h

@@ -18,16 +18,6 @@
 extern "C" {
 #endif
 
-/**
- * @defgroup ESP_NETIF_INIT_API ESP-NETIF Initialization API
- * @brief Initialization and deinitialization of underlying TCP/IP stack and esp-netif instances
- *
- */
-
-/** @addtogroup ESP_NETIF_INIT_API
- * @{
- */
-
 /**
  * @brief  Initialize the underlying TCP/IP stack
  *
@@ -97,30 +87,6 @@ esp_err_t esp_netif_set_driver_config(esp_netif_t *esp_netif,
  */
 esp_err_t esp_netif_attach(esp_netif_t *esp_netif, esp_netif_iodriver_handle driver_handle);
 
-/**
- * @}
- */
-
-/**
- * @defgroup ESP_NETIF_DATA_IO_API ESP-NETIF Input Output API
- * @brief Input and Output functions to pass data packets from communication media (IO driver)
- * to TCP/IP stack.
- *
- * These functions are usually not directly called from user code, but installed, or registered
- * as callbacks in either IO driver on one hand or TCP/IP stack on the other. More specifically
- * esp_netif_receive is typically called from io driver on reception callback to input the packets
- * to TCP/IP stack. Similarly esp_netif_transmit is called from the TCP/IP stack whenever
- * a packet ought to output to the communication media.
- *
- * @note These IO functions are registered (installed) automatically for default interfaces
- * (interfaces with the keys such as WIFI_STA_DEF, WIFI_AP_DEF, ETH_DEF). Custom interface
- * has to register these IO functions when creating interface using @ref esp_netif_new
- *
- */
-
-/** @addtogroup ESP_NETIF_DATA_IO_API
- * @{
- */
 
 /**
  * @brief  Passes the raw packets from communication media to the appropriate TCP/IP stack
@@ -165,20 +131,7 @@ esp_err_t esp_netif_tx_rx_event_enable(esp_netif_t *esp_netif);
  */
 esp_err_t esp_netif_tx_rx_event_disable(esp_netif_t *esp_netif);
 
-/**
- * @}
- */
 
-/**
- * @defgroup ESP_NETIF_LIFECYCLE ESP-NETIF Lifecycle control
- * @brief These APIS define basic building blocks to control network interface lifecycle, i.e.
- * start, stop, set_up or set_down. These functions can be directly used as event handlers
- * registered to follow the events from communication media.
- */
-
-/** @addtogroup ESP_NETIF_LIFECYCLE
- * @{
- */
 
 /**
  * @brief Default building block for network interface action upon IO driver start event
@@ -369,19 +322,6 @@ esp_err_t esp_netif_join_ip6_multicast_group(esp_netif_t *esp_netif, const esp_i
  */
 esp_err_t esp_netif_leave_ip6_multicast_group(esp_netif_t *esp_netif, const esp_ip6_addr_t *addr);
 
-/**
- * @}
- */
-
-/**
- * @defgroup ESP_NETIF_GET_SET ESP-NETIF Runtime configuration
- * @brief Getters and setters for various TCP/IP related parameters
- */
-
-/** @addtogroup ESP_NETIF_GET_SET
- * @{
- */
-
 /**
  * @brief Set the mac address for the interface instance
 
@@ -578,18 +518,6 @@ esp_err_t esp_netif_napt_enable(esp_netif_t *esp_netif);
 */
 esp_err_t esp_netif_napt_disable(esp_netif_t *esp_netif);
 
-/**
- * @}
- */
-
-/**
- * @defgroup ESP_NETIF_NET_DHCP ESP-NETIF DHCP Settings
- * @brief Network stack related interface to DHCP client and server
- */
-
-/** @addtogroup ESP_NETIF_NET_DHCP
- * @{
- */
 
 /**
  * @brief  Set or Get DHCP server option
@@ -754,18 +682,7 @@ esp_err_t esp_netif_dhcps_stop(esp_netif_t *esp_netif);
  */
 esp_err_t esp_netif_dhcps_get_clients_by_mac(esp_netif_t *esp_netif, int num, esp_netif_pair_mac_ip_t *mac_ip_pair);
 
-/**
- * @}
- */
 
-/**
- * @defgroup ESP_NETIF_NET_DNS ESP-NETIF DNS Settings
- * @brief Network stack related interface to NDS
- */
-
-/** @addtogroup ESP_NETIF_NET_DNS
- * @{
- */
 
 /**
  * @brief  Set DNS Server information
@@ -822,18 +739,9 @@ esp_err_t esp_netif_set_dns_info(esp_netif_t *esp_netif, esp_netif_dns_type_t ty
  */
 esp_err_t esp_netif_get_dns_info(esp_netif_t *esp_netif, esp_netif_dns_type_t type, esp_netif_dns_info_t *dns);
 
-/**
- * @}
- */
 
-/**
- * @defgroup ESP_NETIF_NET_IP ESP-NETIF IP address related interface
- * @brief Network stack related interface to IP
- */
 
-/** @addtogroup ESP_NETIF_NET_IP
- * @{
- */
+
 #if CONFIG_LWIP_IPV6
 /**
  * @brief  Create interface link-local IPv6 address
@@ -992,18 +900,9 @@ esp_err_t esp_netif_str_to_ip4(const char *src, esp_ip4_addr_t *dst);
  */
 esp_err_t esp_netif_str_to_ip6(const char *src, esp_ip6_addr_t *dst);
 
-/**
- * @}
- */
 
-/**
- * @defgroup ESP_NETIF_CONVERT ESP-NETIF Conversion utilities
- * @brief  ESP-NETIF conversion utilities to related keys, flags, implementation handle
- */
 
-/** @addtogroup ESP_NETIF_CONVERT
- * @{
- */
+
 
 /**
  * @brief Gets media driver handle for this esp-netif instance
@@ -1071,18 +970,6 @@ int esp_netif_get_route_prio(esp_netif_t *esp_netif);
  */
 int32_t esp_netif_get_event_id(esp_netif_t *esp_netif, esp_netif_ip_event_type_t event_type);
 
-/**
- * @}
- */
-
-/**
- * @defgroup ESP_NETIF_LIST ESP-NETIF List of interfaces
- * @brief  APIs to enumerate all registered interfaces
- */
-
-/** @addtogroup ESP_NETIF_LIST
- * @{
- */
 
 /**
  * @brief Iterates over list of interfaces. Returns first netif if NULL given as parameter
@@ -1154,13 +1041,6 @@ void esp_netif_netstack_buf_ref(void *netstack_buf);
  */
 void esp_netif_netstack_buf_free(void *netstack_buf);
 
-/**
- * @}
- */
-
-/** @addtogroup ESP_NETIF_TCPIP_EXEC
- * @{
- */
 
 /**
  * @brief  TCPIP thread safe callback used with esp_netif_tcpip_exec()
@@ -1175,10 +1055,6 @@ typedef esp_err_t (*esp_netif_callback_fn)(void *ctx);
  */
 esp_err_t esp_netif_tcpip_exec(esp_netif_callback_fn fn, void *ctx);
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif

components/esp_netif/include/esp_netif_sntp.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -16,17 +16,6 @@
 extern "C" {
 #endif
 
-/**
- * @defgroup ESP_NETIF_SNTP_API ESP-NETIF SNTP API
- * @brief SNTP API for underlying TCP/IP stack
- *
- */
-
-/** @addtogroup ESP_NETIF_SNTP_API
- * @{
- */
-
-
 /**
  * @brief Time sync notification function
  */
@@ -101,7 +90,7 @@ void esp_netif_sntp_deinit(void);
 /**
  * @brief Wait for time sync event
  * @param tout Specified timeout in RTOS ticks
- * @return ESP_TIMEOUT if sync event didn't came withing the timeout
+ * @return ESP_TIMEOUT if sync event didn't came within the timeout
  *         ESP_ERR_NOT_FINISHED if the sync event came, but we're in smooth update mode and still in progress (SNTP_SYNC_STATUS_IN_PROGRESS)
  *         ESP_OK if time sync'ed
  */
@@ -118,10 +107,6 @@ esp_err_t esp_netif_sntp_sync_wait(TickType_t tout);
  */
 esp_err_t esp_netif_sntp_reachability(unsigned int index, unsigned int *reachability);
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif