From 0bdda0f23dea4848f9eeb5096949e35a2455b527 Mon Sep 17 00:00:00 2001
From: xuchuanyin <xuchuanyin@hust.edu.cn>
Date: Tue, 23 Jan 2018 15:23:18 +0800
Subject: [PATCH] Optimize SnappyOutputStream java doc

Add more information about output data format
---
 src/main/java/org/xerial/snappy/SnappyOutputStream.java | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/main/java/org/xerial/snappy/SnappyOutputStream.java b/src/main/java/org/xerial/snappy/SnappyOutputStream.java
index 4cfe771..da47bf1 100755
--- 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