remove C++ comment

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

diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex
index d098f5a6c3ef0e94011d156a3b11978f1b5272f6..d0559837ce89dbe8d73b42eacff98575a97fa3a0 100644 (file)
--- a/docs/latex/wx/ftp.tex
+++ b/docs/latex/wx/ftp.tex
@@ -6,7 +6,7 @@
 %% Created:     ~1997
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets team
 %% Created:     ~1997
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets team

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFTP}}\label{wxftp}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFTP}}\label{wxftp}


@@ -87,12 +87,19 @@ enum TransferMode
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxProtocol}{wxprotocol}
+\helpref{wxProtocol}{wxprotocol}\\
+\helpref{wxSocketClient}{wxsocketclient}\\
+\helpref{wxSocketBase}{wxsocketbase}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/protocol/ftp.h>
 
 
 \wxheading{Include files}
 
 <wx/protocol/ftp.h>
 

+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}


@@ -104,14 +111,14 @@ enum TransferMode
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 

-\membersection{wxFTP::wxFTP}
+\membersection{wxFTP::wxFTP}\label{wxftpctor}

 
 \func{}{wxFTP}{\void}
 
 Default constructor.
 
 
 
 \func{}{wxFTP}{\void}
 
 Default constructor.
 
 

-\membersection{wxFTP::\destruct{wxFTP}}
+\membersection{wxFTP::\destruct{wxFTP}}\label{wxftpdtor}

 
 \func{}{\destruct{wxFTP}}{\void}
 
 
 \func{}{\destruct{wxFTP}}{\void}
 


@@ -122,11 +129,11 @@ Destructor will close the connection if connected.
 
 \func{bool}{Abort}{\void}
 
 
 \func{bool}{Abort}{\void}
 

-Aborts the download currently in process, returns {\tt true} if ok, {\tt false} 
-if an error occured.
+Aborts the download currently in process, returns \true if ok, \false 
+if an error occurred.

 
 
 
 

-\membersection{wxFTP::CheckCommand}
+\membersection{wxFTP::CheckCommand}\label{wxftpcheckcommand}

 
 \func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
 
 
 \func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
 


@@ -146,7 +153,7 @@ Send the specified {\it command} to the FTP server and return the first
 character of the return code.
 
 
 character of the return code.
 
 

-\membersection{wxFTP::GetLastResult}
+\membersection{wxFTP::GetLastResult}\label{wxftpgetlastresult}

 
 \func{const wxString\&}{GetLastResult}{\void}
 
 
 \func{const wxString\&}{GetLastResult}{\void}
 


@@ -156,7 +163,7 @@ command.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::ChDir}
+\membersection{wxFTP::ChDir}\label{wxftpchdir}

 
 \func{bool}{ChDir}{\param{const wxString\&}{ dir}}
 
 
 \func{bool}{ChDir}{\param{const wxString\&}{ dir}}
 


@@ -164,7 +171,7 @@ Change the current FTP working directory.
 Returns true if successful.
 
 
 Returns true if successful.
 
 

-\membersection{wxFTP::MkDir}
+\membersection{wxFTP::MkDir}\label{wxftpmkdir}

 
 \func{bool}{MkDir}{\param{const wxString\&}{ dir}}
 
 
 \func{bool}{MkDir}{\param{const wxString\&}{ dir}}
 


@@ -172,7 +179,7 @@ Create the specified directory in the current FTP working directory.
 Returns true if successful.
 
 
 Returns true if successful.
 
 

-\membersection{wxFTP::RmDir}
+\membersection{wxFTP::RmDir}\label{wxftprmdir}

 
 \func{bool}{RmDir}{\param{const wxString\&}{ dir}}
 
 
 \func{bool}{RmDir}{\param{const wxString\&}{ dir}}
 


@@ -180,7 +187,7 @@ Remove the specified directory from the current FTP working directory.
 Returns true if successful.
 
 
 Returns true if successful.
 
 

-\membersection{wxFTP::Pwd}
+\membersection{wxFTP::Pwd}\label{wxftppwd}

 
 \func{wxString}{Pwd}{\void}
 
 
 \func{wxString}{Pwd}{\void}
 


@@ -189,7 +196,7 @@ Returns the current FTP working directory.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::Rename}
+\membersection{wxFTP::Rename}\label{wxftprename}

 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 
 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 


@@ -198,7 +205,7 @@ Rename the specified {\it src} element to {\it dst}. Returns true if successful.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::RmFile}
+\membersection{wxFTP::RmFile}\label{wxftprmfile}

 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
 
 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
 


@@ -207,21 +214,21 @@ Delete the file specified by {\it path}. Returns true if successful.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::SetAscii}
+\membersection{wxFTP::SetAscii}\label{wxftpsetascii}

 
 \func{bool}{SetAscii}{\void}
 
 Sets the transfer mode to ASCII. It will be used for the next transfer.
 
 
 
 \func{bool}{SetAscii}{\void}
 
 Sets the transfer mode to ASCII. It will be used for the next transfer.
 
 

-\membersection{wxFTP::SetBinary}
+\membersection{wxFTP::SetBinary}\label{wxftpsetbinary}

 
 \func{bool}{SetBinary}{\void}
 
 Sets the transfer mode to binary (IMAGE). It will be used for the next transfer.
 
 
 
 \func{bool}{SetBinary}{\void}
 
 Sets the transfer mode to binary (IMAGE). It will be used for the next transfer.
 
 

-\membersection{wxFTP::SetPassive}
+\membersection{wxFTP::SetPassive}\label{wxftpsetpassive}

 
 \func{void}{SetPassive}{\param{bool }{pasv}}
 
 
 \func{void}{SetPassive}{\param{bool }{pasv}}
 


@@ -231,7 +238,7 @@ support passive move, you may call this function with \false argument to use
 active connection.
 
 
 active connection.
 
 

-\membersection{wxFTP::SetTransferMode}
+\membersection{wxFTP::SetTransferMode}\label{wxftpsettransfermode}

 
 \func{bool}{SetTransferMode}{\param{TransferMode }{mode}}
 
 
 \func{bool}{SetTransferMode}{\param{TransferMode }{mode}}
 


@@ -243,7 +250,7 @@ If this function is never called, binary transfer mode is used by default.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::SetUser}
+\membersection{wxFTP::SetUser}\label{wxftpsetuser}

 
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 
 
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 


@@ -260,7 +267,7 @@ For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory
 to specify a user and a password.
 
 
 to specify a user and a password.
 
 

-\membersection{wxFTP::SetPassword}
+\membersection{wxFTP::SetPassword}\label{wxftpsetpassword}

 
 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
 
 
 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
 


@@ -285,7 +292,7 @@ to specify a user and a password.
 
 \func{bool}{FileExists}{\param{const wxString\&}{ filename}}
 
 
 \func{bool}{FileExists}{\param{const wxString\&}{ filename}}
 

-Returns {\tt true} if the given remote file exists, {\tt false} otherwise.
+Returns \true if the given remote file exists, \false otherwise.

 
 
 \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}
 
 
 \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}


@@ -348,7 +355,7 @@ otherwise.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::GetOutputStream}
+\membersection{wxFTP::GetOutputStream}\label{wxftpgetoutputstream}

 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 
 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 


@@ -367,13 +374,13 @@ An initialized write-only stream.
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 
 

-\membersection{wxFTP::GetInputStream}\label{wxftpgetinput}
+\membersection{wxFTP::GetInputStream}\label{wxftpgetinputstream}

 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 

-Creates a new input stream on the the specified path. You can use all but the seek
+Creates a new input stream on the specified path. You can use all but the seek

 functionality of wxStream. Seek isn't available on all streams. For example,
 functionality of wxStream. Seek isn't available on all streams. For example,

-http or ftp streams do not deal with it. Other functions like Tell
+HTTP or FTP streams do not deal with it. Other functions like Tell

 are not available for this sort of stream, at present.
 You will be notified when the EOF is reached by an error.
 
 are not available for this sort of stream, at present.
 You will be notified when the EOF is reached by an error.