summaryrefslogtreecommitdiffstats
path: root/lib/lz4frame.h
diff options
context:
space:
mode:
authorChristopher Harvie <charvie@psdtechnologies.com>2020-05-14 01:48:12 (GMT)
committerChristopher Harvie <charvie@psdtechnologies.com>2020-05-14 01:48:12 (GMT)
commit57c35511d4a0053576468a23837de43fc293d923 (patch)
tree414c8170d578b7239ef3166903221b6d7ff3c3d0 /lib/lz4frame.h
parentf39b79fb02962a1cd880bbdecb6dffba4f754a11 (diff)
downloadlz4-57c35511d4a0053576468a23837de43fc293d923.zip
lz4-57c35511d4a0053576468a23837de43fc293d923.tar.gz
lz4-57c35511d4a0053576468a23837de43fc293d923.tar.bz2
fix LZ4F_compressBound when automatic flushing is enabled
Diffstat (limited to 'lib/lz4frame.h')
-rw-r--r--lib/lz4frame.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h
index 391e484..87b0b2a 100644
--- a/lib/lz4frame.h
+++ b/lib/lz4frame.h
@@ -284,7 +284,7 @@ LZ4FLIB_API size_t LZ4F_compressBegin(LZ4F_cctx* cctx,
* @return is always the same for a srcSize and prefsPtr.
* prefsPtr is optional : when NULL is provided, preferences will be set to cover worst case scenario.
* tech details :
- * @return includes the possibility that internal buffer might already be filled by up to (blockSize-1) bytes.
+ * @return if automatic flushing is not enabled, includes the possibility that internal buffer might already be filled by up to (blockSize-1) bytes.
* It also includes frame footer (ending + checksum), since it might be generated by LZ4F_compressEnd().
* @return doesn't include frame header, as it was already generated by LZ4F_compressBegin().
*/