X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..7c0d297a1f761de31d3a4ac924fa2080b5bbaf41:/interface/mstream.h diff --git a/interface/mstream.h b/interface/mstream.h index 939159252d..37319f10b2 100644 --- a/interface/mstream.h +++ b/interface/mstream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mstream.h -// Purpose: documentation for wxMemoryOutputStream class +// Purpose: interface of wxMemoryOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,17 +14,16 @@ @library{wxbase} @category{streams} - @seealso - wxStreamBuffer + @see wxStreamBuffer */ class wxMemoryOutputStream : public wxOutputStream { public: /** - If @e data is @NULL, then it will initialize a new empty buffer which will + If @a data is @NULL, then it will initialize a new empty buffer which will grow if required. */ - wxMemoryOutputStream(char * data = @NULL, size_t length = 0); + wxMemoryOutputStream(char* data = NULL, size_t length = 0); /** Destructor. @@ -33,19 +32,20 @@ public: /** CopyTo allowed you to transfer data from the internal buffer of - wxMemoryOutputStream to an external buffer. @e len specifies the size of + wxMemoryOutputStream to an external buffer. @a len specifies the size of the buffer. */ - size_t CopyTo(char * buffer, size_t len); + size_t CopyTo(char* buffer, size_t len) const; /** Returns the pointer to the stream object used as an internal buffer for that stream. */ - wxStreamBuffer * GetOutputStreamBuffer(); + wxStreamBuffer* GetOutputStreamBuffer() const; }; + /** @class wxMemoryInputStream @wxheader{mstream.h} @@ -54,8 +54,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxStreamBuffer, wxMemoryOutputStream + @see wxStreamBuffer, wxMemoryOutputStream */ class wxMemoryInputStream : public wxInputStream { @@ -64,12 +63,11 @@ public: /** Creates a new read-only memory stream, initializing it with the data from the given input stream @e stream. - - The @e len argument specifies the amount of data to read from + The @a len argument specifies the amount of data to read from the @e stream. Setting it to @e wxInvalidOffset means that - the @e stream is to be read entirely (i.e. till the EOF is reached). + the @a stream is to be read entirely (i.e. till the EOF is reached). */ - wxMemoryInputStream(const char * data, size_t len); + wxMemoryInputStream(const char* data, size_t len); wxMemoryInputStream(const wxMemoryOutputStream& stream); wxMemoryInputStream(wxInputStream& stream, wxFileOffset len = wxInvalidOffset); @@ -84,5 +82,6 @@ public: Returns the pointer to the stream object used as an internal buffer for that stream. */ - wxStreamBuffer * GetInputStreamBuffer(); + wxStreamBuffer* GetInputStreamBuffer() const; }; +