[SSM] Fix Java api comments

Fix Java api comments

Change-Id: I0931eca3e4d3cab1861f3add814a2e9395653d2a
Signed-off-by: jk13 <jihyeok13.kim@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/601
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Uze Choi <uzchoi@samsung.com>

diff --git a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/CoreController.java b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/CoreController.java
index f775be7..f25c206 100644 (file)
--- a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/CoreController.java
+++ b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/CoreController.java
@@ -65,7 +65,13 @@ public class CoreController
         }
 
         static private CoreController coreController;
-
+        
+        /**
+         * Return instance of this class.
+         *
+         * @return CoreController - instance of this class
+         * 
+         */
         public static CoreController getInstance()
         {
             if (coreController == null)
@@ -156,7 +162,7 @@ public class CoreController
          *               of the query engine with which the query is to be registered
          *
          * @param queryEngineEvent 
-         *               - the event to register with QueryEngine
+         *               - the event class to receive QueryEngine events
          *
          * @return void
          * 
@@ -166,7 +172,7 @@ public class CoreController
 
 
         /**
-         * Kill the registered ContextQuery corresponding to the  to cqid
+         * Kill the registered ContextQuery corresponding to the cqid
          *
          * @param pQueryEngineInstance 
          *              - instance(created on creation of the QueryEngine)
@@ -203,7 +209,7 @@ public class CoreController
          *           property is described from its specification.
          *
          * @param pIModelDataInstance - instance(created on creation of the ModelData)
-         *                of the model data for which propertycount is to be returned
+         *                of the model data for which property count is to be returned
          *
          * @return @return int - number of properties
          * 
@@ -246,7 +252,7 @@ public class CoreController
         /**
          * Get affected context models. The CQL(context query language) can specify
          *       multiple ContextModels for retrieving data so a list of string of affected
-         *       dacontext models is returned
+         *       context models is returned
          *
          * @param pDataReaderInstance 
          *              - instance(created on creation of the DataReader)

diff --git a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/DataReader.java b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/DataReader.java
index 8f99a45..eef8d3a 100644 (file)
--- a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/DataReader.java
+++ b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/DataReader.java
@@ -47,7 +47,7 @@ public class DataReader
         /**
          * Get affected context models. The CQL(context query language) can specify
          *       multiple ContextModels for retrieving data so a list of string of affected
-         *       dacontext models is returned
+         *       context models is returned
          *
          * @return List<String> - affected ContextModel list
          * 

diff --git a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IQueryEngineEvent.java b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IQueryEngineEvent.java
index c379ca0..7244e03 100644 (file)
--- a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IQueryEngineEvent.java
+++ b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IQueryEngineEvent.java
@@ -33,7 +33,7 @@ package org.iotivity.service.ssm;
     *            Application should implement the pure virtual function OnQueryEngineEvent.
     *            The Application should call registerQuery() and add a listener.
     *
-    *
+    *<pre>
     Sample code :
 
         int cqid = SoftSensorManager.registerQuery(edtQuery.getText().toString(), mQueryEngineEventListener);
@@ -60,7 +60,7 @@ package org.iotivity.service.ssm;
                     }
                 }
         }
-        };
+        };</pre>
     */
 public abstract class IQueryEngineEvent
 {

diff --git a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IReportReceiver.java b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IReportReceiver.java
index 7d41e28..f16a7d1 100644 (file)
--- a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IReportReceiver.java
+++ b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/IReportReceiver.java
@@ -40,7 +40,7 @@ public abstract class IReportReceiver
          *       This abstract method needs to be implemeted by application
          *        as a precondition for query engine implementation.
          *
-         * @param tag
+         * @param tag - tag from SSMCore
          *
          * @param msg - received message
          *

diff --git a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/QueryEngine.java b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/QueryEngine.java
index fec628a..0c48844 100644 (file)
--- a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/QueryEngine.java
+++ b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/QueryEngine.java
@@ -75,7 +75,7 @@ public class QueryEngine
          * Register QueryEngineEvent to QueryEngine
          *
          * @param queryEngineEvent 
-         *               - the event to register with QueryEngine
+         *               - the event class to receive QueryEngine events
          *
          * @return void
          * 

diff --git a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/SSMInterface.java b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/SSMInterface.java
index 62ad7c3..4e09faa 100644 (file)
--- a/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/SSMInterface.java
+++ b/service/soft-sensor-manager/SDK/java/org/iotivity/service/ssm/SSMInterface.java
@@ -22,7 +22,7 @@
  *
  * @brief    This file gives description of SSMInterface class and its utility functions.
  *         This is the interface between an application and the query engine.
- *         SSMinterface makes desired querries in form of CQL(Context Query Language)
+ *         SSMinterface makes desired queries in form of CQL(Context Query Language)
  *         to the query engine and passes the returned result obtained in form of callback
  *         back to the application.
  */
@@ -40,7 +40,7 @@ import java.util.concurrent.locks.ReentrantLock;
  * @class SSMInterface
  * @brief This class provides a set of APIs to manage the SSM framework
  *      This class sits in between the application and query engine and acts
- *      as an interface between them. SSMinterface makes desired querries in form of CQL(Context Query Language)
+ *      as an interface between them. SSMinterface makes desired queries in form of CQL(Context Query Language)
  *      to the query engine and passes the returned result obtained in form of callback
  *      back to the application
  */
@@ -83,7 +83,7 @@ public class SSMInterface
                 }
 
                 /**
-                 * To lock QueryEngineEventReceiver object to execute a query atomicaly,
+                 * To lock QueryEngineEventReceiver object to execute a query atomically,
                  *         this is done to provide synchronization in case of multiple queries.
                  *
                  * @return void
@@ -221,7 +221,7 @@ public class SSMInterface
         }
 
         /**
-         * unregister a registered query using its query ID the query corresponding
+         * unregister a registered query using its query ID. The query corresponding
          *      to the cqid will be terminated and removes listener for the given query
          *      The SSMCore will not send any callbacks after successful unregistration.
          *