From 85817e76112f7c97492ea1b8140fb1331052d20f Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Thu, 8 Dec 2016 16:56:19 +0100 Subject: [PATCH] Minor documentation update about IP_ADDR_ANY --- src/include/lwip/ip_addr.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/include/lwip/ip_addr.h b/src/include/lwip/ip_addr.h index b0db3106..bce65edd 100644 --- a/src/include/lwip/ip_addr.h +++ b/src/include/lwip/ip_addr.h @@ -340,7 +340,13 @@ extern const ip_addr_t ip_addr_broadcast; /** * @ingroup ip4addr - * Provided for compatibility. Use IP4_ADDR_ANY for better readability. + * Can be used as a fixed/const ip_addr_t + * for the IP wildcard. + * Defined to @ref IP4_ADDR_ANY when IPv4 is enabled. + * Defined to @ref IP6_ADDR_ANY in IPv6 only systems. + * Use this if you can handle IPv4 _AND_ IPv6 addresses. + * Use @ref IP4_ADDR_ANY or @ref IP6_ADDR_ANY when the IP + * type matters. */ #define IP_ADDR_ANY IP4_ADDR_ANY /** @@ -381,7 +387,7 @@ extern const ip_addr_t ip6_addr_any; #define IP6_ADDR_ANY6 (ip_2_ip6(&ip6_addr_any)) #if !LWIP_IPV4 -/** Just a little upgrade-helper for IPv6-only configurations: */ +/** IPv6-only configurations */ #define IP_ADDR_ANY IP6_ADDR_ANY #endif /* !LWIP_IPV4 */