modify description of resource container apis to correct doxygen warnings
authorMinji Park <minjii.park@samsung.com>
Mon, 5 Oct 2015 11:21:10 +0000 (20:21 +0900)
committerMadan Lanka <lanka.madan@samsung.com>
Tue, 6 Oct 2015 00:41:02 +0000 (00:41 +0000)
- fix doxygen comments of container apis to remove warnings

Change-Id: I917d3b48dd44943c803581145fa82af9ab9fb775
Signed-off-by: Minji Park <minjii.park@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/3479
Reviewed-by: Hun-je Yeon <hunje.yeon@samsung.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Madan Lanka <lanka.madan@samsung.com>
service/resource-container/bundle-api/include/BundleResource.h
service/resource-container/bundle-api/include/ProtocolBridgeResource.h
service/resource-container/bundle-api/include/SoftSensorResource.h
service/resource-container/include/RCSResourceContainer.h

index 960b146..5315edd 100644 (file)
@@ -139,9 +139,6 @@ namespace OIC
                 * The implementor of the function can decide weather to notify OIC clients
                 * about the changed state or not.
                 *
-                * @param key Name of attribute to get
-                *
-                *
                 * @return All attributes
                 */
                 virtual RCSResourceAttributes &handleGetAttributesRequest() = 0;
@@ -158,8 +155,6 @@ namespace OIC
                 * The implementor of the function can decide weather to notify OIC clients
                 * about the changed state or not.
                 *
-                * @param key Name of attribute to set
-                *
                 * @param attrs Attributes to set
                 *
                 * @return void
index c420c27..b8cfc8e 100644 (file)
@@ -65,9 +65,6 @@ namespace OIC
                 * The implementor of the function can decide weather to notify OIC clients
                 * about the changed state or not.
                 *
-                * @param key Name of attribute to get
-                *
-                *
                 * @return Value of all attributes
                 */
                 virtual RCSResourceAttributes &handleGetAttributesRequest() = 0;
@@ -84,8 +81,6 @@ namespace OIC
                 * The implementor of the function can decide weather to notify OIC clients
                 * about the changed state or not.
                 *
-                * @param key Name of attribute to set
-                *
                 * @param attrs Attributes to set
                 *
                 * @return void
index 90b01a0..d26654d 100644 (file)
@@ -62,9 +62,6 @@ namespace OIC
                 * The implementor of the function can decide weather to notify OIC clients
                 * about the changed state or not.
                 *
-                * @param key Name of attribute to get
-                *
-                *
                 * @return Value of all attributes
                 */
                 virtual RCSResourceAttributes &handleGetAttributesRequest() = 0;
@@ -81,8 +78,6 @@ namespace OIC
                 * The implementor of the function can decide weather to notify OIC clients
                 * about the changed state or not.
                 *
-                * @param key Name of attribute to set
-                *
                 * @param attrs Attributes to set
                 *
                 * @return void
index 9d2575c..51f8eba 100644 (file)
@@ -114,7 +114,7 @@ namespace OIC
                 * @param params key-value pairs in string form for other Bundle parameters
                 *
                 */
-                virtual void addResourceConfig(const std::string &bundleId, const std::string &esourceUri,
+                virtual void addResourceConfig(const std::string &bundleId, const std::string &resourceUri,
                                                std::map<std::string, std::string> params) = 0;
                 /**
                 * API for removing the Resource configuration information from the bundle