]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/overviews/stream.h
PCH-less compilation fix
[wxWidgets.git] / docs / doxygen / overviews / stream.h
index 57097edc675efc85273635274940bc87663428ef..6a52ffd6e964df651a2c858acc7710c60df57edb 100644 (file)
@@ -6,7 +6,7 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/*!
+/**
 
 @page overview_stream wxStreams Overview
 
@@ -18,6 +18,15 @@ Classes:
 @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
@@ -58,6 +67,7 @@ nothing in the case of wxMemoryIn/OutputStream which bases itself on
 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
@@ -84,7 +94,7 @@ if (in_stream.Read(data, nb_datas).LastError() != wxSTREAM_NOERROR) {
 // 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);