Fixed compile errors, warnings and other DSMs, and improved comments.

[wxWidgets.git] / docs / latex / wx / ipvaddr.tex

diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex
index 07ae2e0a74c9a35d41c73a7fa7236f1948e6666b..1e2fddfdb5343f6c5d0175a3a8fad2e4f40cb9c5 100644 (file)
--- a/docs/latex/wx/ipvaddr.tex
+++ b/docs/latex/wx/ipvaddr.tex
@@ -14,7 +14,6 @@
 % ----------------------------------------------------------------------------
 % MEMBERS
 % ----------------------------------------------------------------------------
-
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
@@ -25,11 +24,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 +50,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 +65,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
@@ -79,17 +82,38 @@ Returns FALSE if something bad happens (invalid service).
 
 Returns the current service.
 
+%
+% AnyAddress
+%
+
+\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}
+
+\func{bool}{AnyAddress}{\void}
+
+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 TRUE on success, FALSE if something went wrong.
+
 %
 % LocalHost
 %
 
-\membersection{wxIPV4address::LocalHost}
+\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}
 
 \func{bool}{LocalHost}{\void}
 
-Initialize peer host to local host.
+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 FALSE if something bad happens.
+Returns TRUE on success, FALSE if something went wrong.