Add some dual-stack notes to documentation

2016-08-26 15:58:18 +02:00
parent 05a6d82fa1
commit 4b45baee10
4 changed files with 11 additions and 1 deletions
--- a/src/include/lwip/ip_addr.h
+++ b/src/include/lwip/ip_addr.h
@@ -47,9 +47,13 @@
 extern "C" {
 #endif

-/** These are the values for ip_addr_t.type */
+/** Value for ip_addr_t.type: IPv4 */
 #define IPADDR_TYPE_V4                0U
+/** Value for ip_addr_t.type: IPv6 */
 #define IPADDR_TYPE_V6                6U
+/** Value for ip_addr_t.type: IPv4+IPv6 ("dual-stack")
+ * @see tcp_new_ip_type(), udp_new_ip_type(), raw_new_ip_type().
+ */
 #define IPADDR_TYPE_ANY               46U

 #if LWIP_IPV4 && LWIP_IPV6