Documentation

Author: xDestx

JSONJavaWrapper/src/com/xdestx/json/JArray.java

@@ -1,13 +1,22 @@
 package com.xdestx.json;
 
+/**
+ * A wrapper class for an Array of {@link com.xdest.json.JOk JOk} objects.
+ * @author xDestx
+ *
+ */
 class JArray implements JOk {
 
     private final JOk[] jarr;
-
+    /**
+     * Construct an Object with the specified array
+     * @param jarr
+     */
     public JArray(JOk[] jarr) {
         this.jarr = jarr;
     }
 
+    
     public String toJSONString() {
         String jsonString = "";
         jsonString+='[';
@@ -19,6 +28,10 @@ public String toJSONString() {
         return jsonString;
     }
 
+    /**
+     * Retrieve the array stored by this obejct
+     * @return
+     */
     public JOk[] getArray() {
         return this.jarr;
     }

JSONJavaWrapper/src/com/xdestx/json/JBoolean.java

@@ -1,8 +1,17 @@
 package com.xdestx.json;
 
+/**
+ * A boolean wrapper class.
+ * @author xDestx
+ *
+ */
 public class JBoolean implements JOk {
 
     private final boolean b;
+    /**
+     * Construct a boolean object
+     * @param b
+     */
     public JBoolean(boolean b) {
         this.b = b;
     }
@@ -11,6 +20,10 @@ public String toJSONString() {
         return ""+this.b;
     }
 
+    /**
+     * Get the boolean value of this object
+     * @return
+     */
     public boolean getValue() {
         return this.b;
     }

JSONJavaWrapper/src/com/xdestx/json/JNumber.java

@@ -1,37 +1,71 @@
 package com.xdestx.json;
 
+/**
+ * A Number wrapper. All numbers are converted to a double.
+ * @author xDestx
+ *
+ */
 public class JNumber implements JOk {
 
     private final double d;
 
+    /**
+     * Construct a number using a double
+     * @param d the number
+     */
     public JNumber(double d) {
         this.d = d;
     }
 
+    /**
+     * Construct a number using {@link java.lang.Number}
+     * @param n
+     */
     public JNumber(Number n) {
         this.d = n.doubleValue();
     }
 
+    /**
+     * Construct a number using an int
+     * @param n
+     */
     public JNumber(int n) {
         this.d = (double)n;
     }
 
+    /**
+     * Construct a number using a float
+     * @param n
+     */
     public JNumber(float n) {
         this.d = (double)n;
     }
 
+    /**
+     * Constructa number using a short
+     * @param n
+     */
     public JNumber(short n) {
         this.d = (double)n;
     }
 
+    /**
+     * Construct a number using a long (Converted to a double, use caution)
+     * @param n
+     */
     public JNumber(long n) {
         this.d = (double)n;
     }
 
+    
     public String toJSONString() {
         return ""+d;
     }
 
+    /**
+     * Retrieve the value of this number
+     * @return the double value
+     */
     public double getValue() {
         return this.d;
     }

JSONJavaWrapper/src/com/xdestx/json/JOk.java

@@ -1,5 +1,13 @@
 package com.xdestx.json;
-
+/**
+ * An interface representing an object which is compatible with JSONObjects
+ * @author xDest
+ *
+ */
 public interface JOk {
+	/**
+	 * The String representation of this component or object.
+	 * @return A JSON formatted string represeting this object
+	 */
     public String toJSONString();
 }