add doxygen comments for exceptions in Scene-manager remote apis

- add doxygen comments in scene-manager remote apis
- change to use const variable in scenecommons with get request in RemoteSceneList class

Change-Id: I3354b7c271962be8d22f226a663e5cc415c8f211
Signed-off-by: Minji Park <minjii.park@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/5545
Reviewed-by: Uze Choi <uzchoi@samsung.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>

diff --git a/service/scene-manager/include/RemoteScene.h b/service/scene-manager/include/RemoteScene.h
index 32aa8c17b293b2666127d846a9d57646c9d72039..ee0fa0dead10af5b4f58a1486fb38db4a9a284b5 100644 (file)
--- a/service/scene-manager/include/RemoteScene.h
+++ b/service/scene-manager/include/RemoteScene.h
@@ -92,6 +92,7 @@ namespace OIC
                 * @param cb A callback to receive created RemoteSceneAction instance
                 *
                 * @throws RCSInvalidParameterException If parameter is invalid.
+                * @throws PlatformException If the platform operation failed
                 *
                 * @note RemoteSceneAction instance is only produced by RemoteScene class
                 *
@@ -110,6 +111,7 @@ namespace OIC
                 * @param cb A callback to receive created RemoteSceneAction instance
                 *
                 * @throws RCSInvalidParameterException If parameter is invalid.
+                * @throws PlatformException If the platform operation failed
                 *
                 * @note RemoteSceneAction instance is only produced by RemoteScene class
                 *
@@ -152,6 +154,7 @@ namespace OIC
                 * @param cb A callback to receive result of Scene execution
                 *
                 * @throws RCSInvalidParameterException If callback is null
+                * @throws PlatformException If the platform operation failed
                 */
                 void execute(RemoteSceneExecuteCallback cb);
 

diff --git a/service/scene-manager/include/RemoteSceneAction.h b/service/scene-manager/include/RemoteSceneAction.h
index 993943d23bfa13e86d3d51a333dacbe8cb370379..739ae27fe67e9429b99cc9df676c3621b4a4248b 100644 (file)
--- a/service/scene-manager/include/RemoteSceneAction.h
+++ b/service/scene-manager/include/RemoteSceneAction.h
@@ -74,6 +74,7 @@ namespace OIC
                 * @param cb A callback to receive the response
                 *
                 * @throws RCSInvalidParameterException If parameter is invalid.
+                * @throws PlatformException If the platform operation failed
                 *
                 * @see RCSResourceAttributes::Value
                 */
@@ -88,6 +89,7 @@ namespace OIC
                 * @param cb A callback to receive the response
                 *
                 * @throws RCSInvalidParameterException If parameter is invalid.
+                * @throws PlatformException If the platform operation failed
                 *
                 * @see RCSResourceAttributes
                 */

diff --git a/service/scene-manager/include/RemoteSceneCollection.h b/service/scene-manager/include/RemoteSceneCollection.h
index d7b0e2fe875cd2649eb27286595aa5d817881951..5db065dd328da022178efa1c297cdf919389d583 100644 (file)
--- a/service/scene-manager/include/RemoteSceneCollection.h
+++ b/service/scene-manager/include/RemoteSceneCollection.h
@@ -91,6 +91,7 @@ namespace OIC
                 * @param cb A callback to receive created RemoteScene instance
                 *
                 * @throws RCSInvalidParameterException If parameter is invalid
+                * @throws PlatformException If the platform operation failed
                 *
                 * @note RemoteScene instance is only produced by RemoteSceneCollection class.
                 * @note Name of Scene must be unique in one SceneCollection
@@ -122,6 +123,7 @@ namespace OIC
                 * @param cb A callback to receive the response
                 *
                 * @throws RCSInvalidParameterException If callback is null
+                * @throws PlatformException If the platform operation failed
                 */
                 void setName(const std::string &name, SetNameCallback cb);
 

diff --git a/service/scene-manager/include/RemoteSceneList.h b/service/scene-manager/include/RemoteSceneList.h
index 183c144dc2ed759a2ff60619035108d463eda780..b102a3ce40ec3d33d2229711b02f662a6a1c2355 100644 (file)
--- a/service/scene-manager/include/RemoteSceneList.h
+++ b/service/scene-manager/include/RemoteSceneList.h
@@ -111,6 +111,7 @@ namespace OIC
                 * @param cb A callback to receive the response
                 *
                 * @throws RCSInvalidParameterException If parameter is invalid.
+                * @throws PlatformException If the platform operation failed
                 *
                 * @see RCSRemoteResourceObject
                 */
@@ -125,6 +126,7 @@ namespace OIC
                 * @param cb A callback to receive created RemoteSceneCollection instance
                 *
                 * @throws RCSInvalidParameterException If callback is null.
+                * @throws PlatformException If the platform operation failed
                 *
                 * @note RemoteSceneCollection instance is only produced by RemoteSceneList class.
                 */
@@ -144,6 +146,7 @@ namespace OIC
                 * @param cb A callback to receive the response
                 *
                 * @throws RCSInvalidParameterException If callback is null.
+                * @throws PlatformException If the platform operation failed
                 */
                 void setName(const std::string &name, SetNameCallback cb);
 

diff --git a/service/scene-manager/src/RemoteSceneList.cpp b/service/scene-manager/src/RemoteSceneList.cpp
index 8a7a9e71ad027bb2790e626a86776b41442679de..ac2ad2cabfd8760842046174d0d4a56fc434b424 100644 (file)
--- a/service/scene-manager/src/RemoteSceneList.cpp
+++ b/service/scene-manager/src/RemoteSceneList.cpp
@@ -64,7 +64,7 @@ namespace OIC
             SceneListResourceRequestor::Ptr pRequestor =
                 std::make_shared< SceneListResourceRequestor >(sceneListResource);
 
-            std::string requestIf = OC::DEFAULT_INTERFACE;
+            std::string requestIf = SCENE_CLIENT_REQ_IF;
             pRequestor->requestGet(requestIf, std::bind(
                 &RemoteSceneList::onInstanceCreated,
                 std::placeholders::_2, std::placeholders::_3, requestIf,

diff --git a/service/scene-manager/src/SceneMemberResourceRequestor.cpp b/service/scene-manager/src/SceneMemberResourceRequestor.cpp
index eaad4b50145f88050055abb406e8af7fe98114f4..3f437191c8028a5b9cbbb510288d83d87330986d 100644 (file)
--- a/service/scene-manager/src/SceneMemberResourceRequestor.cpp
+++ b/service/scene-manager/src/SceneMemberResourceRequestor.cpp
@@ -137,7 +137,7 @@ namespace OIC
                 }
                 catch (const std::exception &e)
                 {
-                    SCENE_CLIENT_ASSERT_NOT_NULL(e.what());
+                    SCENE_CLIENT_PRINT_LOG(e.what());
                     result = SCENE_SERVER_INTERNALSERVERERROR;
                 }
             }