From ec78053243b4d5ee07b14f8bcc71b03c27b118d5 Mon Sep 17 00:00:00 2001
From: Guillermo Rodriguez Garcia <guille@iies.es>
Date: Fri, 21 Jan 2000 03:17:54 +0000
Subject: [PATCH] Some docs updated

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5564 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/ipvaddr.tex | 48 ++++++++++++++++++++++++++++++---------
 docs/latex/wx/sckaddr.tex |  2 +-
 2 files changed, 38 insertions(+), 12 deletions(-)

diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex
index 07ae2e0a74..b982f7429f 100644
--- a/docs/latex/wx/ipvaddr.tex
+++ b/docs/latex/wx/ipvaddr.tex
@@ -25,11 +25,13 @@
 
 \func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
 
-Use the specified {\it hostname} for the address.
+Set the address to {\it hostname}, which can be a host name
+or an IP-style address in dot notation (a.b.c.d)
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens (invalid hostname, invalid IP address). 
+Returns TRUE on success, FALSE if something goes wrong
+(invalid hostname or invalid IP address).
 
 %
 % Hostname
@@ -49,11 +51,12 @@ Returns the hostname which matches the IP address.
 
 \func{bool}{Service}{\param{const wxString\&}{ service}}
 
-Use the specified {\it service} string for the address.
+Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens (invalid service).
+Returns TRUE on success, FALSE if something goes wrong
+(invalid service).
 
 %
 % Service
@@ -63,11 +66,12 @@ Returns FALSE if something bad happens (invalid service).
 
 \func{bool}{Service}{\param{unsigned short}{ service}}
 
-Use the specified {\it service} for the address.
+Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens (invalid service).
+Returns TRUE on success, FALSE if something goes wrong
+(invalid service).
 
 %
 % Service
@@ -80,16 +84,38 @@ Returns FALSE if something bad happens (invalid service).
 Returns the current service.
 
 %
-% LocalHost
+% AnyAddress
 %
 
-\membersection{wxIPV4address::LocalHost}
+\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}
 
-\func{bool}{LocalHost}{\void}
+\func{bool}{AnyAddress}{\void}
 
-Initialize peer host to local host.
+Set address to any of the addresses of the current machine. Whenever
+possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost},
+as this correctly handles multi-homed hosts and avoids other small
+problems. Internally, this is the same as setting the IP address
+to {\bf INADDR\_ANY}.
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens.
+Returns TRUE on success, FALSE if something went wrong.
+
+
+%
+% LocalHost
+%
+
+\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}
+
+\func{bool}{LocalHost}{\void}
+
+Set address to "localhost" (127.0.0.1). Whenever possible, use the
+\helpref{wxIPV4address::AnyAddress}{wxipv4addressanyaddress},
+function instead of this one, as this will correctly handle multi-homed
+hosts and avoid other small problems.
+
+\wxheading{Return value}
+
+Returns TRUE on success, FALSE if something went wrong.
 
diff --git a/docs/latex/wx/sckaddr.tex b/docs/latex/wx/sckaddr.tex
index e39bf6598f..7fdc148e63 100644
--- a/docs/latex/wx/sckaddr.tex
+++ b/docs/latex/wx/sckaddr.tex
@@ -16,7 +16,7 @@ You are unlikely to need to use this class: only wxSocketBase uses it.
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}
-%\helpref{wxIPV4address}{wxipv4address}\\
+\helpref{wxIPV4address}{wxipv4address}
 %\helpref{wxIPV6address}{wxipv6address}\\
 %\helpref{wxunixaddress}{wxunixaddress}