From e082a9bd5b08c5b8b95a3592c7bf2b449655bcb2 Mon Sep 17 00:00:00 2001 From: Fredrik Gustafsson Date: Tue, 20 Nov 2012 10:07:11 +0100 Subject: Added specs and doc --- lib/kernel/doc/src/inet.xml | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) (limited to 'lib/kernel/doc') diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index b727960d96..c6e9242a4f 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -371,7 +371,48 @@ fe80::204:acff:fe17:bf38 - + + + Parse an IPv4 address + +

Returns a ipv4 address tuple

+
+
+ + + Parse an IPv4 address strict. + +

Returns a ipv4 address tuple

+
+
+ + + Parse an IPv6 address + +

Returns a ipv6 address tuple

+
+
+ + + Parse an IPv6 address strict. + +

Returns a ipv4 address tuple

+
+
+ + + Parse an IPv4 or IPv6 address. + +

Returns a ipv4 or ipv6 address tuple

+
+
+ + + Parse an IPv4 or IPv6 address strict. + +

Returns a ipv4 or ipv6 address tuple

+
+
Return the address and port for the other end of a connection -- cgit v1.2.3 From 9f3141274edd21cffcf371cca553eef56a65df8d Mon Sep 17 00:00:00 2001 From: Fredrik Gustafsson Date: Wed, 21 Nov 2012 17:13:29 +0100 Subject: Changes to function names, tests and docs of inet --- lib/kernel/doc/src/inet.xml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) (limited to 'lib/kernel/doc') 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 - + Parse an IPv4 address

Returns a ipv4 address tuple

- + Parse an IPv4 address strict. -

Returns a ipv4 address tuple

+

Parses an IPv4 address and returns a ipv4 address tuple. Must contain four fields.

- + Parse an IPv6 address -

Returns a ipv6 address tuple

+

Parses an IPv6 address and returns a ipv6 address tuple. + If an IPv4 address is passed, an IPv4-mapped IPv6 address is returned.

- + Parse an IPv6 address strict. -

Returns a ipv4 address tuple

+

Parses an IPv6 address and returns a ipv6 address tuple. + Does not accept IPv4 adresses.

Parse an IPv4 or IPv6 address. -

Returns a ipv4 or ipv6 address tuple

+

Parses an IPv4 or IPv6 address and returns a ipv4 or ipv6 address tuple. Accepts a shortened IPv4 address.

Parse an IPv4 or IPv6 address strict. -

Returns a ipv4 or ipv6 address tuple

+

Parses an IPv4 or IPv6 address and returns a ipv4 or ipv6 address tuple. Does not accept a shortened IPv4 address.

-- cgit v1.2.3 From 0c0146130522ae0ba5057394cedf76fa46a5d8bf Mon Sep 17 00:00:00 2001 From: Fredrik Gustafsson Date: Thu, 22 Nov 2012 11:52:19 +0100 Subject: Documentation changes inet --- lib/kernel/doc/src/inet.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'lib/kernel/doc') diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index 330a188ab8..eff1d07735 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -375,29 +375,29 @@ fe80::204:acff:fe17:bf38 Parse an IPv4 address -

Returns a ipv4 address tuple

+

Parses an IPv4 address string and returns an ip4_address().

Parse an IPv4 address strict. -

Parses an IPv4 address and returns a ipv4 address tuple. Must contain four fields.

+

Parses an IPv4 address string containing four fields and returns a ip4_address().

Parse an IPv6 address -

Parses an IPv6 address and returns a ipv6 address tuple. - If an IPv4 address is passed, an IPv4-mapped IPv6 address is returned.

+

Parses an IPv6 address string and returns a ip6_address(). + If an IPv4 address string is passed, an IPv4-mapped IPv6 address is returned.

Parse an IPv6 address strict. -

Parses an IPv6 address and returns a ipv6 address tuple. +

Parses an IPv6 address string and returns a ip6_address(). Does not accept IPv4 adresses.

@@ -405,14 +405,14 @@ fe80::204:acff:fe17:bf38 Parse an IPv4 or IPv6 address. -

Parses an IPv4 or IPv6 address and returns a ipv4 or ipv6 address tuple. Accepts a shortened IPv4 address.

+

Parses an IPv4 or IPv6 address string and returns a ip4_address() or ip6_address(). Accepts a shortened IPv4 address string.

Parse an IPv4 or IPv6 address strict. -

Parses an IPv4 or IPv6 address and returns a ipv4 or ipv6 address tuple. Does not accept a shortened IPv4 address.

+

Parses an IPv4 or IPv6 address string and returns an ip4_address() or ip6_address(). Does not accept a shortened IPv4 address string.

-- cgit v1.2.3 From dbe3c2c9a76c631b98be020b932150ecbe4dd074 Mon Sep 17 00:00:00 2001 From: Fredrik Gustafsson Date: Fri, 23 Nov 2012 10:19:37 +0100 Subject: Inet doc clarifications --- lib/kernel/doc/src/inet.xml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'lib/kernel/doc') 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 Parse an IPv4 address -

Parses an IPv4 address string and returns an ip4_address().

+

Parses an IPv4 address string and returns an ip4_address(). + Accepts a shortened IPv4 shortened address string.

Parse an IPv4 address strict. -

Parses an IPv4 address string containing four fields and returns a ip4_address().

+

Parses an IPv4 address string containing four fields, i.e not shortened, and returns an ip4_address().

Parse an IPv6 address -

Parses an IPv6 address string and returns a ip6_address(). +

Parses an IPv6 address string and returns an ip6_address(). If an IPv4 address string is passed, an IPv4-mapped IPv6 address is returned.

@@ -397,7 +398,7 @@ fe80::204:acff:fe17:bf38 Parse an IPv6 address strict. -

Parses an IPv6 address string and returns a ip6_address(). +

Parses an IPv6 address string and returns an ip6_address(). Does not accept IPv4 adresses.

@@ -405,7 +406,7 @@ fe80::204:acff:fe17:bf38 Parse an IPv4 or IPv6 address. -

Parses an IPv4 or IPv6 address string and returns a ip4_address() or ip6_address(). Accepts a shortened IPv4 address string.

+

Parses an IPv4 or IPv6 address string and returns an ip4_address() or ip6_address(). Accepts a shortened IPv4 address string.

-- cgit v1.2.3