mchapman/zlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor edits and clarifications of comments.

Browse Source
This commit is contained in:
Mark Adler
2017-01-01 20:02:24 -08:00
parent 7358ef23c2
commit 52aa5501ec
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
zlib.h
View File

@@ -379,10 +379,11 @@ ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
Initializes the internal stream state for decompression. The fields Initializes the internal stream state for decompression. The fields
next_in, avail_in, zalloc, zfree and opaque must be initialized before by next_in, avail_in, zalloc, zfree and opaque must be initialized before by
the caller. In the current version of inflate, the provide input is not the caller. In the current version of inflate, the provided input is not
read or consumed. Any memory allocation will be deferred to the first call read or consumed. The allocation of a sliding window will be deferred to
of inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them the first call of inflate (if the decompression does not complete on the
to use default allocation functions. first call). If zalloc and zfree are set to Z_NULL, inflateInit updates
them to use default allocation functions.
inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 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));
- Decompress more input starting at next_in and update next_in and avail_in - Decompress more input starting at next_in and update next_in and avail_in
accordingly. If not all input can be processed (because there is not accordingly. If not all input can be processed (because there is not
enough room in the output buffer), then next_in and avail_on are updated enough room in the output buffer), then next_in and avail_in are updated
accordingly, and processing will resume at this point for the next call of accordingly, and processing will resume at this point for the next call of
inflate(). inflate().
@@ -1229,7 +1230,7 @@ ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
the byte length of the source buffer. Upon entry, destLen is the total size the byte length of the source buffer. Upon entry, destLen is the total size
of the destination buffer, which must be at least the value returned by of the destination buffer, which must be at least the value returned by
compressBound(sourceLen). Upon exit, destLen is the actual size of the compressBound(sourceLen). Upon exit, destLen is the actual size of the
compressed buffer. compress() is equivalent to compress2() with a level compressed data. compress() is equivalent to compress2() with a level
parameter of Z_DEFAULT_COMPRESSION. parameter of Z_DEFAULT_COMPRESSION.
compress returns Z_OK if success, Z_MEM_ERROR if there was not 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,
length of the source buffer. Upon entry, destLen is the total size of the length of the source buffer. Upon entry, destLen is the total size of the
destination buffer, which must be at least the value returned by destination buffer, which must be at least the value returned by
compressBound(sourceLen). Upon exit, destLen is the actual size of the compressBound(sourceLen). Upon exit, destLen is the actual size of the
compressed buffer. compressed data.
compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
memory, Z_BUF_ERROR if there was not enough room in the output buffer, memory, Z_BUF_ERROR if there was not enough room in the output buffer,