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

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

diff --git a/docs/latex/wx/sckaddr.tex b/docs/latex/wx/sckaddr.tex
index e2ace6b8e0dc7d1b9e6641cd062482f3a3cc01af..7ab64c2b7f26623846f7e67be12e0ef03e3cefc2 100644 (file)
--- a/docs/latex/wx/sckaddr.tex
+++ b/docs/latex/wx/sckaddr.tex
@@ -3,29 +3,29 @@
 % ----------------------------------------------------------------------------
 \section{\class{wxSockAddress}}\label{wxsockaddress}
 
 % ----------------------------------------------------------------------------
 \section{\class{wxSockAddress}}\label{wxsockaddress}
 

+You are unlikely to need to use this class: only wxSocketBase uses it.
+

 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 

-{\bf Actually, you don't have to use these functions: only wxSocketBase use it.}
+\wxheading{Include files}
+
+<wx/socket.h>

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxSocketBase}{wxsocketbase}\\
-\helpref{wxIPV4address}{wxipv4address}\\
-\helpref{wxIPV6address}{wxipv6address}\\
-\helpref{wxunixaddress}{wxunixaddress}
+\helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxIPV4address}{wxipv4address}

 
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------

-

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % ctor/dtor
 %
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % ctor/dtor
 %

-

 \membersection{wxSockAddress::wxSockAddress}
 
 \func{}{wxSockAddress}{\void}
 \membersection{wxSockAddress::wxSockAddress}
 
 \func{}{wxSockAddress}{\void}


@@ -42,126 +42,17 @@ Default destructor.
 % Clear
 %
 \membersection{wxSockAddress::Clear}
 % Clear
 %
 \membersection{wxSockAddress::Clear}

+

 \func{void}{Clear}{\void}
 
 Delete all informations about the address.
 
 \func{void}{Clear}{\void}
 
 Delete all informations about the address.
 

-%
-% Build
-%
-\membersection{wxSockAddress::Build}
-
-\func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}}
-
-Build a coded socket address.
-
-%
-% Disassemble
-%
-\membersection{wxSockAddress::Disassemble}
-
-\func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}}
-
-Decode a socket address. {\bf Actually, you don't have to use this
-function: only wxSocketBase use it.}
-

 %
 % SockAddrLen
 %
 \membersection{wxSockAddress::SockAddrLen}
 
 %
 % SockAddrLen
 %
 \membersection{wxSockAddress::SockAddrLen}
 

-\func{int}{SockAddrLen}{\void};
+\func{int}{SockAddrLen}{\void}

 
 Returns the length of the socket address.
 
 
 Returns the length of the socket address.
 

-% ----------------------------------------------------------------------------
-% CLASS: wxIPV4address
-% ----------------------------------------------------------------------------
-\section{\class{wxIPV4address}}\label{wxipv4address}
-
-\wxheading{Derived from}
-
-\helpref{wxSockAddress}{wxsockaddress}
-
-% ----------------------------------------------------------------------------
-% MEMBERS
-% ----------------------------------------------------------------------------
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-%
-% Hostname
-%
-
-\membersection{wxIPV4address::Hostname}
-
-\func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
-
-Use the specified {\it hostname} for the address.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens (invalid hostname, invalid IP address). 
-
-%
-% Hostname
-%
-
-\membersection{wxIPV4address::Hostname}
-
-\func{wxString}{Hostname}{\void}
-
-Returns the hostname which matches the IP address.
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-
-\func{bool}{Service}{\param{const wxString\&}{ service}}
-
-Use the specified {\it service} string for the address.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens (invalid service).
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-
-\func{bool}{Service}{\param{unsigned short}{ service}}
-
-Use the specified {\it service} for the address.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens (invalid service).
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-
-\func{unsigned short}{Service}{\void}
-
-Returns the current service.
-
-%
-% LocalHost
-%
-
-\membersection{wxIPV4address::LocalHost}
-
-\func{bool}{LocalHost}{\void}
-
-Initialize peer host to local host.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens.
-