add timestamps to recent commits, javadocs for JSONObject, JSONArray queryFrom() methods

stleary · stleary · commit 4a458a9f1c39 · 2016-05-14T09:22:18.000-05:00
diff --git a/JSONArray.java b/JSONArray.java
@@ -78,7 +78,7 @@ of this software and associated documentation files (the "Software"), to deal
  * </ul>
  *
  * @author JSON.org
- * @version 2016-03-05
+ * @version 2016-05-13
  */
 public class JSONArray implements Iterable<Object> {
 
@@ -960,6 +960,25 @@ public JSONArray put(int index, Object value) throws JSONException {
         return this;
     }
     
+    /**
+     * Creates a JSONPointer using an intialization string and tries to 
+     * match it to an item within this JSONArray. For example, given a
+     * JSONArray initialized with this document:
+     * <pre>
+     * [
+     *     {"b":"c"}
+     * ]
+     * </pre>
+     * and this JSONPointer string: 
+     * <pre>
+     * "/0/b"
+     * </pre>
+     * Then this method will return the String "c"
+     * A JSONPointerException may be thrown from code called by this method.
+     *
+     * @param jsonPointer string that can be used to create a JSONPointer
+     * @return the item matched by the JSONPointer, otherwise null
+     */
     public Object query(String jsonPointer) {
         return new JSONPointer(jsonPointer).queryFrom(this);
     }
diff --git a/JSONObject.java b/JSONObject.java
@@ -93,7 +93,7 @@ of this software and associated documentation files (the "Software"), to deal
  * </ul>
  *
  * @author JSON.org
- * @version 2016-05-01
+ * @version 2016-05-13
  */
 public class JSONObject {
     /**
@@ -1337,7 +1337,26 @@ public JSONObject putOpt(String key, Object value) throws JSONException {
         }
         return this;
     }
-    
+
+    /**
+     * Creates a JSONPointer using an intialization string and tries to 
+     * match it to an item within this JSONObject. For example, given a
+     * JSONObject initialized with this document:
+     * <pre>
+     * {
+     *     "a":{"b":"c"}
+     * }
+     * </pre>
+     * and this JSONPointer string: 
+     * <pre>
+     * "/a/b"
+     * </pre>
+     * Then this method will return the String "c".
+     * A JSONPointerException may be thrown from code called by this method.
+     *   
+     * @param jsonPointer string that can be used to create a JSONPointer
+     * @return the item matched by the JSONPointer, otherwise null
+     */
     public Object query(String jsonPointer) {
         return new JSONPointer(jsonPointer).queryFrom(this);
     }
diff --git a/JSONPointer.java b/JSONPointer.java
@@ -35,7 +35,10 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * A JSON Pointer is a simple query language defined for JSON documents by
- * <a href="https://tools.ietf.org/html/rfc6901">RFC 6901</a>. 
+ * <a href="https://tools.ietf.org/html/rfc6901">RFC 6901</a>.
+ *  
+ * @author JSON.org
+ * @version 2016-05-13
  */
 public class JSONPointer {
     
diff --git a/JSONPointerException.java b/JSONPointerException.java
@@ -27,6 +27,9 @@ of this software and associated documentation files (the "Software"), to deal
 /**
  * The JSONPointerException is thrown by {@link JSONPointer} if an error occurs
  * during evaluating a pointer.
+ * 
+ * @author JSON.org
+ * @version 2016-05-13
  */
 public class JSONPointerException extends JSONException {
     private static final long serialVersionUID = 8872944667561856751L;
