Add doxygen comments for resource-encapsulation 61/26661/3
authorpooja <pooja.k@partner.samsung.com>
Tue, 31 Jul 2018 10:11:18 +0000 (15:41 +0530)
committerAshok Babu Channa <ashok.channa@samsung.com>
Thu, 23 Aug 2018 06:05:07 +0000 (06:05 +0000)
Change-Id: I821c17f18eb1cc3c2133a97344f0bbbd2c8d90d7
Signed-off-by: pooja <pooja.k@partner.samsung.com>
14 files changed:
service/resource-encapsulation/android/service/src/main/jni/JniRcsObject.h
service/resource-encapsulation/android/service/src/main/jni/util/ScopedEnv.h
service/resource-encapsulation/include/RCSException.h
service/resource-encapsulation/include/RCSResourceAttributes.h
service/resource-encapsulation/src/common/expiryTimer/include/ExpiryTimer.h
service/resource-encapsulation/src/common/primitiveResource/include/AssertUtils.h
service/resource-encapsulation/src/common/primitiveResource/include/PresenceSubscriber.h
service/resource-encapsulation/src/common/primitiveResource/include/PrimitiveResourceImpl.h
service/resource-encapsulation/src/common/primitiveResource/include/ResourceAttributesConverter.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/ScopeLogger.h
service/resource-encapsulation/src/resourceCache/include/CacheTypes.h
service/resource-encapsulation/src/resourceCache/include/ObserveCache.h

index 46b5671..9f59968 100644 (file)
@@ -33,6 +33,7 @@ extern jfieldID g_field_mNativeHandle;
 void initRCSObject(JNIEnvWrapper*);
 void clearRCSObject(JNIEnvWrapper*);
 
+/** detail namespace */
 namespace Detail
 {
     struct BaseHandleHolder
@@ -50,6 +51,11 @@ namespace Detail
         T* m_ptr;
     };
 
+    /**
+     * get the native method handle
+     * @param env       JNI interface pointer
+     * @param obj       object
+     */
     template< typename ENV >
     void* getNativeHandle(ENV* env, jobject obj)
     {
@@ -63,6 +69,11 @@ bool hasNativeHandle(ENV* env, jobject obj)
     return Detail::getNativeHandle(env, obj) != nullptr;
 }
 
+/**
+ * set the native method handle
+ * @param env       JNI interface pointer
+ * @param obj       object
+ */
 template< typename T, typename ENV, typename ...PARAMS >
 inline void setSafeNativeHandle(ENV* env, jobject obj, PARAMS&&... params)
 {
@@ -78,6 +89,11 @@ inline void setSafeNativeHandle(ENV* env, jobject obj, PARAMS&&... params)
     p.release();
 }
 
+/**
+ * release the native method handle
+ * @param env       JNI interface pointer
+ * @param obj       object
+ */
 template< typename ENV >
 void releaseNativeHandle(ENV* env, jobject obj)
 {
@@ -89,7 +105,11 @@ void releaseNativeHandle(ENV* env, jobject obj)
     env->SetLongField(obj, g_field_mNativeHandle, 0);
 }
 
-
+/**
+ * get the native method handle
+ * @param env       JNI interface pointer
+ * @param obj       object
+ */
 template< typename T >
 inline T& getNativeHandleAs(JNIEnv* env, jobject obj)
 {
@@ -103,6 +123,11 @@ inline T& getNativeHandleAs(JNIEnv* env, jobject obj)
    return *handleHolder->m_ptr;
 }
 
+/**
+ * get the native method handle
+ * @param env       JNI interface pointer
+ * @param obj       object
+ */
 template< typename T >
 inline T& getNativeHandleAs(JNIEnvWrapper* env, jobject obj)
 {
@@ -115,6 +140,10 @@ inline T& getNativeHandleAs(JNIEnvWrapper* env, jobject obj)
 extern "C" {
 #endif
 
+/**
+ * @class     org_iotivity_service_RcsObject
+ * Method     nativeDispose
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_service_RcsObject_nativeDispose(JNIEnv*, jobject);
 
index c1b9030..9fb5d92 100644 (file)
@@ -30,6 +30,7 @@
 
 extern JavaVM* g_jvm;
 
+/** detail namespace */
 namespace Detail
 {
     inline std::pair<JNIEnv*, bool> getEnv()
@@ -37,6 +38,7 @@ namespace Detail
         JNIEnv* env{ };
         bool needToDetach{ };
 
+        /** get the environment information */
         auto ret = g_jvm->GetEnv((void**) &env, JNI_VERSION_1_6);
 
         switch (ret)
@@ -71,6 +73,9 @@ namespace Detail
     }
 }
 
+/**
+ * @class ScopedEnv
+ */
 class ScopedEnv
 {
 public:
@@ -115,6 +120,9 @@ private:
     bool m_needToDetach;
 };
 
+/**
+ * @class ScopedEnvWrapper
+ */
 class ScopedEnvWrapper
 {
 public:
index eeb33bc..6901081 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
index 10fd844..049ac13 100644 (file)
@@ -123,43 +123,81 @@ namespace OIC
                 return this->m_data[it];
             }
 
+            /** consturctor */
             RCSByteString()
             {
             }
+            /**
+             * consturctor with parameter
+             * @param rhs   byte string type data
+             */
             RCSByteString(DataType && rhs)
             : m_data {std::move(rhs)}
             {
             }
+            /**
+             * consturctor with const parameter
+             * @param rhs   const byte string type data
+             */
             RCSByteString(const DataType & rhs)
             : m_data {rhs}
             {
             }
+            /**
+             * consturctor with rcs byte string parameter
+             * @param rhs  byte string type data
+             */
             RCSByteString(RCSByteString && rhs)
             : m_data {DataType{rhs.getByteString()}}
             {
             }
+            /**
+             * consturctor with const rcs byte string parameter
+             * @param rhs   const byte string type data
+             */
             RCSByteString(const RCSByteString & rhs)
             : m_data {DataType{rhs.getByteString()}}
             {
             }
 
+            /**
+             * consturctor with oc byte string parameter
+             * @param rhs   byte string type data
+             */
             RCSByteString(::OCByteString && rhs)
             : m_data {DataType{rhs.bytes, rhs.bytes + rhs.len}}
             {
             }
+            /**
+             * consturctor with const oc byte string parameter
+             * @param rhs   const byte string type data
+             */
             RCSByteString(const ::OCByteString & rhs)
             : m_data {DataType{rhs.bytes, rhs.bytes + rhs.len}}
             {
             }
 
+            /**
+             * consturctor with bytes and size parameter
+             * @param bytes   bytes in data
+             * @param size    size of string
+             */
             RCSByteString(uint8_t* bytes, size_t size)
             : m_data {DataType{bytes, bytes + size}}
             {
             }
+            /**
+             * overloading method to copy assignment operator
+             * @param rhs   byte string type
+             */
             inline RCSByteString& operator=(RCSByteString&& rhs)
             {
                 return operator =(rhs);
             }
+            /**
+             * overloading method to copy assignment operator
+             * @param rhs   const byte string type
+             */
             inline RCSByteString& operator=(const RCSByteString& rhs)
             {
                 if(&rhs != this)
@@ -286,14 +324,14 @@ namespace OIC
              */
             enum class TypeId
             {
-                NULL_T, /**< nullptr_t */
-                INT, /**< int */
-                DOUBLE, /**< double */
-                BOOL, /**< bool */
-                STRING, /**< std::string */
-                BYTESTRING, /**< RCSByteString */
-                ATTRIBUTES, /**< RCSResourceAttributes */
-                VECTOR /**< std::vector */
+                NULL_T,     /*!< nullptr_t */
+                INT,        /*!< int */
+                DOUBLE,     /*!< double */
+                BOOL,       /*!< bool */
+                STRING,     /*!< std::string */
+                BYTESTRING, /*!< RCSByteString */
+                ATTRIBUTES, /*!< RCSResourceAttributes */
+                VECTOR      /*!< std::vector */
             };
 
             /**
@@ -306,9 +344,11 @@ namespace OIC
             class Type
             {
             public:
+                /** constructor */
                 Type(const Type&) = default;
                 Type(Type&&) = default;
 
+                /** overloading */
                 Type& operator=(const Type&) = default;
                 Type& operator=(Type&&) = default;
 
@@ -435,7 +475,9 @@ namespace OIC
             public:
                 class ComparisonHelper;
 
+                /** constructor */
                 Value();
+                /** constructor with const parameter */
                 Value(const Value&);
                 Value(Value&&) BOOST_NOEXCEPT;
 
@@ -449,8 +491,10 @@ namespace OIC
                 {
                 }
 
+                /** constructor with parameter */
                 Value(const char*);
 
+                /** operator overloading */
                 Value& operator=(const Value&);
                 Value& operator=(Value&&);
 
@@ -461,6 +505,7 @@ namespace OIC
                     return *this;
                 }
 
+                /** operator overloading */
                 Value& operator=(const char*);
                 Value& operator=(std::nullptr_t);
 
@@ -548,10 +593,12 @@ namespace OIC
             class const_iterator;
 
         public:
+            /** class constructor */
             RCSResourceAttributes() = default;
             RCSResourceAttributes(const RCSResourceAttributes&) = default;
             RCSResourceAttributes(RCSResourceAttributes&&) = default;
 
+            /** overloading */
             RCSResourceAttributes& operator=(const RCSResourceAttributes&) = default;
             RCSResourceAttributes& operator=(RCSResourceAttributes&&) = default;
 
@@ -759,11 +806,16 @@ namespace OIC
                 return m_valueRef.equals< T >(v);
             }
 
+            /**
+             * This method is to compare the values
+             * @param v value to compare
+             */
             bool equals(const std::string& v) const
             {
                 return m_valueRef.equals< std::string >(v);
             }
 
+            /** overloading */
             bool operator==(const ComparisonHelper&) const;
 
         private:
@@ -957,9 +1009,12 @@ namespace OIC
             typedef std::unordered_map< std::string, Value >::iterator base_iterator;
 
         public:
+            /** constructor */
             iterator();
+            /** constructor with const parameter */
             iterator(const iterator&);
 
+            /** operator overloading */
             iterator& operator=(const iterator&);
 
             reference operator*();
@@ -999,10 +1054,14 @@ namespace OIC
             typedef std::unordered_map< std::string, Value >::const_iterator base_iterator;
 
         public:
+            /** constructor */
             const_iterator();
+            /** constructor with const parameter */
             const_iterator(const const_iterator&);
+            /** constructor with const parameter */
             const_iterator(const RCSResourceAttributes::iterator&);
 
+            /** operator overloading */
             const_iterator& operator=(const const_iterator&);
             const_iterator& operator=(const RCSResourceAttributes::iterator&);
 
index 1637c22..c78e2da 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
index 16fd2c9..ab95ce8 100644 (file)
@@ -72,6 +72,10 @@ namespace OIC
                 }
 
             public:
+                /**
+                 * check the process is in termination state or not
+                 * @return boolean value
+                 */
                 static bool isInTermination()
                 {
                     static TerminationChecker once;
index e986cd3..da3ca38 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_PRESENCESUBSCRIBER_H
 #define COMMON_PRESENCESUBSCRIBER_H
index bc13112..aa0cccf 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_PRIMITIVERESOURCEIMPL_H
 #define COMMON_INTERNAL_PRIMITIVERESOURCEIMPL_H
 
 #include "ResourceAttributesConverter.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
 
@@ -91,6 +93,10 @@ namespace OIC
             {
             }
 
+            /**
+             * This API is for the get request
+             * @param callback  get callback
+             */
             void requestGet(GetCallback callback)
             {
                 requestGetWith("", "", {}, std::move(callback));
@@ -112,6 +118,11 @@ namespace OIC
                                 std::move(callback), _1, _2, _3));
             }
 
+            /**
+             * This API is for the set request
+             * @param attrs     resource attributes
+             * @param callback  set callback
+             */
             void requestSet(const RCSResourceAttributes& attrs, SetCallback callback)
             {
                 requestSetWith("", "", {}, attrs, std::move(callback));
@@ -153,6 +164,11 @@ namespace OIC
                                 _1, _2, _3));
             }
 
+            /**
+             * This API is for the put request
+             * @param attrs     resource attributes
+             * @param callback  put callback
+             */
             void requestPut(const RCSResourceAttributes& attrs, PutCallback callback)
             {
                 using namespace std::placeholders;
@@ -181,6 +197,9 @@ namespace OIC
                                 std::move(callback), _1, _2, _3, _4));
             }
 
+            /**
+             * This API is to cancle the resource observe
+             */
             void cancelObserve()
             {
                 typedef OCStackResult (BaseResource::*CancelObserveFunc)();
@@ -189,36 +208,64 @@ namespace OIC
                         static_cast< CancelObserveFunc >(&BaseResource::cancelObserve));
             }
 
+            /**
+             * This API is to get the sid value of resource
+             * @return resource sid value
+             */
             std::string getSid() const
             {
                 return invokeOC(m_baseResource, &BaseResource::sid);
             }
 
+            /**
+             * API to get the resource URI
+             * @return resource uri
+             */
             std::string getUri() const
             {
                 return invokeOC(m_baseResource, &BaseResource::uri);
             }
 
+            /**
+             * API to get the host information
+             * @return host information
+             */
             std::string getHost() const
             {
                 return invokeOC(m_baseResource, &BaseResource::host);
             }
 
+            /**
+             * API to get the resource type
+             * @return resource type
+             */
             std::vector< std::string > getTypes() const
             {
                 return invokeOC(m_baseResource, &BaseResource::getResourceTypes);
             }
 
+            /**
+             * API is to get the resource interface details
+             * @return resource interface detail
+             */
             std::vector< std::string > getInterfaces() const
             {
                 return invokeOC(m_baseResource, &BaseResource::getResourceInterfaces);
             }
 
+            /**
+             * API is to get the resource connectivity type
+             * @return resource connectivity type
+             */
             OCConnectivityType getConnectivityType() const
             {
                 return invokeOC(m_baseResource, &BaseResource::connectivityType);
             }
 
+            /**
+             * API to get the observable state of resource
+             * @return true or false
+             */
             bool isObservable() const
             {
                 return invokeOC(m_baseResource, &BaseResource::isObservable);
index 90e7d03..fe31e3d 100644 (file)
 
 #include <OCRepresentation.h>
 
-//OIC namespace
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
+        /** detail namespace */
         namespace Detail
         {
             template< int >
@@ -44,21 +46,27 @@ namespace OIC
             template< OC::AttributeType TYPE >
             struct OCBaseType;
 
+            /** Integer type attribute */
             template< >
             struct OCBaseType< OC::AttributeType::Integer > : TypeDef< int >{ };
 
+            /** double type attribute */
             template< >
             struct OCBaseType< OC::AttributeType::Double > : TypeDef< double > { };
 
+            /** boolean type attribute */
             template< >
             struct OCBaseType< OC::AttributeType::Boolean > : TypeDef< bool > { };
 
+            /** string type attribute */
             template< >
             struct OCBaseType< OC::AttributeType::String > : TypeDef< std::string > { };
 
+            /** binary type attribute */
             template< >
             struct OCBaseType< OC::AttributeType::Binary > : TypeDef< RCSByteString::DataType > { };
 
+            /** string type attribute */
             template< >
             struct OCBaseType< OC::AttributeType::OCByteString > : TypeDef< OCByteString > { };
 
@@ -241,6 +249,10 @@ namespace OIC
                     }
                 }
 
+                /**
+                 * extract the atribute value
+                 * @return resource attribute value
+                 */
                 RCSResourceAttributes&& extract()
                 {
                     return std::move(m_target);
@@ -260,6 +272,7 @@ namespace OIC
             class OCRepresentationBuilder
             {
             public:
+                /** constructor */
                 OCRepresentationBuilder() = default;
 
                 template< typename T, typename B = typename Detail::TypeInfo< T >::base_type >
@@ -293,6 +306,11 @@ namespace OIC
                     m_target.setNULL(key);
                 }
 
+                /**
+                 * convert the attribute to the oc representation formate
+                 * @param attrs   resource attributes
+                 * @return converted attributes value
+                 */
                 OC::OCRepresentation convertAttributes(Detail::Int2Type< 0 >,
                         const RCSResourceAttributes& attrs)
                 {
@@ -314,6 +332,11 @@ namespace OIC
                     return result;
                 }
 
+                /**
+                 * convert to byte string value
+                 * @param bytestring    byte string value
+                 * @return converted bytestring
+                 */
                 OCByteString convertByteString(Detail::Int2Type< 0 >,
                         const RCSByteString& byteString)
                 {
@@ -343,6 +366,10 @@ namespace OIC
                     return result;
                 }
 
+                /**
+                 * This method is to extract the value
+                 * @return extracted value
+                 */
                 OC::OCRepresentation&& extract()
                 {
                     return std::move(m_target);
index 1acb596..369f872 100644 (file)
@@ -31,7 +31,7 @@ namespace OIC
     /** service namespace */
     namespace Service
     {
-        typedef RCSRepresentation ResponseStatement;
+        typedef RCSRepresentation ResponseStatement;  /*!< typedef of the rcs representation */
     }
 }
 
index efa0fb9..4c9a091 100644 (file)
@@ -50,18 +50,25 @@ namespace OIC
             class ScopedLock
             {
             public:
+                /**
+                 * parameter constructor
+                 * @param flag   test the flag and set the value
+                 */
                 explicit ScopedLock(std::atomic_flag& flag) noexcept :
                         m_flag(flag)
                 {
                     while (m_flag.test_and_set(std::memory_order_acquire));
                 }
 
+                /** destructor of scopelock */
                 ~ScopedLock() noexcept
                 {
                     m_flag.clear(std::memory_order_release);
                 }
 
+                /** parameter constructor */
                 ScopedLock(const ScopedLock&) = delete;
+                /** operator overloading */
                 ScopedLock& operator=(const ScopedLock&) = delete;
 
             private:
index 143c408..36d5aad 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_SCOPELOGGER_H
 #define COMMON_UTILS_SCOPELOGGER_H
index 76a3ff0..b225bc3 100644 (file)
 #include "PrimitiveResource.h"
 #include "RCSResourceAttributes.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
 
@@ -45,42 +47,42 @@ namespace OIC
         /** enum for report frequency value */
         enum class REPORT_FREQUENCY
         {
-            NONE = 0,
-            UPTODATE,
-            PERIODICTY
+            NONE = 0,        /**< Initialize frequency */
+            UPTODATE,        /**< up to date frequency */
+            PERIODICTY       /**< periodicty frequency */
         };
 
         struct Report_Info
         {
             REPORT_FREQUENCY rf;
-            int reportID;               /*!< report id */
-            long repeatTime;            /*!< repeat time */
-            unsigned int timerID;       /*!< timer id */
+            int reportID;               /**< report id */
+            long repeatTime;            /**< repeat time */
+            unsigned int timerID;       /**< timer id */
         };
 
         /** enum for cache state */
         enum class CACHE_STATE
         {
-            READY = 0,
-            READY_YET,
-            LOST_SIGNAL,
-            DESTROYED,
-            UPDATING,
-            NONE
+            READY = 0,          /**< ready state */
+            READY_YET,          /**< ready yet state */
+            LOST_SIGNAL,        /**< lost signal state */
+            DESTROYED,          /**< destroyed state */
+            UPDATING,           /**< updating state */
+            NONE                /**< none state */
         };
 
         /** enum for cache mode */
         enum class CACHE_MODE
         {
-            OBSERVE = 0,
-            FREQUENCY
+            OBSERVE = 0,         /**< observe mode */
+            FREQUENCY            /**< frequency of mode */
         };
 
         /** enum for cache method */
         enum class CACHE_METHOD
         {
-            OBSERVE_ONLY,
-            ITERATED_GET
+            OBSERVE_ONLY,           /**< observe only method */
+            ITERATED_GET            /**< iterated get method */
         };
 
         typedef int CacheID;
index 3dcaac3..8ae0658 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 /**
  * @file