aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorFredrik Gustafsson <[email protected]>2013-08-05 11:15:37 +0200
committerFredrik Gustafsson <[email protected]>2013-08-05 11:15:37 +0200
commit0fad6449c7ec48aa7454880b5a1caf0f2580b33f (patch)
tree8ad03a5af4cc92d9cab110dfa5facda474d0bb96 /lib/kernel/doc
parent08c4a46e0be4017bbcee596eb4858d0e16eaaec6 (diff)
parentd8787b43ca5f33b6ec95300c8ce6f06c80886801 (diff)
downloadotp-0fad6449c7ec48aa7454880b5a1caf0f2580b33f.tar.gz
otp-0fad6449c7ec48aa7454880b5a1caf0f2580b33f.tar.bz2
otp-0fad6449c7ec48aa7454880b5a1caf0f2580b33f.zip
Merge branch 'fredrik/inet/clarify_doc_address/OTP-10676' into maint
* fredrik/inet/clarify_doc_address/OTP-10676: kernel: fixed specs to inet:ntoa/1 kernel: changed tests where inet_parse:ntoa/1 was used to inet:parse/1 kernel: added ntoa documentation and exported it in inet.erl kernel: clarified inet:parse_address/1 referrering to old code
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/inet.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index 7cd98914d1..254dfbf034 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -76,11 +76,11 @@ FFFF::192.168.42.2
{16#3ffe,16#b80,16#1f8d,16#2,16#204,16#acff,16#fe17,16#bf38}
fe80::204:acff:fe17:bf38
{16#fe80,0,0,0,0,16#204,16#acff,16#fe17,16#bf38}</code>
- <p>A function that may be useful is <c>inet_parse:address/1</c>:</p>
+ <p>A function that may be useful is <seealso marker="#parse_address/1">parse_address/1</seealso>:</p>
<pre>
-1> <input>inet_parse:address("192.168.42.2").</input>
+1> <input>inet:parse_address("192.168.42.2").</input>
{ok,{192,168,42,2}}
-2> <input>inet_parse:address("FFFF::192.168.42.2").</input>
+2> <input>inet:parse_address("FFFF::192.168.42.2").</input>
{ok,{65535,0,0,0,0,0,49320,10754}}</pre>
</description>
@@ -375,6 +375,13 @@ fe80::204:acff:fe17:bf38
</desc>
</func>
<func>
+ <name name="ntoa" arity="1" />
+ <fsummary>Convert IPv6 / IPV4 adress to ascii</fsummary>
+ <desc>
+ <p>Parses an <a href="#type-ip_address">ip_address()</a> and returns an IPv4 or IPv6 address string.</p>
+ </desc>
+ </func>
+ <func>
<name name="parse_ipv4_address" arity="1" />
<fsummary>Parse an IPv4 address</fsummary>
<desc>