summaryrefslogtreecommitdiff
path: root/zlib.h
diff options
context:
space:
mode:
authorMark Adler <madler@alumni.caltech.edu>2015-07-28 23:17:49 -0700
committerMark Adler <madler@alumni.caltech.edu>2015-07-28 23:19:50 -0700
commit5701f48cf5178355b1ec51614d44aa14251250e5 (patch)
tree518331f3b47e3e96824f1d6f8fd31d64bd27e58e /zlib.h
parentc901a34c92c4aa74028f541a9773df726ce2b769 (diff)
downloadzlib-5701f48cf5178355b1ec51614d44aa14251250e5.tar.gz
Clarify deflateReset() documentation.
It previously could have been misinterpreted to mean that parameter changes after deflateInit2() would be reversed, which is not the case.
Diffstat (limited to 'zlib.h')
-rw-r--r--zlib.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/zlib.h b/zlib.h
index c563014..7ec5fa8 100644
--- a/zlib.h
+++ b/zlib.h
@@ -656,10 +656,10 @@ ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
/*
- This function is equivalent to deflateEnd followed by deflateInit,
- but does not free and reallocate all the internal compression state. The
- stream will keep the same compression level and any other attributes that
- may have been set by deflateInit2.
+ This function is equivalent to deflateEnd followed by deflateInit, but
+ does not free and reallocate the internal compression state. The stream
+ will leave the compression level and any other attributes that may have been
+ set unchanged.
deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
stream state was inconsistent (such as zalloc or state being Z_NULL).