Add doxygen comments for easy-setup 55/26655/7
authorpooja <pooja.k@partner.samsung.com>
Tue, 31 Jul 2018 09:32:23 +0000 (15:02 +0530)
committerUze Choi <uzchoi@samsung.com>
Fri, 7 Sep 2018 10:22:30 +0000 (10:22 +0000)
Change-Id: I0b0870dca6ce6c9b3813e5dbf1e263beac785075
Signed-off-by: pooja <pooja.k@partner.samsung.com>
service/easy-setup/mediator/richsdk/android/EasySetupCore/src/main/jni/JniJvm.h
service/easy-setup/mediator/richsdk/android/EasySetupCore/src/main/jni/JniRemoteEnrollee.h
service/easy-setup/mediator/richsdk/inc/ESRichCommon.h
service/easy-setup/mediator/richsdk/src/CloudResource.h
service/easy-setup/mediator/richsdk/src/EnrolleeResource.h

index ce8111b..dfbe93d 100644 (file)
 #include <string>
 #include <android/log.h>
 
+/** easy setup tag information */
 #define ESTAG "ES-JNI"
+/** current version of the JNI */
 #define JNI_CURRENT_VERSION JNI_VERSION_1_6
 
+/** easy setup information logs */
 #define ES_LOGI(...) __android_log_print(ANDROID_LOG_INFO, ESTAG, __VA_ARGS__)
+/** easy setup debug logs */
 #define ES_LOGD(...) __android_log_print(ANDROID_LOG_DEBUG, ESTAG, __VA_ARGS__)
+/** easy setup error logs */
 #define ES_LOGE(...) __android_log_print(ANDROID_LOG_ERROR, ESTAG, __VA_ARGS__)
 
 extern JavaVM *g_jvm;
@@ -69,6 +74,10 @@ typedef void(*RemoveListenerCallback)(JNIEnv *env, jobject jListener);
 
 /**
  * @brief Get the native handle field
+ * @param[in] env    JNI interface pointer
+ * @param[in] jobj   java object
+ *
+ * @return field id
  */
 static jfieldID ESGetHandleField(JNIEnv *env, jobject jobj)
 {
@@ -78,6 +87,10 @@ static jfieldID ESGetHandleField(JNIEnv *env, jobject jobj)
 
 /**
  * @brief Get the native handle
+ * @param[in] env    JNI interface pointer
+ * @param[in] jobj   java object
+ *
+ * @return easy setup handle
  */
 template <typename T>
 static T *ESGetHandle(JNIEnv *env, jobject jobj)
@@ -88,6 +101,9 @@ static T *ESGetHandle(JNIEnv *env, jobject jobj)
 
 /**
  * @brief Set the native handle
+ * @param[in] env    JNI interface pointer
+ * @param[in] jobj   java object
+ * @param[in] type   type of data
  */
 template <typename T>
 static void ESSetHandle(JNIEnv *env, jobject jobj, T *type)
@@ -99,6 +115,7 @@ static void ESSetHandle(JNIEnv *env, jobject jobj, T *type)
 
 /**
  * @brief Get the JNI Environment
+ * @return JNI environment information
  */
 static JNIEnv *GetESJNIEnv(jint &ret)
 {
index 4398c6b..b4dbe74 100644 (file)
@@ -63,15 +63,21 @@ class JniRemoteEnrollee
         ~JniRemoteEnrollee();
 
         // ***** JNI APIs internally call the APIs of this class ***** //
+        /** This method is to get the enrollee status */
         void getStatus(JNIEnv *env, jobject jListener);
+        /** This method is to get the device configurations */
         void getConfiguration(JNIEnv *env, jobject jListener);
+        /** This method is for security provisioning such as ownership tranfer to Enrollee */
         void provisionSecurity(JNIEnv *env, jobject jListener);
+        /** This method is for provisioning the device properties */
         void provisionDeviceProperties(JNIEnv *env, jobject jRepresentation, jobject jListener);
+        /** This method is to provision the cloud properties */
         void provisionCloudProperties(JNIEnv *env, jobject jRepresentation,
                                                             jstring jCloudID,
                                                             jint jCredID,
                                                             jobject jListener);
 
+        /** This method is to get the remote enrollee */
         static JniRemoteEnrollee *getJniRemoteEnrollee(JNIEnv *env, jobject thiz);
 
         template <class T>
index 22a65f7..2526c83 100644 (file)
@@ -659,26 +659,46 @@ namespace OIC
                 }
             }
 
+            /**
+             * This method is to get the selected OT method
+             * @return selected otm method
+             */
             OicSecOxm_t getSelectedOTMethod() const
             {
                 return m_selectedOTMethod;
             }
 
+            /**
+             * This method is to check if MOT is enabled or not
+             * @return boolean value
+             */
             bool isMOTEnabled() const
             {
                 return m_isMOTEnabled;
             }
 
+            /**
+             * This method is to check if the device is owned or not
+             * @return boolean value
+             */
             bool isOwnedDevice() const
             {
                 return m_isOwned;
             }
 
+            /**
+             * This method is to get the owner Id
+             * @return the owner id
+             */
             const std::string getOwnerID()
             {
                 return m_ownerID;
             }
 #endif
+            /**
+             * This method is to get the device UUID
+             * @return device UUID
+             */
             const std::string getDeviceUUID()
             {
                 return m_devUUID;
@@ -1345,6 +1365,12 @@ namespace OIC
             {
             }
 
+            /**
+             * This method is to set the MOT method
+             * @param[in] method     method to set
+             *
+             * @return ES_OK if success, othewise ES_ERROR
+             */
             ESResult setMOTMethod(OicSecOxm_t method)
             {
 #ifdef MULTIPLE_OWNER
@@ -1362,6 +1388,13 @@ namespace OIC
 #endif
             }
 
+            /**
+             * This method is to set the MOT method
+             * @param[in] method     method to set
+             * @param[in] pin        pin to set
+             *
+             * @return ES_OK if success, othewise ES_ERROR
+             */
             ESResult setMOTMethod(OicSecOxm_t method, const std::string& pin)
             {
 #ifdef MULTIPLE_OWNER
@@ -1381,11 +1414,19 @@ namespace OIC
 #endif
             }
 
+            /**
+             * This method is to get the MOT method
+             * @return MOT method
+             */
             OicSecOxm_t getMOTMethod() const
             {
                 return m_MOTMethod;
             }
 
+            /**
+             * This method is to get the configured pin information
+             * @return preconfigured pin detail
+             */
             std::string getPreConfiguredPin() const
             {
                 return m_preconfiguredPin;
index f82be03..b2e6267 100644 (file)
 
 using namespace OC;
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class OCResource;
@@ -46,11 +48,23 @@ namespace OIC
         class CloudResource : public std::enable_shared_from_this<CloudResource>
         {
         public:
+            /**
+             * constructor
+             * @param[in] resource   oc resource
+             */
             CloudResource(std::shared_ptr< OC::OCResource > resource);
             ~CloudResource() = default;
 
+            /**
+             * This method is to register the callback of cloud property provisioning status
+             * @param[in] callback   cloud property provisioning status callback
+             */
             void registerCloudPropProvisioningStatusCallback(
                     const CloudPropProvStatusCb callback);
+            /**
+             * This method is to provision the cloud properties
+             * @param[in] CloudProp   cloud properties
+             */
             void provisionProperties(const CloudProp& CloudProp);
 
         private:
index cbaf441..ad32c3a 100644 (file)
 
 using namespace OC;
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class OCResource;
@@ -50,33 +52,37 @@ namespace OIC
             friend class EnrolleeSecurity;
 
         public:
+            /**
+             * constructor
+             * @param[in] resource   oc resource
+             */
             EnrolleeResource(std::shared_ptr< OC::OCResource > resource);
 
             ~EnrolleeResource() = default;
 
             /**
              * This method is for register the get status callback
-             * @param callback     enrolle status callback
+             * @param[in] callback     enrolle status callback
              */
             void registerGetStatusCallback(const GetStatusCb callback);
 
             /**
              * This method is for register get configuration status callback
-             * @param callback     enrollee configuration status callback
+             * @param[in] 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
+             * @param[in] 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
+             * @param[in] calback      connect request status callback
              */
             void registerConnectRequestStatusCallback(
                 const ConnectRequestStatusCb callback);
@@ -90,7 +96,15 @@ namespace OIC
              * This method is for get device status
              */
             void getStatus();
+            /**
+             * provision the device properties
+             * @param[in] deviceProp   device properties
+             */
             void provisionProperties(const DeviceProp& deviceProp);
+            /**
+             * This API is to request the enrollee to connect
+             * @param[in] connectTypes   connect type for enrollee
+             */
             void requestToConnect(const std::vector<ES_CONNECT_TYPE> &connectTypes);
 
         private: