summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Adler <madler@alumni.caltech.edu>2017-01-01 20:02:24 -0800
committerMark Adler <madler@alumni.caltech.edu>2017-01-01 22:24:37 -0800
commit52aa5501ecfffed933d39647092852cab397ca39 (patch)
tree217726a07a8a20c1c79b3970d6237eaff6327742
parent7358ef23c2b412543196df58c333ebc9aabb1d62 (diff)
downloadzlib-52aa5501ecfffed933d39647092852cab397ca39.tar.gz
zlib-52aa5501ecfffed933d39647092852cab397ca39.tar.bz2
zlib-52aa5501ecfffed933d39647092852cab397ca39.zip
Minor edits and clarifications of comments.
-rw-r--r--zlib.h15
1 files changed, 8 insertions, 7 deletions
diff --git a/zlib.h b/zlib.h
index 16ce8f2..263e6f6 100644
--- a/zlib.h
+++ b/zlib.h
@@ -379,10 +379,11 @@ ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
379 379
380 Initializes the internal stream state for decompression. The fields 380 Initializes the internal stream state for decompression. The fields
381 next_in, avail_in, zalloc, zfree and opaque must be initialized before by 381 next_in, avail_in, zalloc, zfree and opaque must be initialized before by
382 the caller. In the current version of inflate, the provide input is not 382 the caller. In the current version of inflate, the provided input is not
383 read or consumed. Any memory allocation will be deferred to the first call 383 read or consumed. The allocation of a sliding window will be deferred to
384 of inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them 384 the first call of inflate (if the decompression does not complete on the
385 to use default allocation functions. 385 first call). If zalloc and zfree are set to Z_NULL, inflateInit updates
386 them to use default allocation functions.
386 387
387 inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 388 inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
388 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 389 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
@@ -408,7 +409,7 @@ ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
408 409
409 - Decompress more input starting at next_in and update next_in and avail_in 410 - Decompress more input starting at next_in and update next_in and avail_in
410 accordingly. If not all input can be processed (because there is not 411 accordingly. If not all input can be processed (because there is not
411 enough room in the output buffer), then next_in and avail_on are updated 412 enough room in the output buffer), then next_in and avail_in are updated
412 accordingly, and processing will resume at this point for the next call of 413 accordingly, and processing will resume at this point for the next call of
413 inflate(). 414 inflate().
414 415
@@ -1229,7 +1230,7 @@ ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
1229 the byte length of the source buffer. Upon entry, destLen is the total size 1230 the byte length of the source buffer. Upon entry, destLen is the total size
1230 of the destination buffer, which must be at least the value returned by 1231 of the destination buffer, which must be at least the value returned by
1231 compressBound(sourceLen). Upon exit, destLen is the actual size of the 1232 compressBound(sourceLen). Upon exit, destLen is the actual size of the
1232 compressed buffer. compress() is equivalent to compress2() with a level 1233 compressed data. compress() is equivalent to compress2() with a level
1233 parameter of Z_DEFAULT_COMPRESSION. 1234 parameter of Z_DEFAULT_COMPRESSION.
1234 1235
1235 compress returns Z_OK if success, Z_MEM_ERROR if there was not 1236 compress returns Z_OK if success, Z_MEM_ERROR if there was not
@@ -1246,7 +1247,7 @@ ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen,
1246 length of the source buffer. Upon entry, destLen is the total size of the 1247 length of the source buffer. Upon entry, destLen is the total size of the
1247 destination buffer, which must be at least the value returned by 1248 destination buffer, which must be at least the value returned by
1248 compressBound(sourceLen). Upon exit, destLen is the actual size of the 1249 compressBound(sourceLen). Upon exit, destLen is the actual size of the
1249 compressed buffer. 1250 compressed data.
1250 1251
1251 compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1252 compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1252 memory, Z_BUF_ERROR if there was not enough room in the output buffer, 1253 memory, Z_BUF_ERROR if there was not enough room in the output buffer,