From 8801e78f99ba47fa0201a729b4a9717d603c8250 Mon Sep 17 00:00:00 2001
From: Guilhem Lavaux <lavaux@easynet.fr>
Date: Sat, 23 Jan 1999 17:58:03 +0000
Subject: [PATCH] * Stream doc update.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1455 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/stream2.tex | 53 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 50 insertions(+), 3 deletions(-)

diff --git a/docs/latex/wx/stream2.tex b/docs/latex/wx/stream2.tex
index 62547382e1..b9c00157ff 100644
--- a/docs/latex/wx/stream2.tex
+++ b/docs/latex/wx/stream2.tex
@@ -106,14 +106,27 @@ Destructor.
 \membersection{wxInputStream::Peek}
 \func{char}{Peek}{\void}
 
+Returns the first character in the input queue without removing it.
+
 \membersection{wxInputStream::GetC}
 \func{char}{GetC}{\void}
 
+Returns the first character in the input queue and removes it.
+
 \membersection{wxInputStream::Read}
 \func{wxInputStream&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}}
 
+Reads the specified amount of bytes and stores the data in \it{buffer}.
+\it{WARNING !} The buffer needs absolutely to have at least the specified size.
+
+This function returns a reference on the current object, so the user can test
+any states of the stream right away.
+
 \func{wxInputStream&}{Read}{\param{wxOutputStream&}{ stream_out}}
 
+Reads data from the input queue and stores them in the specified output stream.
+The data is read until an error is raised by one of the two streams.
+
 % ------------------
 % Position functions
 % ------------------
@@ -121,9 +134,13 @@ Destructor.
 \membersection{wxInputStream::SeekI}
 \func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
 
+Changes the stream current position.
+
 \membersection{wxInputStream::TellI}
 \constfunc{off_t}{TellI}{\void}
 
+Returns the current stream position.
+
 % ---------------
 % State functions
 % ---------------
@@ -131,9 +148,13 @@ Destructor.
 \membersection{wxInputStream::InputStreamBuffer}
 \func{wxStreamBuffer *}{InputStreamBuffer}{\void}
 
+Returns the stream buffer associated with the input stream.
+
 \membersection{wxInputStream::LastRead}
 \constfunc{size_t}{LastRead}{\void}
 
+Returns the last amount of bytes read.
+
 % -----------------------------------------------------------------------------
 % wxOutputStream
 % -----------------------------------------------------------------------------
@@ -152,36 +173,60 @@ Destructor.
 % ctor & dtor
 % -----------
 
-\membersection{wxOutputStream::wxInputStream}
+\membersection{wxOutputStream::wxOutputStream}
 \func{}{wxOutputStream}{\void}
 
+Creates a dummy wxOutputStream object.
+
 \func{}{wxOutputStream}{\param{wxStreamBuffer *}{sbuf}}
 
+Creates an input stream using the specified stream buffer \it{sbuf}. This
+stream buffer can point to another stream.
+
 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 \func{}{\destruct{wxOutputStream}}
 
+Destructor.
+
 % -----------
 % IO function
 % -----------
 
 \membersection{wxOutputStream::PutC}
-\func{char}{PutC}{\void}
+\func{void}{PutC}{\param{char}{ c}}
+
+Puts the specified character in the output queue and increments the
+stream position.
 
 \membersection{wxOutputStream::Write}
 \func{wxOutputStream&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
 
+Writes the specified amount of bytes using the data of \it{buffer}.
+\it{WARNING !} The buffer needs absolutely to have at least the specified size.
+
+This function returns a reference on the current object, so the user can test
+any states of the stream right away.
+
 \func{wxOutputStream&}{Write}{\param{wxInputStream&}{ stream_in}}
 
+Reads data from the specified input stream and stores them 
+in the current stream. The data is read until an error is raised
+by one of the two streams.
+
 % ------------------
 % Position functions
 % ------------------
 
 \membersection{wxOutputStream::SeekO}
-\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
+\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}}
+
+Changes the stream current position.
 
 \membersection{wxOutputStream::TellO}
 \constfunc{off_t}{TellO}{\void}
 
+Returns the current stream position.
+
 % ---------------
 % State functions
 % ---------------
@@ -189,6 +234,8 @@ Destructor.
 \membersection{wxOutputStream::OutputStreamBuffer}
 \func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
 
+Returns the stream buffer associated with the output stream.
+
 \membersection{wxOutputStream::LastWrite}
 \constfunc{size_t}{LastWrite}{\void}
 
-- 
2.45.2