#27 add javadoc

Author: wanglingsong

jsurfer-core/src/main/java/org/jsfr/json/JsonParserAdapter.java

@@ -65,6 +65,12 @@ public interface JsonParserAdapter {
      */
     ResumableParser createResumableParser(String json, SurfingContext context);
 
+    /**
+     * Create a NonBlockingParser
+     *
+     * @param context Surfing context
+     * @return NonBlockingParser
+     */
     NonBlockingParser createNonBlockingParser(SurfingContext context);
 
 }

jsurfer-core/src/main/java/org/jsfr/json/NonBlockingParser.java

@@ -1,12 +1,23 @@
 package org.jsfr.json;
 
 /**
- * Created by Leo on 2017/8/10.
+ * Interface for non-blocking parsing
  */
-public interface NonBlockingParser extends ResumableParser{
+public interface NonBlockingParser extends ResumableParser {
 
+    /**
+     * Feed data and start or resume parsing immediately
+     *
+     * @param bytes bytes to feed
+     * @param start start position
+     * @param end end position
+     * @return true if all feed data is successfully consumed
+     */
     boolean feed(byte[] bytes, int start, int end);
 
+    /**
+     * Called to notify parser the input ended
+     */
     void endOfInput();
 
 }

jsurfer-core/src/main/java/org/jsfr/json/ResumableParser.java

@@ -13,7 +13,7 @@ public interface ResumableParser {
     /**
      * Resume parsing. It should not be invoked before parse()!
      *
-     * @return true if parser is not stopped and in paused state before calling resume()
+     * @return true if parser was in paused state before invoking resume()
      */
     boolean resume();