more utils.h fixes

[wxWidgets.git] / interface / mstream.h

diff --git a/interface/mstream.h b/interface/mstream.h
index c3d0f02f49d71e95bd039256551b88d597cfb67b..37319f10b2b7a5229e462b4933da29d7bc6dc413 100644 (file)
--- 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
@@ -9,22 +9,21 @@
 /**
     @class wxMemoryOutputStream
     @wxheader{mstream.h}
-    
-    
+
+
     @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,29 +32,29 @@ 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}
-    
-    
+
+
     @library{wxbase}
     @category{streams}
-    
-    @seealso
-    wxStreamBuffer, wxMemoryOutputStream
+
+    @see wxStreamBuffer, wxMemoryOutputStream
 */
 class wxMemoryInputStream : public wxInputStream
 {
@@ -64,15 +63,14 @@ 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 wxMemoryOutputStream& stream);
-        wxMemoryInputStream(wxInputStream& stream,
-                            wxFileOffset len = wxInvalidOffset);
+    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;
 };
+