Merge branch 'docs/esp_netif_programmer_manual' into 'master'

esp netif: formal fixes (docs and c++ sentinels again)

Closes IDFGH-2265

See merge request espressif/esp-idf!6819

components/esp_netif/include/esp_netif_net_stack.h

@@ -62,8 +62,10 @@ void* esp_netif_get_netif_impl(esp_netif_t *esp_netif);
   * This function gets called from network stack to output packets to IO driver.
   *
   * @param[in]  esp_netif Handle to esp-netif instance
-  * @param[in]  data Data to be tranmitted
+  * @param[in]  data Data to be transmitted
   * @param[in]  len Length of the data frame
+  *
+  * @return   ESP_OK on success, an error passed from the I/O driver otherwise
   */
 esp_err_t esp_netif_transmit(esp_netif_t *esp_netif, void* data, size_t len);
 
@@ -75,7 +77,7 @@ esp_err_t esp_netif_transmit(esp_netif_t *esp_netif, void* data, size_t len);
   * to avoid copying)
   *
   * @param[in]  esp_netif Handle to esp-netif instance
-  * @param[in]  void* buffer: rx buffer pointer
+  * @param[in]  buffer Rx buffer pointer
   */
 void esp_netif_free_rx_buffer(void *esp_netif, void* buffer);
 

components/esp_netif/lwip/esp_netif_lwip.c

@@ -531,7 +531,7 @@ esp_err_t esp_netif_set_mac(esp_netif_t *esp_netif, uint8_t mac[])
 
 static void esp_netif_dhcps_cb(u8_t client_ip[4])
 {
-    ESP_LOGI(TAG, "softAP assign IP to station,IP is: %d.%d.%d.%d",
+    ESP_LOGI(TAG, "DHCP server assigned IP to a station, IP is: %d.%d.%d.%d",
              client_ip[0], client_ip[1], client_ip[2], client_ip[3]);
     ip_event_ap_staipassigned_t evt;
 

components/tcpip_adapter/include/tcpip_adapter.h

@@ -23,6 +23,10 @@
 
 #include "tcpip_adapter_types.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /**
  * @brief tcpip adapter legacy init. It is used only to set the compatibility mode of esp-netif, which
  * will enable backward compatibility of esp-netif.
@@ -245,4 +249,8 @@ esp_err_t tcpip_adapter_get_hostname(tcpip_adapter_if_t tcpip_if, const char **h
  */
 esp_err_t tcpip_adapter_set_default_wifi_handlers(void);
 
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
 #endif //_TCPIP_ADAPTER_H_

components/tcpip_adapter/include/tcpip_adapter_compatible/tcpip_adapter_compat.h

@@ -15,6 +15,10 @@
 #ifndef _TCPIP_ADAPTER_COMPAT_H_
 #define _TCPIP_ADAPTER_COMPAT_H_
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /**
  * @brief This function is called from ethernet driver init code to facilitate
  * autostart fo the driver in backward compatible tcpip_adapter way
@@ -54,4 +58,8 @@ esp_err_t tcpip_adapter_set_default_wifi_handlers(void);
  */
 esp_err_t tcpip_adapter_clear_default_wifi_handlers(void);
 
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
 #endif //_TCPIP_ADAPTER_COMPAT_H_

components/tcpip_adapter/include/tcpip_adapter_types.h

@@ -18,6 +18,11 @@
 #include "lwip/ip_addr.h"
 #include "dhcpserver/dhcpserver.h"
 #include "esp_netif_sta_list.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 //
 // Define compatible types if tcpip_adapter interface used
 //
@@ -70,4 +75,8 @@ typedef esp_netif_dns_info_t tcpip_adapter_dns_info_t;
 typedef esp_netif_sta_list_t tcpip_adapter_sta_list_t;
 typedef esp_netif_sta_info_t tcpip_adapter_sta_info_t;
 
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
 #endif // _TCPIP_ADAPTER_TYPES_H_