diff options
| author | Raimo Niskanen <[email protected]> | 2016-06-08 14:46:44 +0200 |
|---|---|---|
| committer | Raimo Niskanen <[email protected]> | 2016-06-09 08:48:35 +0200 |
| commit | 16e895198a541ccbbbe6c970bd9572cf347a9c77 (patch) | |
| tree | f5dc043fd49796f454eae52cc61ba91036826b93 /lib/kernel/doc/src/gen_udp.xml | |
| parent | f429adba7e7a862b9949821b40aa3cba12455b3e (diff) | |
| download | otp-16e895198a541ccbbbe6c970bd9572cf347a9c77.tar.gz otp-16e895198a541ccbbbe6c970bd9572cf347a9c77.tar.bz2 otp-16e895198a541ccbbbe6c970bd9572cf347a9c77.zip | |
Document the local (unix) address family
Diffstat (limited to 'lib/kernel/doc/src/gen_udp.xml')
| -rw-r--r-- | lib/kernel/doc/src/gen_udp.xml | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml index ca9d9c978c..3f88a0272d 100644 --- a/lib/kernel/doc/src/gen_udp.xml +++ b/lib/kernel/doc/src/gen_udp.xml @@ -85,11 +85,11 @@ <item><p>Received <c>Packet</c> is delivered as a list.</p></item> <tag><c>binary</c></tag> <item><p>Received <c>Packet</c> is delivered as a binary.</p></item> - <tag><c>{ip, ip_address()}</c></tag> + <tag><c>{ip, Address}</c></tag> <item><p>If the host has many network interfaces, this option specifies which one to use.</p></item> - <tag><c>{ifaddr, ip_address()}</c></tag> - <item><p>Same as <c>{ip, ip_address()}</c>. If the host has many + <tag><c>{ifaddr, Address}</c></tag> + <item><p>Same as <c>{ip, Address}</c>. If the host has many network interfaces, this option specifies which one to use.</p></item> <tag><c>{fd, integer() >= 0}</c></tag> @@ -107,9 +107,10 @@ <tag><c>local</c></tag> <item> <p> - Sets up the socket for local address family. This option is only - valid together with <c>{fd, integer()}</c> when the file descriptor - is of local address family (e.g. a Unix Domain Socket) + Sets up a Unix Domain Socket. See + <seealso marker="inet#type-local_address"> + <c>inet:local_address()</c> + </seealso> </p> </item> <tag><c>{udp_module, module()}</c></tag> @@ -184,8 +185,10 @@ <name name="send" arity="4"/> <fsummary>Send a packet.</fsummary> <desc> - <p>Sends a packet to the specified address and port. Argument - <c><anno>Address</anno></c> can be a hostname or an IP address.</p> + <p> + Sends a packet to the specified address and port. Argument + <c><anno>Address</anno></c> can be a hostname or a socket address. + </p> </desc> </func> </funcs> |