Address JDoc errors and warnings (#59)

Author: sazzad16

src/main/java/com/redislabs/modules/rejson/JReJSON.java

@@ -190,6 +190,7 @@ public long clear(String key, Path path) {
 
     /**
      * Gets an object at the root path
+     * @param <T> type of data represented at {@code key}
      * @param key the key name
      * @return the requested object
      */
@@ -199,6 +200,7 @@ public <T> T get(String key) {
 
     /**
      * Gets an object
+     * @param <T> type of data represented at {@code key}
      * @param key the key name
      * @param paths optional one ore more paths in the object
      * @return the requested object
@@ -212,8 +214,9 @@ public <T> T get(String key, Path... paths) {
 
     /**
      * Gets an object
+     * @param <T> type of data represented at {@code key}
      * @param key the key name
-     * @param clazz
+     * @param clazz Class representing {@code T}
      * @param paths optional one ore more paths in the object
      * @return the requested object
      */
@@ -528,8 +531,6 @@ private Jedis getConnection() {
      *
      * Returns the string's new size.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonstrappend}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @param objects objects One or more elements to be added to the array
@@ -554,8 +555,6 @@ public Long strAppend(String key, Path path, Object... objects) {
      * Report the length of the JSON String at path in key.
      * Path defaults to root if not provided.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonstrlen}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @return the size of string at path. If the key or path do not exist, null is returned.
@@ -576,8 +575,6 @@ public Long strLen(String key, Path path) {
      *
      * Returns the array's new size.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrappend}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @param objects one or more elements to be added to the array
@@ -605,8 +602,6 @@ public Long arrAppend(String key, Path path, Object... objects) {
      * If the item is not found, it returns -1. If called on a key path that is not
      * an array, it throws an error.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrindex}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @param scalar the JSON scalar to search for
@@ -631,8 +626,6 @@ public Long arrIndex(String key, Path path, Object scalar) {
      *
      * Returns the array's new size.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrinsert}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @param index position in the array to insert the value(s)
@@ -660,8 +653,6 @@ public Long arrInsert(String key, Path path, Long index, Object... objects) {
      *
      * If called on a key path that is not an array, it will throw an error.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrlen}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @return the size of array at path
@@ -684,8 +675,6 @@ public Long arrLen(String key, Path path) {
      * popping from (defaults to -1, meaning the last element). Out of range indices are
      * rounded to their respective array ends. Popping an empty array yields null.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrpop}</a>.
-     *
      * @param key the key of the value
      * @param clazz target class to serialize results
      * @param path the path of the value
@@ -714,8 +703,6 @@ public <T> T arrPop(String key, Class<T> clazz, Path path, Long index) {
      * popping from (defaults to -1, meaning the last element). Out of range indices are
      * rounded to their respective array ends. Popping an empty array yields null.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrpop}</a>.
-     *
      * @param key the key of the value
      * @param clazz target class to serialize results
      * @param path the path of the value
@@ -732,8 +719,6 @@ public <T> T arrPop(String key, Class<T> clazz, Path path) {
      * popping from (defaults to -1, meaning the last element). Out of range indices are
      * rounded to their respective array ends. Popping an empty array yields null.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrpop}</a>.
-     *
      * @param key the key of the value
      * @param clazz target class to serialize results
      * @return the popped JSON value.
@@ -750,8 +735,6 @@ public <T> T arrPop(String key, Class<T> clazz) {
      * will be an empty array. If start is < 0 then it will be treated as 0. If stop is larger
      * than the end of the array, it will be treated like the last element in it.
      *
-     * See <a href="#{@link}">{@link https://oss.redislabs.com/redisjson/commands/#jsonarrtrim}</a>.
-     *
      * @param key the key of the value
      * @param path the path of the value
      * @param start the start of the range

src/main/java/com/redislabs/modules/rejson/Path.java

@@ -56,12 +56,6 @@ public String toString() {
         return strPath;
     }
 
-    /**
-     * Static factory method
-     * 
-     * @param strPath
-     * @return
-     */
     public static Path of(final String strPath) {
         return new Path(strPath);
     }