Update netifapi documentation

This commit is contained in:
Dirk Ziegelmeier 2017-07-12 10:48:43 +02:00
parent 66df84a5b5
commit c08459490d

View File

@ -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)
/**