From bc3e6ae1f445e1776141cd982840655ae6771348 Mon Sep 17 00:00:00 2001 From: George Nash Date: Fri, 13 Jan 2017 15:52:01 -0800 Subject: [PATCH] Cleanup documentation warnings in the resourcecontainer java code Change-Id: Ia19f5d6470b6ea8ef8018bd40dc5edf13808e56b Signed-off-by: George Nash Reviewed-on: https://gerrit.iotivity.org/gerrit/16407 Tested-by: jenkins-iotivity Reviewed-by: Rick Bell --- .../iotivity/service/resourcecontainer/BundleResource.java | 2 ++ .../service/resourcecontainer/RcsResourceAttributes.java | 1 + .../service/resourcecontainer/RcsResourceContainer.java | 2 +- .../java/org/iotivity/service/resourcecontainer/RcsValue.java | 11 ++++++++++- 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/BundleResource.java b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/BundleResource.java index 93304f7..551bd35 100644 --- a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/BundleResource.java +++ b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/BundleResource.java @@ -135,6 +135,8 @@ public abstract class BundleResource { /** * Retrieve the attribute (map to read command) + * + * @return RcsResourceAttributes containing the attributes */ public abstract RcsResourceAttributes handleGetAttributesRequest(); diff --git a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceAttributes.java b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceAttributes.java index f8ae251..a2f8b2c 100644 --- a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceAttributes.java +++ b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceAttributes.java @@ -193,6 +193,7 @@ public final class RcsResourceAttributes /** * Updates all properties provided as parameter. + * @param attrs the attributes to update */ public void put(RcsResourceAttributes attrs){ for (final String key : attrs.keySet()) { diff --git a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceContainer.java b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceContainer.java index 0564904..73d61a1 100644 --- a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceContainer.java +++ b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsResourceContainer.java @@ -119,7 +119,7 @@ public class RcsResourceContainer implements RcsResourceContainerBundleAPI { * @param configFile * configuration File that contains the Bundle/Bundles * information. - * + * @return collection of container bundles */ public List startContainer(String configFile) { if(configFile == null || configFile.isEmpty()){ diff --git a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsValue.java b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsValue.java index f21ccc9..d411257 100644 --- a/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsValue.java +++ b/service/resource-container/android/resource-container/src/main/java/org/iotivity/service/resourcecontainer/RcsValue.java @@ -88,6 +88,8 @@ public final class RcsValue { * * For non sequence types, it is equivalent to calling {@link #getId()}. * + * @param t the type identifier to get a base type of + * * @return identifier of type * * @see getDepth @@ -100,7 +102,9 @@ public final class RcsValue { /** * Returns the depth of a type. * - * The return will be zero for non sequence types. + * @param t type to find the depth of + * + * @return the depth of a type. Will be zero for non sequence types. * * @see getBaseTypeId */ @@ -112,6 +116,8 @@ public final class RcsValue { * Factory method to create Type instance from an object. * Note that object must be a supported type by RcsValue. * + * @param obj object to create a type instance from + * * @return An instance that has TypeId for obj. * * @throws NullPointerException @@ -132,6 +138,8 @@ public final class RcsValue { * Factory method to create Type instance from a class. * Note that class must be a supported type by RcsValue. * + * @param cls class to create Type instance from + * * @return An instance that has TypeId for class. * * @throws NullPointerException @@ -541,6 +549,7 @@ public final class RcsValue { /** * Returns the value as T. * + * @param the return type * @return a value as T * * @throws ClassCastException -- 2.7.4