Add doxygen comments for scene-manager 59/26659/4
authorpooja <pooja.k@partner.samsung.com>
Tue, 31 Jul 2018 10:08:33 +0000 (15:38 +0530)
committerAshok Babu Channa <ashok.channa@samsung.com>
Thu, 23 Aug 2018 06:03:31 +0000 (06:03 +0000)
Change-Id: Ifa897b017f54a5149df3c6be533ab5525049c092
Signed-off-by: pooja <pooja.k@partner.samsung.com>
service/coap-http-proxy/include/CoapHttpParser.h
service/scene-manager/include/RemoteSceneAction.h
service/scene-manager/src/SceneListResource.h
service/scene-manager/src/SceneMemberResourceRequestor.h

index 66687a2..44670b6 100644 (file)
@@ -35,21 +35,21 @@ extern "C"
 #include "uarraylist.h"
 #include "octypes.h"
 
-#define CHP_MAX_HF_DATA_LENGTH 1024
-#define CHP_MAX_HF_NAME_LENGTH 255
-#define JSON_CONTENT_TYPE "application/json"
-#define CBOR_CONTENT_TYPE "application/cbor"
-#define ACCEPT_MEDIA_TYPE (CBOR_CONTENT_TYPE "; q=1.0, " JSON_CONTENT_TYPE "; q=0.5")
+#define CHP_MAX_HF_DATA_LENGTH 1024 /**< maximum data length */
+#define CHP_MAX_HF_NAME_LENGTH 255  /**< maximum name length */
+#define JSON_CONTENT_TYPE "application/json" /**< type of json content */
+#define CBOR_CONTENT_TYPE "application/cbor" /**< type of cbor content */
+#define ACCEPT_MEDIA_TYPE (CBOR_CONTENT_TYPE "; q=1.0, " JSON_CONTENT_TYPE "; q=0.5") /**< media type */
 
 // HTTP Option types
-#define HTTP_OPTION_CACHE_CONTROL   "cache-control"
-#define HTTP_OPTION_ACCEPT          "accept"
-#define HTTP_OPTION_IF_MATCH        "if-match"
-#define HTTP_OPTION_IF_NONE_MATCH   "if-none-match"
-#define HTTP_OPTION_ETAG            "etag"
-#define HTTP_OPTION_CONTENT_TYPE    "content-type"
-#define HTTP_OPTION_CONTENT_LENGTH  "content-length"
-#define HTTP_OPTION_EXPIRES         "expires"
+#define HTTP_OPTION_CACHE_CONTROL   "cache-control"  /**< cache control option type */
+#define HTTP_OPTION_ACCEPT          "accept"         /**< accept option type */
+#define HTTP_OPTION_IF_MATCH        "if-match"       /**< match option type */
+#define HTTP_OPTION_IF_NONE_MATCH   "if-none-match"  /**< not match option type */
+#define HTTP_OPTION_ETAG            "etag"           /**< tag information */
+#define HTTP_OPTION_CONTENT_TYPE    "content-type"   /**< content type option */
+#define HTTP_OPTION_CONTENT_LENGTH  "content-length" /**< content length option */
+#define HTTP_OPTION_EXPIRES         "expires"        /**< expires option type */
 
 /**
  * @enum HttpResponseResult_t
@@ -94,6 +94,7 @@ typedef struct
     char optionData[CHP_MAX_HF_DATA_LENGTH];                /**< Option data values. **/
 } HttpHeaderOption_t;
 
+/** enum value for http method */
 typedef enum
 {
     CHP_GET = 1,   /**< GET */
@@ -103,6 +104,7 @@ typedef enum
     CHP_INVALID
 }HttpMethod_t;
 
+/** structure of http request */
 typedef struct HttpRequest_t
 {
     unsigned short httpMajor;
@@ -117,6 +119,7 @@ typedef struct HttpRequest_t
     char acceptFormat[CHP_MAX_HF_DATA_LENGTH];
 }HttpRequest_t;
 
+/** structure of http response */
 typedef struct HttpResponse_t
 {
     unsigned short httpMajor;
index 739ae27..aba4836 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_REMOTE_SCENEACTION_H_
 #define SM_REMOTE_SCENEACTION_H_
index d9e0d03..59fa3d6 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
index 4871850..ad0b6fe 100644 (file)
 #include "SceneCommons.h"
 #include "RCSRemoteResourceObject.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
 
@@ -39,12 +41,20 @@ namespace OIC
                 typedef std::function < void(int eCode) > InternalAddSceneActionCallback;
 
             public:
+                /**
+                 * constructor
+                 * @param memberResource   member resource
+                 * @param id               member id
+                 */
                 SceneMemberResourceRequestor(RCSRemoteResourceObject::Ptr memberResource,
                                              const std::string &id);
                 ~SceneMemberResourceRequestor() = default;
 
                 /**
                  * This method is for scene action creation request
+                 * @param sceneName  name of the scene
+                 * @param attr       resource attributes
+                 * @param InternalAddSceneActionCallback  callback for scene action
                  */
                 void requestSceneActionCreation(const std::string &sceneName,
                                                 const RCSResourceAttributes &attr,