comments for resource-container and scene-manager 91/26591/3
authorpooja <pooja.k@partner.samsung.com>
Wed, 25 Jul 2018 13:23:21 +0000 (18:53 +0530)
committerAshok Babu Channa <ashok.channa@samsung.com>
Mon, 30 Jul 2018 12:36:27 +0000 (12:36 +0000)
Change-Id: Ie61b6db9e929883027c10c313e0e947255fa2818
Signed-off-by: pooja <pooja.k@partner.samsung.com>
service/resource-container/examples/BMISensorBundle/include/BMISensorBundleActivator.h
service/resource-container/examples/BMISensorBundle/src/inputSensors/HeightSensorApp/include/HeightSensorApp.h
service/resource-container/examples/BMISensorBundle/src/inputSensors/WeightSensorApp/include/WeightSensorApp.h
service/resource-container/unittests/ResourceContainerTestSimulator.h
service/scene-manager/src/SceneCollectionResource.h
service/scene-manager/src/SceneCollectionResourceRequestor.h
service/scene-manager/src/SceneCommons.h
service/scene-manager/src/SceneListResourceRequestor.h
service/scene-manager/src/SceneMemberResourceRequestor.h

index 3ba3fcd..1371a42 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2015 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2015 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef BMISENSOR_BUNDLE_ACTIVATOR_H_
 #define BMISENSOR_BUNDLE_ACTIVATOR_H_
@@ -36,7 +36,9 @@ class BMISensorBundleActivator : public BundleActivator
         void activateBundle(ResourceContainerBundleAPI *resourceContainer, std::string bundleId);
         void deactivateBundle();
 
+        /** create resource */
         void createResource(resourceInfo resourceInfo);
+        /** destroy resource */
         void destroyResource(BundleResource::Ptr pBundleResource);
 
         std::string m_bundleId;
index 9dc4991..fa0a7cc 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2015 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2015 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef HEIGHTSENSORAPP_H_
 #define HEIGHTSENSORAPP_H_
 #define RESOURCE_TYPE_NAME          "oic.r.sensor.height"
 
 //  testing case
-#define INTERVAL_FOR_CHECK          4   // seconds
-#define INTERVAL_FOR_MEASUREMENT    3   // seconds
-#define INIT_VAL                    1   // default value
-#define DIFF_VAL                    0.02   // default value
+#define INTERVAL_FOR_CHECK          4   /*!< seconds */
+#define INTERVAL_FOR_MEASUREMENT    3   /*!< seconds */
+#define INIT_VAL                    1   /*!< default value */
+#define DIFF_VAL                    0.02   /*!< default value */
 
 
 class HeightResource
@@ -71,12 +71,19 @@ class HeightResource
         {
         }
 
+        /** register the height resource */
         void registerResource();
 
+        /** get the handle */
         OCResourceHandle getHandle();
 
+        /**
+         * set the resource representation
+         * @param rep   oc representation to set
+         */
         void setResourceRepresentation(OC::OCRepresentation &rep);
 
+        /** get resource representation */
         OC::OCRepresentation getResourceRepresentation();
 };
 
index ab990d4..0702f22 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2015 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2015 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef WEIGHTSENSORAPP_H_
 #define WEIGHTSENSORAPP_H_
 #define RESOURCE_TYPE_NAME          "oic.r.sensor.weight"
 
 //  testing case
-#define INTERVAL_FOR_CHECK          14   // seconds
-#define INTERVAL_FOR_MEASUREMENT    3   // seconds
-#define INIT_VAL                    33   // default value
-#define DIFF_VAL                    0.01   // default value
+#define INTERVAL_FOR_CHECK          14   /*!< seconds */
+#define INTERVAL_FOR_MEASUREMENT    3   /*!< seconds */
+#define INIT_VAL                    33   /*!< default value */
+#define DIFF_VAL                    0.01   /*!< default value */
 
 
 class WeightResource
@@ -71,12 +71,19 @@ class WeightResource
         {
         }
 
+        /** register the weight resource */
         void registerResource();
 
+        /** get the handle */
         OCResourceHandle getHandle();
 
+        /**
+         * set the resource representation
+         * @param rep   oc representation to set
+         */
         void setResourceRepresentation(OC::OCRepresentation &rep);
 
+        /** get resource representation */
         OC::OCRepresentation getResourceRepresentation();
 };
 
index 39857a7..31de8b2 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2015 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2015 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #include <memory>
 #include <mutex>
@@ -131,6 +131,9 @@ class ResourceContainerTestSimulator
         }
 
     public:
+        /**
+         * Run simulator
+         */
         void defaultRunSimulator()
         {
             createResource();
@@ -138,6 +141,9 @@ class ResourceContainerTestSimulator
             waitForDiscovery();
         }
 
+        /**
+         * Create resource
+         */
         void createResource()
         {
             server = RCSResourceObject::Builder(RESOURCEURI, RESOURCETYPE, RESOURCEINTERFACE)
@@ -145,11 +151,17 @@ class ResourceContainerTestSimulator
             server->setAttribute(ATTR_KEY, ATTR_VALUE);
         }
 
+        /**
+         * Discover resource
+         */
         void discoveryResource()
         {
             discoveryResource(RESOURCETYPE);
         }
 
+        /**
+         * Discover resource with type
+         */
         void discoveryResource(std::string &resourceType)
         {
             try
@@ -166,21 +178,39 @@ class ResourceContainerTestSimulator
             }
         }
 
+        /**
+         * Get server uri
+         *
+         * @return resource uri
+         */
         std::string getServerUri() const
         {
             return RESOURCEURI;
         }
 
+        /**
+         * Get resource server
+         *
+         * @return RCSResourceObject
+         */
         RCSResourceObject::Ptr getResourceServer() const
         {
             return server;
         }
 
+        /**
+         * Get remote resource
+         *
+         * @return RCSRemoteResourceObject
+         */
         RCSRemoteResourceObject::Ptr getRemoteResource() const
         {
             return remoteResource;
         }
 
+        /**
+         * Change attribute value
+         */
         void ChangeAttributeValue()
         {
             std::chrono::milliseconds interval(DEFAULT_WAITTIME);
index bd22a82..1b12c92 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef SCENE_COLLECTION_RESOURCE_OBJECT_H
 #define SCENE_COLLECTION_RESOURCE_OBJECT_H
@@ -27,6 +27,7 @@
 #include "SceneCommons.h"
 #include "SceneMemberResource.h"
 
+/** OIC namespace */
 namespace OIC
 {
     namespace Service
@@ -43,32 +44,57 @@ namespace OIC
             static SceneCollectionResource::Ptr create();
             static SceneCollectionResource::Ptr create(const RCSResourceAttributes &);
 
+            /**
+             * add new scene resource and it is already exists then throw the exception
+             * @param new scene to add
+             */
             void addScene(std::string &&);
             void addScene(const std::string &);
 
+            /**
+             * add new scene member and if it is already registered then throw exception
+             * @param new scene member to add
+             */
             void addSceneMember(SceneMemberResource::Ptr);
 
+             /**
+              * execute the given scene name
+              * @param name of the scene to execute
+              * @param scene execute callback
+              */
             void execute(std::string &&);
             void execute(const std::string &);
             void execute(std::string &&, SceneExecuteCallback);
             void execute(const std::string &, SceneExecuteCallback);
 
+            /**
+             * set the scene name
+             * @param string name to set
+             */
             void setName(std::string &&);
             void setName(const std::string &);
 
+            /** get scene values from resource collection */
             std::vector<std::string> getSceneValues() const;
 
+             /** get the scene name from collections */
             std::string getName() const;
 
+            /** get Id of scene resource */
             std::string getId() const;
+             /** get uri details */
             std::string getUri() const;
+            /** get address details */
             std::string getAddress() const;
 
+            /** get scene member information */
             std::vector<SceneMemberResource::Ptr> getSceneMembers() const;
 
+            /** find scene member details with the given scene name */
             std::vector<SceneMemberResource::Ptr> findSceneMembers(
                     const std::string & sceneName) const;
 
+           /** get the resource object */
             RCSResourceObject::Ptr getRCSResourceObject() const;
 
         private:
@@ -139,8 +165,11 @@ namespace OIC
             SceneCollectionResource & operator = (
                     SceneCollectionResource &&) = delete;
 
+            /** create the new resource object */
             RCSResourceObject::Ptr createResourceObject();
+            /** set the default attributes value */
             void setDefaultAttributes();
+            /** intialize the request handler */
             void initSetRequestHandler();
         };
     }
index 1975f80..1e4bb97 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef SM_SCENECOLLECTION_RESOURCE_REQUESTOR_H_
 #define SM_SCENECOLLECTION_RESOURCE_REQUESTOR_H_
 #include "RCSRepresentation.h"
 #include "SceneMemberResourceRequestor.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
 
@@ -46,38 +48,44 @@ namespace OIC
                     ADD_SCENE, REMOVE_SCENE, EXECUTE_SCENE
                 };
 
+                /** internal scene request callback */
                 typedef std::function< 
                     void(REQUEST_TYPE, const std::string &name, int eCode) >
                         InternalSceneRequestCallback;
 
+                /** internal add member callback */
                 typedef std::function < void(int eCode) > InternalAddMemberCallback;
 
+                /** internal set name callback */
                 typedef std::function < void(int eCode) > InternalSetNameCallback;
 
             public:
                 SceneCollectionResourceRequestor(RCSRemoteResourceObject::Ptr collectionResource);
                 ~SceneCollectionResourceRequestor() = default;
 
+                /** This method is for new scene creation request */
                 void requestSceneCreation(const std::string &name, InternalSceneRequestCallback);
+                /** This method is for scene removal request */
                 void requestSceneRemoval(const std::string &name, InternalSceneRequestCallback);
-
+                /** This method is for scene execution request */
                 void requestSceneExecution(const std::string &name, InternalSceneRequestCallback);
-
+                /** This method is for add scene member request */
                 void requestAddSceneMember(RCSRemoteResourceObject::Ptr targetResource,
                                            const std::string &sceneName,
                                            const RCSResourceAttributes &attr,
                                            InternalAddMemberCallback);
 
+                /** This method is for set name request */
                 void requestSetName(const std::string &, InternalSetNameCallback);
-
+                /** This method is for get request */
                 void requestGet(const std::string &, RCSRemoteResourceObject::GetCallback);
-
+                /** This method is for get remote resource object */
                 RCSRemoteResourceObject::Ptr getRemoteResourceObject() const;
-
+                /** This method is for create scene member resource requestor */
                 SceneMemberResourceRequestor::Ptr createSceneMemberResourceRequestor(
                     const std::string &memHref, const std::string &id,
                     RCSRemoteResourceObject::Ptr target);
-
+                /** This method is for get scene member resource requestor */
                 SceneMemberResourceRequestor::Ptr getSceneMemberResourceRequestor(
                     const std::string &targetHref) const;
 
index 8a2c8b5..1e28d12 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 /**
  * @file
 #include "OCApi.h"
 #include "RCSRemoteResourceObject.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
-        const std::string SCENE_LIST_DEFAULT_NAME = "list of scene Collections";
+        const std::string SCENE_LIST_DEFAULT_NAME = "list of scene Collections";   /*!< scene list default name */
 
-        const std::string SCENE_KEY_LAST_SCENE = "lastScene";
-        const std::string SCENE_KEY_SCENEVALUES = "sceneValues";
-        const std::string SCENE_KEY_NAME = "n";
-        const std::string SCENE_KEY_ID = "id";
+        const std::string SCENE_KEY_LAST_SCENE = "lastScene";                      /*!< last selected scene */
+        const std::string SCENE_KEY_SCENEVALUES = "sceneValues";                   /*!< all available scene values */
+        const std::string SCENE_KEY_NAME = "n";                                    /*!< name of the resource */
+        const std::string SCENE_KEY_ID = "id";                                     /*!< unique value */
         const std::string SCENE_KEY_RTS = "rts";
         const std::string SCENE_KEY_RT = "rt";
         const std::string SCENE_KEY_IF = "if";
-        const std::string SCENE_KEY_PAYLOAD_LINK = "link";
-        const std::string SCENE_KEY_SCENEMAPPINGS = "sceneMappings";
+        const std::string SCENE_KEY_PAYLOAD_LINK = "link";                         /*!< payload link */
+        const std::string SCENE_KEY_SCENEMAPPINGS = "sceneMappings";               /*!< scene mappings */
         const std::string SCENE_KEY_HREF = "href";
         const std::string SCENE_KEY_SCENE = "scene";
-        const std::string SCENE_KEY_MEMBERPROPERTY = "memberProperty";
-        const std::string SCENE_KEY_MEMBERVALUE = "memberValue";
-        const std::string SCENE_KEY_CREATEDLINK = "createdlink";
+        const std::string SCENE_KEY_MEMBERPROPERTY = "memberProperty";             /*!< property name that will be papped */
+        const std::string SCENE_KEY_MEMBERVALUE = "memberValue";                   /*!< scene member property value */
+        const std::string SCENE_KEY_CREATEDLINK = "createdlink";                   /*!< created link */
 
         const std::string SCENE_KEY_URI = "uri";
         const std::string SCENE_KEY_CHILD = "child";
@@ -61,22 +63,25 @@ namespace OIC
         const std::string SCENE_MEMBER_RT = "oic.wk.sceneMember";
         const std::string SCENE_COLLECTION_RT = "oic.wk.sceneCollection";
 
-        const std::string COAP_TAG = "coap://";
-        const std::string SCENE_LIST_URI = "/SceneListResURI";
+        const std::string COAP_TAG = "coap://";                                    /*!< coap tag information */
+        const std::string SCENE_LIST_URI = "/SceneListResURI";                     /*!< scene list uri */
         const std::string PREFIX_SCENE_COLLECTION_URI = "/a/sceneCollection";
         const std::string PREFIX_SCENE_MEMBER_URI = "/a/sceneMember";
 
-        const std::string LINK_BATCH = "oic.if.lb";
-        const std::string BASELINE_IF = "oic.if.baseline";
+        const std::string LINK_BATCH = "oic.if.lb";                                /*!< batch */
+        const std::string BASELINE_IF = "oic.if.baseline";                         /*!< baseline interface */
 
         const OCConnectivityType SCENE_CONNECTIVITY = CT_ADAPTER_IP;
         const std::string SCENE_CLIENT_REQ_IF = BASELINE_IF;
         const std::string SCENE_CLIENT_CREATE_REQ_IF = OC::BATCH_INTERFACE;
 
-        const int SCENE_RESPONSE_SUCCESS = 200;
-        const int SCENE_CLIENT_BADREQUEST = 400;
-        const int SCENE_SERVER_INTERNALSERVERERROR = 500;
+        const int SCENE_RESPONSE_SUCCESS = 200;                                    /*!< success response */
+        const int SCENE_CLIENT_BADREQUEST = 400;                                   /*!< bad request */
+        const int SCENE_SERVER_INTERNALSERVERERROR = 500;                          /*!< internal server error */
 
+        /**
+         * @class   SceneUtils
+         */
         class SceneUtils
         {
         public:
index eb7a260..b16eb2c 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef SM_SCENELIST_RESOURCE_REQUESTOR_H_
 #define SM_SCENELIST_RESOURCE_REQUESTOR_H_
 #include "RCSRepresentation.h"
 #include "RemoteSceneUtils.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
 
@@ -49,13 +51,17 @@ namespace OIC
                 SceneListResourceRequestor(RCSRemoteResourceObject::Ptr listResource);
                 ~SceneListResourceRequestor() = default;
 
+                /** This method is for scene collection creation request */
                 void requestSceneCollectionCreation(
                     const std::string &name, InternalCreateSceneCollectionCallback);
 
+                /** This method is for set name request */
                 void requestSetName(const std::string &, InternalSetNameCallback);
 
+                /** This method is for get request */
                 void requestGet(const std::string &, RCSRemoteResourceObject::GetCallback);
 
+                /** This method is for get remote resource object */
                 RCSRemoteResourceObject::Ptr getRemoteResourceObject() const;
 
             private:
index 76c1b5e..4871850 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef SM_SCENEMEMBER_RESOURCE_REQUESTOR_H_
 #define SM_SCENEMEMBER_RESOURCE_REQUESTOR_H_
@@ -43,14 +43,18 @@ namespace OIC
                                              const std::string &id);
                 ~SceneMemberResourceRequestor() = default;
 
+                /**
+                 * This method is for scene action creation request
+                 */
                 void requestSceneActionCreation(const std::string &sceneName,
                                                 const RCSResourceAttributes &attr,
                                                 InternalAddSceneActionCallback);
 
+                /** This method is for get request */
                 void requestGet(const std::string &, RCSRemoteResourceObject::GetCallback);
-
+                /** This method is for set remote resource object */
                 void setRemoteResourceObject(RCSRemoteResourceObject::Ptr);
-
+                /** This method is for get remote resource object */
                 RCSRemoteResourceObject::Ptr getRemoteResourceObject() const;
 
             private: