aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorFredrik Gustafsson <fredrik@erlang.org>2012-11-21 17:13:29 +0100
committerFredrik Gustafsson <fredrik@erlang.org>2012-11-21 17:13:29 +0100
commit9f3141274edd21cffcf371cca553eef56a65df8d (patch)
tree11ed180925101e4c201d202ffa4236d0d92bd3fc /lib/kernel/doc
parente082a9bd5b08c5b8b95a3592c7bf2b449655bcb2 (diff)
downloadotp-9f3141274edd21cffcf371cca553eef56a65df8d.tar.gz
otp-9f3141274edd21cffcf371cca553eef56a65df8d.tar.bz2
otp-9f3141274edd21cffcf371cca553eef56a65df8d.zip
Changes to function names, tests and docs of inet
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/inet.xml20
1 files changed, 11 insertions, 9 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index c6e9242a4f..330a188ab8 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -372,45 +372,47 @@ fe80::204:acff:fe17:bf38
</desc>
</func>
<func>
- <name name="ipv4_address" arity="1" />
+ <name name="parse_ipv4_address" arity="1" />
<fsummary>Parse an IPv4 address</fsummary>
<desc>
<p>Returns a ipv4 address tuple</p>
</desc>
</func>
<func>
- <name name="ipv4strict_address" arity="1" />
+ <name name="parse_ipv4strict_address" arity="1" />
<fsummary>Parse an IPv4 address strict.</fsummary>
<desc>
- <p>Returns a ipv4 address tuple</p>
+ <p>Parses an IPv4 address and returns a ipv4 address tuple. Must contain four fields.</p>
</desc>
</func>
<func>
- <name name="ipv6_address" arity="1" />
+ <name name="parse_ipv6_address" arity="1" />
<fsummary>Parse an IPv6 address</fsummary>
<desc>
- <p>Returns a ipv6 address tuple</p>
+ <p>Parses an IPv6 address and returns a ipv6 address tuple.
+ If an IPv4 address is passed, an IPv4-mapped IPv6 address is returned.</p>
</desc>
</func>
<func>
- <name name="ipv6strict_address" arity="1" />
+ <name name="parse_ipv6strict_address" arity="1" />
<fsummary>Parse an IPv6 address strict.</fsummary>
<desc>
- <p>Returns a ipv4 address tuple</p>
+ <p>Parses an IPv6 address and returns a ipv6 address tuple.
+ Does <b>not</b> accept IPv4 adresses.</p>
</desc>
</func>
<func>
<name name="parse_address" arity="1" />
<fsummary>Parse an IPv4 or IPv6 address.</fsummary>
<desc>
- <p>Returns a ipv4 or ipv6 address tuple</p>
+ <p>Parses an IPv4 or IPv6 address and returns a ipv4 or ipv6 address tuple. Accepts a shortened IPv4 address.</p>
</desc>
</func>
<func>
<name name="parse_strict_address" arity="1" />
<fsummary>Parse an IPv4 or IPv6 address strict.</fsummary>
<desc>
- <p>Returns a ipv4 or ipv6 address tuple</p>
+ <p>Parses an IPv4 or IPv6 address and returns a ipv4 or ipv6 address tuple. Does <b>not</b> accept a shortened IPv4 address.</p>
</desc>
</func>
<func>