document operator\!

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58079 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/stream.h b/interface/wx/stream.h
index 6398891aa704828d13e5615d27741c3ebd0644c9..2cb6d47e6389f462f6cd53cb51627e978a7816b1 100644 (file)
--- a/interface/wx/stream.h
+++ b/interface/wx/stream.h
@@ -80,6 +80,23 @@ public:
     */
     virtual bool IsSeekable() const;
 
+    /**
+        Returns the opposite of IsOk().
+        You can use this function to test the validity of the stream as if
+        it was a pointer:
+
+        @code
+            bool DoSomething(wxInputStream& stream)
+            {
+                wxInt32 data;
+                if (!stream.Read(&data, 4))
+                    return false;
+                ...
+            }
+        @endcode
+    */
+    bool operator!() const;
+
 protected:
 
     /**