Add doxygen comments for easy-setup 85/26585/2
authorpooja <pooja.k@partner.samsung.com>
Wed, 25 Jul 2018 10:43:28 +0000 (16:13 +0530)
committerpooja <pooja.k@partner.samsung.com>
Thu, 26 Jul 2018 10:49:36 +0000 (16:19 +0530)
Change-Id: Ia7ff5ffee691995867209259c5d6b70462425b52
Signed-off-by: pooja <pooja.k@partner.samsung.com>
service/easy-setup/enrollee/inc/ESEnrolleeCommon.h
service/easy-setup/enrollee/inc/internal/es_util.h
service/easy-setup/enrollee/src/resourcehandler.h
service/easy-setup/enrollee/unittests/ESMediatorSimulator.h
service/easy-setup/inc/escommon.h
service/easy-setup/mediator/richsdk/src/CloudResource.h
service/easy-setup/mediator/richsdk/src/EnrolleeResource.h
service/easy-setup/mediator/richsdk/unittests/ESEnrolleeSimulator.h
service/easy-setup/sampleapp/enrollee/linux/easysetup_x.h
service/easy-setup/sampleapp/enrollee/tizen-sdb/EnrolleeSample/easysetup_wifi_conn.h

index 25548ba..e3b2efc 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 ES_ENROLLEE_COMMON_H_
 #define ES_ENROLLEE_COMMON_H_
@@ -34,8 +34,8 @@ extern "C"
  */
 typedef struct
 {
-    ES_CONNECT_TYPE connect[NUM_CONNECT_TYPE];
-    int numRequest;
+    ES_CONNECT_TYPE connect[NUM_CONNECT_TYPE]; /*!< connect type */
+    int numRequest;                            /*!< num of request */
 } ESConnectRequest;
 
 /**
@@ -43,11 +43,11 @@ typedef struct
  */
 typedef struct
 {
-    char ssid[OIC_STRING_MAX_VALUE];        /**< Ssid of the Enroller**/
-    char pwd[OIC_STRING_MAX_VALUE];         /**< Pwd of the Enroller**/
-    WIFI_AUTHTYPE authtype;                 /**< Auth type of the Enroller**/
-    WIFI_ENCTYPE enctype;                   /**< Encryption type of the Enroller**/
-    void *userdata;                         /**< Vender-specific data**/
+    char ssid[OIC_STRING_MAX_VALUE];        /*!< Ssid of the Enroller**/
+    char pwd[OIC_STRING_MAX_VALUE];         /*!< Pwd of the Enroller**/
+    WIFI_AUTHTYPE authtype;                 /*!< Auth type of the Enroller**/
+    WIFI_ENCTYPE enctype;                   /*!< Encryption type of the Enroller**/
+    void *userdata;                         /*!< Vender-specific data**/
 } ESWiFiConfData;
 
 /**
@@ -56,7 +56,7 @@ typedef struct
 typedef struct
 {
     // TODO: variables can be added when some properties in oic.r.devconf resource are specified.
-    void *userdata;                         /**< Vender-specific data**/
+    void *userdata;                         /*!< Vender-specific data**/
 } ESDevConfData;
 
 /**
@@ -64,11 +64,11 @@ typedef struct
  */
 typedef struct
 {
-    char accessToken[OIC_STRING_MAX_VALUE];     /**< Access token resolved with an auth code **/
-    OAUTH_TOKENTYPE accessTokenType;            /**< Access token type **/
-    char authProvider[OIC_STRING_MAX_VALUE];    /**< Auth provider ID **/
-    char ciServer[OIC_URI_STRING_MAX_VALUE];    /**< Cloud interface server URL which an Enrollee is going to registered **/
-    void *userdata;                             /**< Vender-specific data**/
+    char accessToken[OIC_STRING_MAX_VALUE];     /*!< Access token resolved with an auth code **/
+    OAUTH_TOKENTYPE accessTokenType;            /*!< Access token type **/
+    char authProvider[OIC_STRING_MAX_VALUE];    /*!< Auth provider ID **/
+    char ciServer[OIC_URI_STRING_MAX_VALUE];    /*!< Cloud interface server URL which an Enrollee is going to registered **/
+    void *userdata;                             /*!< Vender-specific data**/
 } ESCoapCloudConfData;
 
 /**
@@ -81,14 +81,14 @@ typedef struct
      */
     struct
     {
-        WIFI_MODE supportedMode[NUM_WIFIMODE];
-        uint8_t numSupportedMode;
-        WIFI_FREQ supportedFreq[NUM_WIFIFREQ];
-        uint8_t numSupportedFreq;
-        WIFI_AUTHTYPE supportedAuthType[NUM_WIFIAUTHTYPE];
-        uint8_t numSupportedAuthType;
-        WIFI_ENCTYPE supportedEncType[NUM_WIFIENCTYPE];
-        uint8_t numSupportedEncType;
+        WIFI_MODE supportedMode[NUM_WIFIMODE];              /*!< wifi supported mode **/
+        uint8_t numSupportedMode;                           /*!< number of supported mode **/
+        WIFI_FREQ supportedFreq[NUM_WIFIFREQ];              /*!< number of supported frequency **/
+        uint8_t numSupportedFreq;                           /*!< number of supported frequency **/
+        WIFI_AUTHTYPE supportedAuthType[NUM_WIFIAUTHTYPE];  /*!< wifi supported auth type **/
+        uint8_t numSupportedAuthType;                       /*!< number of supported enc type **/
+        WIFI_ENCTYPE supportedEncType[NUM_WIFIENCTYPE];     /*!< wifi supported enc type **/
+        uint8_t numSupportedEncType;                        /*!< number of supported enc type **/
     } WiFi;
 
     /**
@@ -96,7 +96,7 @@ typedef struct
      */
     struct
     {
-        char deviceName[OIC_STRING_MAX_VALUE];
+        char deviceName[OIC_STRING_MAX_VALUE];  /*!< device name */
     } DevConf;
 } ESDeviceProperty;
 
@@ -106,10 +106,10 @@ typedef struct
  */
 typedef struct
 {
-    void (*ConnectRequestCb) (ESConnectRequest *);
-    void (*WiFiConfProvCb) (ESWiFiConfData *);
-    void (*DevConfProvCb) (ESDevConfData *);
-    void (*CoapCloudConfProvCb) (ESCoapCloudConfData *);
+    void (*ConnectRequestCb) (ESConnectRequest *); /*!< connect request callback */
+    void (*WiFiConfProvCb) (ESWiFiConfData *);     /*!< wifi configuration provision callback */
+    void (*DevConfProvCb) (ESDevConfData *);       /*!< device configuration provision callback */
+    void (*CoapCloudConfProvCb) (ESCoapCloudConfData *); /*!< coap cloud config provision cb */
 } ESProvisioningCallbacks;
 
 
index cfb7922..e7eb5d8 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2017 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 2017 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 ES_UTIL_H_
 #define ES_UTIL_H_
@@ -28,18 +28,69 @@ extern "C"
 {
 #endif
 
-// Some type conversion helpers
-// For all *EnumToString(...) functions: They take the Enum Type Value as input (val), and return
-// the corresponding string representation, which conforms to the OCF specification.
-// For all *StringToEnum(...) functions: They take the string representation, as per the OCF
-// specification as input (valIn). And return the Enum Value in valOut. If conversion fails,
-// false is returned by the function.
+/**
+ * Some type conversion helpers
+ * For all *EnumToString(...) functions: They take the Enum Type Value as input (val), and return
+ * the corresponding string representation, which conforms to the OCF specification.
+ * For all *StringToEnum(...) functions: They take the string representation, as per the OCF
+ * specification as input (valIn). And return the Enum Value in valOut. If conversion fails,
+ * false is returned by the function.
+ */
 
+/**
+ * convert wifi mode value to related string representation
+ *
+ * @param val Enum Type Value as input
+ *
+ * @return corresponding string representation
+ */
 const char* WiFiModeEnumToString(WIFI_MODE val);
+
+/**
+ * convert wifi freq value to related string representation
+ *
+ * @param val Enum Type Value as input
+ *
+ * @return corresponding string representation
+ */
 const char* WiFiFreqEnumToString(WIFI_FREQ val);
+
+/**
+ * convert wifi auth type value to related string representation
+ *
+ * @param val Enum Type Value as input
+ *
+ * @return corresponding string representation
+ */
 const char* WiFiAuthTypeEnumToString(WIFI_AUTHTYPE val);
+
+/**
+ * convert string representation to Enum value
+ *
+ * @param val     string representation
+ * @param valOut  return the Enum Value in valOut
+ *
+ * @return result as true or false
+ */
 bool WiFiAuthTypeStringToEnum(const char *val, WIFI_AUTHTYPE *valOut);
+
+/**
+ * convert wifi enc type value to related string representation
+ *
+ * @param val Enum Type Value as input
+ *
+ * @return corresponding string representation
+ */
 const char* WiFiEncTypeEnumToString(WIFI_ENCTYPE val);
+
+/**
+ * convert string representation to Enum value
+ *
+ * @param val     string representation
+ * @param valOut  return the Enum Value in valOut
+ *
+ * @return result as true or false
+ */
 bool WiFiEncTypeStringToEnum(const char *val, WIFI_ENCTYPE *valOut);
 
 #ifdef __cplusplus
index 6f3fef0..36c0487 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.
+ *
+ ******************************************************************/
 
 // Do not remove the include below
 
@@ -42,50 +42,53 @@ typedef void (*ESDevConfCB) (ESResult, ESDevConfData *);
 typedef void (*ESWriteUserdataCb)(OCRepPayload* payload, char* resourceType);
 typedef void (*ESReadUserdataCb)(OCRepPayload* payload, char* resourceType, void** userdata);
 
-/* Structure to represent a Light resource */
+/** Structure to represent a Light resource */
 typedef struct
 {
-    OCResourceHandle handle;
-    ProvStatus status; // provisiong status
-    ESErrorCode lastErrCode;
-    ES_CONNECT_TYPE connectRequest[NUM_CONNECT_TYPE];
-    int numRequest;
+    OCResourceHandle handle;  /*!< resource handle */
+    ProvStatus status;        /*!< provisiong status */
+    ESErrorCode lastErrCode;  /*!< last error code */
+    ES_CONNECT_TYPE connectRequest[NUM_CONNECT_TYPE]; /*!< connect request */
+    int numRequest;           /*!< num of request */
 } EasySetupResource;
 
+/** WiFi Configuration Resource */
 typedef struct
 {
-    OCResourceHandle handle;
-    WIFI_MODE supportedMode[NUM_WIFIMODE];
-    uint8_t numMode;        // the number of device's supported Wi-Fi modes
-    WIFI_FREQ supportedFreq[NUM_WIFIFREQ];
-    uint8_t numSupportedFreq;        // the number of device's supported Wi-Fi frequency bands
-    WIFI_AUTHTYPE supportedAuthType[NUM_WIFIAUTHTYPE];
-    uint8_t numSupportedAuthType;
-    WIFI_ENCTYPE supportedEncType[NUM_WIFIENCTYPE];
-    uint8_t numSupportedEncType;
-    char ssid[OIC_STRING_MAX_VALUE]; // SSID
-    char cred[OIC_STRING_MAX_VALUE]; // credential information.
-    WIFI_AUTHTYPE authType;
-    WIFI_ENCTYPE encType;
+    OCResourceHandle handle;               /*!< resource handle */
+    WIFI_MODE supportedMode[NUM_WIFIMODE]; /*!< wifi supported mode */
+    uint8_t numMode;                       /*!< the number of device's supported Wi-Fi modes */
+    WIFI_FREQ supportedFreq[NUM_WIFIFREQ]; /*!< wifi supported frequency */
+    uint8_t numSupportedFreq;              /*!< the number of device's supported Wi-Fi frequency bands */
+    WIFI_AUTHTYPE supportedAuthType[NUM_WIFIAUTHTYPE]; /*!< wifi supported auth type */
+    uint8_t numSupportedAuthType;          /*!< num of supported auth type */
+    WIFI_ENCTYPE supportedEncType[NUM_WIFIENCTYPE]; /*!< supported enc type */
+    uint8_t numSupportedEncType;           /*!< num of supported enc type */
+    char ssid[OIC_STRING_MAX_VALUE];       /*!< SSID */
+    char cred[OIC_STRING_MAX_VALUE];       /*!< credential information */
+    WIFI_AUTHTYPE authType;                /*!< auth type */
+    WIFI_ENCTYPE encType;                  /*!< encryption type */
 } WiFiConfResource;
 
+/** CoAP Cloud Configuration Resource */
 typedef struct
 {
-    OCResourceHandle handle;
-    char accessToken[OIC_STRING_MAX_VALUE];
-    OAUTH_TOKENTYPE accessTokenType;
-    char authProvider[OIC_STRING_MAX_VALUE];
+    OCResourceHandle handle;                 /*!< resource handle */
+    char accessToken[OIC_STRING_MAX_VALUE];  /*!< access token */
+    OAUTH_TOKENTYPE accessTokenType;         /*!< access token type */
+    char authProvider[OIC_STRING_MAX_VALUE]; /*!< auth provider */
     char ciServer[OIC_URI_STRING_MAX_VALUE];
 } CoapCloudConfResource;
 
+/** Device configuration resource */
 typedef struct
 {
-    OCResourceHandle handle;
-    char devName[OIC_STRING_MAX_VALUE];
-    char modelNumber[OIC_STRING_MAX_VALUE];
-    char location[OIC_STRING_MAX_VALUE];
-    char language[OIC_STRING_MAX_VALUE];
-    char country[OIC_STRING_MAX_VALUE];
+    OCResourceHandle handle;                /*!< resource handle */
+    char devName[OIC_STRING_MAX_VALUE];     /*!< device name */
+    char modelNumber[OIC_STRING_MAX_VALUE]; /*!< device model number */
+    char location[OIC_STRING_MAX_VALUE];    /*!< device location */
+    char language[OIC_STRING_MAX_VALUE];    /*!< language information */
+    char country[OIC_STRING_MAX_VALUE];     /*!< country information */
 } DevConfResource;
 
 /* Note: These values of structures are not thread-safety */
@@ -94,19 +97,100 @@ extern WiFiConfResource g_ESWiFiConfResource;
 extern CoapCloudConfResource g_ESCoapCloudConfResource;
 extern DevConfResource g_ESDevConfResource;
 
+/**
+ * Create easy ssetup resources.
+ *
+ * @param isSecured      check for secure mode.
+ * @param resourceMask   resource mask.
+ *
+ * @return result value.
+ */
 OCStackResult CreateEasySetupResources(bool isSecured, ESResourceMask resourceMask);
+
+/**
+ * Delete easysetup resource.
+ *
+ * @return result value.
+ */
 OCStackResult DeleteEasySetupResources(void);
 
+/**
+ * Set device property.
+ *
+ * @param deviceProperty device property.
+ *
+ * @return success if set property, otherwise error.
+ */
 OCStackResult SetDeviceProperty(ESDeviceProperty *deviceProperty);
+
+/**
+ * Set enrollee state.
+ *
+ * @param esState easy setup state.
+ *
+ * @return success if set state.
+ */
 OCStackResult SetEnrolleeState(ESEnrolleeState esState);
+
+/**
+ * Set enrollee error code.
+ *
+ * @param esErrCode easy setup error code.
+ *
+ * @return success if set error code.
+ */
 OCStackResult SetEnrolleeErrCode(ESErrorCode esErrCode);
+
+/**
+ * Check entity handler request payload.
+ *
+ * @param ehRequest entity handler request.
+ *
+ * @return success if check, otherwise error.
+ */
 OCEntityHandlerResult CheckEhRequestPayload(OCEntityHandlerRequest *ehRequest);
 
+/**
+ * Register wifi resource event callback.
+ *
+ * @param cb callback.
+ */
 void RegisterWifiRsrcEventCallBack(ESWiFiConfCB);
+
+/**
+ * Register cloud resource event callback.
+ *
+ * @param cb callback.
+ */
 void RegisterCloudRsrcEventCallBack(ESCoapCloudConfCB);
+
+/**
+ * Register device resource event callback.
+ *
+ * @param cb callback.
+ */
 void RegisterDevConfRsrcEventCallBack(ESDevConfCB);
+
+/**
+ * Register connect request event callback.
+ *
+ * @param cb callback.
+ */
 void RegisterConnectRequestEventCallBack(ESConnectRequestCB cb);
+
+/**
+ * UnRegister resource event callback.
+ */
 void UnRegisterResourceEventCallBack(void);
+
+/**
+ * Set userdata callback.
+ *
+ * @param readCb   read callback.
+ * @param writeCb  write callback.
+ *
+ * @return success if both callbacks are not null, otherwise ERROR.
+ */
 ESResult SetCallbackForUserData(ESReadUserdataCb readCb, ESWriteUserdataCb writeCb);
 
 #ifdef __cplusplus
index aa001eb..34cb489 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 _ES_MEDIATOR_SIMULATOR_H_
 #define _ES_MEDIATOR_SIMULATOR_H_
@@ -65,6 +65,7 @@ public:
     ESMediatorSimulator(ESMediatorSimulator &&) = delete;
     ESMediatorSimulator & operator = (ESMediatorSimulator &&) = delete;
 
+    /** discover the remote enrollee */
     void discoverRemoteEnrollee(std::function<void(std::shared_ptr<OC::OCResource> resource)> cb)
     {
         m_discoveryCb = cb;
@@ -76,6 +77,7 @@ public:
 
     }
 
+    /** get configuration of remote enrollee */
     void getConfiguration(std::function<void(std::shared_ptr< GetConfigurationStatus >)> cb)
     {
         m_getConfigurationCb = cb;
@@ -87,6 +89,7 @@ public:
                                                                     this, std::placeholders::_1));
     }
 
+    /** get wifi resource */
     void getWifiRsrc(std::function<void(const OCRepresentation& rep)> cb)
     {
         m_getWifiCb = cb;
@@ -97,6 +100,7 @@ public:
                                                                     this, std::placeholders::_1));
     }
 
+    /** get cloud resource information */
     void getCloudRsrc(std::function<void(const OCRepresentation& rep)> cb)
     {
         m_getCloudCb = cb;
@@ -107,6 +111,7 @@ public:
                                                                     this, std::placeholders::_1));
     }
 
+    /** get device configuration information */
     void getDevConfiguration(std::function<void(const OCRepresentation& rep)> cb)
     {
         m_getDevConfCb = cb;
@@ -117,6 +122,7 @@ public:
                                                                     this, std::placeholders::_1));
     }
 
+    /** get enrollee status */
     void getStatus(std::function<void(std::shared_ptr< GetEnrolleeStatus >)> cb)
     {
         m_getStatusCb = cb;
@@ -128,6 +134,7 @@ public:
                                                                     this, std::placeholders::_1));
     }
 
+    /** provision the device properties */
     void provisionDeviceProperties(std::function<void(std::shared_ptr< DevicePropProvisioningStatus >)> cb)
     {
         m_DevicePropProvisioningCb = cb;
@@ -139,6 +146,7 @@ public:
                                                                     this, std::placeholders::_1));
     }
 
+    /** provision the cloud properties */
     void provisionCloudProperties(std::function<void(std::shared_ptr< CloudPropProvisioningStatus >)> cb)
     {
         m_CloudPropProvisioningCb = cb;
index 7a24588..90ec90f 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 ES_COMMON_H_
 #define ES_COMMON_H_
@@ -30,44 +30,44 @@ extern "C"
 #endif
 
 // Defines
-#define OC_RSRVD_ES_RES_TYPE_COL          "oic.wk.col"
-#define OC_RSRVD_ES_INTERFACE             "if"
-#define OC_RSRVD_ES_RES_TYPE              "rt"
-
-#define OIC_STRING_MAX_VALUE        64
-#define OIC_URI_STRING_MAX_VALUE    256
-#define MAX_WEBLINKLEN              3
-#define NUM_WIFIMODE                10
-#define NUM_WIFIFREQ                5
-#define NUM_CONNECT_TYPE            3
-#define NUM_WIFIAUTHTYPE            4
-#define NUM_WIFIENCTYPE             6
+#define OC_RSRVD_ES_RES_TYPE_COL          "oic.wk.col"    /*!< Resource type value */
+#define OC_RSRVD_ES_INTERFACE             "if"            /*!< Interface */
+#define OC_RSRVD_ES_RES_TYPE              "rt"            /*!< Resource type */
+
+#define OIC_STRING_MAX_VALUE        64                    /*!< OIC string max value */
+#define OIC_URI_STRING_MAX_VALUE    256                   /*!< OIC uri string max value */
+#define MAX_WEBLINKLEN              3                     /*!< Wenlink length */
+#define NUM_WIFIMODE                10                    /*!< Supported wifi mode */
+#define NUM_WIFIFREQ                5                     /*!< Supported wifi frequency */
+#define NUM_CONNECT_TYPE            3                     /*!< Num of connect type */
+#define NUM_WIFIAUTHTYPE            4                     /*!< Supported wifi auth type */
+#define NUM_WIFIENCTYPE             6                     /*!< Supported wifi enc type */
 
 /**
  * Attributes used to form a proper easysetup conforming JSON message.
  */
-#define OC_RSRVD_ES_PROVSTATUS             "ps"
-#define OC_RSRVD_ES_LAST_ERRORCODE         "lec"
-#define OC_RSRVD_ES_LINKS                  "links"
-#define OC_RSRVD_ES_SUPPORTEDWIFIMODE      "swmt"
-#define OC_RSRVD_ES_SUPPORTEDWIFIFREQ      "swf"
-#define OC_RSRVD_ES_SUPPORTEDWIFIAUTHTYPE  "swat"
-#define OC_RSRVD_ES_SUPPORTEDWIFIENCTYPE   "swet"
-#define OC_RSRVD_ES_SSID                   "tnn"
-#define OC_RSRVD_ES_CRED                   "cd"
-#define OC_RSRVD_ES_AUTHTYPE               "wat"
-#define OC_RSRVD_ES_ENCTYPE                "wet"
+#define OC_RSRVD_ES_PROVSTATUS             "ps"           /*!< Provision status */
+#define OC_RSRVD_ES_LAST_ERRORCODE         "lec"          /*!< Last error code */
+#define OC_RSRVD_ES_LINKS                  "links"        /*!< links */
+#define OC_RSRVD_ES_SUPPORTEDWIFIMODE      "swmt"         /*!< Supported wifi mode */
+#define OC_RSRVD_ES_SUPPORTEDWIFIFREQ      "swf"          /*!< Supported wifi frequency */
+#define OC_RSRVD_ES_SUPPORTEDWIFIAUTHTYPE  "swat"         /*!< Supported wifi auth type */
+#define OC_RSRVD_ES_SUPPORTEDWIFIENCTYPE   "swet"         /*!< Supported wifi enc type */
+#define OC_RSRVD_ES_SSID                   "tnn"          /*!< SSID */
+#define OC_RSRVD_ES_CRED                   "cd"           /*!< credential information */
+#define OC_RSRVD_ES_AUTHTYPE               "wat"          /*!< auth type */
+#define OC_RSRVD_ES_ENCTYPE                "wet"          /*!< enc type */
 
 // Auth Code is no longer supported as per OCF 1.4 CoAPCloudConf Resource schema.
-#define OC_RSRVD_ES_AUTHCODE               "ac"
-#define OC_RSRVD_ES_ACCESSTOKEN            "at"
-#define OC_RSRVD_ES_ACCESSTOKEN_TYPE       "att"
-#define OC_RSRVD_ES_AUTHPROVIDER           "apn"
+#define OC_RSRVD_ES_AUTHCODE               "ac"           /*!< Auth code */
+#define OC_RSRVD_ES_ACCESSTOKEN            "at"           /*!< Access token */
+#define OC_RSRVD_ES_ACCESSTOKEN_TYPE       "att"          /*!< Access token type */
+#define OC_RSRVD_ES_AUTHPROVIDER           "apn"          /*!< Auth provider */
 #define OC_RSRVD_ES_CISERVER               "cis"
-#define OC_RSRVD_ES_SERVERID               "sid"
-#define OC_RSRVD_ES_DEVNAME                "dn"
+#define OC_RSRVD_ES_SERVERID               "sid"          /*!< server Id */
+#define OC_RSRVD_ES_DEVNAME                "dn"           /*!< device name */
 #define OC_RSRVD_ES_HREF                   "href"
-#define OC_RSRVD_ES_CONNECT                "cn"
+#define OC_RSRVD_ES_CONNECT                "cn"           /*!< connect */
 
 /**
  * Easysetup defined resoruce types and uris.
@@ -88,10 +88,10 @@ extern "C"
 //TODO: Remove WIFI_BOTH & WIFI_FREQ_NONE, if they are not used anymore. Array should be used to specify multiple values.
 typedef enum
 {
-    WIFI_24G = 0,       /**< 2.4G **/
-    WIFI_5G,            /**< 5G **/
-    WIFI_BOTH,          /**< 2.4G and 5G **/
-    WIFI_FREQ_NONE      /**< EOF **/
+    WIFI_24G = 0,       /*!< 2.4G **/
+    WIFI_5G,            /*!< 5G **/
+    WIFI_BOTH,          /*!< 2.4G and 5G **/
+    WIFI_FREQ_NONE      /*!< EOF **/
 } WIFI_FREQ;
 
 /**
@@ -99,11 +99,11 @@ typedef enum
  */
 typedef enum
 {
-    WIFI_11A = 0,       /**< 802.11a **/
-    WIFI_11B,           /**< 802.11b **/
-    WIFI_11G,           /**< 802.11g **/
-    WIFI_11N,           /**< 802.11n **/
-    WIFI_11AC           /**< 802.11ac **/
+    WIFI_11A = 0,       /*!< 802.11a **/
+    WIFI_11B,           /*!< 802.11b **/
+    WIFI_11G,           /*!< 802.11g **/
+    WIFI_11N,           /*!< 802.11n **/
+    WIFI_11AC           /*!< 802.11ac **/
 } WIFI_MODE;
 
 /**
@@ -111,10 +111,10 @@ typedef enum
  */
 typedef enum
 {
-    NONE_AUTH = 0,      /**< NO authentication **/
-    WEP,                /**< WEP **/
-    WPA_PSK,            /**< WPA-PSK **/
-    WPA2_PSK            /**< WPA2-PSK **/
+    NONE_AUTH = 0,      /*!< NO authentication **/
+    WEP,                /*!< WEP **/
+    WPA_PSK,            /*!< WPA-PSK **/
+    WPA2_PSK            /*!< WPA2-PSK **/
 } WIFI_AUTHTYPE;
 
 /**
@@ -122,12 +122,12 @@ typedef enum
  */
 typedef enum
 {
-    NONE_ENC = 0,       /**< NO encryption **/
-    WEP_64,             /**< WEP-64 **/
-    WEP_128,            /**< WEP-128**/
-    TKIP,               /**< TKIP **/
-    AES,                /**< AES **/
-    TKIP_AES            /**< TKIP-AES **/
+    NONE_ENC = 0,       /*!< NO encryption **/
+    WEP_64,             /*!< WEP-64 **/
+    WEP_128,            /*!< WEP-128**/
+    TKIP,               /*!< TKIP **/
+    AES,                /*!< AES **/
+    TKIP_AES            /*!< TKIP-AES **/
 } WIFI_ENCTYPE;
 
 /**
@@ -135,9 +135,9 @@ typedef enum
  */
 typedef enum
 {
-    NONE_OAUTH_TOKENTYPE = 0,
-    OAUTH_TOKENTYPE_BEARER,
-    OAUTH_TOKENTYPE_MAC
+    NONE_OAUTH_TOKENTYPE = 0, /*!< no oauth tokentype **/
+    OAUTH_TOKENTYPE_BEARER,   /*!< oauth tokentype bearer **/
+    OAUTH_TOKENTYPE_MAC       /*!< oauth tokentype mac **/
 } OAUTH_TOKENTYPE;
 
 /**
@@ -145,9 +145,9 @@ typedef enum
  */
 typedef enum
 {
-    ES_CONNECT_NONE = 0,        /**< Init value **/
-    ES_CONNECT_WIFI = 1,        /**< WiFi Conf resource **/
-    ES_CONNECT_COAPCLOUD = 2    /**< Coap Cloud Conf resource **/
+    ES_CONNECT_NONE = 0,        /*!< Init value **/
+    ES_CONNECT_WIFI = 1,        /*!< WiFi Conf resource **/
+    ES_CONNECT_COAPCLOUD = 2    /*!< Coap Cloud Conf resource **/
 } ES_CONNECT_TYPE;
 
 /**
index 8c1f6c1..f82be03 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 CLOUD_RESOURCE_H_
 #define CLOUD_RESOURCE_H_
@@ -63,7 +63,7 @@ namespace OIC
                                                 const OCRepresentation& rep,
                                                 const int eCode);
 
-            // Determine Specification Version Enrollee follows using header options from discovered resource
+            /// Determine Specification Version Enrollee follows using header options from discovered resource
             int GetOCFServerVersion();
 
         private:
index 3230729..cbaf441 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 ENROLLEE_RESOURCE_H_
 #define ENROLLEE_RESOURCE_H_
@@ -54,15 +54,41 @@ namespace OIC
 
             ~EnrolleeResource() = default;
 
+            /**
+             * This method is for register the get status callback
+             * @param callback     enrolle status callback
+             */
             void registerGetStatusCallback(const GetStatusCb callback);
+
+            /**
+             * This method is for register get configuration status callback
+             * @param callback     enrollee configuration status callback
+             */
             void registerGetConfigurationStatusCallback(
                 const GetConfigurationStatusCb callback);
+
+            /**
+             * This method is for register device property provision callback
+             * @param callback     Enrollee device property provisioning status callback
+             */
             void registerDevicePropProvStatusCallback(
                 const DevicePropProvStatusCb callback);
+
+            /**
+             * This method is for register connect request status callback
+             * @param              connect request status callback
+             */
             void registerConnectRequestStatusCallback(
                 const ConnectRequestStatusCb callback);
 
+            /**
+             * This method is for get enrollee's configuration
+             */
             void getConfiguration();
+
+            /**
+             * This method is for get device status
+             */
             void getStatus();
             void provisionProperties(const DeviceProp& deviceProp);
             void requestToConnect(const std::vector<ES_CONNECT_TYPE> &connectTypes);
index 906f44f..5b66663 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 _ES_MEDIATOR_SIMULATOR_H_
 #define _ES_MEDIATOR_SIMULATOR_H_
@@ -45,6 +45,11 @@ public:
     ESEnrolleeSimulator(ESEnrolleeSimulator &&) = delete;
     ESEnrolleeSimulator & operator = (ESEnrolleeSimulator &&) = delete;
 
+    /**
+     * Initialize enrollee
+     *
+     * ES_OK on success, some other value upon failure.
+     */
     ESResult initEnrollee()
     {
         ESResourceMask resourcemMask = (ESResourceMask)(ES_WIFICONF_RESOURCE |
@@ -59,6 +64,11 @@ public:
         return ESInitEnrollee(false, resourcemMask, callbacks);
     }
 
+    /**
+     * Set device information
+     *
+     * @return ES_OK on success, some other value upon failure.
+     */
     ESResult setDeviceProperty()
     {
         ESDeviceProperty deviceProperty =
@@ -74,11 +84,21 @@ public:
         return ESSetDeviceProperty(&deviceProperty);
     }
 
+    /**
+     * Set Enrollee's State
+     *
+     * @return ES_OK on success, some other value upon failure.
+     */
     ESResult setESState()
     {
         return ESSetState(ES_STATE_CONNECTED_TO_ENROLLER);
     }
 
+    /**
+     * Set Enrollee's Error Code
+     *
+     * @return ES_OK on success, some other value upon failure.
+     */
     ESResult setESErrorCode()
     {
         return ESSetErrorCode(ES_ERRCODE_NO_INTERNETCONNECTION);
index cbe6c3c..2b47ff9 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 "easysetup.h"
 #include "escommon.h"
 
 typedef struct UserProperties_t
 {
-    int userValue_int;                 /**< User-specific property in WiFi resource **/
-    char userValue_str[MAXLEN_STRING]; /**< User-specific property in DevConf resource **/
+    int userValue_int;                 /*!< User-specific property in WiFi resource **/
+    char userValue_str[MAXLEN_STRING]; /*!< User-specific property in DevConf resource **/
 } UserProperties;
 
 #define USERPROPERTY_KEY_INT "x.user.property.int"
 #define USERPROPERTY_KEY_STR "x.user.property.str"
 
+/**
+ * API to parse user-specific properties from received POST request.
+ *
+ * @param payload         Represents a received POST request
+ * @param resourceType    Used to distinguish which resource the received property belongs to
+ * @param userdata        User-specific data you want to deliver to desired users
+ */
 void ReadUserdataCb(OCRepPayload* payload, char* resourceType, void** userdata);
+
+/**
+ * API to set user-specific properties to a response going back to a client.
+ *
+ * @param payload          Represents a response
+ * @param resourceType     Used to distinguish which resource the received property belongs to
+ */
 void WriteUserdataCb(OCRepPayload* payload, char* resourceType);
 
+/**
+ * set user properties
+ *
+ * @param prop  user properties
+ */
 void SetUserProperties(const UserProperties *prop);
 
 
index 15f8b06..37efcd1 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 EASYSETUP_WIFI_CONN_H__
 #define EASYSETUP_WIFI_CONN_H__
@@ -26,6 +26,7 @@ extern "C"
 {
 #endif
 
+/** enum for wifi connection error code value */
 typedef enum
 {
     /** No error.*/ 
@@ -46,9 +47,25 @@ typedef enum
     WIFI_WRONG_PWD_ERROR,
 } WiFiConnErrCode;
 
+/**
+ * Initialize wifi for Tizen
+ * @return wifi connection error code
+ */
 WiFiConnErrCode TizenWiFiInit(void);
+/**
+ * Deintialize wifi for Tizen
+ * @return wifi connection error code
+ */
 WiFiConnErrCode TizenWiFiDeinit(void);
+/**
+ * start wifi scan for Tizen
+ * @return wifi connection error code
+ */
 WiFiConnErrCode TizenWiFiScanStart(void);
+/**
+ * connect to AP for Tizen
+ * @return wifi connection error code
+ */
 WiFiConnErrCode TizenWiFiConn(char *ssid, char* passwd);
 
 #ifdef __cplusplus