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

@@ -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);