// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-/*!
+/**
@page overview_stream wxStreams Overview
@li wxFilterInputStream
@li wxFilterOutputStream
+@li @ref overview_stream_intro
+@li @ref overview_stream_example
+
+<hr>
+
+
+
+@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 and using
wxStreamBuffer. This could also be a simple link to the a true syscall (for
example read(...), write(...)).
+
@section overview_stream_example Example
Usage is simple. We can take the example of wxFileInputStream and here is some
// You can also get the last number of bytes REALLY put into the buffer.
size_t really_read = in_stream.LastRead();
-// Ok, moves to the beginning of the stream. SeekI returns the last position
+// Ok, moves to the beginning of the stream. SeekI returns the last position
// in the stream counted from the beginning.
off_t old_position = in_stream.SeekI(0, wxFromBeginning);