summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2014-08-26 12:48:13 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2014-08-26 12:48:13 (GMT)
commit18392cd5e186ae2d3420130dc0f5451b4d916e3e (patch)
tree78a59746964eb45920f843eaa2e8d47724b28bdf
parentef7cbfd76275ed4cce8d2df3c2e658228e89da2e (diff)
downloadlz4-18392cd5e186ae2d3420130dc0f5451b4d916e3e.zip
lz4-18392cd5e186ae2d3420130dc0f5451b4d916e3e.tar.gz
lz4-18392cd5e186ae2d3420130dc0f5451b4d916e3e.tar.bz2
minor comment clarification about LZ4_compressBound()
-rw-r--r--lz4.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/lz4.h b/lz4.h
index c81c982..377e075 100644
--- a/lz4.h
+++ b/lz4.h
@@ -97,9 +97,9 @@ LZ4_decompress_safe() :
/*
LZ4_compressBound() :
- Provides the maximum size that LZ4 may output in a "worst case" scenario (input data not compressible)
- primarily useful for memory allocation of output buffer.
- macro is also provided when result needs to be evaluated at compilation (such as stack memory allocation).
+ Provides the maximum size that LZ4 compression may output in a "worst case" scenario (input data not compressible)
+ This function is primarily useful for memory allocation purposes (output buffer size).
+ Macro LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation (stack memory allocation for example).
isize : is the input size. Max supported value is LZ4_MAX_INPUT_SIZE
return : maximum output size in a "worst case" scenario