cross-reference types in the generated docs (patch 1038083)

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

diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex
index b982f7429fe7992b82e5ee876ae93e331c477f7b..0f314073a654ee708d7799c44f02230b3f2ac0c5 100644 (file)
--- a/docs/latex/wx/ipvaddr.tex
+++ b/docs/latex/wx/ipvaddr.tex
@@ -5,7 +5,7 @@
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxSockAddress}{wxsockaddress}
+\helpref{wxIPaddress}{wxipaddress}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -14,14 +14,13 @@
 % ----------------------------------------------------------------------------
 % MEMBERS
 % ----------------------------------------------------------------------------
 % ----------------------------------------------------------------------------
 % MEMBERS
 % ----------------------------------------------------------------------------

-

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % Hostname
 %
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % Hostname
 %
 

-\membersection{wxIPV4address::Hostname}
+\membersection{wxIPV4address::Hostname}\label{wxipv4addresshostname}

 
 \func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
 
 
 \func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
 


@@ -30,24 +29,28 @@ or an IP-style address in dot notation (a.b.c.d)
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE on success, FALSE if something goes wrong
+Returns true on success, false if something goes wrong

 (invalid hostname or invalid IP address).
 
 (invalid hostname or invalid IP address).
 

+\func{wxString}{Hostname}{\void}
+
+Returns the hostname which matches the IP address.
+

 %
 %

-% Hostname
+% IPAddress

 %
 
 %
 

-\membersection{wxIPV4address::Hostname}
+\membersection{wxIPV4address::IPAddress}\label{wxipv4addressipaddress}

 
 

-\func{wxString}{Hostname}{\void}
+\func{wxString}{IPAddress}{\void}

 
 

-Returns the hostname which matches the IP address.
+Returns a wxString containing the IP address in dot quad (127.0.0.1) format.

 
 %
 % Service
 %
 
 
 %
 % Service
 %
 

-\membersection{wxIPV4address::Service}
+\membersection{wxIPV4address::Service}\label{wxipv4addressservice}

 
 \func{bool}{Service}{\param{const wxString\&}{ service}}
 
 
 \func{bool}{Service}{\param{const wxString\&}{ service}}
 


@@ -55,30 +58,18 @@ Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE on success, FALSE if something goes wrong
+Returns true on success, false if something goes wrong

 (invalid service).
 
 (invalid service).
 

-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-

 \func{bool}{Service}{\param{unsigned short}{ service}}
 
 Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 
 \func{bool}{Service}{\param{unsigned short}{ service}}
 
 Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 

-Returns TRUE on success, FALSE if something goes wrong
+Returns true on success, false if something goes wrong

 (invalid service).
 
 (invalid service).
 

-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-

 \func{unsigned short}{Service}{\void}
 
 Returns the current service.
 \func{unsigned short}{Service}{\void}
 
 Returns the current service.


@@ -99,8 +90,7 @@ to {\bf INADDR\_ANY}.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE on success, FALSE if something went wrong.
-
+Returns true on success, false if something went wrong.

 
 %
 % LocalHost
 
 %
 % LocalHost


@@ -110,12 +100,12 @@ Returns TRUE on success, FALSE if something went wrong.
 
 \func{bool}{LocalHost}{\void}
 
 
 \func{bool}{LocalHost}{\void}
 

-Set address to "localhost" (127.0.0.1). Whenever possible, use the
+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}
 
 \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.
+Returns true on success, false if something went wrong.