Fixed comment styles, added note about JSON path limitations

Author: Cody Ebberson

src/main/java/com/box/sdk/BoxFile.java

@@ -402,8 +402,8 @@ public Metadata createMetadata(Metadata metadata) {
 
     /**
      * Creates the metadata of specified type.
-     * @param typeName The metadata type name.
-     * @param metadata The new metadata values.
+     * @param typeName the metadata type name.
+     * @param metadata the new metadata values.
      * @return the metadata returned from the server.
      */
     public Metadata createMetadata(String typeName, Metadata metadata) {
@@ -425,7 +425,7 @@ public Metadata getMetadata() {
 
     /**
      * Gets the file metadata of specified type.
-     * @param typeName The metadata type name.
+     * @param typeName the metadata type name.
      * @return the metadata returned from the server.
      */
     public Metadata getMetadata(String typeName) {
@@ -437,7 +437,7 @@ public Metadata getMetadata(String typeName) {
 
     /**
      * Updates the file metadata.
-     * @param metadata The new metadata values.
+     * @param metadata the new metadata values.
      * @return the metadata returned from the server.
      */
     public Metadata updateMetadata(Metadata metadata) {
@@ -458,7 +458,7 @@ public void deleteMetadata() {
 
     /**
      * Deletes the file metadata of specified type.
-     * @param typeName The metadata type name.
+     * @param typeName the metadata type name.
      */
     public void deleteMetadata(String typeName) {
         URL url = METADATA_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID(), typeName);

src/main/java/com/box/sdk/Metadata.java

@@ -22,15 +22,15 @@ public Metadata() {
 
     /**
      * Creates a new metadata.
-     * @param values The initial metadata values.
+     * @param values the initial metadata values.
      */
-    public Metadata(JsonObject values) {
+    Metadata(JsonObject values) {
         this.values = values;
     }
 
     /**
      * Creates a copy of another metadata.
-     * @param other The other metadata object to copy.
+     * @param other the other metadata object to copy.
      */
     public Metadata(Metadata other) {
         this.values = new JsonObject(other.values);
@@ -62,8 +62,8 @@ public String getParentID() {
 
     /**
      * Adds a new metdata value.
-     * @param path The path that designates the key. Must be prefixed with a "/".
-     * @param value The value.
+     * @param path the path that designates the key. Must be prefixed with a "/".
+     * @param value the value.
      * @return this metadata object.
      */
     public Metadata add(String path, String value) {
@@ -74,8 +74,8 @@ public Metadata add(String path, String value) {
 
     /**
      * Replaces an existing metdata value.
-     * @param path The path that designates the key. Must be prefixed with a "/".
-     * @param value The value.
+     * @param path the path that designates the key. Must be prefixed with a "/".
+     * @param value the value.
      * @return this metadata object.
      */
     public Metadata replace(String path, String value) {
@@ -86,7 +86,7 @@ public Metadata replace(String path, String value) {
 
     /**
      * Removes an existing metadata value.
-     * @param path The path that designates the key. Must be prefixed with a "/".
+     * @param path the path that designates the key. Must be prefixed with a "/".
      * @return this metadata object.
      */
     public Metadata remove(String path) {
@@ -97,8 +97,8 @@ public Metadata remove(String path) {
 
     /**
      * Tests that a property has the expected value.
-     * @param path The path that designates the key. Must be prefixed with a "/".
-     * @param value The expected value.
+     * @param path the path that designates the key. Must be prefixed with a "/".
+     * @param value the expected value.
      * @return this metadata object.
      */
     public Metadata test(String path, String value) {
@@ -108,8 +108,8 @@ public Metadata test(String path, String value) {
 
     /**
      * Returns a value.
-     * @param key The metadata property name.
-     * @return The metadata property value.
+     * @param key the metadata property name.
+     * @return the metadata property value.
      */
     public String get(String key) {
         return this.values.get(key).asString();
@@ -137,18 +137,19 @@ public String toString() {
 
     /**
      * Converts a JSON patch path to a JSON property name.
-     * @param path The path that designates the key.  Must be prefixed with a "/".
-     * @return The JSON property name.
+     * Currently the metadata API only supports flat maps.
+     * @param path the path that designates the key.  Must be prefixed with a "/".
+     * @return the JSON property name.
      */
     private String pathToProperty(String path) {
         return path.substring(1);
     }
 
     /**
      * Adds a patch operation.
-     * @param op The operation type. Must be add, replace, remove, or test.
-     * @param path The path that designates the key. Must be prefixed with a "/".
-     * @param value The value to be set.
+     * @param op the operation type. Must be add, replace, remove, or test.
+     * @param path the path that designates the key. Must be prefixed with a "/".
+     * @param value the value to be set.
      */
     private void addOp(String op, String path, String value) {
         if (this.operations == null) {