Replaced @returns with @return for more standard command use and compatibility.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53549 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -116,7 +116,7 @@ public:
|
||||
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.
|
||||
@return @true if the command has been sent successfully, else @false.
|
||||
*/
|
||||
bool CheckCommand(const wxString& command, char ret);
|
||||
|
||||
@@ -173,7 +173,7 @@ public:
|
||||
This list always has the same format and contains one full (including the
|
||||
directory path) file name per line.
|
||||
|
||||
@returns @true if the file list was successfully retrieved, @false otherwise.
|
||||
@return @true if the file list was successfully retrieved, @false otherwise.
|
||||
|
||||
@see GetDirList()
|
||||
*/
|
||||
@@ -190,7 +190,7 @@ 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
|
||||
@return Returns @NULL if an error occurred (it could be a network failure
|
||||
or the fact that the file doesn't exist).
|
||||
*/
|
||||
wxInputStream* GetInputStream(const wxString& path);
|
||||
@@ -206,7 +206,7 @@ public:
|
||||
The returned stream has all but the seek functionality of wxStreams.
|
||||
When the user finishes writing data, he has to delete the stream to close it.
|
||||
|
||||
@returns An initialized write-only stream.
|
||||
@return An initialized write-only stream.
|
||||
|
||||
@see wxOutputStream
|
||||
*/
|
||||
|
@@ -43,7 +43,7 @@ public:
|
||||
In such case, you may want to use wxInputStream::LastRead() method in a loop
|
||||
to get the total size.
|
||||
|
||||
@returns Returns the initialized stream. You must delete it yourself
|
||||
@return 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
|
||||
|
@@ -44,7 +44,7 @@ public:
|
||||
It is advised to destroy the input stream instead of aborting the stream
|
||||
this way.
|
||||
|
||||
@returns Returns @true, if successful, else @false.
|
||||
@return Returns @true, if successful, else @false.
|
||||
*/
|
||||
bool Abort();
|
||||
|
||||
@@ -69,7 +69,7 @@ public:
|
||||
available for the moment for this sort of stream.
|
||||
You will be notified when the EOF is reached by an error.
|
||||
|
||||
@returns Returns the initialized stream. You will have to delete it
|
||||
@return Returns the initialized stream. You will have to delete it
|
||||
yourself once you don't use it anymore. The destructor
|
||||
closes the network connection.
|
||||
|
||||
@@ -81,7 +81,7 @@ public:
|
||||
Tries to reestablish a previous opened connection (close and renegotiate
|
||||
connection).
|
||||
|
||||
@returns @true, if the connection is established, else @false.
|
||||
@return @true, if the connection is established, else @false.
|
||||
*/
|
||||
bool Reconnect();
|
||||
|
||||
|
Reference in New Issue
Block a user