Cleanup Java documentation warnings
authorGeorge Nash <george.nash@intel.com>
Mon, 23 Jan 2017 17:57:05 +0000 (09:57 -0800)
committerRick Bell <richard.s.bell@intel.com>
Tue, 24 Jan 2017 20:30:38 +0000 (20:30 +0000)
Cleanup the warings in OcCloudProvisioning and OcRepresentation

Change-Id: I4516b8fbd13b6a157291ce34080f985eb21bed4a
Signed-off-by: George Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/16705
Reviewed-by: Ossama Othman <ossama.othman@intel.com>
Tested-by: jenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: Rick Bell <richard.s.bell@intel.com>
java/common/src/main/java/org/iotivity/base/OcCloudProvisioning.java
java/common/src/main/java/org/iotivity/base/OcRepresentation.java

index fea2184..951eaf9 100755 (executable)
@@ -42,7 +42,7 @@ public class  OcCloudProvisioning {
    /**
     * API to construct the CloudProvisioning
     *
-    * @param ipAddr address of the cloud server
+    * @param ip address of the cloud server
     * @param port port of the cloud server
     */
     public OcCloudProvisioning(String ip, int port) {
index 24d8b88..bed9eb7 100644 (file)
@@ -191,6 +191,9 @@ public class OcRepresentation {
     private native void setValueByteArray(String key, byte[] value) throws OcException;
 
     /**
+     * Get Value
+     * @param key the key for the value
+     * @return the value as an integer
      * @deprecated use {@link #getValue(String key)} instead.
      */
     @Deprecated
@@ -206,6 +209,9 @@ public class OcRepresentation {
     }
 
     /**
+     * Get value
+     * @param key the key for the value
+     * @return the value as a boolean
      * @deprecated use {@link #getValue(String key)} instead.
      */
     @Deprecated
@@ -221,6 +227,9 @@ public class OcRepresentation {
     }
 
     /**
+     * Get value
+     * @param key the key for the value
+     * @return the value as a String
      * @deprecated use {@link #getValue(String key)} instead.
      */
     @Deprecated
@@ -236,6 +245,9 @@ public class OcRepresentation {
     }
 
     /**
+     * Set key/value pair
+     * @param key the value key
+     * @param value integer value
      * @deprecated use {@link #setValue(String key, int value)} instead.
      */
     @Deprecated
@@ -249,6 +261,9 @@ public class OcRepresentation {
     }
 
     /**
+     * Set key/value pair
+     * @param key the value key
+     * @param value boolean value
      * @deprecated use {@link #setValue(String key, boolean value)} instead.
      */
     @Deprecated
@@ -262,6 +277,9 @@ public class OcRepresentation {
     }
 
     /**
+     * Set key/value pair
+     * @param key the value key
+     * @param value String value
      * @deprecated use {@link #setValue(String key, String value)} instead.
      */
     @Deprecated