Cleanup documentation warnings in RcsLockedAttributes.java
authorGeorge Nash <george.nash@intel.com>
Tue, 10 Jan 2017 18:36:56 +0000 (10:36 -0800)
committerRick Bell <richard.s.bell@intel.com>
Tue, 10 Jan 2017 22:31:51 +0000 (22:31 +0000)
Change-Id: If4d37ace9f61cbdd681ecb050d62e093f1759128
Signed-off-by: George Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/16283
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Larry Sachs <larry.j.sachs@intel.com>
Reviewed-by: Rick Bell <richard.s.bell@intel.com>
service/resource-encapsulation/android/service/src/main/java/org/iotivity/service/server/RcsLockedAttributes.java

index 67651ce..9be3915 100644 (file)
@@ -144,6 +144,7 @@ public final class RcsLockedAttributes extends RcsObject {
      * @param attributes
      *            attributes to be copied
      *
+     * @return the RcsLockedAttributes
      * @throws RcsUnlockedException
      *             if the {@link RcsResourceObject.AttributesLock} for this
      *             object is unlocked
@@ -172,12 +173,12 @@ public final class RcsLockedAttributes extends RcsObject {
      * @param value
      *            value to be associated with the specified key
      *
+     * @return the RcsLockedAttributes
      * @throws NullPointerException
      *             if key or value is null
      * @throws RcsUnlockedException
      *             if the {@link RcsResourceObject.AttributesLock} for this
      *             object is unlocked
-     *
      */
     public RcsLockedAttributes put(String key, RcsValue value)
             throws RcsException {
@@ -219,6 +220,8 @@ public final class RcsLockedAttributes extends RcsObject {
     /**
      * Returns whether attribute is empty.
      *
+     * @return true if attribute is empty.
+     *
      * @throws RcsUnlockedException
      *             if the {@link RcsResourceObject.AttributesLock} for this
      *             object is unlocked
@@ -230,8 +233,9 @@ public final class RcsLockedAttributes extends RcsObject {
     }
 
     /**
-     * Returns the number of key-value mappings.
+     * Get the number of key-value mappings.
      *
+     * @return the number of key-value mappings
      * @throws RcsUnlockedException
      *             if the {@link RcsResourceObject.AttributesLock} for this
      *             object is unlocked