search

lz4 / lz4-java

LZ4 compression for Java
Apache License 2.0
1.1k stars 253 forks source link

Correct conflicting Javadoc in LZ4SafeDecompressor #158

Closed MariusVolkhart closed 4 years ago

MariusVolkhart commented 4 years ago

The existing Javadoc summary conflicts with the extended explanation

odaira commented 4 years ago

LZ4SafeDecompressor does require the size of the compressed data to be known, doesn't it...? What would you mean by "the extended explanation"?

MariusVolkhart commented 4 years ago

Following the <p> tag, the Javadoc goes on to say

Implementations of this class are usually a little slower than those of {@link LZ4FastDecompressor} but do not require the size of the original data to be known

odaira commented 4 years ago

"the size of the original data " is the size before the compression. "the size of the compressed data " is the size after the compression. If these descriptions are confusing, they should be improved.