api: Adapt doc comment to varying parameters

This commit is contained in:
Erik Ekman 2021-11-27 20:26:01 +01:00
parent 754d628f2d
commit 5b9159ce0d

View File

@ -1260,13 +1260,13 @@ netconn_join_leave_group_netif(struct netconn *conn,
*
* @param name a string representation of the DNS host name to query
* @param addr a preallocated ip_addr_t where to store the resolved IP address
* @param dns_addrtype IP address type (IPv4 / IPv6)
* @return ERR_OK: resolving succeeded
* ERR_MEM: memory error, try again later
* ERR_ARG: dns client not initialized or invalid hostname
* ERR_VAL: dns server response was invalid
*/
#if LWIP_IPV4 && LWIP_IPV6
/** @param dns_addrtype IP address type (IPv4 / IPv6) */
err_t
netconn_gethostbyname_addrtype(const char *name, ip_addr_t *addr, u8_t dns_addrtype)
#else