summaryrefslogtreecommitdiffstats
path: root/lib/lz4frame.h
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2015-04-14 17:51:36 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2015-04-14 17:51:36 (GMT)
commit05a46fc59ab0934389055f97b7be5b5a6da2824d (patch)
treea38fee9efa394b674986bbd031795eac37fc2120 /lib/lz4frame.h
parent348f5099e42c23393ec9c8e6b403f4bca99bbb41 (diff)
downloadlz4-05a46fc59ab0934389055f97b7be5b5a6da2824d.zip
lz4-05a46fc59ab0934389055f97b7be5b5a6da2824d.tar.gz
lz4-05a46fc59ab0934389055f97b7be5b5a6da2824d.tar.bz2
Changes LZ4F_compressBound() definition using NULL prefsPtr to cover worst case instead of default.
Diffstat (limited to 'lib/lz4frame.h')
-rw-r--r--lib/lz4frame.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h
index e5435cd..f22ef00 100644
--- a/lib/lz4frame.h
+++ b/lib/lz4frame.h
@@ -141,9 +141,9 @@ size_t LZ4F_compressBegin(LZ4F_compressionContext_t cctx, void* dstBuffer, size_
size_t LZ4F_compressBound(size_t srcSize, const LZ4F_preferences_t* prefsPtr);
/* LZ4F_compressBound() :
* Provides the minimum size of Dst buffer given srcSize to handle worst case situations.
- * prefsPtr is optional : you can provide NULL as argument, all preferences will then be set to default.
- * Note that different preferences will produce different results.
- * This function doesn't include frame termination cost (4 bytes, or 8 is frame checksum is enabled)
+ * Different preferences can produce different results.
+ * prefsPtr is optional : you can provide NULL as argument, all preferences will then be set to cover worst case.
+ * This function includes frame termination cost (4 bytes, or 8 is frame checksum is enabled)
*/
size_t LZ4F_compressUpdate(LZ4F_compressionContext_t cctx, void* dstBuffer, size_t dstMaxSize, const void* srcBuffer, size_t srcSize, const LZ4F_compressOptions_t* cOptPtr);