kernel: Document ifaddr option

* same as ip option
coolluck · Apr 16, 2012 · 57c50be · 57c50be
1 parent d64479b
commit 57c50be
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
@@ -102,17 +102,19 @@ do_recv(Sock, Bs) ->
               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 several network interfaces, this option
+              specifies which one to use.</p>
+		  </item>
+
           <tag><c>{fd, integer() >= 0}</c></tag>
           <item>
             <p>If a socket has somehow been connected without using
               <c>gen_tcp</c>, use this option to pass the file
               descriptor for it.</p>
           </item>
 
-		  <tag><c>{ifaddr, ip_address()}</c></tag>
-          <item> <p>TODO: Document</p>
-		  </item>
-
           <tag><c>inet</c></tag>
           <item>
             <p>Set up the socket for IPv4.</p>
@@ -207,7 +209,9 @@ do_recv(Sock, Bs) ->
           </item>
 
 		  <tag><c>{ifaddr, ip_address()}</c></tag>
-          <item> <p>TODO: Document</p>
+          <item>
+			  <p>Same as <c>{ip, ip_address()}</c>. If the host has several network interfaces, this option
+              specifies which one to use.</p>
 		  </item>
 
           <tag><c>inet6</c></tag>

diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml
@@ -72,6 +72,14 @@
             <p>If the host has several 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 several network interfaces, this option
+              specifies which one to use.</p>
+		  </item>
+
+
           <tag><c>{fd, integer() >= 0}</c></tag>
           <item>
             <p>If a socket has somehow been opened without using