Merge pull request #206 from xuchuanyin/opt_output_doc

[DOC] Optimize SnappyOutputStream java doc
2018-01-23 01:30:17 -08:00 · 2018-01-23 01:30:17 -08:00 · aed3843f8e
parent 118aa3e6d2 0bdda0f23d
commit aed3843f8e
1 changed files with 1 additions and 0 deletions
--- a/src/main/java/org/xerial/snappy/SnappyOutputStream.java
+++ b/src/main/java/org/xerial/snappy/SnappyOutputStream.java
@ -41,6 +41,7 @@ import java.io.OutputStream;
 * The output data format is:
 * <ol>
 * <li>snappy codec header defined in {@link SnappyCodec} (8 bytes)
+ * <li>codec version (4 bytes integer, at least 1) and compatible version (4 bytes integer)
 * <li>compressed block 1 : a pair of (compressed data size [4 byte integer.
 * Big-endian], compressed data...)
 * <li>compressed block 2