Add class description of container bundle API

- add class and file description of container bundle API
- remove '-' for parameter description in comments for APIs

Change-Id: Iaca3db8d948657381fdf80350e45b7d783a5672a
Signed-off-by: Minji Park <minjii.park@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/2983
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Madan Lanka <lanka.madan@samsung.com>

diff --git a/service/resource-encapsulation/src/resourceContainer/bundle-api/include/BundleActivator.h b/service/resource-encapsulation/src/resourceContainer/bundle-api/include/BundleActivator.h
index 5a802ad..5551d8e 100644 (file)
--- a/service/resource-encapsulation/src/resourceContainer/bundle-api/include/BundleActivator.h
+++ b/service/resource-encapsulation/src/resourceContainer/bundle-api/include/BundleActivator.h
@@ -53,9 +53,9 @@ namespace OIC
                 /**
                 * Activate the Bundle to make bundle work and create bundle resources
                 *
-                * @param resourceContainer - resourceContainer which registered the bundle
+                * @param resourceContainer ResourceContainer which registers the bundle
                 *
-                * @param bundleId - assigned id for the bundle
+                * @param bundleId Assigned id for the bundle
                 *
                 * @return void
                 */
@@ -72,7 +72,7 @@ namespace OIC
                 /**
                 * Create Bundle Resource instance and register the resource in the container
                 *
-                * @param resourceInfo - information to create bundle resource
+                * @param resourceInfo Information of the bundle resource to be created
                 *
                 * @return void
                 */
@@ -81,7 +81,7 @@ namespace OIC
                 /**
                 * Destroy Bundle Resource instance and register the resource in the container
                 *
-                * @param pBundleResource - bundle resource to be destroyed
+                * @param pBundleResource Bundle resource to be destroyed
                 *
                 * @return void
                 */

diff --git a/service/resource-encapsulation/src/resourceContainer/bundle-api/include/NotificationReceiver.h b/service/resource-encapsulation/src/resourceContainer/bundle-api/include/NotificationReceiver.h
index d4d3515..a1d25a1 100644 (file)
--- a/service/resource-encapsulation/src/resourceContainer/bundle-api/include/NotificationReceiver.h
+++ b/service/resource-encapsulation/src/resourceContainer/bundle-api/include/NotificationReceiver.h
@@ -51,7 +51,7 @@ namespace OIC
                 /**
                 * Callback method for getting notification from bundle resources
                 *
-                * @param strResourceUri - uri of attribute updated bundle resource
+                * @param strResourceUri Uri of attribute updated bundle resource
                 *
                 * @return void
                 */

diff --git a/service/resource-encapsulation/src/resourceContainer/bundle-api/include/ResourceContainerBundleAPI.h b/service/resource-encapsulation/src/resourceContainer/bundle-api/include/ResourceContainerBundleAPI.h
index 373a8e0..2f4a676 100644 (file)
--- a/service/resource-encapsulation/src/resourceContainer/bundle-api/include/ResourceContainerBundleAPI.h
+++ b/service/resource-encapsulation/src/resourceContainer/bundle-api/include/ResourceContainerBundleAPI.h
@@ -18,6 +18,13 @@
 //
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
+/**
+* @file
+*
+* This file contains the resource container Bundle APIs provided
+*     to the resource bundle developers.
+*/
+
 #ifndef RESOURCECONTAINERBUNDLEAPI_H_
 #define RESOURCECONTAINERBUNDLEAPI_H_
 
@@ -31,6 +38,13 @@ namespace OIC
 {
     namespace Service
     {
+
+        /**
+        * @class   ResourceContainerBundleAPI
+        * @brief   This class provides APIs for retrieving bundle and resource configuration
+        *              and registering/unregistering resources.
+        *
+        */
         class ResourceContainerBundleAPI: public NotificationReceiver
         {
             public:
@@ -38,7 +52,7 @@ namespace OIC
                 * Register bundle resource in the container
                 *   and register resource server for bundle resource
                 *
-                * @param resource - bundle resource to register
+                * @param resource bundle resource to register
                 *
                 * @return void
                 */
@@ -48,7 +62,7 @@ namespace OIC
                 * Unregister bundle resource from the container
                 *   and unregister resource server
                 *
-                * @param resource - bundle resource to unregister
+                * @param resource Bundle resource to unregister
                 *
                 * @return void
                 */
@@ -57,9 +71,9 @@ namespace OIC
                 /**
                 * Get Configuration data of certain bundle
                 *
-                * @param [in] bundleId - bundle id to get configuration data
+                * @param [in] bundleId Bundle id to get configuration data
                 *
-                * @param [out] configOutput - returned configuration data
+                * @param [out] configOutput Returned configuration data of bundle
                 *
                 * @return void
                 */
@@ -68,9 +82,9 @@ namespace OIC
                 /**
                 * Get the list of Configuration data of resources that certain bundle has
                 *
-                * @param [in] bundleId - bundle id to get configuration data
+                * @param [in] bundleId Bundle id to get configuration data
                 *
-                * @param [out] configOutput - returned resource configuration data vector
+                * @param [out] configOutput Returned vector of resource configuration data
                 *
                 * @return void
                 */
@@ -80,7 +94,7 @@ namespace OIC
                 /**
                 * API for getting an instance of ResourceContainerBundleAPI
                 *
-                * @return ResourceContainerBundleAPI * - return the object pointer of ResourceContainerBundleAPI
+                * @return ResourceContainerBundleAPI * Return the object pointer of ResourceContainerBundleAPI
                 */
                 static ResourceContainerBundleAPI *getInstance();
 
@@ -96,4 +110,4 @@ namespace OIC
     }
 }
 
-#endif
+#endif
\ No newline at end of file

diff --git a/service/resource-encapsulation/src/resourceContainer/src/ResourceContainerImpl.cpp b/service/resource-encapsulation/src/resourceContainer/src/ResourceContainerImpl.cpp
index 91c7db6..c935508 100644 (file)
--- a/service/resource-encapsulation/src/resourceContainer/src/ResourceContainerImpl.cpp
+++ b/service/resource-encapsulation/src/resourceContainer/src/ResourceContainerImpl.cpp
@@ -817,8 +817,8 @@ namespace OIC
 
         void ResourceContainerImpl::registerJavaBundle(RCSBundleInfo *bundleInfo)
         {
-            OC_LOG_V(INFO, CONTAINER_TAG, "Registering Java bundle (%s)", std::string(+
-                     bundleInfo->getID()).c_str());
+            OC_LOG_V(INFO, CONTAINER_TAG, "Registering Java bundle (%s)",
+                     std::string(bundleInfo->getID()).c_str());
 
             JavaVM *jvm;
             JNIEnv *env;