wxMessageBox off the main thread lost result code.

[wxWidgets.git] / docs / doxygen / overviews / stream.h

diff --git a/docs/doxygen/overviews/stream.h b/docs/doxygen/overviews/stream.h
index 132b142eed99a9a8fd1116ae81b2beee612976de..99d2d7958f1e93e25ff20d66cc8b011acd049504 100644 (file)
--- a/docs/doxygen/overviews/stream.h
+++ b/docs/doxygen/overviews/stream.h
@@ -1,48 +1,34 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stream.h
-// Purpose:     topic overview
+// Purpose:     stream classes overview
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 
-@page overview_stream Stream classes overview
+@page overview_stream Stream Classes Overview
 
-Classes:
-@li wxStreamBase
-@li wxStreamBuffer
-@li wxInputStream
-@li wxOutputStream
-@li wxFilterInputStream
-@li wxFilterOutputStream
-@li wxFileInputStream
-@li wxFileOutputStream
-@li wxTextInputStream
-@li wxTextOutputStream
-@li wxDataInputStream
-@li wxDataOutputStream
+@tableofcontents
 
-@li @ref overview_stream_intro
-@li @ref overview_stream_example
+wxWidgets provides its own set of stream classes in order to support platforms
+not providing standard C++ streams implementation and also to make it possible
+to provide binary versions of wxWidgets application not depending on any
+particular standard library version. The wxWidgets stream classes also provide
+some functionality not available in the standard library such as support for
+several compression formats and possibility to work with sockets or text
+controls (for output only in the latter case).
 
-<hr>
+Nevertheless wxWidgets programs can also use standard stream classes and are
+encouraged to do so if the above considerations don't apply. Moreover,
+wxStdInputStream and wxStdOutputStream classes are provided to provide a degree
+of interoperability between the two and make it possible to use any wxWidgets
+stream as a standard stream (the converse possibility to use a standard stream
+as a wxWidgets stream is planned for a future release).
 
 
 
-@section overview_stream_intro Introduction
-
-wxWidgets provides its own set of stream classes in order to be
-independent of the standard C++ stream class and their different
-implementations.
-
-Besides, using @c std::iostream on Linux makes impossible to write programs that are
-binary compatible across different Linux distributions.
-
-Therefore, wxStreams have been added to wxWidgets so that an applications can
-reliably compile and run on all supported platforms without dependence on a
-particular release of libg++.
+@section overview_stream_classes Stream Classes
 
 wxStream classes are divided in two main groups:
 
@@ -117,4 +103,3 @@ off_t position = in_stream.TellI();
 @endcode
 
 */
-