fixed comment and docs for GetSize()

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 3a18bd74a041739d7c95f6ea44b8cca7a9cdc951..857394939e2f46e78ca1d2564b1b9df6fecfc411 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -100,9 +100,5 @@ the file.
 \wxheading{Warning}
 
 There are streams which do not have size by definition, such as socket streams.
 \wxheading{Warning}
 
 There are streams which do not have size by definition, such as socket streams.

-In that cases, GetSize returns an invalid size represented by
-
-\begin{verbatim}
-~(size_t)0
-\end{verbatim}
+In that cases, GetSize returns $0$ so you should always test its return value.

 
 

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 2c770c2b3e21e04fdf230bada2760eef5a73e106..151dd0bca45fac884215f903c0dab62690ea5b5d 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -81,7 +81,7 @@ public:
     // reset the stream state
     void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
 
     // reset the stream state
     void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
 

-    // deprecated (doesn't make sense!), don't use
+    // this doesn't make sense for all streams, always test its return value

     virtual size_t GetSize() const { return 0; }
 
 #if WXWIN_COMPATIBILITY_2_2
     virtual size_t GetSize() const { return 0; }
 
 #if WXWIN_COMPATIBILITY_2_2