Add javadoc

wanglingsong · Aug 11, 2017 · 26b3808 · 26b3808
1 parent ca67375
commit 26b3808
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/jsurfer-core/src/main/java/org/jsfr/json/JsonSurfer.java b/jsurfer-core/src/main/java/org/jsfr/json/JsonSurfer.java
@@ -150,6 +150,8 @@ public void onValue(Object value, ParsingContext context) {
     }
 
     /**
+     * Start surfing
+     *
      * @param json          json
      * @param configuration SurfingConfiguration that holds JsonPath binding
      */
@@ -159,6 +161,8 @@ public void surf(String json, SurfingConfiguration configuration) {
     }
 
     /**
+     * Start surfing
+     *
      * @param json          Json source
      * @param configuration SurfingConfiguration that holds JsonPath binding
      */
@@ -167,16 +171,36 @@ public void surf(Reader json, SurfingConfiguration configuration) {
         jsonParserAdapter.parse(json, new SurfingContext(configuration));
     }
 
+    /**
+     * Create resumable parser
+     *
+     * @param json          Json source
+     * @param configuration SurfingConfiguration
+     * @return Resumable parser
+     */
     public ResumableParser createResumableParser(String json, SurfingConfiguration configuration) {
         ensureSetting(configuration);
         return jsonParserAdapter.createResumableParser(json, new SurfingContext(configuration));
     }
 
+    /**
+     * Create resumable parser
+     *
+     * @param json          Json source
+     * @param configuration SurfingConfiguration
+     * @return Resumable parser
+     */
     public ResumableParser createResumableParser(Reader json, SurfingConfiguration configuration) {
         ensureSetting(configuration);
         return jsonParserAdapter.createResumableParser(json, new SurfingContext(configuration));
     }
 
+    /**
+     * Create non-blocking parser
+     *
+     * @param configuration
+     * @return
+     */
     public NonBlockingParser createNonBlockingParser(SurfingConfiguration configuration) {
         ensureSetting(configuration);
         return jsonParserAdapter.createNonBlockingParser(new SurfingContext(configuration));

diff --git a/jsurfer-core/src/main/java/org/jsfr/json/ResumableParser.java b/jsurfer-core/src/main/java/org/jsfr/json/ResumableParser.java
@@ -1,7 +1,7 @@
 package org.jsfr.json;
 
 /**
- * Resumable Parser
+ * A parser can be paused and resumed
  */
 public interface ResumableParser {