updated LZ4F_compressBound() documentation

to clarify it includes potentially buffered data.

1 files changed, 6 insertions, 3 deletions

diff --git a/doc/lz4frame_manual.html b/doc/lz4frame_manual.html
index db004ab..f0f7f5a 100644
--- a/doc/lz4frame_manual.html
+++ b/doc/lz4frame_manual.html
@@ -153,10 +153,13 @@ LZ4F_errorCode_t LZ4F_freeCompressionContext(LZ4F_cctx* cctx);
 </p></pre><BR>
 
 <pre><b>size_t LZ4F_compressBound(size_t srcSize, const LZ4F_preferences_t* prefsPtr);
-</b><p>  Provides minimum dstCapacity for a given srcSize to guarantee operation success in worst case scenarios.
-  Estimation includes frame footer, which would be generated by LZ4F_compressEnd().
-  Estimation doesn't include frame header, already generated by LZ4F_compressBegin().
+</b><p>  Provides minimum dstCapacity required to guarantee compression success
+  given a srcSize and preferences, covering worst case scenario.
   prefsPtr is optional : when NULL is provided, preferences will be set to cover worst case scenario.
+  Estimation is valid for either LZ4F_compressUpdate(), LZ4F_flush() or LZ4F_compressEnd(),
+  Estimation includes the possibility that internal buffer might already be filled by up to (blockSize-1) bytes.
+  It also includes frame footer (ending + checksum), which would have to be generated by LZ4F_compressEnd().
+  Estimation doesn't include frame header, as it was already generated by LZ4F_compressBegin().
   Result is always the same for a srcSize and prefsPtr, so it can be trusted to size reusable buffers.
   When srcSize==0, LZ4F_compressBound() provides an upper bound for LZ4F_flush() and LZ4F_compressEnd() operations.