diff options
author | Yann Collet <cyan@fb.com> | 2020-11-08 20:54:59 (GMT) |
---|---|---|
committer | Yann Collet <cyan@fb.com> | 2020-11-08 20:54:59 (GMT) |
commit | be634559e3b6bb7bce77cc83ec2080b2bfb6c844 (patch) | |
tree | c598740ac7a30ec310839a850025d5e20ea7ae55 /doc/lz4frame_manual.html | |
parent | c41be7e92060cfc2e5f52bcdd7f7426edd4935a4 (diff) | |
download | lz4-be634559e3b6bb7bce77cc83ec2080b2bfb6c844.zip lz4-be634559e3b6bb7bce77cc83ec2080b2bfb6c844.tar.gz lz4-be634559e3b6bb7bce77cc83ec2080b2bfb6c844.tar.bz2 |
update obsolete section documentation
and update manuals.
fix #712
Diffstat (limited to 'doc/lz4frame_manual.html')
-rw-r--r-- | doc/lz4frame_manual.html | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/lz4frame_manual.html b/doc/lz4frame_manual.html index 607583b..2758306 100644 --- a/doc/lz4frame_manual.html +++ b/doc/lz4frame_manual.html @@ -299,8 +299,10 @@ LZ4F_errorCode_t LZ4F_freeDecompressionContext(LZ4F_dctx* dctx); void* dstBuffer, size_t* dstSizePtr, const void* srcBuffer, size_t* srcSizePtr, const LZ4F_decompressOptions_t* dOptPtr); -</b><p> Call this function repetitively to regenerate compressed data from `srcBuffer`. - The function will read up to *srcSizePtr bytes from srcBuffer, +</b><p> Call this function repetitively to regenerate data compressed in `srcBuffer`. + + The function requires a valid dctx state. + It will read up to *srcSizePtr bytes from srcBuffer, and decompress data into dstBuffer, of capacity *dstSizePtr. The nb of bytes consumed from srcBuffer will be written into *srcSizePtr (necessarily <= original value). |