From c08459490d17c3f4cf66a6c0990c23ac8942cc3f Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Wed, 12 Jul 2017 10:48:43 +0200 Subject: [PATCH] Update netifapi documentation --- src/include/lwip/netifapi.h | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/include/lwip/netifapi.h b/src/include/lwip/netifapi.h index 4c8779b8..1013080f 100644 --- a/src/include/lwip/netifapi.h +++ b/src/include/lwip/netifapi.h @@ -123,23 +123,31 @@ err_t netifapi_netif_index_to_name(u8_t index, char *name); * @ingroup netifapi * To be called from non-TCPIP threads */ -/** @ingroup netifapi_dhcp4 */ +/** @ingroup netifapi_dhcp4 + * @see dhcp_start() + */ #define netifapi_dhcp_start(n) netifapi_netif_common(n, NULL, dhcp_start) /** * @ingroup netifapi_dhcp4 * @deprecated Use netifapi_dhcp_release_and_stop() instead. */ #define netifapi_dhcp_stop(n) netifapi_netif_common(n, dhcp_stop, NULL) -/** @ingroup netifapi_dhcp4 */ +/** @ingroup netifapi_dhcp4 + * @see dhcp_inform() + */ #define netifapi_dhcp_inform(n) netifapi_netif_common(n, dhcp_inform, NULL) -/** @ingroup netifapi_dhcp4 */ +/** @ingroup netifapi_dhcp4 + * @see dhcp_renew() + */ #define netifapi_dhcp_renew(n) netifapi_netif_common(n, NULL, dhcp_renew) /** * @ingroup netifapi_dhcp4 * @deprecated Use netifapi_dhcp_release_and_stop() instead. */ #define netifapi_dhcp_release(n) netifapi_netif_common(n, NULL, dhcp_release) -/** @ingroup netifapi_dhcp4 */ +/** @ingroup netifapi_dhcp4 + * @see dhcp_release_and_stop() + */ #define netifapi_dhcp_release_and_stop(n) netifapi_netif_common(n, dhcp_release_and_stop, NULL) /**