diff options
| author | Fredrik Gustafsson <[email protected]> | 2012-11-23 10:19:37 +0100 |
|---|---|---|
| committer | Fredrik Gustafsson <[email protected]> | 2012-11-23 10:19:37 +0100 |
| commit | dbe3c2c9a76c631b98be020b932150ecbe4dd074 (patch) | |
| tree | bb4feb1e4ef3820aea3ea1275ff792f519f2457e /lib/kernel/doc/src | |
| parent | 0c0146130522ae0ba5057394cedf76fa46a5d8bf (diff) | |
| download | otp-dbe3c2c9a76c631b98be020b932150ecbe4dd074.tar.gz otp-dbe3c2c9a76c631b98be020b932150ecbe4dd074.tar.bz2 otp-dbe3c2c9a76c631b98be020b932150ecbe4dd074.zip | |
Inet doc clarifications
Diffstat (limited to 'lib/kernel/doc/src')
| -rw-r--r-- | lib/kernel/doc/src/inet.xml | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index eff1d07735..6e9e67b9c9 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -375,21 +375,22 @@ fe80::204:acff:fe17:bf38 <name name="parse_ipv4_address" arity="1" /> <fsummary>Parse an IPv4 address</fsummary> <desc> - <p>Parses an IPv4 address string and returns an <a href="#type-ip4_address">ip4_address()</a>.</p> + <p>Parses an IPv4 address string and returns an <a href="#type-ip4_address">ip4_address()</a>. + Accepts a shortened IPv4 shortened address string.</p> </desc> </func> <func> <name name="parse_ipv4strict_address" arity="1" /> <fsummary>Parse an IPv4 address strict.</fsummary> <desc> - <p>Parses an IPv4 address string containing four fields and returns a <a href="#type-ip4_adress">ip4_address()</a>.</p> + <p>Parses an IPv4 address string containing four fields, i.e <b>not</b> shortened, and returns an <a href="#type-ip4_adress">ip4_address()</a>.</p> </desc> </func> <func> <name name="parse_ipv6_address" arity="1" /> <fsummary>Parse an IPv6 address</fsummary> <desc> - <p>Parses an IPv6 address string and returns a <a href="#type-ip6_address">ip6_address()</a>. + <p>Parses an IPv6 address string and returns an <a href="#type-ip6_address">ip6_address()</a>. If an IPv4 address string is passed, an IPv4-mapped IPv6 address is returned.</p> </desc> </func> @@ -397,7 +398,7 @@ fe80::204:acff:fe17:bf38 <name name="parse_ipv6strict_address" arity="1" /> <fsummary>Parse an IPv6 address strict.</fsummary> <desc> - <p>Parses an IPv6 address string and returns a <a href="#type-ip6_address">ip6_address()</a>. + <p>Parses an IPv6 address string and returns an <a href="#type-ip6_address">ip6_address()</a>. Does <b>not</b> accept IPv4 adresses.</p> </desc> </func> @@ -405,7 +406,7 @@ fe80::204:acff:fe17:bf38 <name name="parse_address" arity="1" /> <fsummary>Parse an IPv4 or IPv6 address.</fsummary> <desc> - <p>Parses an IPv4 or IPv6 address string and returns a <a href="#type-ip4_address">ip4_address()</a> or <a href="#type-ip6_address">ip6_address()</a>. Accepts a shortened IPv4 address string.</p> + <p>Parses an IPv4 or IPv6 address string and returns an <a href="#type-ip4_address">ip4_address()</a> or <a href="#type-ip6_address">ip6_address()</a>. Accepts a shortened IPv4 address string.</p> </desc> </func> <func> |