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

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

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