document the main event table macros, wxEventType, wxNewEventType; create a new group...

[wxWidgets.git] / interface / wx / mstream.h

diff --git a/interface/wx/mstream.h b/interface/wx/mstream.h
index 8db9a2e2e45868d5e0db7c8fdebb4a31cb064736..eec704124a2f14b2f50ef831358851be659a09ff 100644 (file)
--- a/interface/wx/mstream.h
+++ b/interface/wx/mstream.h
@@ -9,6 +9,7 @@
 /**
     @class wxMemoryOutputStream
 
+    @todo describe me.
 
     @library{wxbase}
     @category{streams}
@@ -21,20 +22,22 @@ public:
     /**
         If @a data is @NULL, then it will initialize a new empty buffer which will
         grow if required.
+
+        @warning
+        If the buffer is created, it will be destroyed at the destruction of the stream.
     */
-    wxMemoryOutputStream(char* data = NULL, size_t length = 0);
+    wxMemoryOutputStream(void* data = NULL, size_t length = 0);
 
     /**
         Destructor.
     */
-    ~wxMemoryOutputStream();
+    virtual ~wxMemoryOutputStream();
 
     /**
-        CopyTo allowed you to transfer data from the internal buffer of
-        wxMemoryOutputStream to an external buffer. @a len specifies the size of
-        the buffer.
+        Allows you to transfer data from the internal buffer of wxMemoryOutputStream
+        to an external buffer. @a len specifies the size of the buffer.
     */
-    size_t CopyTo(char* buffer, size_t len) const;
+    size_t CopyTo(void* buffer, size_t len) const;
 
     /**
         Returns the pointer to the stream object used as an internal buffer
@@ -48,6 +51,7 @@ public:
 /**
     @class wxMemoryInputStream
 
+    @todo describe me.
 
     @library{wxbase}
     @category{streams}
@@ -57,24 +61,34 @@ public:
 class wxMemoryInputStream : public wxInputStream
 {
 public:
-    //@{
     /**
-        Creates a new read-only memory stream, initializing it with the
-        data from the given input stream @e stream.
-        The @a len argument specifies the amount of data to read from
-        the @e stream. Setting it to @e wxInvalidOffset means that
-        the @a stream is to be read entirely (i.e. till the EOF is reached).
+        Initializes a new read-only memory stream which will use the specified
+        buffer data of length len. The stream does not take ownership of the buffer,
+        i.e. the buffer will not be deleted in its destructor.
+    */
+    wxMemoryInputStream(const void* data, size_t len);
+
+    /**
+        Creates a new read-only memory stream, initializing it with the data from
+        the given output stream @a stream.
     */
-    wxMemoryInputStream(const char* data, size_t len);
     wxMemoryInputStream(const wxMemoryOutputStream& stream);
+
+    /**
+        Creates a new read-only memory stream, initializing it with the
+        data from the given input stream @a stream.
+
+        The @a len argument specifies the amount of data to read from the
+        @a stream. Setting it to @e wxInvalidOffset means that the @a stream
+        is to be read entirely (i.e. till the EOF is reached).
+    */
     wxMemoryInputStream(wxInputStream& stream,
                         wxFileOffset len = wxInvalidOffset);
-    //@}
 
     /**
         Destructor.
     */
-    ~wxMemoryInputStream();
+    virtual ~wxMemoryInputStream();
 
     /**
         Returns the pointer to the stream object used as an internal buffer