Minor stream class changes

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

diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h
index a76a23b1af53524a0ca3fa521b752ec08c85d3ea..e123b0a3a52b9a121fb0cce86a2c1d6ddd2f0baa 100644 (file)
--- a/docs/doxygen/mainpages/cat_classes.h
+++ b/docs/doxygen/mainpages/cat_classes.h
@@ -596,7 +596,7 @@ Related Overviews: @ref overview_debugging
 
 wxWidgets provides several classes and functions for message logging.
 
 
 wxWidgets provides several classes and functions for message logging.
 

-Related Overviews: @ref overview_log
+Related overview: @ref overview_log

 
 @see @ref group_funcmacro_log "Logging Functions and Macros"
 
 
 @see @ref group_funcmacro_log "Logging Functions and Macros"
 


@@ -688,7 +688,7 @@ wxWidgets provides a few smart pointer class templates.
 
 wxWidgets has several small classes to work with disk files and directories.
 
 
 wxWidgets has several small classes to work with disk files and directories.
 

-Related Overviews: @ref overview_file
+Related overview: @ref overview_file

 
 @li wxFileName: Operations with the file name and attributes
 @li wxDir: Class for enumerating files/subdirectories.
 
 @li wxFileName: Operations with the file name and attributes
 @li wxDir: Class for enumerating files/subdirectories.


@@ -705,8 +705,10 @@ Related Overviews: @ref overview_file
 
 @section page_class_cat_streams Streams
 
 
 @section page_class_cat_streams Streams
 

-wxWidgets has its own set of stream classes, as an alternative to often buggy
-standard stream libraries, and to provide enhanced functionality.
+wxWidgets has its own set of stream classes as an alternative to the
+standard stream libraries and to provide enhanced functionality.
+
+Related overview: @ref overview_stream

 
 @li wxStreamBase: Stream base class
 @li wxStreamBuffer: Stream buffer class
 
 @li wxStreamBase: Stream base class
 @li wxStreamBuffer: Stream buffer class


@@ -763,7 +765,7 @@ standard stream libraries, and to provide enhanced functionality.
 Resources allow your application to create controls and other user interface
 elements from specifications stored in an XML format.
 
 Resources allow your application to create controls and other user interface
 elements from specifications stored in an XML format.
 

-Related Overviews: @ref overview_xrc
+Related overview: @ref overview_xrc

 
 @li wxXmlResource: The main class for working with resources
 @li wxXmlResourceHandler: The base class for XML resource handlers
 
 @li wxXmlResource: The main class for working with resources
 @li wxXmlResourceHandler: The base class for XML resource handlers


@@ -793,7 +795,7 @@ wxWidgets provides its own classes for socket based networking.
 wxWidgets provides simple interprocess communications facilities based on
 Windows DDE, but available on most platforms using TCP.
 
 wxWidgets provides simple interprocess communications facilities based on
 Windows DDE, but available on most platforms using TCP.
 

-Related Overviews: @ref overview_ipc
+Related overview: @ref overview_ipc

 
 @li wxClient, wxDDEClient: Represents a client
 @li wxConnection, wxDDEConnection: Represents the connection between a client
 
 @li wxClient, wxDDEClient: Represents a client
 @li wxConnection, wxDDEConnection: Represents the connection between a client

diff --git a/docs/doxygen/overviews/stream.h b/docs/doxygen/overviews/stream.h
index 759c0c903df2b80f8c55cec34c9895bb147eacf0..132b142eed99a9a8fd1116ae81b2beee612976de 100644 (file)
--- a/docs/doxygen/overviews/stream.h
+++ b/docs/doxygen/overviews/stream.h
@@ -8,7 +8,7 @@
 
 /**
 
 
 /**
 

-@page overview_stream wxStreams Overview
+@page overview_stream Stream classes overview

 
 Classes:
 @li wxStreamBase
 
 Classes:
 @li wxStreamBase


@@ -17,6 +17,12 @@ Classes:
 @li wxOutputStream
 @li wxFilterInputStream
 @li wxFilterOutputStream
 @li wxOutputStream
 @li wxFilterInputStream
 @li wxFilterOutputStream

+@li wxFileInputStream
+@li wxFileOutputStream
+@li wxTextInputStream
+@li wxTextOutputStream
+@li wxDataInputStream
+@li wxDataOutputStream

 
 @li @ref overview_stream_intro
 @li @ref overview_stream_example
 
 @li @ref overview_stream_intro
 @li @ref overview_stream_example


@@ -27,10 +33,9 @@ Classes:
 
 @section overview_stream_intro Introduction
 
 
 @section overview_stream_intro Introduction
 

-Standard C++ streams can cause problems on several platforms: they work quite
-well in most cases, but in the multi-threaded case, for example, they have many
-problems. Some Borland compilers refuse to work at all with them.
-@todo is this still true?
+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.
 
 Besides, using @c std::iostream on Linux makes impossible to write programs that are
 binary compatible across different Linux distributions.


@@ -45,6 +50,9 @@ wxStream classes are divided in two main groups:
     wxFilterInputStream, wxFilterOutputStream
 @li The "IO" classes: wxSocketInputStream, wxSocketOutputStream,
     wxFileInputStream, wxFileOutputStream, ...
     wxFilterInputStream, wxFilterOutputStream
 @li The "IO" classes: wxSocketInputStream, wxSocketOutputStream,
     wxFileInputStream, wxFileOutputStream, ...

+@li Classes for reading text or binary data from a particular stream
+    such as wxTextInputStream, wxTextOutputStream, wxDataInputStream
+    and wxDataOutputStream

 
 wxStreamBase is the base definition of a stream. It defines, for example, the
 API of OnSysRead(), OnSysWrite(), OnSysSeek() and OnSysTell(). These functions are
 
 wxStreamBase is the base definition of a stream. It defines, for example, the
 API of OnSysRead(), OnSysWrite(), OnSysSeek() and OnSysTell(). These functions are