add missing jsdoc

Author: UrielCh

json-smart/src/main/java/net/minidev/json/JSONAware.java

@@ -22,6 +22,8 @@
  */
 public interface JSONAware {
   /**
+   * Converts this object to JSON string representation.
+   *
    * @return JSON text
    */
   String toJSONString();

json-smart/src/main/java/net/minidev/json/JSONAwareEx.java

@@ -24,6 +24,9 @@
  */
 public interface JSONAwareEx extends JSONAware {
   /**
+   * Converts this object to JSON string representation with specified compression style.
+   *
+   * @param compression the JSON style for formatting
    * @return JSON text
    */
   String toJSONString(JSONStyle compression);

json-smart/src/main/java/net/minidev/json/JSONNavi.java

@@ -24,6 +24,7 @@
 /**
  * A JQuery like Json editor, accessor.
  *
+ * @param <T> the type of the root object
  * @since 1.0.9
  * @author Uriel Chemouni &lt;[email protected]&gt;
  */

json-smart/src/main/java/net/minidev/json/JSONStreamAware.java

@@ -23,6 +23,11 @@
  * @author FangYidong <[email protected]>
  */
 public interface JSONStreamAware {
-  /** write JSON string to out. */
+  /**
+   * write JSON string to out.
+   *
+   * @param out the output to write to
+   * @throws IOException if I/O error occurs
+   */
   void writeJSONString(Appendable out) throws IOException;
 }

json-smart/src/main/java/net/minidev/json/JSONStreamAwareEx.java

@@ -23,6 +23,12 @@
  * @author FangYidong <[email protected]>
  */
 public interface JSONStreamAwareEx extends JSONStreamAware {
-  /** write JSON string to out. */
+  /**
+   * write JSON string to out.
+   *
+   * @param out the output to write to
+   * @param compression the JSON style for formatting
+   * @throws IOException if I/O error occurs
+   */
   void writeJSONString(Appendable out, JSONStyle compression) throws IOException;
 }

json-smart/src/main/java/net/minidev/json/writer/DefaultMapper.java

@@ -22,8 +22,8 @@
 /**
  * Simple Reader Class for generic Map
  *
+ * @param <T> the type of object to map
  * @author uriel
- * @param <T>
  */
 public class DefaultMapper<T> extends JsonReaderI<T> {
   protected DefaultMapper(JsonReader base) {

json-smart/src/main/java/net/minidev/json/writer/JsonReaderI.java

@@ -43,6 +43,9 @@ public JsonReaderI(JsonReader base) {
    * called when json-smart parser meet an object key
    *
    * @param key key name
+   * @return a JsonReaderI to handle the object parsing
+   * @throws ParseException if parsing fails
+   * @throws IOException if I/O error occurs
    */
   public JsonReaderI<?> startObject(String key) throws ParseException, IOException {
     throw new RuntimeException(
@@ -53,41 +56,78 @@ public JsonReaderI<?> startObject(String key) throws ParseException, IOException
    * called when json-smart parser start an array.
    *
    * @param key the destination key name, or null.
+   * @return a JsonReaderI to handle the array parsing
+   * @throws ParseException if parsing fails
+   * @throws IOException if I/O error occurs
    */
   public JsonReaderI<?> startArray(String key) throws ParseException, IOException {
     throw new RuntimeException(ERR_MSG + " startArray in " + this.getClass() + " key=" + key);
   }
 
-  /** called when json-smart done parsing a value */
+  /**
+   * called when json-smart done parsing a value
+   *
+   * @param current the current object being built
+   * @param key the key for the value
+   * @param value the parsed value
+   * @throws ParseException if parsing fails
+   * @throws IOException if I/O error occurs
+   */
   public void setValue(Object current, String key, Object value)
       throws ParseException, IOException {
     throw new RuntimeException(ERR_MSG + " setValue in " + this.getClass() + " key=" + key);
   }
 
-  /** ------------- */
+  /**
+   * Gets a value from the current object
+   *
+   * @param current the current object
+   * @param key the key to get the value for
+   * @return the value associated with the key
+   */
   public Object getValue(Object current, String key) {
     throw new RuntimeException(
         ERR_MSG + " getValue(Object current, String key) in " + this.getClass() + " key=" + key);
   }
 
-  // Object current,
+  /**
+   * Gets the type for the specified key
+   *
+   * @param key the key to get the type for
+   * @return the Type associated with the key
+   */
   public Type getType(String key) {
     throw new RuntimeException(
         ERR_MSG + " getType(String key) in " + this.getClass() + " key=" + key);
   }
 
-  /** add a value in an array json object. */
+  /**
+   * add a value in an array json object.
+   *
+   * @param current the current array object
+   * @param value the value to add
+   * @throws ParseException if parsing fails
+   * @throws IOException if I/O error occurs
+   */
   public void addValue(Object current, Object value) throws ParseException, IOException {
     throw new RuntimeException(
         ERR_MSG + " addValue(Object current, Object value) in " + this.getClass());
   }
 
-  /** use to instantiate a new object that will be used as an object */
+  /**
+   * use to instantiate a new object that will be used as an object
+   *
+   * @return a new object instance
+   */
   public Object createObject() {
     throw new RuntimeException(ERR_MSG + " createObject() in " + this.getClass());
   }
 
-  /** use to instantiate a new object that will be used as an array */
+  /**
+   * use to instantiate a new object that will be used as an array
+   *
+   * @return a new array instance
+   */
   public Object createArray() {
     throw new RuntimeException(ERR_MSG + " createArray() in " + this.getClass());
   }
@@ -96,6 +136,9 @@ public Object createArray() {
    * Allow a mapper to convert a temporary structure to the final data format.
    *
    * <p>example: convert an List&lt;Integer&gt; to an int[]
+   *
+   * @param current the current object to convert
+   * @return the converted object
    */
   @SuppressWarnings("unchecked")
   public T convert(Object current) {

json-smart/src/main/java/net/minidev/json/writer/MapperRemapped.java

@@ -9,8 +9,8 @@
 /**
  * Simple solution to support on read field renaming
  *
+ * @param <T> the type of object to map
  * @author uriel
- * @param <T>
  */
 public class MapperRemapped<T> extends JsonReaderI<T> {
   private Map<String, String> rename;