Updated java doc comments for services : TM and RE layer

- updated comments for bundle-java-api of Resurce Container module
- updated comments of Things Manager.

Change-Id: I39970e0cce8920488ac034d3b110421dce2fc0de
Signed-off-by: Jay Sharma <jay.sharma@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/2923
Reviewed-by: Abhishek Pandey <abhi.siso@samsung.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Madan Lanka <lanka.madan@samsung.com>
(cherry picked from commit ee0ccf1a7f9210b40030bb6a5ed26d73dbe8d8d3)
Reviewed-on: https://gerrit.iotivity.org/gerrit/2937

diff --git a/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/BundleResource.java b/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/BundleResource.java
index 68bab81..411a428 100644 (file)
--- a/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/BundleResource.java
+++ b/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/BundleResource.java
@@ -73,7 +73,7 @@ public abstract class BundleResource {
 
     /**
      * Returns the URI of the resource
-     * @return
+     * @return Resource URI
      */
     public String getURI() {
         return m_uri;
@@ -97,7 +97,7 @@ public abstract class BundleResource {
 
     /**
      * Sets the technology specific address information (e.g., ZigBee short or long identifier)    
-     * @param address
+     * @param address Resource address
      */
     public void setAddress(String address) {
         this.m_address = address;
@@ -105,7 +105,7 @@ public abstract class BundleResource {
 
     /**
      * Returns the technology specific address information
-     * @return
+     * @return Resource address
      */
     public String getAddress() {
         return m_address;
@@ -113,7 +113,7 @@ public abstract class BundleResource {
 
     /**
      * Sets the name property of the resource
-     * @param name
+     * @param name Resource name
      */
     public void setName(String name) {
         this.m_name = name;
@@ -121,7 +121,7 @@ public abstract class BundleResource {
 
     /**
      * Returns the name property of the resource
-     * @return
+     * @return Resource name
      */
     public String getName() {
         return m_name;

diff --git a/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/ResourceConfig.java b/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/ResourceConfig.java
index cf35f4e..fdcc17f 100644 (file)
--- a/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/ResourceConfig.java
+++ b/service/resource-encapsulation/src/resourceContainer/bundle-java-api/src/main/java/org/iotivity/resourcecontainer/bundle/api/ResourceConfig.java
@@ -55,7 +55,7 @@ public class ResourceConfig {
 
     /**
      * Sets the name
-     * @param m_name
+     * @param m_name Resource name
      */
     public void setName(String m_name) {
         this.m_name = m_name;
@@ -79,7 +79,7 @@ public class ResourceConfig {
 
     /**
      * Returns the configured resource type
-     * @param m_uri configured resource type
+     * @return configured resource type
      */
     public String getResourceType() {
         return m_resourceType;

diff --git a/service/things-manager/sdk/java/src/org/iotivity/service/tm/GroupManager.java b/service/things-manager/sdk/java/src/org/iotivity/service/tm/GroupManager.java
index 14e487c..9ca73d5 100644 (file)
--- a/service/things-manager/sdk/java/src/org/iotivity/service/tm/GroupManager.java
+++ b/service/things-manager/sdk/java/src/org/iotivity/service/tm/GroupManager.java
@@ -257,6 +257,8 @@ public class GroupManager {
      *
      * @return OCStackResult - return value of this API. It returns OC_STACK_OK
      *         if success.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult subscribeCollectionPresence(OcResource resource)
             throws OcException {
@@ -283,6 +285,8 @@ public class GroupManager {
      *            collection resource handle. It will be added child resource.
      *
      * @return OcResourceHandle - Child resource handle.
+     *
+     * @throws OcException {@link OcException}
      */
     public OcResourceHandle bindResourceToGroup(OcResource resource,
             OcResourceHandle collectionHandle) throws OcException {
@@ -305,6 +309,8 @@ public class GroupManager {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult addActionSet(OcResource resource, ActionSet actionSet)
             throws OcException {
@@ -333,6 +339,8 @@ public class GroupManager {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult executeActionSet(OcResource resource,
             String actionsetName) throws OcException {
@@ -364,6 +372,8 @@ public class GroupManager {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult executeActionSet(OcResource resource,
             String actionsetName, long delay) throws OcException {
@@ -396,6 +406,8 @@ public class GroupManager {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
 
     public OCStackResult cancelActionSet(OcResource resource,
@@ -428,6 +440,8 @@ public class GroupManager {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult getActionSet(OcResource resource, String actionsetName)
             throws OcException {
@@ -459,6 +473,8 @@ public class GroupManager {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult deleteActionSet(OcResource resource,
             String actionsetName) throws OcException {

diff --git a/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsConfiguration.java b/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsConfiguration.java
index deddcb5..7e91bd0 100644 (file)
--- a/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsConfiguration.java
+++ b/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsConfiguration.java
@@ -172,6 +172,8 @@ public class ThingsConfiguration {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult updateConfigurations(OcResource resource,
             Map<String, String> configurations) throws OcException {
@@ -199,6 +201,8 @@ public class ThingsConfiguration {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult getConfigurations(OcResource resource,
             Vector<String> configurations) throws OcException {

diff --git a/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsMaintenance.java b/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsMaintenance.java
index dc948a0..e4b45f3 100644 (file)
--- a/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsMaintenance.java
+++ b/service/things-manager/sdk/java/src/org/iotivity/service/tm/ThingsMaintenance.java
@@ -129,6 +129,8 @@ public class ThingsMaintenance {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult reboot(OcResource resource) throws OcException {
 
@@ -158,6 +160,8 @@ public class ThingsMaintenance {
      *
      * @return OCStackResult - OC_STACK_OK on success, otherwise a failure error
      *         code.
+     *
+     * @throws OcException {@link OcException}
      */
     public OCStackResult factoryReset(OcResource resource) throws OcException {