* wxStream doc updates

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

diff --git a/docs/latex/wx/fltinstr.tex b/docs/latex/wx/fltinstr.tex
index 954e025cc5ed5be4a44b2b4907631ecdc8082df5..4e935524dfa0ca2c9a4c12a4cf152f8d5c546873 100644 (file)
--- a/docs/latex/wx/fltinstr.tex
+++ b/docs/latex/wx/fltinstr.tex
@@ -20,3 +20,7 @@ differs and it is documented below.
 
 \func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
 
 
 \func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
 

+Initializes a "filter" stream. A filter stream has the capability of a normal
+stream but it can be placed on the top of another stream. So, for example, it
+can uncompress, uncrypt the datas which are read from another stream and pass it
+to the requester.

diff --git a/docs/latex/wx/fltoutst.tex b/docs/latex/wx/fltoutst.tex
index bb126f619e3c600fa73484057dc4053ef9c9819d..9feae4fd132f5b6dbb3eaabbaa900bedc1fd964a 100644 (file)
--- a/docs/latex/wx/fltoutst.tex
+++ b/docs/latex/wx/fltoutst.tex
@@ -20,3 +20,7 @@ differs and it is documented below.
 
 \func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ stream}}
 
 
 \func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ stream}}
 

+Initializes a "filter" stream. A filter stream has the capability of a normal
+stream but it can be placed on the top of another stream. So, for example, it
+can compress, crypt the datas which are passed to it and write them to another
+stream.

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index fec1deea18a4960d742b6666be657c5337436167..795b834dd3833c05b0e1addca83c511363e075b8 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -52,7 +52,11 @@ Returns the first character in the input queue and removes it.
 
 Reads the specified amount of bytes and stores the data in \it{buffer}.
 
 
 Reads the specified amount of bytes and stores the data in \it{buffer}.
 

-\it{WARNING!} The buffer absolutely needs to have at least the specified size.
+\wxheading{Warning}
+
+The buffer absolutely needs to have at least the specified size.
+
+\wxheading{Return value}

 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.


@@ -62,6 +66,11 @@ any states of the stream right away.
 Reads data from the input queue and stores it in the specified output stream.
 The data is read until an error is raised by one of the two streams.
 
 Reads data from the input queue and stores it in the specified output stream.
 The data is read until an error is raised by one of the two streams.
 

+\wxheading{Return value}
+
+This function returns a reference on the current object, so the user can test
+any states of the stream right away.
+

 % ------------------
 % Position functions
 % ------------------
 % ------------------
 % Position functions
 % ------------------

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index 641609234a49582b72f9f6ad84db45542332608a..a2fdd74c09dfa66b584e5c4fd80b69508dc4d2a1 100644 (file)
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -16,7 +16,7 @@ None
 % -----------
 % ctor & dtor
 % -----------
 % -----------
 % ctor & dtor
 % -----------

-\membersection{wxStreamBuffer::wxStreamBuffer}
+\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufconst}

 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 
 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 


@@ -211,11 +211,40 @@ Resets to the initial state variables concerning the buffer.
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
 
 Specifies which pointers to use for stream buffering. You need to pass a pointer on the
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
 
 Specifies which pointers to use for stream buffering. You need to pass a pointer on the

-start of the buffer end and another on the end.
+start of the buffer end and another on the end. The object will use this buffer
+to cache stream data. It may be used also as a source/destination buffer when
+you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufconst}).
+
+\wxheading{Remarks}
+
+When you use this function, you'll have to destroy the IO buffers yourself
+after the stream buffer is destroyed or don't use it anymore.
+In the case you use it with an empty buffer, the stream buffer will not grow
+it when it is full.
+
+\wxheading{See also}
+
+\helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
+\helpref{wxStreamBuffer::Fixed}{wxstreambuffixed}\\
+\helpref{wxStreamBuffer::Flushable}{wxstreambufflushable}

 
 \func{void}{SetBufferIO}{\param{size\_t}{ bufsize}}
 
 
 \func{void}{SetBufferIO}{\param{size\_t}{ bufsize}}
 

-Changes the size of the current IO buffer.
+Destroys or invalidates the previous IO buffer and allocates a new one of the
+specified size.
+
+\wxheading{Warning}
+
+All previous pointers aren't valid anymore.
+
+\wxheading{Remark}
+
+The created IO buffer is growable by the object.
+
+\wxheading{See also}
+
+\helpref{wxStreamBuffer::Fixed}{wxstreambuffixed}\\
+\helpref{wxStreamBuffer::Flushable}{wxstreambufflushable}

 
 \membersection{wxStreamBuffer::GetBufferStart}
 
 
 \membersection{wxStreamBuffer::GetBufferStart}
 


@@ -239,7 +268,7 @@ Returns a pointer on the current position of the stream buffer.
 
 \constfunc{off\_t}{GetIntPosition}{\void}
 
 
 \constfunc{off\_t}{GetIntPosition}{\void}
 

-Returns the current position in the stream buffer.
+Returns the current position (counted in bytes) in the stream buffer.

 
 \membersection{wxStreamBuffer::SetIntPosition}
 
 
 \membersection{wxStreamBuffer::SetIntPosition}
 


@@ -258,8 +287,12 @@ Returns the amount of bytes read during the last IO call to the parent stream.
 \func{void}{Fixed}{\param{bool}{ fixed}}
 
 Toggles the fixed flag. Usually this flag is toggled at the same time as 
 \func{void}{Fixed}{\param{bool}{ fixed}}
 
 Toggles the fixed flag. Usually this flag is toggled at the same time as 

-\it{flushable}. This flag allows (when it is FALSE) or forbids (when it is TRUE)
-the stream buffer to resize dynamically the IO buffer.
+\it{flushable}. This flag allows (when it has the FALSE value) or forbids
+(when it has the TRUE value) the stream buffer to resize dynamically the IO buffer.
+
+\wxheading{See also}
+
+\helpref{wxStreamBuffer::SetBufferIO}{wxstreambufsetbufferio}

 
 \membersection{wxStreamBuffer::Flushable}
 
 
 \membersection{wxStreamBuffer::Flushable}
 

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 4ff8ade705eedf3630ef7611a3281ebc10c9e951..140aec0f5da998c123ed8e714bf80892901b6296 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -24,7 +24,7 @@ None
 
 \func{}{wxStreamBase}{\void}
 
 
 \func{}{wxStreamBase}{\void}
 

-Creates a dummy stream object.
+Creates a dummy stream object. It doesn't do anything.

 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 
 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 


@@ -49,7 +49,15 @@ This function returns the last error.
 \constfunc{size_t}{StreamSize}{\void}
 
 This function returns the size of the stream. For example, for a file it is the size of
 \constfunc{size_t}{StreamSize}{\void}
 
 This function returns the size of the stream. For example, for a file it is the size of

-the file). Warning! There are streams which do not have size by definition, such as a socket.
+the file).
+
+\wxheading{Warning}
+
+There are streams which do not have size by definition, such as socket streams.
+In that cases, StreamSize returns an invalid size represented by
+\begin{verbatim}
+~(size_t)0
+\end{verbatim}

 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 
 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 

diff --git a/docs/latex/wx/strmzlib.tex b/docs/latex/wx/strmzlib.tex
index 1bfbf12fa0e6f8371ffc0e5740e7b3ecd98449fe..eadbb0897c2f1e635c39db6819f6a6e2d2f68b8b 100644 (file)
--- a/docs/latex/wx/strmzlib.tex
+++ b/docs/latex/wx/strmzlib.tex
@@ -13,7 +13,7 @@
 
 \wxheading{Short description}
 
 
 \wxheading{Short description}
 

-This stream uncompresses all data read from it. It uses the ``filtered''
+This stream uncompresses all data read from it. It uses the "filtered"

 stream to get new compressed data.
 
 % -----------------------------------------------------------------------------
 stream to get new compressed data.
 
 % -----------------------------------------------------------------------------