remove C++ comment

[wxWidgets.git] / docs / latex / wx / strmzlib.tex

diff --git a/docs/latex/wx/strmzlib.tex b/docs/latex/wx/strmzlib.tex
index 46945e16adea4b0efa7dbe4c7a182a899e67d17c..0cddc65c1ffca8080a487bee4b7b3d1340ca5681 100644 (file)
--- a/docs/latex/wx/strmzlib.tex
+++ b/docs/latex/wx/strmzlib.tex
@@ -5,7 +5,7 @@
 
 This filter stream decompresses a stream that is in zlib or gzip format.
 Note that reading the gzip format requires zlib version 1.2.1 or greater,
-(the builtin version does support gzips).
+(the builtin version does support gzip format).
 
 The stream is not seekable, \helpref{SeekI()}{wxinputstreamseeki} returns
  {\it wxInvalidOffset}. Also \helpref{GetSize()}{wxstreambasegetsize} is
@@ -13,12 +13,18 @@ not supported, it always returns $0$.
 
 \wxheading{Derived from}
 
-\helpref{wxFilterInputStream}{wxfilterinputstream}
+\helpref{wxFilterInputStream}{wxfilterinputstream}\\
+\helpref{wxInputStream}{wxinputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
 
 \wxheading{Include files}
 
 <wx/zstream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxInputStream}{wxinputstream}, 
@@ -26,10 +32,15 @@ not supported, it always returns $0$.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxZlibInputStream::wxZlibInputStream}
+\membersection{wxZlibInputStream::wxZlibInputStream}\label{wxzlibinputstreamwxzlibinputstream}
 
 \func{}{wxZlibInputStream}{\param{wxInputStream\&}{ stream}, \param{int}{ flags = wxZLIB\_AUTO}}
 
+\func{}{wxZlibInputStream}{\param{wxInputStream*}{ stream}, \param{int}{ flags = wxZLIB\_AUTO}}
+
+If the parent stream is passed as a pointer then the new filter stream
+takes ownership of it. If it is passed by reference then it does not.
+
 The {\it flags} wxZLIB\_ZLIB and wxZLIB\_GZIP specify whether the input data
 is in zlib or gzip format. If wxZLIB\_AUTO is used, then zlib will
 autodetect the stream type, this is the default.
@@ -42,8 +53,8 @@ deflate stream embedded in a higher level protocol.
 %if WXWIN_COMPATIBILITY_2_4
 This version is not by default compatible with the output produced by
 the version of {\it wxZlibOutputStream} in wxWidgets 2.4.x. However,
-there is a compatibilty mode, which is switched on by passing
-wxZLIB\_24COMPATIBLE for flags. Note that in when operating in compatibilty
+there is a compatibility mode, which is switched on by passing
+wxZLIB\_24COMPATIBLE for flags. Note that in when operating in compatibility
 mode error checking is very much reduced.
 %endif
 
@@ -76,19 +87,25 @@ Returns true if zlib library in use can handle gzip compressed data.
 This stream compresses all data written to it. The compressed output can be
 in zlib or gzip format.
 Note that writing the gzip format requires zlib version 1.2.1 or greater
-(the builtin version does support gzips).
+(the builtin version does support gzip format).
 
 The stream is not seekable, \helpref{SeekO()}{wxoutputstreamseeko} returns
  {\it wxInvalidOffset}.
 
 \wxheading{Derived from}
 
-\helpref{wxFilterOutputStream}{wxfilteroutputstream}
+\helpref{wxFilterOutputStream}{wxfilteroutputstream}\\
+\helpref{wxOutputStream}{wxoutputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
 
 \wxheading{Include files}
 
 <wx/zstream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxOutputStream}{wxoutputstream},
@@ -97,15 +114,20 @@ The stream is not seekable, \helpref{SeekO()}{wxoutputstreamseeko} returns
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxZlibOutputStream::wxZlibOutputStream}
+\membersection{wxZlibOutputStream::wxZlibOutputStream}\label{wxzliboutputstreamwxzliboutputstream}
 
 \func{}{wxZlibOutputStream}{\param{wxOutputStream\&}{ stream}, \param{int}{ level = -1}, \param{int}{ flags = wxZLIB\_ZLIB}}
 
+\func{}{wxZlibOutputStream}{\param{wxOutputStream*}{ stream}, \param{int}{ level = -1}, \param{int}{ flags = wxZLIB\_ZLIB}}
+
 Creates a new write-only compressed stream. {\it level} means level of 
 compression. It is number between 0 and 9 (including these values) where
 0 means no compression and 9 best but slowest compression. -1 is default
 value (currently equivalent to 6).
 
+If the parent stream is passed as a pointer then the new filter stream
+takes ownership of it. If it is passed by reference then it does not.
+
 The {\it flags} wxZLIB\_ZLIB and wxZLIB\_GZIP specify whether the output data
 will be in zlib or gzip format. wxZLIB\_ZLIB is the default.