Add doxygen comments for resource-encapsulation 89/26589/3
authorpooja <pooja.k@partner.samsung.com>
Wed, 25 Jul 2018 12:15:53 +0000 (17:45 +0530)
committerAshok Babu Channa <ashok.channa@samsung.com>
Mon, 30 Jul 2018 12:34:26 +0000 (12:34 +0000)
Change-Id: I87036ea9adcab811e16ea71f4d4d4235780fea48
Signed-off-by: pooja <pooja.k@partner.samsung.com>
28 files changed:
service/resource-encapsulation/android/service/src/main/jni/JniRcsDiscoveryManager.h
service/resource-encapsulation/android/service/src/main/jni/JniRcsLockedAttributes.h
service/resource-encapsulation/android/service/src/main/jni/JniRcsRemoteResourceObject.h
service/resource-encapsulation/android/service/src/main/jni/JniRcsResourceAttributes.h
service/resource-encapsulation/android/service/src/main/jni/JniRcsResourceObject.h
service/resource-encapsulation/android/service/src/main/jni/JniRcsValue.h
service/resource-encapsulation/android/service/src/main/jni/util/JNIEnvWrapper.h
service/resource-encapsulation/android/service/src/main/jni/util/JavaClasses.h
service/resource-encapsulation/android/service/src/main/jni/util/JavaExceptions.h
service/resource-encapsulation/include/RCSResourceAttributes.h
service/resource-encapsulation/src/common/expiryTimer/src/ExpiryTimerImpl.h
service/resource-encapsulation/src/common/primitiveResource/include/AssertUtils.h
service/resource-encapsulation/src/common/primitiveResource/include/RCSAddressDetail.h
service/resource-encapsulation/src/common/primitiveResource/include/ResourceAttributesConverter.h
service/resource-encapsulation/src/common/primitiveResource/include/ResourceAttributesUtils.h
service/resource-encapsulation/src/common/primitiveResource/include/ResponseStatement.h
service/resource-encapsulation/src/common/utils/include/AtomicHelper.h
service/resource-encapsulation/src/common/utils/include/UnitTestHelper.h
service/resource-encapsulation/src/common/utils/include/UnitTestHelperWithFakeOCPlatform.h
service/resource-encapsulation/src/resourceBroker/include/BrokerTypes.h
service/resource-encapsulation/src/resourceBroker/include/DeviceAssociation.h
service/resource-encapsulation/src/resourceBroker/include/DevicePresence.h
service/resource-encapsulation/src/resourceBroker/include/ResourcePresence.h
service/resource-encapsulation/src/resourceCache/include/CacheTypes.h
service/resource-encapsulation/src/resourceCache/include/DataCache.h
service/resource-encapsulation/src/resourceClient/RCSDiscoveryManagerImpl.h
service/resource-encapsulation/src/serverBuilder/include/InterfaceHandler.h
service/resource-encapsulation/src/serverBuilder/include/RequestHandler.h

index f5d21bf..8e16d30 100644 (file)
 
 #include <jni.h>
 
+/**
+ * @class JNIEnvWrapper
+ */
 class JNIEnvWrapper;
 
+/**
+ * Initialize rcs discovery manager
+ */
 void initRCSDiscoveryManager(JNIEnvWrapper*);
+
+/**
+ * clear rcs discovery manager
+ */
 void clearRCSDiscoveryManager(JNIEnvWrapper*);
 
 #ifdef __cplusplus
index 79bbb8b..f07a4ca 100644 (file)
 extern "C" {
 #endif
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeIsEmpty
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeIsEmpty
 (JNIEnv*, jclass, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeSize
+ */
 JNIEXPORT jint JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeSize
 (JNIEnv*, jclass, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeRemove
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeRemove
 (JNIEnv*, jclass, jobject, jstring keyObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeClear
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeClear
 (JNIEnv*, jclass, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeContains
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeContains
 (JNIEnv*, jclass, jobject, jstring keyObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeAddKeys
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeAddKeys
 (JNIEnv*, jclass, jobject, jstring setObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeAsJavaObject
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeAsJavaObject
 (JNIEnv*, jclass, jobject, jstring keyObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeApply
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeApply
 (JNIEnv*, jclass, jobject, jstring cacheObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeLock
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeLock
 (JNIEnv*, jobject, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsLockedAttributes
+ * Method:     nativeUnlock
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsLockedAttributes_nativeUnlock
 (JNIEnv*, jobject);
index 5086eac..315883d 100644 (file)
 
 class JNIEnvWrapper;
 
+/**
+ * Initialize rcs remote resource object
+ */
 void initRCSRemoteResourceObject(JNIEnvWrapper*);
+
+/**
+ * Clear rcs remote resource object
+ */
 void clearRCSRemoteResourceObject(JNIEnvWrapper*);
 
 jobject newRemoteResourceObject(JNIEnvWrapper*);
@@ -34,70 +41,138 @@ jobject newRemoteResourceObject(JNIEnvWrapper*);
 extern "C" {
 #endif
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeIsMonitoring
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeIsMonitoring
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeIsCaching
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeIsCaching
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeIsObservable
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeIsObservable
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeStartMonitoring
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeStartMonitoring
 (JNIEnv*, jobject, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeStopMonitoring
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeStopMonitoring
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetState
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetState
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeStartCaching
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeStartCaching
 (JNIEnv*, jobject, jobject cacheUpdateListener);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeStopCaching
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeStopCaching
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetCacheState
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetCacheState
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeIsCachedAvailable
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeIsCachedAvailable
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetCachedAttributes
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetCachedAttributes
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetRemoteAttributes
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetRemoteAttributes
 (JNIEnv*, jobject, jobject listener);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeSetRemoteAttributes
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeSetRemoteAttributes
 (JNIEnv*, jobject, jobject attrs, jobject listener);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetUri
+ */
 JNIEXPORT jstring JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetUri
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetAddress
+ */
 JNIEXPORT jstring JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetAddress
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetTypes
+ */
 JNIEXPORT jobjectArray JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetTypes
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_client_RcsRemoteResourceObject
+ * Method:     nativeGetInterfaces
+ */
 JNIEXPORT jobjectArray JNICALL
 Java_org_iotivity_service_client_RcsRemoteResourceObject_nativeGetInterfaces
 (JNIEnv*, jobject);
index 9476c67..5ab142a 100644 (file)
 
 #include <jni.h>
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class RCSResourceAttributes;
@@ -33,7 +35,14 @@ namespace OIC
 
 class JNIEnvWrapper;
 
+/**
+ * Initialize rcs resource attributes
+ */
 void initRCSResourceAttributes(JNIEnvWrapper*);
+
+/**
+ * Clear rcs resource attributes
+ */
 void clearRCSResourceAttributes(JNIEnvWrapper*);
 
 jobject newAttributesObject(JNIEnv*, const OIC::Service::RCSResourceAttributes&);
@@ -51,27 +60,59 @@ void writeNativeAttributesFromMap(JNIEnvWrapper*, jobject mapObj,
 extern "C" {
 #endif
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeIsEmpty
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeIsEmpty(JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeSize
+ */
 JNIEXPORT jint JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeSize(JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeRemove
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeRemove(JNIEnv*, jobject, jstring keyObj);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeClear
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeClear(JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeContains
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeContains(JNIEnv*, jobject, jstring keyObj);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeAddKeys
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeAddKeys(JNIEnv*, jobject, jstring setObj);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeExtract
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeExtract(JNIEnv*, jobject, jstring keyObj);
 
+/**
+ * @class:     org_iotivity_service_RcsResourceAttributes
+ * Method:     nativeExtractAll
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_RcsResourceAttributes_nativeExtractAll(JNIEnv*, jobject, jobject);
 
index 0c3aae6..f213cd0 100644 (file)
 
 class JNIEnvWrapper;
 
+/**
+ * Initialize rcs resource object
+ */
 void initRCSResourceObject(JNIEnvWrapper*);
+
+/**
+ * Clear rcs resource object
+ */
 void clearRCSResourceObject(JNIEnvWrapper*);
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * @class:     org_iotivity_service_server_RcsResponse
+ * Method:     nativeGetDefaultErrorCode
+ */
 JNIEXPORT jint JNICALL
 Java_org_iotivity_service_server_RcsResponse_nativeGetDefaultErrorCode
 (JNIEnv*, jclass);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeBuild
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeBuild
 (JNIEnv*, jclass, jstring uri, jstring type, jstring interface, jboolean isObservable,
         jboolean isDiscovervable, jobject attrs);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeSetAttribute
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeSetAttribute
 (JNIEnv*, jobject, jstring key, jobject value);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeGetAttributeValue
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeGetAttributeValue
 (JNIEnv*, jobject, jstring key);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeRemoveAttribute
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeRemoveAttribute
 (JNIEnv*, jobject, jstring key);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeContainsAttribute
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeContainsAttribute
 (JNIEnv*, jobject, jstring key);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeGetAttributes
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeGetAttributes
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeIsObservable
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeIsObservable
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeIsDiscoverable
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeIsDiscoverable
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeSetGetRequestHandler
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeSetGetRequestHandler
 (JNIEnv*, jobject, jobject handler);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeSetSetRequestHandler
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeSetSetRequestHandler
 (JNIEnv*, jobject, jobject handler);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeAddAttributeUpdatedListener
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeAddAttributeUpdatedListener
 (JNIEnv*, jobject, jstring key, jobject listenr);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeRemoveAttributeUpdatedListener
+ */
 JNIEXPORT jboolean JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeRemoveAttributeUpdatedListener
 (JNIEnv*, jobject, jstring key);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeNotify
+ */
 JNIEXPORT void JNICALL Java_org_iotivity_service_server_RcsResourceObject_nativeNotify
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeSetAutoNotifyPolicy
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeSetAutoNotifyPolicy
 (JNIEnv*, jobject, jobject policyObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeGetAutoNotifyPolicy
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeGetAutoNotifyPolicy
 (JNIEnv*, jobject);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeSetSetRequestHandlerPolicy
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeSetSetRequestHandlerPolicy
 (JNIEnv*, jobject, jobject policyObj);
 
+/**
+ * @class:     org_iotivity_service_server_RcsResourceObject
+ * Method:     nativeGetSetRequestHandlerPolicy
+ */
 JNIEXPORT jobject JNICALL
 Java_org_iotivity_service_server_RcsResourceObject_nativeGetSetRequestHandlerPolicy
 (JNIEnv*, jobject);
index c27c23f..2e5de10 100644 (file)
 
 class JNIEnvWrapper;
 
+/**
+ * Initialize rcs value
+ */
 void initRCSValue(JNIEnvWrapper*);
+
+/**
+ * Clear rcs value
+ */
 void clearRCSValue(JNIEnvWrapper*);
 
 OIC::Service::RCSResourceAttributes::Value toNativeAttrsValue(JNIEnv*, jobject);
index facc807..22b9345 100644 (file)
 
 #include "JavaLocalRef.h"
 
+/**
+ * @class JavaException
+ */
 class JavaException: public std::exception
 {
 };
 
+/*
+ * @class JNIEnvWrapper
+ */
 class JNIEnvWrapper
 {
 public:
@@ -43,11 +49,18 @@ public:
         return *this;
     }
 
+    /**
+     *  check the object is same or not
+     *  compare the lhs and rhs object
+     */
     jboolean IsSameObject(jobject lhs, jobject rhs)
     {
         return m_env->IsSameObject(lhs, rhs);
     }
 
+    /* get object class
+     * @param obj   object
+     */
     jclass GetObjectClass(jobject obj)
     {
         auto ret = m_env->GetObjectClass(obj);
@@ -55,6 +68,11 @@ public:
         return ret;
     }
 
+    /**
+     * This method is to find the class
+     * @param name    name of class to find
+     * @return the class
+     */
     jclass FindClass(const char* name)
     {
         auto ret = m_env->FindClass(name);
@@ -62,6 +80,11 @@ public:
         return ret;
     }
 
+    /**
+     * This method is to find class as global reference
+     * @param name   name of reference to find
+     * @return the new reference class
+     */
     jclass FindClassAsGlobalRef(const char* name)
     {
         JavaLocalClass cls{ m_env, FindClass(name) };
@@ -69,6 +92,11 @@ public:
         return NewGlobalRef(cls);
     }
 
+    /**
+     * This method is to create new global reference
+     * @pram obj   new object to create
+     * @return the new object
+     */
     jobject NewGlobalRef(jobject obj)
     {
         auto ret = m_env->NewGlobalRef(obj);
@@ -92,11 +120,15 @@ public:
         return ret;
     }
 
+    /** This method is to delete global reference */
     void DeleteGlobalRef(jobject obj)
     {
         m_env->DeleteGlobalRef(obj);
     }
 
+    /**
+     * This method is to create new object
+     */
     jobject NewObject(jclass cls, jmethodID ctor, ...)
     {
         va_list args;
@@ -108,6 +140,7 @@ public:
         return ret;
     }
 
+    /** new string UTF */
     jstring NewStringUTF(const char* str)
     {
         auto ret = m_env->NewStringUTF(str);
@@ -115,6 +148,7 @@ public:
         return ret;
     }
 
+    /** get string UTF chars */
     const char* GetStringUTFChars(jstring str, jboolean* isCopy)
     {
         auto ret = m_env->GetStringUTFChars(str, isCopy);
@@ -122,12 +156,14 @@ public:
         return ret;
     }
 
+    /** release string UTF chars */
     void ReleaseStringUTFChars(jstring str, const char* chars)
     {
         m_env->ReleaseStringUTFChars(str, chars);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** get constructor Id */
     jmethodID GetConstructorID(jclass cls, const char* sig)
     {
         auto ret = m_env->GetMethodID(cls, "<init>", sig);
@@ -135,6 +171,7 @@ public:
         return ret;
     }
 
+    /** get method Id */
     jmethodID GetMethodID(jclass cls, const char* name, const char* sig)
     {
         auto ret = m_env->GetMethodID(cls, name, sig);
@@ -142,6 +179,7 @@ public:
         return ret;
     }
 
+    /** get static method Id */
     jmethodID GetStaticMethodID(jclass cls, const char* name, const char* sig)
     {
         auto ret = m_env->GetStaticMethodID(cls, name, sig);
@@ -149,7 +187,7 @@ public:
         return ret;
     }
 
-
+    /** get field Id */
     jfieldID GetFieldID(jclass cls, const char* name, const char* sig)
     {
         auto ret = m_env->GetFieldID(cls, name, sig);
@@ -157,6 +195,7 @@ public:
         return ret;
     }
 
+    /** get static field Id */
     jfieldID GetStaticFieldID(jclass cls, const char* name, const char* sig)
     {
         auto ret = m_env->GetStaticFieldID(cls, name, sig);
@@ -164,6 +203,7 @@ public:
         return ret;
     }
 
+    /** get static object field */
     jobject GetStaticObjectField(jclass cls, jfieldID fieldId)
     {
         auto ret = m_env->GetStaticObjectField(cls, fieldId);
@@ -171,11 +211,13 @@ public:
         return ret;
     }
 
+    /* get static object filed */
     jobject GetStaticObjectField(jclass cls, const char* name, const char* sig)
     {
         return GetStaticObjectField(cls, GetStaticFieldID(cls, name, sig));
     }
 
+    /** get Int filed */
     jint GetIntField(jobject obj, jfieldID fieldId)
     {
         auto ret = m_env->GetIntField(obj, fieldId);
@@ -183,6 +225,7 @@ public:
         return ret;
     }
 
+    /** get long field */
     jlong GetLongField(jobject obj, jfieldID fieldId)
     {
         auto ret = m_env->GetLongField(obj, fieldId);
@@ -190,12 +233,14 @@ public:
         return ret;
     }
 
+    /** set long field */
     void SetLongField(jobject obj, jfieldID fieldId, jlong val)
     {
         m_env->SetLongField(obj, fieldId, val);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** get object field */
     jobject GetObjectField(jobject obj, jfieldID fieldId)
     {
         auto ret = m_env->GetObjectField(obj, fieldId);
@@ -203,6 +248,7 @@ public:
         return ret;
     }
 
+    /** call static Int method */
     jint CallStaticIntMethod(jclass cls, jmethodID methodId, ...)
     {
         va_list args;
@@ -213,6 +259,7 @@ public:
         return ret;
     }
 
+    /** call static object method */
     jobject CallStaticObjectMethod(jclass cls, jmethodID methodId, ...)
     {
         va_list args;
@@ -223,6 +270,7 @@ public:
         return ret;
     }
 
+    /** call void method */
     void CallVoidMethod(jobject obj, jmethodID methodId, ...)
     {
          va_list args;
@@ -232,6 +280,7 @@ public:
          if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** call boolean method */
     jboolean CallBooleanMethod(jobject obj, jmethodID methodId, ...)
     {
         va_list args;
@@ -242,6 +291,7 @@ public:
         return ret;
     }
 
+    /** call Int method */
     jint CallIntMethod(jobject obj, jmethodID methodId, ...)
     {
          va_list args;
@@ -252,6 +302,7 @@ public:
          return ret;
     }
 
+     /** call double method */
      jdouble CallDoubleMethod(jobject obj, jmethodID methodId, ...)
      {
           va_list args;
@@ -262,7 +313,7 @@ public:
           return ret;
      }
 
-
+    /** call object method */
     jobject CallObjectMethod(jobject obj, jmethodID methodId, ...)
     {
         va_list args;
@@ -273,6 +324,11 @@ public:
         return ret;
     }
 
+    /*
+     * create new boolean array
+     *
+     * @param len   size of array
+     */
     jbooleanArray NewBooleanArray(jsize len)
     {
         auto ret = m_env->NewBooleanArray(len);
@@ -280,6 +336,11 @@ public:
         return ret;
     }
 
+    /*
+     * create new Int array
+     *
+     * @param len   size of array
+     */
     jintArray NewIntArray(jsize len)
     {
         auto ret = m_env->NewIntArray(len);
@@ -287,6 +348,11 @@ public:
         return ret;
     }
 
+    /*
+     * create new double array
+     *
+     * @param len   size of array
+     */
     jdoubleArray NewDoubleArray(jsize len)
     {
         auto ret = m_env->NewDoubleArray(len);
@@ -294,6 +360,11 @@ public:
         return ret;
     }
 
+    /*
+     * create new byte array
+     *
+     * @param len   size of array
+     */
     jbyteArray NewByteArray(jsize len)
     {
         auto ret = m_env->NewByteArray(len);
@@ -301,6 +372,7 @@ public:
         return ret;
     }
 
+  /* new object array */
   jobjectArray NewObjectArray(jsize len, jclass cls, jobject init)
     {
         auto ret = m_env->NewObjectArray(len, cls, init);
@@ -308,6 +380,13 @@ public:
         return ret;
     }
 
+    /**
+     * get array length
+     *
+     * @param array   find length of this array
+     *
+     * @return size of array
+     */
     jsize GetArrayLength(jarray array)
     {
         auto ret = m_env->GetArrayLength(array);
@@ -315,6 +394,7 @@ public:
         return ret;
     }
 
+    /** get object array element */
     jobject GetObjectArrayElement(jobjectArray array, jsize index)
     {
         auto ret = m_env->GetObjectArrayElement(array, index);
@@ -322,6 +402,7 @@ public:
         return ret;
     }
 
+    /** get byte array element */
     jbyte *GetByteArrayElements(jbyteArray array, jboolean *value)
     {
         auto ret = m_env->GetByteArrayElements(array, value);
@@ -329,36 +410,42 @@ public:
         return ret;
     }
 
+    /** set object array element */
     void SetObjectArrayElement(jobjectArray array, jsize index, jobject val)
     {
         m_env->SetObjectArrayElement(array, index, val);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** set boolean array region */
     void SetBooleanArrayRegion(jbooleanArray array, jsize start, jsize len, const jboolean* buf)
     {
         m_env->SetBooleanArrayRegion(array, start, len, buf);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** set Integer array region */
     void SetIntArrayRegion(jintArray array, jsize start, jsize len, const jint* buf)
     {
         m_env->SetIntArrayRegion(array, start, len, buf);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** set double array region */
     void SetDoubleArrayRegion(jdoubleArray array, jsize start, jsize len, const jdouble* buf)
     {
         m_env->SetDoubleArrayRegion(array, start, len, buf);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** set byte array region */
     void SetByteArrayRegion(jbyteArray array, jsize start, jsize len, const jbyte *buf)
     {
         m_env->SetByteArrayRegion(array, start, len, buf);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** get primitive array critical */
     void* GetPrimitiveArrayCritical(jarray array, jboolean* isCopy)
     {
         auto ret = m_env->GetPrimitiveArrayCritical(array, isCopy);
@@ -366,34 +453,40 @@ public:
         return ret;
     }
 
+    /** release primitive array critical */
     void ReleasePrimitiveArrayCritical(jarray array, void* carray, int mode)
     {
         m_env->ReleasePrimitiveArrayCritical(array, carray, mode);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** release byte array element */
     void ReleaseByteArrayElements(jbyteArray array, jbyte* byteArray, int mode)
     {
         m_env->ReleaseByteArrayElements(array, byteArray, mode);
         if (m_env->ExceptionCheck()) throw JavaException();
     }
 
+    /** throw exception */
     void ThrowNew(jclass cls, const char* msg)
     {
         m_env->ThrowNew(cls, msg);
         throw JavaException();
     }
 
+    /** exception describe */
     void ExceptionDescribe() const noexcept
     {
         m_env->ExceptionDescribe();
     }
 
+    /** exception clear */
     void ExceptionClear() noexcept
     {
         m_env->ExceptionClear();
     }
 
+    /** exception check */
     jboolean ExceptionCheck() const noexcept
     {
         return m_env->ExceptionCheck();
@@ -404,6 +497,7 @@ public:
         return m_env != nullptr;
     }
 
+    /** get environment */
     JNIEnv* get() const
     {
         return m_env;
index 10033ad..a174ba3 100644 (file)
 
 #include <string>
 
-#define PACKAGE_NAME "org/iotivity/service"
+#define PACKAGE_NAME "org/iotivity/service"     /*!< package name */
 
-#define CLS_NAME_VALUE PACKAGE_NAME "/RcsValue"
+#define CLS_NAME_VALUE PACKAGE_NAME "/RcsValue" /*!< cls name value */
 
-#define CLS_NAME_RESOURCEATTRIBUTES PACKAGE_NAME "/RcsResourceAttributes"
-#define CLS_NAME_REMOTERESOURCEOBJECT PACKAGE_NAME "/client/RcsRemoteResourceObject"
-#define CLS_NAME_RESOURCEBYTESTRING PACKAGE_NAME "/RcsByteString"
+#define CLS_NAME_RESOURCEATTRIBUTES PACKAGE_NAME "/RcsResourceAttributes" /*!< resource attribute name */
+#define CLS_NAME_REMOTERESOURCEOBJECT PACKAGE_NAME "/client/RcsRemoteResourceObject" /*!< remote resource object name */
+#define CLS_NAME_RESOURCEBYTESTRING PACKAGE_NAME "/RcsByteString" /*!< resource byte string name */
 
-#define CLS_NAME_OBJECT "java/lang/Object"
-#define CLS_NAME_STRING "java/lang/String"
-#define CLS_NAME_INTEGER "java/lang/Integer"
-#define CLS_NAME_DOUBLE "java/lang/Double"
-#define CLS_NAME_BOOLEAN "java/lang/Boolean"
+#define CLS_NAME_OBJECT "java/lang/Object"   /*!< object name */
+#define CLS_NAME_STRING "java/lang/String"   /*!< string name */
+#define CLS_NAME_INTEGER "java/lang/Integer" /*!< Integer name */
+#define CLS_NAME_DOUBLE "java/lang/Double"   /*!< double name */
+#define CLS_NAME_BOOLEAN "java/lang/Boolean" /*!< boolean name */
 
-#define CLS_NAME_COLLECTION "java/util/Collection"
-#define CLS_NAME_ARRAY_LIST "java/util/ArrayList"
-#define CLS_NAME_SET "java/util/Set"
-#define CLS_NAME_MAP "java/util/Map"
-#define CLS_NAME_MAP_ENTRY "java/util/Map$Entry"
-#define CLS_NAME_ITERATOR "java/util/Iterator"
+#define CLS_NAME_COLLECTION "java/util/Collection" /*!< collection name */
+#define CLS_NAME_ARRAY_LIST "java/util/ArrayList"  /*!< array list */
+#define CLS_NAME_SET "java/util/Set"               /*!< set name */
+#define CLS_NAME_MAP "java/util/Map"               /*!< map name */
+#define CLS_NAME_MAP_ENTRY "java/util/Map$Entry"   /*!< map entry name */
+#define CLS_NAME_ITERATOR "java/util/Iterator"     /*!< iterator name */
 
-#define EXC_NAME_RCS PACKAGE_NAME "/RcsException"
-#define EXC_NAME_PLATFORM PACKAGE_NAME "/RcsPlatformException"
-#define EXC_NAME_ILLEGAL_STATE PACKAGE_NAME "/RcsIllegalStateException"
+#define EXC_NAME_RCS PACKAGE_NAME "/RcsException"              /*!< resource exception */
+#define EXC_NAME_PLATFORM PACKAGE_NAME "/RcsPlatformException" /*!< platform exception */
+#define EXC_NAME_ILLEGAL_STATE PACKAGE_NAME "/RcsIllegalStateException" /*!< illegal exception */
 
 #define AS_SIG(CLS_NAME) "L" CLS_NAME ";"
 
@@ -91,30 +91,45 @@ extern jmethodID g_ctor_ArrayList;
 void initJavaClasses(JNIEnvWrapper*);
 void clearJavaClasses(JNIEnvWrapper*);
 
+/**
+ * new boolean object
+ */
 template< typename ENV >
 inline jobject newBooleanObject(ENV* env, bool value)
 {
     return env->NewObject(g_cls_Boolean, g_ctor_Boolean, value);
 }
 
+/**
+ * new Integer object
+ */
 template< typename ENV >
 inline jobject newIntegerObject(ENV* env, int value)
 {
     return env->NewObject(g_cls_Integer, g_ctor_Integer, value);
 }
 
+/**
+ * new double object
+ */
 template< typename ENV >
 inline jobject newDoubleObject(ENV* env, double value)
 {
     return env->NewObject(g_cls_Double, g_ctor_Double, value);
 }
 
+/**
+ * new string object
+ */
 template< typename ENV >
 inline jstring newStringObject(ENV* env, const std::string& value)
 {
     return env->NewStringUTF(value.c_str());
 }
 
+/**
+ * new string object
+ */
 template< typename ENV >
 inline jstring newStringObjectCstr(ENV* env, const char* value)
 {
@@ -137,6 +152,9 @@ inline std::string toStdString(ENV* env, jstring obj)
     return result;
 }
 
+/**
+ * new array list
+ */
 template< typename ENV >
 inline jobject newArrayList(ENV* env)
 {
index eccbf0d..c0c469c 100644 (file)
 
 #include "JavaClasses.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class RCSPlatformException;
@@ -35,9 +37,19 @@ namespace OIC
 
 class JNIEnvWrapper;
 
+/**
+ * initialize java exception
+ */
 void initJavaExceptions(JNIEnvWrapper*);
+
+/**
+ * clear java exception
+ */
 void clearJavaExceptions(JNIEnvWrapper*);
 
+/**
+ * throw platform exception
+ */
 void throwPlatformException(JNIEnv*, const OIC::Service::RCSPlatformException&);
 
 template < typename ENV >
index 0973af2..10fd844 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.
+ *
+ ******************************************************************/
 
 /**
  * @file
@@ -26,8 +26,8 @@
 #ifndef RES_ENCAPSULATION_RESOURCEATTRIBUTES_H
 #define RES_ENCAPSULATION_RESOURCEATTRIBUTES_H
 
-// To avoid conflict using different boost::variant configuration with OC.
-// It causes compile errors.
+/// To avoid conflict using different boost::variant configuration with OC.
+/// It causes compile errors.
 #define BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS
 #define BOOST_MPL_LIMIT_LIST_SIZE 30
 #define BOOST_MPL_LIMIT_VECTOR_SIZE 30
@@ -45,6 +45,7 @@
 
 #include "RCSException.h"
 
+/** OIC namespace */
 namespace OIC
 {
     namespace Service
index 084ce3c..ed9c62f 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 _EXPIRY_TIMER_IMPL_H_
 #define _EXPIRY_TIMER_IMPL_H_
 #include <unordered_set>
 #include <atomic>
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class TimerTask;
@@ -56,11 +58,13 @@ namespace OIC
             ExpiryTimerImpl& operator=(const ExpiryTimerImpl&) = delete;
 
         public:
+            /** This API is to get instance */
             static ExpiryTimerImpl* getInstance();
 
             std::shared_ptr< TimerTask > post(DelayInMillis, Callback);
-
+            /** This API is cancel for given Id */
             bool cancel(Id);
+            /** This API is to cancel all */
             size_t cancelAll(const std::unordered_set< std::shared_ptr<TimerTask > >&);
 
         private:
@@ -110,7 +114,9 @@ namespace OIC
             TimerTask& operator=(const TimerTask&) = delete;
             TimerTask& operator=(TimerTask&&) = delete;
 
+            /** API is to check executed or not */
             bool isExecuted() const;
+            /** API is to get Id */
             ExpiryTimerImpl::Id getId() const;
 
         private:
@@ -123,6 +129,6 @@ namespace OIC
             friend class ExpiryTimerImpl;
         };
 
-    }
-}
+    } /** service namespace */
+} /** OIC namespace */
 #endif //_EXPIRY_TIMER_IMPL_H_
index 6265dad..16fd2c9 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 COMMON_INTERNAL_ASSERTUTILS_H
 #define COMMON_INTERNAL_ASSERTUTILS_H
@@ -37,20 +37,21 @@ namespace OIC
     {
         namespace Detail
         {
-
-            // This is a helper class to avoid calling the base layer during terminating the process.
-            // The reason why you should not call the base layer in this situation is that
-            // OC apis are singletons or internally implemented as singleton.
-            // Singleton implemented with a static variable is initialized
-            // in the first call to the function.
-            // It means you can not guarantee the order of initialization of the singletons,
-            // which is the reverse order of destruction.
-            // Some of RE classes are also implemented as singletons.
-            // Now we have a problem if RE tries to call one of OC apis
-            // after OC classes are destroyed first.
-            // To solve this issue, it registers exit handler to catch the termination event.
-            // Keep this information with a bool flag dynamically allocated to
-            // make sure it is not destroyed during the destruction of the static objects.
+            /**
+             * This is a helper class to avoid calling the base layer during terminating the process.
+             * The reason why you should not call the base layer in this situation is that
+             * OC apis are singletons or internally implemented as singleton.
+             * Singleton implemented with a static variable is initialized
+             * in the first call to the function.
+             * It means you can not guarantee the order of initialization of the singletons,
+             * which is the reverse order of destruction.
+             * Some of RE classes are also implemented as singletons.
+             * Now we have a problem if RE tries to call one of OC apis
+             * after OC classes are destroyed first.
+             * To solve this issue, it registers exit handler to catch the termination event.
+             * Keep this information with a bool flag dynamically allocated to
+             * make sure it is not destroyed during the destruction of the static objects.
+             */
             class TerminationChecker
             {
             private:
@@ -298,4 +299,4 @@ namespace OIC
     }
 }
 
-#endif // COMMON_INTERNAL_ASSERTUTILS_H
+#endif /* COMMON_INTERNAL_ASSERTUTILS_H */
index 4a52eaf..34dd85b 100644 (file)
@@ -1,30 +1,32 @@
-//******************************************************************
-//
-// 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 OIC_SERVICE_RCSADDRESSDETAIL_H
 #define OIC_SERVICE_RCSADDRESSDETAIL_H
 
 #include <string>
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class RCSAddress;
@@ -32,6 +34,7 @@ namespace OIC
         class RCSAddressDetail
         {
         public:
+            /** API is to get rcs details */
             static const RCSAddressDetail* getDetail(const RCSAddress&);
 
             RCSAddressDetail(const std::string& addr);
@@ -39,13 +42,14 @@ namespace OIC
 
             const std::string& getAddress() const;
 
+            /** API is to check multicast */
             bool isMulticast() const;
 
         private:
             std::string m_addr;
         };
 
-    }
-}
+    } /** service namespace */
+} /** OIC namespace */
 
 #endif // OIC_SERVICE_RCSADDRESSDETAIL_H
index 0fb93ef..90e7d03 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 COMMON_RESOURCEATTRIBUTESCONVERTER_H
 #define COMMON_RESOURCEATTRIBUTESCONVERTER_H
@@ -25,6 +25,7 @@
 
 #include <OCRepresentation.h>
 
+//OIC namespace
 namespace OIC
 {
     namespace Service
@@ -221,6 +222,7 @@ namespace OIC
             public:
                 ResourceAttributesBuilder() = default;
 
+                /** insert items */
                 void insertItem(const OC::OCRepresentation::AttributeItem& item)
                 {
                     switch (item.depth())
index f83b003..bb7274c 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 COMMON_RESOURCEATTRIBUTESUTILS_H
 #define COMMON_RESOURCEATTRIBUTESUTILS_H
 
 #include <RCSResourceAttributes.h>
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         typedef std::pair< std::string, RCSResourceAttributes::Value > AttrKeyValuePair;
         typedef std::vector< AttrKeyValuePair > AttrKeyValuePairs;
 
+        /** acceptable resource attributes */
         bool acceptableAttributes(const RCSResourceAttributes& dest, const RCSResourceAttributes& attr);
 
+        /** acceptable resource attribute value */
         bool acceptableAttributeValue(const RCSResourceAttributes::Value& dest,
                 const RCSResourceAttributes::Value& value);
 
+        /** replace resource attributes */
         AttrKeyValuePairs replaceAttributes(RCSResourceAttributes& dest,
                 const RCSResourceAttributes& attrs);
     }
index 8c49dc3..1acb596 100644 (file)
@@ -1,30 +1,34 @@
-//******************************************************************
-//
-// 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 COMMON_RESPONSESTATEMENT_H
 #define COMMON_RESPONSESTATEMENT_H
 
 #include "RCSRepresentation.h"
 
+/**
+ * OIC namespace
+ */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         typedef RCSRepresentation ResponseStatement;
index 9a48d37..efa0fb9 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 COMMON_UTILS_ATOMICHELPER_H
 #define COMMON_UTILS_ATOMICHELPER_H
 #define RCS_USE_CUSTOM_ATOMIC
 #endif
 
+/** OIC namespace */
 namespace OIC
 {
+    /** Service namespace */
     namespace Service
     {
+        /** Detail namespace */
         namespace Detail
         {
 
@@ -230,7 +233,7 @@ namespace OIC
             }
 #endif
 
-        } // namespace detail
+        } /* namespace detail */
 
         template < typename T >
         struct AtomicBase
@@ -303,4 +306,4 @@ namespace OIC
     }
 }
 
-#endif // COMMON_UTILS_ATOMICHELPER_H
+#endif /* COMMON_UTILS_ATOMICHELPER_H */
index 14bfca2..7599166 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 COMMON_UTILS_UNITTESTHELPER_H
 #define COMMON_UTILS_UNITTESTHELPER_H
@@ -24,6 +24,9 @@
 #include <gtest/gtest.h>
 #include <HippoMocks/hippomocks.h>
 
+/**
+ * @class TestWithMock
+ */
 class TestWithMock: public testing::Test
 {
 public:
index 6a2401c..bc8bac7 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 COMMON_UTIL_UNITTESTHELPERWITHFAKEOCPLATFORM_H
 #define COMMON_UTIL_UNITTESTHELPERWITHFAKEOCPLATFORM_H
 using namespace std;
 using namespace std::placeholders;
 
+/**
+ * @class FakeOCPlatform
+ */
 class FakeOCPlatform
 {
 public:
+    /** API is to subscribe the resource presence */
     virtual OCStackResult subscribePresence(OC::OCPlatform::OCPresenceHandle& a,
                                             const std::string& b, OCConnectivityType c,
                                             OC::SubscribeCallback d);
 
+    /** API is to subscribe presence2 */
     virtual OCStackResult subscribePresence2(OC::OCPlatform::OCPresenceHandle& a,
                                              const std::string& b, const std::string& c,
                                              OCConnectivityType d, OC::SubscribeCallback e);
 
+    /** API is to unsubscribe resource presence */
     virtual OCStackResult unsubscribePresence(OC::OCPlatform::OCPresenceHandle a);
 
+    /** API is to find the resource */
     virtual OCStackResult findResource(const std::string& a, const std::string& b,
                                OCConnectivityType c, OC::FindCallback d);
+    /** API is to register the resource */
     virtual OCStackResult registerResource(OCResourceHandle&, string&, const string&, const string&,
                OC::EntityHandler, uint8_t ) = 0;
+    /** This method is for unregister resource */
     virtual OCStackResult unregisterResource(const OCResourceHandle &) = 0;
 
+    /** This method is for send response */
     virtual OCStackResult sendResponse(const std::shared_ptr<OC::OCResourceResponse>) = 0;
+    /** This method is to bind interface to resource */
     virtual OCStackResult bindInterfaceToResource(
             const OCResourceHandle &, const std::string &) = 0;
+    /** This method is to bind the type to resource */
     virtual OCStackResult bindTypeToResource(const OCResourceHandle &, const std::string &) = 0;
+    /** This method is for bind the resource */
     virtual OCStackResult bindResource(const OCResourceHandle, const OCResourceHandle) = 0;
-
+    /** notify all observers */
     virtual OCStackResult notifyAllObservers(OCResourceHandle) = 0;
 
     virtual ~FakeOCPlatform() { }
@@ -63,42 +76,57 @@ public:
 extern MockRepository mocks;
 extern FakeOCPlatform * mockFakePlatform;
 
+/** namespace */
 namespace OC
 {
     namespace OCPlatform
     {
+        /** This method is for subscribe the resource presence */
         OCStackResult subscribePresence(OCPresenceHandle& a, const std::string& b,
                                         OCConnectivityType c, SubscribeCallback d);
 
+        /** This method is for subscribe presence */
         OCStackResult subscribePresence(OCPresenceHandle& a, const std::string& b,
                                         const std::string& c, OCConnectivityType d,
                                         SubscribeCallback e);
 
+        /** This method is forunsubscribe presence */
         OCStackResult unsubscribePresence(OCPresenceHandle a);
 
+        /** This method is for find resource */
         OCStackResult findResource(const std::string& a, const std::string& b,
                                    OCConnectivityType c, FindCallback d);
 
+        /** This method is for register resource */
         OCStackResult registerResource(
                 OCResourceHandle &a, string &b, const string &c,
                 const string &d, EntityHandler e, uint8_t f);
 
+        /** This method is for unregister resource */
         OCStackResult unregisterResource(const OCResourceHandle &a);
 
+        /** This method is for bind resource */
         OCStackResult bindResource(const OCResourceHandle a, const OCResourceHandle b);
 
+        /** This method is for send response */
         OCStackResult sendResponse(const std::shared_ptr<OCResourceResponse> a);
 
+        /** This method is for bind the type to resource */
         OCStackResult bindTypeToResource(const OCResourceHandle &a,
                                 const std::string &b);
 
+        /** This method is for bind the interface to resource */
         OCStackResult bindInterfaceToResource(const OCResourceHandle &a,
                                               const std::string &b);
 
+        /** This method is for notify to all observers */
         OCStackResult notifyAllObservers(OCResourceHandle a);
     }
 }
 
+/**
+ * @class TestWithExternMock
+ */
 class TestWithExternMock: public testing::Test
 {
 protected:
index 8d2c0a2..3ba98de 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 RB_BROKERTYPES_H_
 #define RB_BROKERTYPES_H_
 #include "experimental/logger.h"
 #include "PrimitiveResource.h"
 
+/** namespace */
 namespace OIC
 {
     namespace Service
     {
-        #define BROKER_TAG "BROKER"
-        #define BROKER_DEVICE_PRESENCE_TIMEROUT (15000l)
-        #define BROKER_SAFE_SECOND (5l)
-        #define BROKER_SAFE_MILLISECOND (BROKER_SAFE_SECOND * (1000))
-        #define BROKER_TRANSPORT OCConnectivityType::CT_ADAPTER_IP
+        #define BROKER_TAG "BROKER"                      /*!< broker tag information */
+        #define BROKER_DEVICE_PRESENCE_TIMEROUT (15000l) /*!< broker device presence timeout value */
+        #define BROKER_SAFE_SECOND (5l)                  /*!< broker safe secons */
+        #define BROKER_SAFE_MILLISECOND (BROKER_SAFE_SECOND * (1000)) /*!< safe millisecons */
+        #define BROKER_TRANSPORT OCConnectivityType::CT_ADAPTER_IP    /*!< transport type */
 
-        /*
+        /**
          * @BROKER_STATE
          * brief : resourcePresence state
          * ALIVE       - It means that 'getCB' function receives 'OK' message
@@ -57,7 +58,7 @@ namespace OIC
             NONE
         };
 
-        /*
+        /**
          * @DEVICE_STATE
          * brief : devicePresence state
          * ALIVE       - It means that 'subscribeCB' function receives 'OK' message
@@ -66,25 +67,25 @@ namespace OIC
          */
         enum class DEVICE_STATE
         {
-            ALIVE = 0,
-            REQUESTED,
-            LOST_SIGNAL
+            ALIVE = 0,            /*!< alive state */
+            REQUESTED,            /*!< requested state */
+            LOST_SIGNAL           /*!< lost signal state */
         };
 
         enum class BROKER_MODE
         {
-            DEVICE_PRESENCE_MODE = 0,
-            NON_PRESENCE_MODE
+            DEVICE_PRESENCE_MODE = 0,  /*!< device presence mode */
+            NON_PRESENCE_MODE          /*!< none device presence mode */
         };
 
-        typedef unsigned int BrokerID;
+        typedef unsigned int BrokerID;  /*!< broker ID */
 
         typedef std::function<void(BROKER_STATE)> BrokerCB;
         struct BrokerRequesterInfo
         {
             BrokerRequesterInfo(BrokerID _id, BrokerCB _cb) : brokerId(_id), brokerCB(_cb){}
-            BrokerID brokerId;
-            BrokerCB brokerCB;
+            BrokerID brokerId;  /*!< broker Id */
+            BrokerCB brokerCB;  /*!< broker callback */
         };
         typedef std::shared_ptr<BrokerRequesterInfo> BrokerRequesterInfoPtr;
 
@@ -113,7 +114,7 @@ namespace OIC
 
         typedef std::function<void(const HeaderOptions&, const ResponseStatement&, int)> RequestGetCB;
         typedef std::function<void(long long)> TimerCB;
-    } // namespace Service
-} // namespace OIC
+    } /* namespace Service */
+} /* namespace OIC */
 
-#endif // RB_BROKERTYPES_H_
+#endif /* RB_BROKERTYPES_H_ */
index 1f3bc2a..d120902 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 RB_DEVICEASSOCIATION_H_
 #define RB_DEVICEASSOCIATION_H_
 
 #include "BrokerTypes.h"
 
-
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class DeviceAssociation {
         public:
 
+            /** This method is for get instance */
             static DeviceAssociation * getInstance();
 
+            /** This method is for find device with the given information */
             DevicePresencePtr findDevice(const std::string & address);
+            /** This method is for add new device */
             void addDevice(DevicePresencePtr dPresence);
+            /** This method is for remove device */
             void removeDevice(DevicePresencePtr dPresence);
+            /** This method is for Check device list is empty or not */
             bool isEmptyDeviceList();
 
         private:
@@ -52,7 +58,7 @@ namespace OIC
             static std::mutex s_mutexForCreation;
             static std::list< DevicePresencePtr > s_deviceList;
         };
-    } // namespace Service
-} // namespace OIC
+    } /** namespace Service */
+} /** namespace OIC */
 
 #endif /* RB_DEVICEASSOCIATION_H_ */
index c34f876..5116907 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 RB_DEVICEPRESENCE_H_
 #define RB_DEVICEPRESENCE_H_
 #include "PresenceSubscriber.h"
 #include "ExpiryTimer.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class DevicePresence
@@ -48,13 +50,19 @@ namespace OIC
             DevicePresence & operator = (DevicePresence &&) = delete;
             DevicePresence & operator = (const DevicePresence &) = delete;
 
+            /** This method is for initialize device presence */
             void initializeDevicePresence(PrimitiveResourcePtr pResource);
 
+            /** This method is for add presence resource */
             void addPresenceResource(ResourcePresence * rPresence);
+            /** This method is for remove presence resource */
             void removePresenceResource(ResourcePresence * rPresence);
 
+            /** This method is for check resource */
             bool isEmptyResourcePresence() const;
+            /** This method is for get address */
             const std::string getAddress() const;
+            /** This method is for get device state information */
             DEVICE_STATE getDeviceState() const noexcept;
 
         private:
@@ -79,7 +87,7 @@ namespace OIC
 
             void setDeviceState(DEVICE_STATE);
         };
-    } // namespace Service
-} // namespace OIC
+    } /** namespace Service */
+} /** namespace OIC */
 
 #endif /* RB_DEVICEPRESENCE_H_ */
index 7baede1..fa81f0b 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.
+ *
+ ******************************************************************/
 
 /**
  * @file
@@ -159,7 +159,9 @@ namespace OIC
 
             void registerDevicePresence();
         public:
+            /** This method is for get callback */
             void getCB(const HeaderOptions &hos, const ResponseStatement& rep, int eCode);
+            /** This method is for timeout callback */
             void timeOutCB(unsigned int msg);
         private:
             void verifiedGetResponse(int eCode);
index 4cda733..76a3ff0 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 RCM_CACHETYPES_H
 #define RCM_CACHETYPES_H
@@ -38,10 +38,11 @@ namespace OIC
 
         class DataCache;
 
-#define CACHE_TAG  "CACHE"
-#define CACHE_DEFAULT_REPORT_MILLITIME 10000
-#define CACHE_DEFAULT_EXPIRED_MILLITIME 15000
+#define CACHE_TAG  "CACHE"   /*!< cache tag information */
+#define CACHE_DEFAULT_REPORT_MILLITIME 10000 /*!< default report time */
+#define CACHE_DEFAULT_EXPIRED_MILLITIME 15000 /*!< default expired time */
 
+        /** enum for report frequency value */
         enum class REPORT_FREQUENCY
         {
             NONE = 0,
@@ -52,11 +53,12 @@ namespace OIC
         struct Report_Info
         {
             REPORT_FREQUENCY rf;
-            int reportID;
-            long repeatTime;
-            unsigned int timerID;
+            int reportID;               /*!< report id */
+            long repeatTime;            /*!< repeat time */
+            unsigned int timerID;       /*!< timer id */
         };
 
+        /** enum for cache state */
         enum class CACHE_STATE
         {
             READY = 0,
@@ -67,12 +69,14 @@ namespace OIC
             NONE
         };
 
+        /** enum for cache mode */
         enum class CACHE_MODE
         {
             OBSERVE = 0,
             FREQUENCY
         };
 
+        /** enum for cache method */
         enum class CACHE_METHOD
         {
             OBSERVE_ONLY,
@@ -92,7 +96,7 @@ namespace OIC
 
         typedef std::shared_ptr<DataCache> DataCachePtr;
         typedef std::shared_ptr<PrimitiveResource> PrimitiveResourcePtr;
-    } // namespace Service
-} // namespace OIC
+    } /* namespace Service */
+} /* namespace OIC */
 
 #endif /* RCM_CACHETYPES_H */
index 090edb1..f9808f5 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 RCM_DATACACHE_H_
 #define RCM_DATACACHE_H_
 #include "CacheTypes.h"
 #include "ExpiryTimer.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         class DataCache : public std::enable_shared_from_this<DataCache>
@@ -48,17 +50,23 @@ namespace OIC
                 DataCache & operator = (const DataCache &) = default;
                 DataCache & operator = (DataCache &&) = default;
 
+                /// This method is for initialize the cache data
                 void initializeDataCache(PrimitiveResourcePtr pResource);
-
+                /// This method is for add the subscriber
                 CacheID addSubscriber(CacheCB func, REPORT_FREQUENCY rf, long repeatTime);
+                /// This method is for delete the subscriber
                 CacheID deleteSubscriber(CacheID id);
-
+                /// This method is for get the cache state
                 CACHE_STATE getCacheState() const;
+                /// This method is for get the cache data
                 const RCSResourceAttributes getCachedData() const;
+                /// This method is for get the primitive resource
                 const PrimitiveResourcePtr getPrimitiveResource() const;
-
+                /// This method is for get request
                 void requestGet();
+                /// This method is for check subscriber is empty or not
                 bool isEmptySubscriber() const;
+                /// This method is for check cache data is empty or not
                 bool isCachedData() const;
 
             private:
@@ -100,7 +108,7 @@ namespace OIC
                 SubscriberInfoPair findSubscriber(CacheID id);
                 void notifyObservers(const RCSResourceAttributes Att, int eCode);
         };
-    } // namespace Service
-} // namespace OIC
+    } /* namespace Service */
+} /* namespace OIC */
 
 #endif /* RCM_DATACACHE_H_ */
index f8286e4..d036ba4 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.
+ *
+ ******************************************************************/
 
 /**
  * @file
@@ -56,9 +56,13 @@ namespace OIC
                         const std::vector< std::string >&, DiscoverCallback);
 
             public:
+                /** This method is for dicover the resource */
                 void discover() const;
+                /** This method is for check known resource */
                 bool isKnownResource(const std::shared_ptr< PrimitiveResource >&) const;
+                /** This method is for add known resource */
                 void addKnownResource(const std::shared_ptr< PrimitiveResource >&);
+                /** This method is for check matched address */
                 bool isMatchedAddress(const std::string&) const;
 
             private:
index 0049785..45913af 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2015 Samsung Electronics All Rights Reserved.\r
-//\r
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
-//\r
-// Licensed under the Apache License, Version 2.0 (the "License");\r
-// you may not use this file except in compliance with the License.\r
-// You may obtain a copy of the License at\r
-//\r
-//      http://www.apache.org/licenses/LICENSE-2.0\r
-//\r
-// Unless required by applicable law or agreed to in writing, software\r
-// distributed under the License is distributed on an "AS IS" BASIS,\r
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
-// See the License for the specific language governing permissions and\r
-// limitations under the License.\r
-//\r
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
+/******************************************************************\r
+ *\r
+ * Copyright 2015 Samsung Electronics All Rights Reserved.\r
+ *\r
+ *\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ *      http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ *\r
+ ******************************************************************/\r
 \r
 #ifndef RE_INTERFACEHANDLER_H_\r
 #define RE_INTERFACEHANDLER_H_\r
 #include <string>\r
 #include <functional>\r
 \r
+/** OIC namespace */\r
 namespace OIC\r
 {\r
+    /** service namespace */\r
     namespace Service\r
     {\r
         class RCSRequest;\r
@@ -53,7 +55,9 @@ namespace OIC
             bool isGetSupported() const;\r
             bool isSetSupported() const;\r
 \r
+            /** This method is for get the response builder */\r
             GetResponseBuilder getGetResponseBuilder() const;\r
+            /** This method is for set the response builder */\r
             SetResponseBuilder getSetResponseBuilder() const;\r
 \r
         private:\r
@@ -61,6 +65,9 @@ namespace OIC
             SetResponseBuilder m_setBuilder;\r
         };\r
 \r
+        /**\r
+         * get the default interface handler\r
+         */\r
         InterfaceHandler getDefaultInterfaceHandler(const std::string&, const std::string&);\r
     }\r
 }\r
index 6e0f2b6..fbeb82f 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 SERVERBUILDER_REQUESTHANDLER_H
 #define SERVERBUILDER_REQUESTHANDLER_H
 
 #include "OCRepresentation.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
 
@@ -48,15 +50,21 @@ namespace OIC
             RequestHandler(RCSResourceAttributes&&, int errorCode = DEFAULT_ERROR_CODE);
 
             virtual ~RequestHandler() { };
-
+            /**
+             * This method is for get the error code
+             */
             int getErrorCode() const;
 
+            /**
+             * This method is for check custom representation and return true or false value
+             */
             bool hasCustomRepresentation() const;
 
+            /** get the representation information */
             OC::OCRepresentation getRepresentation() const;
 
         public:
-            static constexpr int DEFAULT_ERROR_CODE = 200;
+            static constexpr int DEFAULT_ERROR_CODE = 200;  /*!< default error code */
 
         private:
             const int m_errorCode;
@@ -74,6 +82,7 @@ namespace OIC
             SetRequestHandler(const SetRequestHandler&) = delete;
             SetRequestHandler(SetRequestHandler&&) = default;
 
+            /** This method is for set request handler */
             SetRequestHandler();
 
             SetRequestHandler(int errorCode);