X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..f0871806fb56851483a12ec8e49a9bf43cd5caf7:/interface/wfstream.h

diff --git a/interface/wfstream.h b/interface/wfstream.h
index 130e169da7..62c1399238 100644
--- a/interface/wfstream.h
+++ b/interface/wfstream.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wfstream.h
-// Purpose:     documentation for wxTempFileOutputStream class
+// Purpose:     interface of wxTempFileOutputStream
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -17,8 +17,7 @@
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    wxTempFile
+    @see wxTempFile
 */
 class wxTempFileOutputStream : public wxOutputStream
 {
@@ -27,7 +26,6 @@ public:
         Associates wxTempFileOutputStream with the file to be replaced and opens it.
         You should use
         wxStreamBase::IsOk to verify if the constructor succeeded.
-        
         Call Commit() or wxOutputStream::Close to
         replace the old file and close this one. Calling Discard()
         (or allowing the destructor to do it) will discard the changes.
@@ -51,6 +49,7 @@ public:
 };
 
 
+
 /**
     @class wxFFileOutputStream
     @wxheader{wfstream.h}
@@ -67,8 +66,7 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream
+    @see wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream
 */
 class wxFFileOutputStream : public wxOutputStream
 {
@@ -78,9 +76,9 @@ public:
         Initializes a file stream in write-only mode using the file descriptor @e fp.
     */
     wxFFileOutputStream(const wxString& filename,
-                        const wxString& mode="w+b");
+                        const wxString& mode = "w+b");
     wxFFileOutputStream(wxFFile& file);
-    wxFFileOutputStream(FILE * fp);
+    wxFFileOutputStream(FILE* fp);
     //@}
 
     /**
@@ -91,10 +89,11 @@ public:
     /**
         Returns @true if the stream is initialized and ready.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;
 };
 
 
+
 /**
     @class wxFileOutputStream
     @wxheader{wfstream.h}
@@ -111,8 +110,7 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream
+    @see wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream
 */
 class wxFileOutputStream : public wxOutputStream
 {
@@ -134,10 +132,11 @@ public:
     /**
         Returns @true if the stream is initialized and ready.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;
 };
 
 
+
 /**
     @class wxFileInputStream
     @wxheader{wfstream.h}
@@ -154,8 +153,7 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream
+    @see wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream
 */
 class wxFileInputStream : public wxInputStream
 {
@@ -177,10 +175,11 @@ public:
     /**
         Returns @true if the stream is initialized and ready.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;
 };
 
 
+
 /**
     @class wxFFileInputStream
     @wxheader{wfstream.h}
@@ -197,8 +196,7 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream
+    @see wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream
 */
 class wxFFileInputStream : public wxInputStream
 {
@@ -211,7 +209,7 @@ public:
     wxFFileInputStream(const wxString& filename,
                        const wxString& mode = "rb");
     wxFFileInputStream(wxFFile& file);
-    wxFFileInputStream(FILE * fp);
+    wxFFileInputStream(FILE* fp);
     //@}
 
     /**
@@ -222,10 +220,11 @@ public:
     /**
         Returns @true if the stream is initialized and ready.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;
 };
 
 
+
 /**
     @class wxFFileStream
     @wxheader{wfstream.h}
@@ -234,8 +233,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxStreamBuffer
+    @see wxStreamBuffer
 */
 class wxFFileStream : public wxFFileOutputStream
 {
@@ -248,6 +246,7 @@ public:
 };
 
 
+
 /**
     @class wxFileStream
     @wxheader{wfstream.h}
@@ -256,8 +255,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxStreamBuffer
+    @see wxStreamBuffer
 */
 class wxFileStream : public wxFileOutputStream
 {
@@ -268,3 +266,4 @@ public:
     */
     wxFileStream(const wxString& iofileName);
 };
+