Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
interface/protocol/ftp.h
View File

@@ -84,12 +84,12 @@ public:
/**
Default constructor.
*/
#define wxFTP() /* implementation is private */
wxFTP();
/**
Destructor will close the connection if connected.
*/
#define ~wxFTP() /* implementation is private */
~wxFTP();
/**
Aborts the download currently in process, returns @true if ok, @false
@@ -104,7 +104,7 @@ public:
bool ChDir(const wxString& dir);
/**
Send the specified @e command to the FTP server. @e ret specifies
Send the specified @a command to the FTP server. @a ret specifies
the expected result.
@returns @true if the command has been sent successfully, else @false.
@@ -118,16 +118,17 @@ public:
/**
The GetList function is quite low-level. It returns the list of the files in
the current directory. The list can be filtered using the @e wildcard string.
If @e wildcard is empty (default), it will return all files in directory.
the current directory. The list can be filtered using the @a wildcard string.
If @a wildcard is empty (default), it will return all files in directory.
The form of the list can change from one peer system to another. For example,
for a UNIX peer system, it will look like this:
But on Windows system, it will look like this:
Return value: @true if the file list was successfully retrieved, @false
otherwise.
@sa GetFilesList()
@see GetFilesList()
*/
bool GetDirList(wxArrayString& files,
const wxString& wildcard = "");
@@ -145,7 +146,6 @@ public:
directory (optionally only of the files matching the @e wildcard, all files
by default). This list always has the same format and contains one full
(including the directory path) file name per line.
Return value: @true if the file list was successfully retrieved, @false
otherwise.
*/
@@ -160,9 +160,9 @@ public:
You will be notified when the EOF is reached by an error.
@returns Returns @NULL if an error occurred (it could be a network failure
or the fact that the file doesn't exist).
or the fact that the file doesn't exist).
*/
wxInputStream * GetInputStream(const wxString& path);
wxInputStream* GetInputStream(const wxString& path);
/**
Returns the last command result, i.e. the full server reply for the last
@@ -177,9 +177,9 @@ public:
@returns An initialized write-only stream.
@sa wxOutputStream
@see wxOutputStream
*/
wxOutputStream * GetOutputStream(const wxString& file);
wxOutputStream* GetOutputStream(const wxString& file);
/**
Create the specified directory in the current FTP working directory.
@@ -190,10 +190,10 @@ public:
/**
Returns the current FTP working directory.
*/
#define wxString Pwd() /* implementation is private */
wxString Pwd();
/**
Rename the specified @e src element to @e dst. Returns @true if successful.
Rename the specified @a src element to @e dst. Returns @true if successful.
*/
bool Rename(const wxString& src, const wxString& dst);
@@ -209,7 +209,7 @@ public:
bool RmFile(const wxString& path);
/**
Send the specified @e command to the FTP server and return the first
Send the specified @a command to the FTP server and return the first
character of the return code.
*/
char SendCommand(const wxString& command);
@@ -225,7 +225,7 @@ public:
bool SetBinary();
/**
If @e pasv is @true, passive connection to the FTP server is used. This is
If @a pasv is @true, passive connection to the FTP server is used. This is
the default as it works with practically all firewalls. If the server doesn't
support passive move, you may call this function with @false argument to use
active connection.
@@ -240,7 +240,6 @@ public:
/**
Sets the transfer mode to the specified one. It will be used for the next
transfer.
If this function is never called, binary transfer mode is used by default.
*/
bool SetTransferMode(TransferMode mode);

19
interface/protocol/http.h
View File

@@ -30,7 +30,6 @@ public:
/**
Creates a new input stream on the specified path. Notice that this stream is
unseekable, i.e. SeekI() and TellI() methods shouldn't be used.
Note that you can still know the size of the file you are getting using
wxStreamBase::GetSize. However there is a
limitation: in HTTP protocol, the size is not always specified so sometimes
@@ -39,16 +38,16 @@ public:
method in a loop to get the total size.
@returns Returns the initialized stream. You must delete it yourself once
you don't use it anymore and this must be done before
the wxHTTP object itself is destroyed. The destructor
closes the network connection. The next time you will
try to get a file the network connection will have to
be reestablished, but you don't have to take care of
this since wxHTTP reestablishes it automatically.
you don't use it anymore and this must be done before
the wxHTTP object itself is destroyed. The destructor
closes the network connection. The next time you will
try to get a file the network connection will have to
be reestablished, but you don't have to take care of
this since wxHTTP reestablishes it automatically.
@sa wxInputStream
@see wxInputStream
*/
wxInputStream * GetInputStream(const wxString& path);
wxInputStream* GetInputStream(const wxString& path);
/**
Returns the HTTP response code returned by the server. Please refer to
@@ -59,7 +58,7 @@ public:
/**
It sets data of a field to be sent during the next request to the HTTP server.
The field
name is specified by @e header and the content by @e h_data.
name is specified by @a header and the content by @e h_data.
This is a low level function and it assumes that you know what you are doing.
*/
void SetHeader(const wxString& header, const wxString& h_data);

19
interface/protocol/protocol.h
View File

@@ -35,55 +35,44 @@ public:
/**
Returns the last occurred error.
@b wxPROTO_NOERR
No error.
@b wxPROTO_NETERR
A generic network error occurred.
@b wxPROTO_PROTERR
An error occurred during negotiation.
@b wxPROTO_CONNERR
The client failed to connect the server.
@b wxPROTO_INVVAL
Invalid value.
@b wxPROTO_NOHNDLR
.
@b wxPROTO_NOFILE
The remote file doesn't exist.
@b wxPROTO_ABRT
Last action aborted.
@b wxPROTO_RCNCT
An error occurred during reconnection.
@b wxPROTO_STREAM
Someone tried to send a command during a transfer.
*/
wxProtocolError GetError();
@@ -96,12 +85,12 @@ public:
You will be notified when the EOF is reached by an error.
@returns Returns the initialized stream. You will have to delete it
yourself once you don't use it anymore. The
destructor closes the network connection.
yourself once you don't use it anymore. The destructor
closes the network connection.
@sa wxInputStream
@see wxInputStream
*/
wxInputStream * GetInputStream(const wxString& path);
wxInputStream* GetInputStream(const wxString& path);
/**
Tries to reestablish a previous opened connection (close and renegotiate