add doxygen comments for exceptions in Scene-manager remote apis
authorMinji Park <minjii.park@samsung.com>
Tue, 8 Mar 2016 08:55:59 +0000 (17:55 +0900)
committerUze Choi <uzchoi@samsung.com>
Fri, 11 Mar 2016 06:22:26 +0000 (06:22 +0000)
- 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>
(cherry picked from commit 5f95d30eb6f7e7a00675a74ac2dd348e5d5c53e4)
Reviewed-on: https://gerrit.iotivity.org/gerrit/5649
Reviewed-by: Phil Coval <philippe.coval@osg.samsung.com>
service/scene-manager/include/RemoteScene.h
service/scene-manager/include/RemoteSceneAction.h
service/scene-manager/include/RemoteSceneCollection.h
service/scene-manager/include/RemoteSceneList.h
service/scene-manager/src/RemoteSceneList.cpp
service/scene-manager/src/SceneMemberResourceRequestor.cpp

index 32aa8c1..ee0fa0d 100644 (file)
@@ -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);
 
index 993943d..739ae27 100644 (file)
@@ -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
                 */
index d7b0e2f..5db065d 100644 (file)
@@ -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);
 
index 183c144..b102a3c 100644 (file)
@@ -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);
 
index 8a7a9e7..ac2ad2c 100644 (file)
@@ -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,
index eaad4b5..3f43719 100644 (file)
@@ -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;
                 }
             }