diff --git a/src/api/netifapi.c b/src/api/netifapi.c index 6261569d..2c246802 100644 --- a/src/api/netifapi.c +++ b/src/api/netifapi.c @@ -31,6 +31,12 @@ * */ +/** + * @defgroup netifapi Thread-safe API + * @ingroup netif + * Thread-safe functions to be called from non-TCPIP threads + */ + #include "lwip/opt.h" #if LWIP_NETIF_API /* don't build if not configured for use in lwipopts.h */ @@ -108,6 +114,7 @@ netifapi_do_netif_common(struct tcpip_api_call_data *m) } /** + * @ingroup netifapi * Call netif_add() in a thread-safe way by running that function inside the * tcpip_thread context. * @@ -152,6 +159,7 @@ netifapi_netif_add(struct netif *netif, #if LWIP_IPV4 /** + * @ingroup netifapi * Call netif_set_addr() in a thread-safe way by running that function inside the * tcpip_thread context. * diff --git a/src/core/dns.c b/src/core/dns.c index b04dbd75..5ee482ce 100644 --- a/src/core/dns.c +++ b/src/core/dns.c @@ -60,6 +60,8 @@ * must be implemented by the module that uses the resolver). * * All functions must be called from TCPIP thread. + * + * @see @ref netconn_dns */ /*----------------------------------------------------------------------------- diff --git a/src/core/tcp.c b/src/core/tcp.c index 6a1f9149..e7281498 100644 --- a/src/core/tcp.c +++ b/src/core/tcp.c @@ -40,7 +40,7 @@ * @defgroup tcp_raw TCP * @ingroup raw_api * Transmission Control Protocol for IP\n - * @see @ref raw_api + * @see @ref raw_api and @ref netconn * * Common functions for the TCP implementation, such as functinos * for manipulating the data structures and the TCP timer functions. TCP functions diff --git a/src/core/udp.c b/src/core/udp.c index da5e7c8d..14130ab3 100644 --- a/src/core/udp.c +++ b/src/core/udp.c @@ -40,7 +40,7 @@ * @defgroup udp_raw UDP * @ingroup raw_api * User Datagram Protocol module\n - * @see @ref raw_api + * @see @ref raw_api and @ref netconn */ /* udp.c diff --git a/src/include/lwip/netifapi.h b/src/include/lwip/netifapi.h index 0071f921..b9f8104d 100644 --- a/src/include/lwip/netifapi.h +++ b/src/include/lwip/netifapi.h @@ -92,15 +92,21 @@ err_t netifapi_netif_set_addr(struct netif *netif, const ip4_addr_t *ipaddr, err_t netifapi_netif_common(struct netif *netif, netifapi_void_fn voidfunc, netifapi_errt_fn errtfunc); +/** @ingroup netifapi */ #define netifapi_netif_remove(n) netifapi_netif_common(n, netif_remove, NULL) +/** @ingroup netifapi */ #define netifapi_netif_set_up(n) netifapi_netif_common(n, netif_set_up, NULL) +/** @ingroup netifapi */ #define netifapi_netif_set_down(n) netifapi_netif_common(n, netif_set_down, NULL) +/** @ingroup netifapi */ #define netifapi_netif_set_default(n) netifapi_netif_common(n, netif_set_default, NULL) + #define netifapi_dhcp_start(n) netifapi_netif_common(n, NULL, dhcp_start) #define netifapi_dhcp_stop(n) netifapi_netif_common(n, dhcp_stop, NULL) #define netifapi_dhcp_inform(n) netifapi_netif_common(n, dhcp_inform, NULL) #define netifapi_dhcp_renew(n) netifapi_netif_common(n, NULL, dhcp_renew) #define netifapi_dhcp_release(n) netifapi_netif_common(n, NULL, dhcp_release) + #define netifapi_autoip_start(n) netifapi_netif_common(n, NULL, autoip_start) #define netifapi_autoip_stop(n) netifapi_netif_common(n, NULL, autoip_stop)