Add doxygen comments for notification 87/26587/11
authorpooja <pooja.k@partner.samsung.com>
Wed, 25 Jul 2018 11:17:53 +0000 (16:47 +0530)
committerAshok Babu Channa <ashok.channa@samsung.com>
Tue, 25 Sep 2018 06:02:06 +0000 (06:02 +0000)
Change-Id: I0b1ef304a494687e1b53fee0be82b4af56d7326b
Signed-off-by: pooja <pooja.k@partner.samsung.com>
34 files changed:
service/notification/android/notification-service/src/main/jni/common/JniNotificationCommon.h
service/notification/android/notification-service/src/main/jni/consumer/JniNotificationConsumer.cpp
service/notification/android/notification-service/src/main/jni/consumer/JniNotificationConsumer.h
service/notification/android/notification-service/src/main/jni/provider/JniNotificationProvider.h
service/notification/cpp-wrapper/common/NSMessage.h
service/notification/cpp-wrapper/common/NSUtils.h
service/notification/include/NSCommon.h
service/notification/include/NSConsumerInterface.h
service/notification/src/common/NSConstants.h
service/notification/src/common/NSStructs.h
service/notification/src/common/NSUtil.h
service/notification/src/consumer/NSConsumerCommon.c
service/notification/src/consumer/NSConsumerCommon.h
service/notification/src/consumer/NSConsumerCommunication.h
service/notification/src/consumer/NSConsumerDiscovery.h
service/notification/src/consumer/NSConsumerInternalTaskController.h
service/notification/src/consumer/NSConsumerMQPlugin.h
service/notification/src/consumer/NSConsumerMemoryCache.h
service/notification/src/consumer/NSConsumerNetworkEventListener.h
service/notification/src/consumer/NSConsumerQueue.h
service/notification/src/consumer/NSConsumerScheduler.h
service/notification/src/consumer/NSConsumerSystem.h
service/notification/src/consumer/NSThread.h
service/notification/src/provider/NSProviderCallbackResponse.h
service/notification/src/provider/NSProviderDiscovery.h
service/notification/src/provider/NSProviderListener.h
service/notification/src/provider/NSProviderMemoryCache.h
service/notification/src/provider/NSProviderNotification.h
service/notification/src/provider/NSProviderResource.h
service/notification/src/provider/NSProviderScheduler.h
service/notification/src/provider/NSProviderSubscription.h
service/notification/src/provider/NSProviderSystem.h
service/notification/src/provider/NSProviderTopic.h
service/notification/unittest/NSUnittestUtil.h

index b4061ae..b7360b7 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _JNI_NOTIFICATION_COMMON_H_\r
 #define _JNI_NOTIFICATION_COMMON_H_\r
@@ -50,14 +50,32 @@ extern "C" {
 #define JNI_NS_ALLOW 500\r
 #define JNI_NS_DENY 600\r
 \r
+/**\r
+ * get the notification exception\r
+ * @param env    JNI interface pointer.\r
+ */\r
 jobject getNSException(JNIEnv *env, const char *file, const char *functionName, const int line,\r
                        const int code, const char *message);\r
+\r
+/**\r
+ * throw notification exception\r
+ * @param env    JNI interface pointer.\r
+ */\r
 void throwNSException(JNIEnv *env, jobject ex);\r
 \r
 #define GetNSException(code, message) getNSException(env, __FILE__, __func__, __LINE__, code, message)\r
 #define ThrowNSException(code, message) throwNSException(env, GetNSException(code, message))\r
 \r
+/**\r
+ * according to result code return message.\r
+ * @param nsresult      result value\r
+ */\r
 static const char *NSResultToChar(const int nsresult);\r
+\r
+/**\r
+ * Initialize the exception\r
+ * @param env    JNI interface pointer.\r
+ */\r
 int NSExceptionInit(JNIEnv *env);\r
 \r
 #ifdef __cplusplus\r
index 0d16c3d..ce32415 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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
 #include "JniNotificationConsumer.h"\r
 #include "NSConsumerService.h"\r
@@ -43,6 +43,13 @@ jclass g_cls_TopicsList;
 jclass g_cls_OcRepresentation;\r
 jmethodID g_mid_OcRepresentation_N_ctor_bool = NULL;\r
 \r
+/**\r
+ * Get JNI environment.\r
+ *\r
+ * @param ret Initial environment value.\r
+ *\r
+ * @return return JNI envirinment value.\r
+ */\r
 static JNIEnv *GetJNIEnv(jint *ret)\r
 {\r
     JNIEnv *env = NULL;\r
@@ -71,6 +78,14 @@ static JNIEnv *GetJNIEnv(jint *ret)
     }\r
 }\r
 \r
+/**\r
+ * Get Native Provider.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param jObj         java object.\r
+ *\r
+ * @return 1, exception return 0.\r
+ */\r
 static jlong getNativeProvider(JNIEnv *env, jobject jObj)\r
 {\r
 \r
@@ -89,6 +104,14 @@ static jlong getNativeProvider(JNIEnv *env, jobject jObj)
     return (env->GetLongField(jObj, nativeHandle));\r
 }\r
 \r
+/**\r
+ * Get java provider state.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param state        provider state\r
+ *\r
+ * @return provider state.\r
+ */\r
 jobject getJavaProviderState(JNIEnv *env, OIC::Service::NSProviderState state)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaProviderState - IN");\r
@@ -133,6 +156,14 @@ jobject getJavaProviderState(JNIEnv *env, OIC::Service::NSProviderState state)
     return providerState;\r
 }\r
 \r
+/**\r
+ * Get java sync type.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param nsType       notification type.\r
+ *\r
+ * @return sync type.\r
+ */\r
 jobject getJavaSyncType(JNIEnv *env, OIC::Service::NSSyncInfo::NSSyncType nsType)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaSyncType - IN");\r
@@ -179,6 +210,14 @@ jobject getJavaSyncType(JNIEnv *env, OIC::Service::NSSyncInfo::NSSyncType nsType
     return syncType;\r
 }\r
 \r
+/**\r
+ * Get java topic state.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param nsState      notification state.\r
+ *\r
+ * @return topic state.\r
+ */\r
 jobject getJavaTopicState(JNIEnv *env, OIC::Service::NSTopic::NSTopicState nsState)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaTopicState - IN");\r
@@ -219,6 +258,14 @@ jobject getJavaTopicState(JNIEnv *env, OIC::Service::NSTopic::NSTopicState nsSta
     return topicState;\r
 }\r
 \r
+/**\r
+ * Get java topics list.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param topicList    topic list.\r
+ *\r
+ * @return topic list.\r
+ */\r
 jobject getJavaTopicsList(JNIEnv *env, std::shared_ptr<OIC::Service::NSTopicsList> topicList)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaTopicsList - IN");\r
@@ -259,6 +306,15 @@ jobject getJavaTopicsList(JNIEnv *env, std::shared_ptr<OIC::Service::NSTopicsLis
     return obj_topicList;\r
 }\r
 \r
+/**\r
+ * Get Native topic state.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param jTopic       topic object.\r
+ * @param state        topic state.\r
+ *\r
+ * @return true if state found, otherwise false.\r
+ */\r
 bool getNativeTopicState(JNIEnv *env,  jobject jTopic , OIC::Service::NSTopic::NSTopicState &state )\r
 {\r
     NS_LOGD ("ConsumerService_getNativeTopicState - IN");\r
@@ -292,6 +348,14 @@ bool getNativeTopicState(JNIEnv *env,  jobject jTopic , OIC::Service::NSTopic::N
 \r
 }\r
 \r
+/**\r
+ * Get Native topic name.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param jTopic       topic object.\r
+ *\r
+ * @return  topic name.\r
+ */\r
 const char *getNativeTopicName(JNIEnv *env,  jobject jTopic)\r
 {\r
     NS_LOGD ("ConsumerService_getNativeTopicName - IN");\r
@@ -322,6 +386,14 @@ const char *getNativeTopicName(JNIEnv *env,  jobject jTopic)
 \r
 }\r
 \r
+/**\r
+ * Get Native topics list.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param jTopicList   topic list.\r
+ *\r
+ * @return  topic list.\r
+ */\r
 std::shared_ptr<OIC::Service::NSTopicsList> getNativeTopicsList(JNIEnv *env, jobject jTopicList)\r
 {\r
     NS_LOGD ("ConsumerService_getNativeTopicsList - IN");\r
@@ -394,6 +466,14 @@ std::shared_ptr<OIC::Service::NSTopicsList> getNativeTopicsList(JNIEnv *env, job
     return nsTopicList;\r
 }\r
 \r
+/**\r
+ * Get java provider.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param provider     notification provider.\r
+ *\r
+ * @return object of provider.\r
+ */\r
 jobject getJavaProvider(JNIEnv *env, std::shared_ptr<OIC::Service::NSProvider> provider)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaProvider - IN");\r
@@ -445,6 +525,14 @@ jobject getJavaProvider(JNIEnv *env, std::shared_ptr<OIC::Service::NSProvider> p
     return obj_provider;\r
 }\r
 \r
+/**\r
+ * Get java message type.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param type         message type.\r
+ *\r
+ * @return message type.\r
+ */\r
 jobject getJavaMessageType(JNIEnv *env, OIC::Service::NSMessage::NSMessageType type)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaMessageType - IN");\r
@@ -489,6 +577,14 @@ jobject getJavaMessageType(JNIEnv *env, OIC::Service::NSMessage::NSMessageType t
     return messageType;\r
 }\r
 \r
+/**\r
+ * Get java message.\r
+ *\r
+ * @param env          JNI interface pointer.\r
+ * @param message      notification message.\r
+ *\r
+ * @return message object.\r
+ */\r
 jobject getJavaMessage(JNIEnv *env, OIC::Service::NSMessage message)\r
 {\r
     NS_LOGD ("ConsumerService_getJavaMessage - IN");\r
@@ -648,6 +744,9 @@ jobject getJavaMessage(JNIEnv *env, OIC::Service::NSMessage message)
     return obj_message;\r
 }\r
 \r
+/**\r
+ * On discover provider.\r
+ */\r
 void onDiscoverProvider(std::shared_ptr<OIC::Service::NSProvider> provider)\r
 {\r
     NS_LOGD ("ConsumerService_onDiscoverProvider - IN");\r
@@ -716,6 +815,9 @@ void onDiscoverProvider(std::shared_ptr<OIC::Service::NSProvider> provider)
     return ;\r
 }\r
 \r
+/**\r
+ * On provider state.\r
+ */\r
 void onProviderState( OIC::Service::NSProviderState state)\r
 {\r
     NS_LOGD ("ConsumerService_onProviderState -IN");\r
@@ -783,6 +885,9 @@ void onProviderState( OIC::Service::NSProviderState state)
 \r
 }\r
 \r
+/**\r
+ * On message posted.\r
+ */\r
 void onMessagePosted(OIC::Service::NSMessage message)\r
 {\r
     NS_LOGD ("ConsumerService_onMessagePosted -IN");\r
@@ -850,6 +955,9 @@ void onMessagePosted(OIC::Service::NSMessage message)
     return ;\r
 }\r
 \r
+/**\r
+ * On sync info received.\r
+ */\r
 void onSyncInfoReceived(OIC::Service::NSSyncInfo sync)\r
 {\r
     NS_LOGD ("ConsumerService_onSyncInfoReceived - IN");\r
index cbcbce1..29b3901 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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
 /* DO NOT EDIT THIS FILE - it is machine generated */\r
 #include "JniNotificationCommon.h"\r
index f17d110..192b241 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.
+ *
+ ******************************************************************/
 
 #include "JniNotificationCommon.h"
 
index ae17131..8a4beeb 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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
  * @file\r
 #include "NSMediaContents.h"\r
 #include "OCRepresentation.h"\r
 \r
+/** OIC namespace */\r
 namespace OIC\r
 {\r
+    /** service namespace */\r
     namespace Service\r
     {\r
         /**\r
@@ -45,11 +47,11 @@ namespace OIC
                 /** NSMessageType - enumeration for Notification service MessageType*/\r
                 enum class NSMessageType\r
                 {\r
-                    NS_MESSAGE_ALERT = 1,\r
-                    NS_MESSAGE_NOTICE = 2,\r
-                    NS_MESSAGE_EVENT = 3,\r
-                    NS_MESSAGE_INFO = 4,\r
-                    NS_MESSAGE_WARNING = 5,\r
+                    NS_MESSAGE_ALERT = 1,   /**< alert message */\r
+                    NS_MESSAGE_NOTICE = 2,  /**< notice message */\r
+                    NS_MESSAGE_EVENT = 3,   /**< event message */\r
+                    NS_MESSAGE_INFO = 4,    /**< information message */\r
+                    NS_MESSAGE_WARNING = 5, /**< warning message */\r
                 };\r
 \r
                 /**\r
index 88d440e..c1c45a1 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
@@ -37,31 +37,31 @@ namespace OIC
         /** NSResult - enumeration for NS service Result*/
         enum class NSResult
         {
-            OK = 100,
-            ERROR = 200,
-            SUCCESS = 300,
-            FAIL = 400,
+            OK = 100,      /**< success result */
+            ERROR = 200,   /**< error result */
+            SUCCESS = 300, /**< success result*/
+            FAIL = 400,    /**< failure result */
         };
 
         /**
-             * NSProviderState of notification service
-             */
+         * NSProviderState of notification service
+         */
         enum class NSProviderState
         {
-            ALLOW = 1,
-            DENY = 2,
-            TOPIC = 3,
-            STOPPED = 12
+            ALLOW = 1,   /**< allow state */
+            DENY = 2,    /**< deny state */
+            TOPIC = 3,   /**< topic */
+            STOPPED = 12 /**< stopped state */
         };
 
         /**
-             * NSProviderSubscribedState of notification service
-             */
+         * NSProviderSubscribedState of notification service
+         */
         enum class NSProviderSubscribedState
         {
-            DENY = 0,
-            DISCOVERED = 1,
-            SUBSCRIBED = 2
+            DENY = 0,       /**< deny state */
+            DISCOVERED = 1, /**< discovered state */
+            SUBSCRIBED = 2  /**< subscribed state */
         };
     }
 }
index 8e9eba5..c1c3370 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
 #include <stdint.h>
 #include <octypes.h>
 
-#define NS_UUID_STRING_SIZE 37
+#define NS_UUID_STRING_SIZE 37 /**< UUID string size */
 //#define WITH_MQ
 /**
  * Result code of notification service
  */
 typedef enum eResult
 {
-    NS_OK = 100,
-    NS_ERROR = 200,
-    NS_SUCCESS = 300,
-    NS_FAIL = 400,
+    NS_OK = 100,        /**< success result */
+    NS_ERROR = 200,     /**< error result */
+    NS_SUCCESS = 300,   /**< success result */
+    NS_FAIL = 400,      /**< failure result */
 
 } NSResult;
 
@@ -49,11 +49,11 @@ typedef enum eResult
  */
 typedef enum
 {
-    NS_ALLOW = 1,
-    NS_DENY = 2,
-    NS_TOPIC = 3,
-    NS_DISCOVERED = 11,
-    NS_STOPPED = 12
+    NS_ALLOW = 1,        /**< allow state */
+    NS_DENY = 2,         /**< deny state */
+    NS_TOPIC = 3,        /**< topic state */
+    NS_DISCOVERED = 11,  /**< discovered state */
+    NS_STOPPED = 12      /**< stopped state */
 
 } NSProviderState;
 
@@ -62,9 +62,9 @@ typedef enum
  */
 typedef enum
 {
-    NS_SYNC_UNREAD = 0,
-    NS_SYNC_READ = 1,
-    NS_SYNC_DELETED = 2,
+    NS_SYNC_UNREAD = 0,       /**< synchronize unread status */
+    NS_SYNC_READ = 1,         /**< synchronize read status */
+    NS_SYNC_DELETED = 2,      /**< synchronize deleted status */
 
 } NSSyncType;
 
@@ -77,13 +77,13 @@ typedef enum
  */
 typedef enum
 {
-    NS_MESSAGE_ALERT = 1,
-    NS_MESSAGE_NOTICE = 2,
-    NS_MESSAGE_EVENT = 3,
-    NS_MESSAGE_INFO = 4,
-    NS_MESSAGE_WARNING = 5,
-    NS_MESSAGE_READ = 11,
-    NS_MESSAGE_DELETED = 12
+    NS_MESSAGE_ALERT = 1,        /**< alert message type */
+    NS_MESSAGE_NOTICE = 2,       /**< notice message type */
+    NS_MESSAGE_EVENT = 3,        /**< event message type */
+    NS_MESSAGE_INFO = 4,         /**< info message type */
+    NS_MESSAGE_WARNING = 5,      /**< warning message type */
+    NS_MESSAGE_READ = 11,        /**< read message type */
+    NS_MESSAGE_DELETED = 12      /**< deleted message type */
 
 } NSMessageType;
 
@@ -92,8 +92,8 @@ typedef enum
  */
 typedef enum
 {
-    NS_TOPIC_UNSUBSCRIBED = 0,
-    NS_TOPIC_SUBSCRIBED = 1,
+    NS_TOPIC_UNSUBSCRIBED = 0,   /**< topic unsubscribed notification */
+    NS_TOPIC_SUBSCRIBED = 1,     /**< topic subscribed notification */
 
 } NSTopicState;
 
@@ -102,9 +102,9 @@ typedef enum
  */
 typedef struct _nsTopic
 {
-    char * topicName;
-    NSTopicState state;
-    struct _nsTopic * next;
+    char * topicName;         /**< topic name */
+    NSTopicState state;       /**< topic state */
+    struct _nsTopic * next;   /**< link to other node */
 
 } NSTopicLL;
 
@@ -113,7 +113,7 @@ typedef struct _nsTopic
  */
 typedef struct
 {
-    char consumerId[NS_UUID_STRING_SIZE];
+    char consumerId[NS_UUID_STRING_SIZE];  /**< consumer Id */
 
 } NSConsumer;
 
@@ -122,7 +122,7 @@ typedef struct
  */
 typedef struct
 {
-    char providerId[NS_UUID_STRING_SIZE];
+    char providerId[NS_UUID_STRING_SIZE];   /**< provider Id */
 
 } NSProvider;
 
@@ -131,7 +131,7 @@ typedef struct
  */
 typedef struct
 {
-    char * iconImage;
+    char * iconImage;    /**< icon image */
 
 } NSMediaContents;
 
@@ -140,20 +140,20 @@ typedef struct
  */
 typedef struct
 {
-    //Mandatory
-    uint64_t messageId;
-    char providerId[NS_UUID_STRING_SIZE];
-
-    //optional
-    NSMessageType type;
-    char * dateTime;
-    uint64_t ttl;
-    char * title;
-    char * contentText;
-    char * sourceName;
-    NSMediaContents * mediaContents;
-    char * topic;
-    OCRepPayload * extraInfo;
+    // Mandatory
+    uint64_t messageId;                   /**< the notification of index message */
+    char providerId[NS_UUID_STRING_SIZE]; /**< provider Id */
+
+    // optional
+    NSMessageType type;                   /**< message type */
+    char * dateTime;                      /**< date time */
+    uint64_t ttl;                         /**< time duaration in which the notification is meaningful */
+    char * title;                         /**< title of the notification */
+    char * contentText;                   /**< description of the notification */
+    char * sourceName;                    /**< source name which produce the notification message */
+    NSMediaContents * mediaContents;      /**< notification icon image */
+    char * topic;                         /**< interest topic */
+    OCRepPayload * extraInfo;             /**< additional information which is user defined data */
 
 } NSMessage;
 
@@ -162,9 +162,9 @@ typedef struct
  */
 typedef struct
 {
-    uint64_t messageId;
-    char providerId[NS_UUID_STRING_SIZE];
-    NSSyncType state;
+    uint64_t messageId;                   /**< index of notification message */
+    char providerId[NS_UUID_STRING_SIZE]; /**< provider Id */
+    NSSyncType state;                     /**< status of notification message */
 
 } NSSyncInfo;
 
index 6f54281..06c033d 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
@@ -58,9 +58,9 @@ typedef void (* NSSyncInfoReceivedCallback)(NSSyncInfo *);
 
 typedef struct
 {
-    NSProviderStateCallback changedCb;
-    NSMessageReceivedCallback messageCb;
-    NSSyncInfoReceivedCallback syncInfoCb;
+    NSProviderStateCallback changedCb;       /**< provider state callback */
+    NSMessageReceivedCallback messageCb;     /**< message received callback */
+    NSSyncInfoReceivedCallback syncInfoCb;   /**< sync information received callback */
 
 } NSConsumerConfig;
 
index 7f016bc..1c589d9 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSTANTS_H_
 #define _NS_CONSTANTS_H_
 #endif // LOG_TAG
 #define LOG_TAG "NotificationService"
 
+/**
+ * convert log level
+ * @param level   according to log level print the information
+ * @return log level information
+ */
 inline log_priority NSConvertLogLevel(int level)
 {
     // Always log private data on Tizen.
     level &= ~OC_LOG_PRIVATE_DATA;
-
+    /** debug log */
     if (level == DEBUG)
     {
         return DLOG_DEBUG;
     }
-
+    /** information log */
     if ((level == INFO) || (level == DEBUG_LITE) || (level == INFO_LITE))
     {
         return DLOG_INFO;
     }
-
+    /** warning log */
     if (level == WARNING)
     {
         return DLOG_WARN;
     }
-
+    /** error log */
     if ((level == ERROR) || (level == FATAL))
     {
         return DLOG_ERROR;
@@ -98,58 +103,61 @@ inline log_priority NSConvertLogLevel(int level)
 #endif // (__PRINTLOG == 1)
 #endif // TB_LOG
 
-#define NS_TAG                     "IOT_NOTI"
+#define NS_TAG                     "IOT_NOTI"   /**< notification tag information */
 
-// SCHEDULE //
+/* SCHEDULE */
 #define THREAD_COUNT               5
 
-// NOTIOBJ //
-#define NOTIOBJ_TITLE_KEY          "x.org.iotivity.ns.title"
-#define NOTIOBJ_ID_KEY             "x.org.iotivity.ns.id"
-#define NOTOOBJ_CONTENT_KEY        "x.org.iotivity.ns.contenttext"
+/* NOTIOBJ */
+#define NOTIOBJ_TITLE_KEY          "x.org.iotivity.ns.title" /**< notification object title key */
+#define NOTIOBJ_ID_KEY             "x.org.iotivity.ns.id"    /**< notification object Id key */
+#define NOTOOBJ_CONTENT_KEY        "x.org.iotivity.ns.contenttext" /**< notification object content key */
 
-#define DISCOVERY_TAG              "NS_PROVIDER_DISCOVERY"
-#define SUBSCRIPTION_TAG           "NS_PROVIDER_SUBSCRIPTION"
-#define INTERFACE_TAG              "NS_PROVIDER_INTERFACE"
-#define NOTIFICATION_TAG           "NS_PROVIDER_NOTIFICATION"
-#define SCHEDULER_TAG              "NS_PROVIDER_SCHEDULER"
-#define LISTENER_TAG               "NS_PROVIDER_LISTENER"
-#define RESOURCE_TAG               "NS_PROVIDER_RESOURCE"
-#define TOPIC_TAG                  "NS_PROVIDER_TOPIC"
+#define DISCOVERY_TAG              "NS_PROVIDER_DISCOVERY"    /**< discovery tag */
+#define SUBSCRIPTION_TAG           "NS_PROVIDER_SUBSCRIPTION" /**< subscription tag */
+#define INTERFACE_TAG              "NS_PROVIDER_INTERFACE"    /**< Interface tag */
+#define NOTIFICATION_TAG           "NS_PROVIDER_NOTIFICATION" /**< notification tag */
+#define SCHEDULER_TAG              "NS_PROVIDER_SCHEDULER"    /**< scheduler tag */
+#define LISTENER_TAG               "NS_PROVIDER_LISTENER"     /**< listener tag */
+#define RESOURCE_TAG               "NS_PROVIDER_RESOURCE"     /**< resource tag */
+#define TOPIC_TAG                  "NS_PROVIDER_TOPIC"        /**< topic tag */
 
-#define NS_ROOT_TYPE               "x.org.iotivity.notification"
-#define NS_COLLECTION_MESSAGE_TYPE "x.org.iotivity.notification.message"
-#define NS_COLLECTION_SYNC_TYPE    "x.org.iotivity.notification.sync"
-#define NS_COLLECTION_TOPIC_TYPE   "x.org.iotivity.notification.topic"
+#define NS_ROOT_TYPE               "x.org.iotivity.notification" /**< notification root type */
+#define NS_COLLECTION_MESSAGE_TYPE "x.org.iotivity.notification.message" /**< collection message type */
+#define NS_COLLECTION_SYNC_TYPE    "x.org.iotivity.notification.sync"    /**< collection sync type */
+#define NS_COLLECTION_TOPIC_TYPE   "x.org.iotivity.notification.topic"   /**< collection topic type */
 
-#define NS_INTERFACE_READ          "oic.if.r"
-#define NS_INTERFACE_READWRITE     "oic.if.rw"
-#define NS_INTERFACE_BASELINE      "oic.if.baseline"
+#define NS_INTERFACE_READ          "oic.if.r"        /**< read */
+#define NS_INTERFACE_READWRITE     "oic.if.rw"       /**< read write */
+#define NS_INTERFACE_BASELINE      "oic.if.baseline" /**< baseline */
 
-#define NS_ROOT_URI                "/notification"
-#define NS_COLLECTION_MESSAGE_URI  "/notification/message"
-#define NS_COLLECTION_SYNC_URI     "/notification/sync"
-#define NS_COLLECTION_TOPIC_URI    "/notification/topic"
+#define NS_ROOT_URI                "/notification"   /**< root uri */
+#define NS_COLLECTION_MESSAGE_URI  "/notification/message" /**< collection message uri */
+#define NS_COLLECTION_SYNC_URI     "/notification/sync"    /**< collection sync uri */
+#define NS_COLLECTION_TOPIC_URI    "/notification/topic"   /**< collection topic uri */
 
-#define NS_QUERY_SEPARATOR         "&;"
-#define NS_KEY_VALUE_DELIMITER     "="
+#define NS_QUERY_SEPARATOR         "&;" /**< query separator */
+#define NS_KEY_VALUE_DELIMITER     "="  /**< key value delimiter */
 
-#define NS_QUERY_CONSUMER_ID       "x.org.iotivity.ns.consumerid"
-#define NS_QUERY_PROVIDER_ID       "x.org.iotivity.ns.providerid"
-#define NS_QUERY_INTERFACE         "if"
+#define NS_QUERY_CONSUMER_ID       "x.org.iotivity.ns.consumerid" /**< query consumer Id */
+#define NS_QUERY_PROVIDER_ID       "x.org.iotivity.ns.providerid" /**< query provider Id */
+#define NS_QUERY_INTERFACE         "if" /**< query interface */
 
-#define NS_QUERY_ID_SIZE           10
+#define NS_QUERY_ID_SIZE           10   /**< query Id size */
 
-#define NS_POLICY_PROVIDER         1
-#define NS_POLICY_CONSUMER         0
+#define NS_POLICY_PROVIDER         1    /**< policy provider */
+#define NS_POLICY_CONSUMER         0    /**< policy consumer */
 
-#define NS_RD_PUBLISH_QUERY        "/oic/rd?rt=oic.wk.rdpub"
+#define NS_RD_PUBLISH_QUERY        "/oic/rd?rt=oic.wk.rdpub"   /**< RD publish query */
 
 #ifdef WITH_MQ
-#define NS_ATTRIBUTE_MQ_MESSAGE   "x.org.iotivity.ns.message"
-#define NS_ATTIRBUTE_MQ_TOPICLIST "x.org.iotivity.ns.topiclist"
+#define NS_ATTRIBUTE_MQ_MESSAGE   "x.org.iotivity.ns.message"   /**< attribute MQ message */
+#define NS_ATTIRBUTE_MQ_TOPICLIST "x.org.iotivity.ns.topiclist" /**< attribute MQ topic list */
 #endif
 
+/**
+ * Verify not null value
+ */
 #define NS_VERIFY_NOT_NULL_V(obj) \
     { \
         if ((obj) == NULL) \
@@ -159,6 +167,9 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * Verify not null value
+ */
 #define NS_VERIFY_NOT_NULL(obj, retVal) \
     { \
         if ((obj) == NULL) \
@@ -168,6 +179,9 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * Verify not null value with post cleanup
+ */
 #define NS_VERIFY_NOT_NULL_WITH_POST_CLEANING_V(obj, func) \
     { \
         if ((obj) == NULL) \
@@ -179,6 +193,10 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * Verify not null value of object
+ * If value is null return with cleanup
+ */
 #define NS_VERIFY_NOT_NULL_WITH_POST_CLEANING(obj, retVal, func) \
     { \
         if ((obj) == NULL) \
@@ -190,6 +208,9 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * Verify with success value.
+ */
 #define NS_VERIFY_STACK_SUCCESS_V(obj) \
     { \
         bool _ret = (obj); \
@@ -200,6 +221,9 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * Verify with success value.
+ */
 #define NS_VERIFY_STACK_SUCCESS(obj, retVal) \
     { \
         bool _ret = (obj); \
@@ -210,6 +234,10 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * Verify with success value.
+ * If value is not match then cleanup and return.
+ */
 #define NS_VERIFY_STACK_SUCCESS_WITH_POST_CLEANING(obj, retVal, func) \
     { \
         bool _ret = (obj); \
@@ -221,6 +249,9 @@ inline log_priority NSConvertLogLevel(int level)
         } \
     }
 
+/**
+ * OIC free object
+ */
 #define NSOICFree(obj) \
     { \
         if ((obj)) \
@@ -233,141 +264,141 @@ inline log_priority NSConvertLogLevel(int level)
 
 #define VERSION        IOTIVITY_VERSION
 
-#define NS_ATTRIBUTE_VERSION "x.org.iotivity.ns.version"
-#define NS_ATTRIBUTE_POLICY "x.org.iotivity.ns.subcontrollability"
-#define NS_ATTRIBUTE_MESSAGE "x.org.iotivity.ns.messageuri"
-#define NS_ATTRIBUTE_SYNC "x.org.iotivity.ns.syncuri"
-#define NS_ATTRIBUTE_TOPIC "x.org.iotivity.ns.topicuri"
-#define NS_ATTRIBUTE_MESSAGE_ID "x.org.iotivity.ns.messageid"
-#define NS_ATTRIBUTE_PROVIDER_ID "x.org.iotivity.ns.providerid"
-#define NS_ATTRIBUTE_CONSUMER_ID "x.org.iotivity.ns.consumerid"
-#define NS_ATTRIBUTE_TOPIC_LIST "x.org.iotivity.ns.topiclist"
-#define NS_ATTRIBUTE_TOPIC_NAME "x.org.iotivity.ns.topicname"
-#define NS_ATTRIBUTE_TOPIC_SELECTION "x.org.iotivity.ns.topicstate"
-#define NS_ATTRIBUTE_TITLE "x.org.iotivity.ns.title"
-#define NS_ATTRIBUTE_TEXT "x.org.iotivity.ns.contenttext"
-#define NS_ATTRIBUTE_SOURCE "x.org.iotivity.ns.source"
-#define NS_ATTRIBUTE_STATE "x.org.iotivity.ns.state"
-#define NS_ATTRIBUTE_DEVICE "x.org.iotivity.ns.device"
-#define NS_ATTRIBUTE_TYPE "x.org.iotivity.ns.type"
-#define NS_ATTRIBUTE_DATETIME "x.org.iotivity.ns.datetime"
-#define NS_ATTRIBUTE_TTL "x.org.iotivity.ns.ttl"
-#define NS_ATTRIBUTE_ICON_IMAGE "x.org.iotivity.ns.iconimage"
+#define NS_ATTRIBUTE_VERSION "x.org.iotivity.ns.version"            /**< attribute version */
+#define NS_ATTRIBUTE_POLICY "x.org.iotivity.ns.subcontrollability"  /**< attribute policy */
+#define NS_ATTRIBUTE_MESSAGE "x.org.iotivity.ns.messageuri"         /**< attribute messge */
+#define NS_ATTRIBUTE_SYNC "x.org.iotivity.ns.syncuri"               /**< attribute sync */
+#define NS_ATTRIBUTE_TOPIC "x.org.iotivity.ns.topicuri"             /**< attribute topic */
+#define NS_ATTRIBUTE_MESSAGE_ID "x.org.iotivity.ns.messageid"       /**< attribute message Id */
+#define NS_ATTRIBUTE_PROVIDER_ID "x.org.iotivity.ns.providerid"     /**< attribute provider Id */
+#define NS_ATTRIBUTE_CONSUMER_ID "x.org.iotivity.ns.consumerid"     /**< attribute consumer Id */
+#define NS_ATTRIBUTE_TOPIC_LIST "x.org.iotivity.ns.topiclist"       /**< attribute topic list */
+#define NS_ATTRIBUTE_TOPIC_NAME "x.org.iotivity.ns.topicname"       /**< attribute topic name */
+#define NS_ATTRIBUTE_TOPIC_SELECTION "x.org.iotivity.ns.topicstate" /**< attribute topic selection */
+#define NS_ATTRIBUTE_TITLE "x.org.iotivity.ns.title"                /**< attribute title */
+#define NS_ATTRIBUTE_TEXT "x.org.iotivity.ns.contenttext"           /**< attribute text */
+#define NS_ATTRIBUTE_SOURCE "x.org.iotivity.ns.source"              /**< attribute source */
+#define NS_ATTRIBUTE_STATE "x.org.iotivity.ns.state"                /**< attribute state */
+#define NS_ATTRIBUTE_DEVICE "x.org.iotivity.ns.device"              /**< attribute device */
+#define NS_ATTRIBUTE_TYPE "x.org.iotivity.ns.type"                  /**< attribute type */
+#define NS_ATTRIBUTE_DATETIME "x.org.iotivity.ns.datetime"          /**< attribute date time */
+#define NS_ATTRIBUTE_TTL "x.org.iotivity.ns.ttl"                    /**< attribute ttl */
+#define NS_ATTRIBUTE_ICON_IMAGE "x.org.iotivity.ns.iconimage"       /**< attribute icon image */
 
 typedef enum eConnectionState
 {
-    DISCONNECTED = 0,
-    CONNECTED = 1,
+    DISCONNECTED = 0,           /**< disconnected state */
+    CONNECTED = 1,              /**< connected state */
 
 } NSConnectionState;
 
 typedef enum eSchedulerType
 {
-    CALLBACK_RESPONSE_SCHEDULER = 0,
-    DISCOVERY_SCHEDULER = 1,
-    SUBSCRIPTION_SCHEDULER = 2,
-    NOTIFICATION_SCHEDULER = 3,
-    TOPIC_SCHEDULER = 4,
+    CALLBACK_RESPONSE_SCHEDULER = 0,    /**< callback response scheduler */
+    DISCOVERY_SCHEDULER = 1,            /**< discovery scheduler */
+    SUBSCRIPTION_SCHEDULER = 2,         /**< subscription scheduler */
+    NOTIFICATION_SCHEDULER = 3,         /**< notification scheduler */
+    TOPIC_SCHEDULER = 4,                /**< topic scheduler */
 
 } NSSchedulerType;
 
 typedef enum eTaskType
 {
 #ifdef WITH_MQ
-    TASK_MQ_REQ_SUBSCRIBE = 20001,
+    TASK_MQ_REQ_SUBSCRIBE = 20001,              /**< subscribe request */
 #endif
 
-    TASK_REGISTER_RESOURCE = 1000,
-    TASK_PUBLISH_RESOURCE = 1001,
+    TASK_REGISTER_RESOURCE = 1000,             /**< register resource */
+    TASK_PUBLISH_RESOURCE = 1001,              /**< publish resource */
 
-    TASK_START_PRESENCE = 2000,
-    TASK_STOP_PRESENCE = 2001,
+    TASK_START_PRESENCE = 2000,                /**< start presence */
+    TASK_STOP_PRESENCE = 2001,                 /**< stop presence */
 
-    TASK_RECV_SUBSCRIPTION = 3000,
-    TASK_RECV_UNSUBSCRIPTION = 3001,
-    TASK_SEND_POLICY = 3002,
-    TASK_SEND_ALLOW = 3003,
-    TASK_SEND_DENY = 3004,
-    TASK_SYNC_SUBSCRIPTION = 3005,
+    TASK_RECV_SUBSCRIPTION = 3000,             /**< receive subscription */
+    TASK_RECV_UNSUBSCRIPTION = 3001,           /**< receive unsubscription */
+    TASK_SEND_POLICY = 3002,                   /**< send policy */
+    TASK_SEND_ALLOW = 3003,                    /**< allow send */
+    TASK_SEND_DENY = 3004,                     /**< deny send */
+    TASK_SYNC_SUBSCRIPTION = 3005,             /**< sync subscription */
 
-    TASK_SEND_NOTIFICATION = 4000,
-    TASK_SEND_PENDING_NOTI = 4001,
+    TASK_SEND_NOTIFICATION = 4000,            /**< send notification */
+    TASK_SEND_PENDING_NOTI = 4001,            /**< send pending notification */
 
-    TASK_RECV_SYNCINFO = 5000,
-    TASK_RECV_READ = 5001,
-    TASK_RECV_DISMISS = 5003,
-    TASK_SEND_SYNCINFO = 5099,
-    TASK_MAKE_SYNCINFO = 5100,
-    TASK_SEND_READ = 5101,
+    TASK_RECV_SYNCINFO = 5000,                /**< receive sync information */
+    TASK_RECV_READ = 5001,                    /**< receive read */
+    TASK_RECV_DISMISS = 5003,                 /**< receive dismiss */
+    TASK_SEND_SYNCINFO = 5099,                /**< send sync information */
+    TASK_MAKE_SYNCINFO = 5100,                /**< make sync information */
+    TASK_SEND_READ = 5101,                    /**< send read */
     TASK_SEND_DISMISS = 5102,
 
-    TASK_CONSUMER_REQ_DISCOVER = 8001,
-    TASK_CONSUMER_REQ_SUBSCRIBE = 8002,
-    TASK_CONSUMER_REQ_SUBSCRIBE_CANCEL = 8003,
-    TASK_CONSUMER_SENT_REQ_OBSERVE = 8004,
-    TASK_CONSUMER_RECV_PROVIDER_CHANGED = 8005,
-    TASK_CONSUMER_RECV_MESSAGE = 8101,
-
-    TASK_CONSUMER_PROVIDER_DISCOVERED = 8201,
-    TASK_CONSUMER_PROVIDER_DELETED = 8202,
-    TASK_CONSUMER_RECV_CONFIRM = 8206,
-
-    TASK_CONSUMER_REQ_TOPIC_URI = 8299,
-    TASK_CONSUMER_REQ_TOPIC_LIST = 8300,
-    TASK_CONSUMER_RECV_TOPIC_LIST = 8031,
-    TASK_CONSUMER_SELECT_TOPIC_LIST = 8303,
-
-    TASK_EVENT_CONNECTED = 9000,
-    TASK_EVENT_CONNECTED_TCP = 9001,
-    TASK_EVENT_DISCONNECTED = 9002,
-
-    TASK_CB_SUBSCRIPTION = 10000,
-    TASK_CB_SYNC = 10001,
-
-    TASK_SEND_TOPICS = 11000,
-    TASK_REGISTER_TOPIC = 11001,
-    TASK_UNREGISTER_TOPIC = 11002,
-    TASK_SUBSCRIBE_TOPIC = 11003,
-    TASK_UNSUBSCRIBE_TOPIC = 11004,
-    TASK_POST_TOPIC = 11005,
-    TASK_GET_TOPICS = 11006,
-    TAST_GET_CONSUMER_TOPICS = 11007
+    TASK_CONSUMER_REQ_DISCOVER = 8001,         /**< consumer request discover */
+    TASK_CONSUMER_REQ_SUBSCRIBE = 8002,        /**< consumer request subscribe */
+    TASK_CONSUMER_REQ_SUBSCRIBE_CANCEL = 8003, /**< cancle consumer request subscribe */
+    TASK_CONSUMER_SENT_REQ_OBSERVE = 8004,     /**< consumer send request observe */
+    TASK_CONSUMER_RECV_PROVIDER_CHANGED = 8005,/**< consumer receive change provider */
+    TASK_CONSUMER_RECV_MESSAGE = 8101,         /**< consumer receive message */
+
+    TASK_CONSUMER_PROVIDER_DISCOVERED = 8201,  /**< consumer provider discovered */
+    TASK_CONSUMER_PROVIDER_DELETED = 8202,     /**< consumer provider deleted */
+    TASK_CONSUMER_RECV_CONFIRM = 8206,         /**< consumer receive confirm */
+
+    TASK_CONSUMER_REQ_TOPIC_URI = 8299,       /**< consumer request topic uri */
+    TASK_CONSUMER_REQ_TOPIC_LIST = 8300,      /**< consumer request topic list */
+    TASK_CONSUMER_RECV_TOPIC_LIST = 8031,     /**< consumer receive topic list */
+    TASK_CONSUMER_SELECT_TOPIC_LIST = 8303,   /**< consumer select topic list */
+
+    TASK_EVENT_CONNECTED = 9000,             /**< event connected */
+    TASK_EVENT_CONNECTED_TCP = 9001,         /**< TCP event connected */
+    TASK_EVENT_DISCONNECTED = 9002,          /**< event disconnected */
+
+    TASK_CB_SUBSCRIPTION = 10000,            /**< subscription callback */
+    TASK_CB_SYNC = 10001,                    /**< sync callback */
+
+    TASK_SEND_TOPICS = 11000,               /**< send topics */
+    TASK_REGISTER_TOPIC = 11001,            /**< register topic */
+    TASK_UNREGISTER_TOPIC = 11002,          /**< unregister topic */
+    TASK_SUBSCRIBE_TOPIC = 11003,           /**< subscribe topic */
+    TASK_UNSUBSCRIBE_TOPIC = 11004,         /**< unsubscribe topic */
+    TASK_POST_TOPIC = 11005,                /**< post topic */
+    TASK_GET_TOPICS = 11006,                /**< get topic */
+    TAST_GET_CONSUMER_TOPICS = 11007        /**< get consumer topic */
 
 } NSTaskType;
 
 typedef enum eCache
 {
-    NS_CONSUMER_BLACKLIST = 0,
-    NS_CONSUMER_WHITELIST = 1,
+    NS_CONSUMER_BLACKLIST = 0,           /**< consumer black list */
+    NS_CONSUMER_WHITELIST = 1,           /**< consumer white list */
 
 } NSCache;
 
 typedef enum eCacheType
 {
-    NS_PROVIDER_CACHE_SUBSCRIBER = 1000,
-    NS_PROVIDER_CACHE_MESSAGE = 1001,
-    NS_PROVIDER_CACHE_CONSUMER_TOPIC_NAME = 1002,
-    NS_PROVIDER_CACHE_CONSUMER_TOPIC_CID = 1003,
-    NS_PROVIDER_CACHE_REGISTER_TOPIC = 1004,
-    NS_PROVIDER_CACHE_SUBSCRIBER_OBSERVE_ID = 1005,
+    NS_PROVIDER_CACHE_SUBSCRIBER = 1000,           /**< provider cache subscriber */
+    NS_PROVIDER_CACHE_MESSAGE = 1001,              /**< provider cache messge */
+    NS_PROVIDER_CACHE_CONSUMER_TOPIC_NAME = 1002,  /**< provider cache consumer topic name */
+    NS_PROVIDER_CACHE_CONSUMER_TOPIC_CID = 1003,   /**< provider cache consumer topic CID */
+    NS_PROVIDER_CACHE_REGISTER_TOPIC = 1004,       /**< provider cache register topic */
+    NS_PROVIDER_CACHE_SUBSCRIBER_OBSERVE_ID = 1005,/**< provider cache subscriber observe Id */
 
-    NS_CONSUMER_CACHE_PROVIDER = 2000,
-    NS_CONSUMER_CACHE_MESSAGE = 2001,
+    NS_CONSUMER_CACHE_PROVIDER = 2000,             /**< consumer cache provider */
+    NS_CONSUMER_CACHE_MESSAGE = 2001,              /**< consumer cache message */
 
 } NSCacheType;
 
 typedef enum eResourceType
 {
-    NS_RESOURCE_MESSAGE = 1000,
-    NS_RESOURCE_SYNC = 1001,
-    NS_RESOURCE_TOPIC = 1002,
+    NS_RESOURCE_MESSAGE = 1000,   /**< resource message */
+    NS_RESOURCE_SYNC = 1001,      /**< resource sync */
+    NS_RESOURCE_TOPIC = 1002,     /**< resource topic */
 
 } NSResourceType;
 
 typedef enum eInterfaceType
 {
-    NS_INTERFACE_TYPE_READ = 1,
-    NS_INTERFACE_TYPE_READWRITE = 2,
+    NS_INTERFACE_TYPE_READ = 1,      /**< read */
+    NS_INTERFACE_TYPE_READWRITE = 2, /**< read write */
 
 } NSInterfaceType;
 
index a2e4c7b..8111c9f 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_STRUCTS_H_\r
 #define _NS_STRUCTS_H_\r
 #include "NSConstants.h"\r
 #include "ocstack.h"\r
 \r
+/** ns task structure */\r
 typedef struct _nsTask\r
 {\r
-    NSTaskType taskType;\r
-    void * taskData;\r
-    struct _nsTask * nextTask;\r
+    NSTaskType taskType;        /**< task type */\r
+    void * taskData;            /**< task data */\r
+    struct _nsTask * nextTask;  /**< pointer to next task */\r
 \r
 } NSTask;\r
 \r
+/** ns topic list structure */\r
 typedef struct\r
 {\r
-    NSTopicLL * head;\r
-    NSTopicLL * tail;\r
-    char consumerId[NS_UUID_STRING_SIZE];\r
-    NSTopicLL ** topics;\r
+    NSTopicLL * head;                       /**< head node of list */\r
+    NSTopicLL * tail;                       /**< tail node of list */\r
+    char consumerId[NS_UUID_STRING_SIZE];   /**< consumer Id */\r
+    NSTopicLL ** topics;                    /**< poniter to structure */\r
 \r
 } NSTopicList;\r
 \r
-typedef void * NSCacheData;\r
+typedef void * NSCacheData; /**< ns cache data */\r
 \r
+/** ns cache element structure */\r
 typedef struct _NSCacheElement\r
 {\r
-    NSCacheData * data;\r
-    struct _NSCacheElement * next;\r
+    NSCacheData * data;                 /**< cache data */\r
+    struct _NSCacheElement * next;      /**< pointer to next element */\r
 \r
 } NSCacheElement;\r
 \r
+/** ns cache list */\r
 typedef struct\r
 {\r
-    NSCacheType cacheType;\r
-    NSCacheElement * head;\r
-    NSCacheElement * tail;\r
+    NSCacheType cacheType;         /**< cache type */\r
+    NSCacheElement * head;         /**< head node of list */\r
+    NSCacheElement * tail;         /**< tail node of list */\r
 \r
 } NSCacheList;\r
 \r
+/** ns cache sub data structure */\r
 typedef struct\r
 {\r
-    char id[NS_UUID_STRING_SIZE];\r
-    int syncObId; // sync resource observer ID for local consumer\r
-    int messageObId; // message resource observer ID for local consumer\r
-    bool isWhite; // access state -> True: allowed / False: blocked\r
+    char id[NS_UUID_STRING_SIZE]; /**< id */\r
+    int syncObId;                 /**< sync resource observer ID for local consumer */\r
+    int messageObId;              /**< message resource observer ID for local consumer */\r
+    bool isWhite;                 /**< access state -> True: allowed / False: blocked */\r
 \r
 } NSCacheSubData;\r
 \r
+/** ns cache message data structure */\r
 typedef struct\r
 {\r
-    char * id;\r
-    int messageType; // noti = 1, read = 2, dismiss = 3\r
-    NSMessage * nsMessage;\r
+    char * id; /**< id */\r
+    int messageType; /**< noti = 1, read = 2, dismiss = 3 */\r
+    NSMessage * nsMessage; /**< message */\r
 \r
 } NSCacheMsgData;\r
 \r
+/** ns cache topic data structure */\r
 typedef struct\r
 {\r
-    char * topicName;\r
-    NSTopicState state;\r
+    char * topicName;    /**< topic name */\r
+    NSTopicState state;  /**< topic state */\r
 \r
 } NSCacheTopicData;\r
 \r
+/** ns cache topic sub data structure */\r
 typedef struct\r
 {\r
-    char id[NS_UUID_STRING_SIZE];\r
-    char * topicName;\r
+    char id[NS_UUID_STRING_SIZE];  /**< id */\r
+    char * topicName;              /**< topic name */\r
 \r
 } NSCacheTopicSubData;\r
 \r
+/** ns notification resource structure */\r
 typedef struct\r
 {\r
-    OCResourceHandle handle;\r
-    char providerId[NS_UUID_STRING_SIZE];\r
-    char * version;\r
-    bool policy;\r
-    char * message_uri;\r
-    char * sync_uri;\r
+    OCResourceHandle handle;               /**< resource handle */\r
+    char providerId[NS_UUID_STRING_SIZE];  /**< provider Id */\r
+    char * version;                        /**< version */\r
+    bool policy;                           /**< policy */\r
+    char * message_uri;                    /**< message uri */\r
+    char * sync_uri;                       /**< sync uri */\r
 \r
-    //optional\r
-    char * topic_uri;\r
+    /** optional */\r
+    char * topic_uri;                     /**< topic uri */\r
 \r
 } NSNotificationResource;\r
 \r
+/** ns message resource */\r
 typedef struct\r
 {\r
-    OCResourceHandle handle;\r
+    OCResourceHandle handle;              /**< resource handle */\r
 \r
-    uint64_t messageId;\r
-    char providerId[NS_UUID_STRING_SIZE];\r
+    uint64_t messageId;                   /**< message Id */\r
+    char providerId[NS_UUID_STRING_SIZE]; /**< provider Id */\r
 \r
     //optional\r
-    NSMessageType type;\r
-    char * dateTime;\r
-    uint64_t ttl;\r
-    char * title;\r
-    char * contentText;\r
-    char * sourceName;\r
-    char * topicName;\r
-    NSMediaContents * mediaContents;\r
+    NSMessageType type;                   /**< type */\r
+    char * dateTime;                      /**< date time */\r
+    uint64_t ttl;                         /**< ttl */\r
+    char * title;                         /**< title */\r
+    char * contentText;                   /**< content text */\r
+    char * sourceName;                    /**< source name */\r
+    char * topicName;                     /**< topic name */\r
+    NSMediaContents * mediaContents;      /**< media contents */\r
 \r
 } NSMessageResource;\r
 \r
+/** ns sync resource structure */\r
 typedef struct\r
 {\r
-    OCResourceHandle handle;\r
-    uint64_t messageId;\r
-    char providerId[NS_UUID_STRING_SIZE];\r
-    char * state;\r
+    OCResourceHandle handle;              /**< resource handle */\r
+    uint64_t messageId;                   /**< message Id */\r
+    char providerId[NS_UUID_STRING_SIZE]; /**< provider Id */\r
+    char * state;                         /**< resource state */\r
 \r
 } NSSyncResource;\r
 \r
+/** ns topic resource structure */\r
 typedef struct\r
 {\r
-    OCResourceHandle handle;\r
-    char providerId[NS_UUID_STRING_SIZE];\r
-    char consumerId[NS_UUID_STRING_SIZE];\r
-    NSTopicList ** TopicList;\r
+    OCResourceHandle handle;              /**< resource handle */\r
+    char providerId[NS_UUID_STRING_SIZE]; /**< provider Id */\r
+    char consumerId[NS_UUID_STRING_SIZE]; /**< consumer Id */\r
+    NSTopicList ** TopicList;             /**< pointer to topic list */\r
 \r
 } NSTopicResource;\r
 \r
+/** ns provider information structure */\r
 typedef struct\r
 {\r
-    char providerId[NS_UUID_STRING_SIZE];\r
-    char * providerName;\r
-    char * userInfo;\r
+    char providerId[NS_UUID_STRING_SIZE];  /**< provider Id */\r
+    char * providerName;                   /**< provider name */\r
+    char * userInfo;                       /**< user information */\r
 \r
 } NSProviderInfo;\r
 \r
 #ifdef WITH_MQ\r
+/** ns MQ topic address structure */\r
 typedef struct\r
 {\r
-    char * serverAddr;\r
-    char * topicName;\r
+    char * serverAddr;                     /**< server address */\r
+    char * topicName;                      /**< topic name */\r
 \r
 } NSMQTopicAddress;\r
 \r
+/** ns MQ server information structure */\r
 typedef struct\r
 {\r
-    char * serverUri;\r
-    OCDevAddr * devAddr;\r
+    char * serverUri;                   /**< server uri */\r
+    OCDevAddr * devAddr;                /**< device address */\r
 \r
 } NSMQServerInfo;\r
 #endif\r
index 3ba1920..d20965a 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_UTIL__H_\r
 #define _NS_UTIL__H_\r
 #include "oic_time.h"\r
 #include "NSProviderSystem.h"\r
 \r
-OCEntityHandlerRequest *NSCopyOCEntityHandlerRequest(OCEntityHandlerRequest *);\r
-NSResult NSFreeOCEntityHandlerRequest(OCEntityHandlerRequest *);\r
+/**\r
+ * Copy OC entity handler on request.\r
+ *\r
+ * @param entityHandlerRequest   entity handler request to handle the incomming requests\r
+ *\r
+ * @return entity handler request pointer\r
+ */\r
+OCEntityHandlerRequest *NSCopyOCEntityHandlerRequest(OCEntityHandlerRequest *entityHandlerRequest);\r
 \r
+/**\r
+ * Free OC entity handler on request.\r
+ * @param entityHandlerRequest   entity handler request to handle the incomming requests\r
+ * @return NS_OK\r
+ */\r
+NSResult NSFreeOCEntityHandlerRequest(OCEntityHandlerRequest *entityHandlerRequest);\r
+\r
+/**\r
+ * Initialize the message.\r
+ *\r
+ * @return message.\r
+ */\r
 NSMessage * NSInitializeMessage(void);\r
-NSResult NSFreeMessage(NSMessage *);\r
-NSMessage * NSDuplicateMessage(NSMessage *);\r
 \r
-NSResult NSFreeSync(NSSyncInfo *);\r
-NSSyncInfo * NSDuplicateSync(NSSyncInfo *);\r
+/**\r
+ * Free the messagei object.\r
+ *\r
+ * @param obj    message object.\r
+ *\r
+ * @return NS_OK for successfully free, otherwise NS_ERROR.\r
+ */\r
+NSResult NSFreeMessage(NSMessage *obj);\r
+\r
+/**\r
+ * Duplicate the message.\r
+ *\r
+ * @param copyMsg     notification mesage to duplicate\r
+ *\r
+ * @return new message\r
+ */\r
+NSMessage * NSDuplicateMessage(NSMessage *copyMsg);\r
+\r
+/**\r
+ * Free sync information object.\r
+ *\r
+ * @param obj   object to free.\r
+ *\r
+ * @return NS_OK for successfully free, otherwise NS_ERROR.\r
+ */\r
+NSResult NSFreeSync(NSSyncInfo *obj);\r
+\r
+/**\r
+ * Duplicate the sync.\r
+ *\r
+ * @param copyMsg    notification sync information to copy\r
+ *\r
+ * @return new message\r
+ */\r
+NSSyncInfo * NSDuplicateSync(NSSyncInfo *copyMsg);\r
+\r
+/**\r
+ * Get the sync information.\r
+ *\r
+ * @param payload    oc payload\r
+ *\r
+ * @return sync information\r
+ */\r
 NSSyncInfo * NSGetSyncInfo(OCPayload * payload);\r
 \r
-NSResult NSFreeConsumer(NSConsumer *);\r
-NSConsumer * NSDuplicateConsumer(NSConsumer *);\r
+/**\r
+ * Free the consumer object.\r
+ *\r
+ * @param obj   object to free.\r
+ *\r
+ * @return NS_OK for successfully free, otherwise NS_ERROR.\r
+ */\r
+NSResult NSFreeConsumer(NSConsumer *obj);\r
+\r
+/**\r
+ * Duplicate the consumer.\r
+ *\r
+ * @param copyMsg    notification consumer to duplicate\r
+ *\r
+ * @return new message\r
+ */\r
+NSConsumer * NSDuplicateConsumer(NSConsumer *copyMsg);\r
 \r
+/**\r
+ * Initialize the topic list.\r
+ *\r
+ * @return topic list.\r
+ */\r
 NSTopicList * NSInitializeTopicList(void);\r
 \r
-void NSDuplicateSetPropertyString(OCRepPayload **, const char *, const char *);\r
+/**\r
+ * Set property string.\r
+ *\r
+ * @param msgPayload   oc representation payload\r
+ * @param name         payload name value to copy\r
+ * @param copyString   copy value according to the type\r
+ */\r
+void NSDuplicateSetPropertyString(OCRepPayload **msgPayload, const char *name, const char *copyString);\r
+\r
+/**\r
+ * Set integer property.\r
+ *\r
+ * @param msgPayload  oc message payload\r
+ * @param name        payload name value to copy\r
+ * @param value       copy int value\r
+ */\r
 void NSDuplicateSetPropertyInt(OCRepPayload ** msgPayload, const char * name, int64_t value);\r
+\r
+/**\r
+ * Generate UUID string.\r
+ *\r
+ * @param uuidStr  store uuid string\r
+ *\r
+ * @return NS_OK if success, otherwise NS_ERROR\r
+ */\r
 NSResult NSGenerateUUIDStr(char uuidStr[UUID_STRING_SIZE]);\r
 \r
+/**\r
+ * Get value from query using comparekey.\r
+ *\r
+ * @param query       query information\r
+ * @param compareKey  get value from query using key\r
+ *\r
+ * @return value\r
+ */\r
 char * NSGetValueFromQuery(char *query, char * compareKey);\r
+\r
+/**\r
+ * Free the object.\r
+ *\r
+ * @param obj  object to free\r
+ *\r
+ * @return NS_OK if success, otherwise NS_FAIL\r
+ */\r
 NSResult NSFreeMalloc(char ** obj);\r
 \r
+/**\r
+ * Free media contents.\r
+ *\r
+ * @param obj   object of media contents\r
+ *\r
+ * @return NS_OK if success, otherwise NS_FAIL\r
+ */\r
 NSResult NSFreeMediaContents(NSMediaContents * obj);\r
+\r
+/**\r
+ * Duplicate media contents.\r
+ *\r
+ * @param copyObj  media content object\r
+ *\r
+ * @return new object\r
+ */\r
 NSMediaContents * NSDuplicateMediaContents(NSMediaContents * copyObj);\r
 \r
+/**\r
+ * Find value in payload.\r
+ *\r
+ * @param payload  oc representation payload\r
+ * @param name     value to find\r
+ *\r
+ * @return value\r
+ */\r
 OCRepPayloadValue* NSPayloadFindValue(const OCRepPayload* payload, const char* name);\r
 \r
+/**\r
+ * Change the address.\r
+ *\r
+ * @param address address to change\r
+ *\r
+ * @return changed address\r
+ */\r
 OCDevAddr * NSChangeAddress(const char * address);\r
+\r
+/**\r
+ * OC stack result.\r
+ *\r
+ * @param ret   result value\r
+ *\r
+ * @return true or false\r
+ */\r
 bool NSOCResultToSuccess(OCStackResult ret);\r
 \r
 #endif /* _NS_UTIL__H_ */\r
index 07eb03d..5b7a2a0 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.
+ *
+ ******************************************************************/
 
 #include "NSConsumerCommon.h"
 #include "NSConstants.h"
@@ -31,6 +31,9 @@ static bool NSIsExtraValue(const char * name);
 static void NSCopyPayloadValueArray(OCRepPayloadValue* dest, OCRepPayloadValue* source);
 static OCRepPayloadValue * NSCopyPayloadValue(OCRepPayloadValue * value);
 
+/**
+ * Get stack mutex.
+ */
 pthread_mutex_t ** NSGetStackMutex(void)
 {
     static pthread_mutex_t * g_stackMutext = NULL;
@@ -270,6 +273,13 @@ NSTask * NSMakeTask(NSTaskType type, void * data)
     return retTask;
 }
 
+/**
+ * create the new message for the given id
+ * @param id            message id
+ * @param providerId    provider identity
+ *
+ * @return created message
+ */
 static NSMessage * NSCreateMessage_internal(uint64_t id, const char * providerId)
 {
     NSMessage * retMsg = (NSMessage *)OICMalloc(sizeof(NSMessage));
@@ -290,6 +300,11 @@ static NSMessage * NSCreateMessage_internal(uint64_t id, const char * providerId
     return retMsg;
 }
 
+/**
+ * get extra information from the payload
+ * @param[in] payload   oc payload
+ * @return required information
+ */
 static OCRepPayload * NSGetExtraInfo(OCRepPayload * payload)
 {
     NS_LOG(DEBUG, "get extra info");
index 3c8efd4..4782fc0 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_COMMON_H_
 #define _NS_CONSUMER_COMMON_H_
@@ -32,18 +32,18 @@ extern "C" {
 #include "NSStructs.h"
 #include "ocstack.h"
 
-#define NS_QOS OC_HIGH_QOS
-#define NS_RESOURCE_TYPE "x.org.iotivity.notification"
-#define NS_RESOURCE_URI "/notification"
-#define NS_INTERFACE_BASELINE "oic.if.baseline"
-#define NS_RESOURCE_QUERY "/oic/res"
+#define NS_QOS OC_HIGH_QOS                             /**< high QOS */
+#define NS_RESOURCE_TYPE "x.org.iotivity.notification" /**< resource type */
+#define NS_RESOURCE_URI "/notification"                /**< resource uri */
+#define NS_INTERFACE_BASELINE "oic.if.baseline"        /**< interface baseline */
+#define NS_RESOURCE_QUERY "/oic/res"                   /**< resource query */
 
-#define NS_DISCOVER_QUERY "/oic/res?rt=x.org.iotivity.notification"
-#define NS_DEVICE_ID_LENGTH 37
+#define NS_DISCOVER_QUERY "/oic/res?rt=x.org.iotivity.notification" /**< resource query */
+#define NS_DEVICE_ID_LENGTH 37                                      /**< device ID length */
 
 typedef enum
 {
-    NS_DISCOVER_DEFAULT, // will work for adapter_ip.
+    NS_DISCOVER_DEFAULT, /**<  will work for adapter_ip. */
     NS_DISCOVER_UDP,
     NS_DISCOVER_TCP,
     NS_DISCOVER_CLOUD
@@ -51,101 +51,313 @@ typedef enum
 
 typedef enum
 {
-    NS_SELECTION_CONSUMER = 0,
-    NS_SELECTION_PROVIDER = 1
+    NS_SELECTION_CONSUMER = 0, /**< select consumer */
+    NS_SELECTION_PROVIDER = 1  /**< select provider */
 } NSSelector;
 
 typedef struct NSProviderConnectionInfo
 {
-    OCDevAddr * addr;
+    OCDevAddr * addr;          /**< device address */
 
-    OCDoHandle messageHandle;
-    OCDoHandle syncHandle;
+    OCDoHandle messageHandle;  /**< message handle */
+    OCDoHandle syncHandle;     /**< sync handle */
 
-    bool isCloudConnection;
-    bool isSubscribing;
+    bool isCloudConnection;    /**< check cloud connection */
+    bool isSubscribing;        /**< check subscribing or not */
 
-    struct NSProviderConnectionInfo * next;
+    struct NSProviderConnectionInfo * next; /**< pointer to nect node */
 
 } NSProviderConnectionInfo;
 
 typedef struct
 {
-    char providerId[NS_DEVICE_ID_LENGTH];
+    char providerId[NS_DEVICE_ID_LENGTH]; /**< provider Id */
 
-    NSTopicLL * topicLL;
+    NSTopicLL * topicLL;                  /**< pointer to topic link list */
 
-    char * messageUri;
-    char * syncUri;
-    char * topicUri;
+    char * messageUri;                    /**< message URI */
+    char * syncUri;                       /**< sync URI */
+    char * topicUri;                      /**< topic URI */
 
-    NSSelector accessPolicy;
-    NSProviderState state;
+    NSSelector accessPolicy;             /**< access policy */
+    NSProviderState state;               /**< provider state information */
 
-    NSProviderConnectionInfo * connection;
+    NSProviderConnectionInfo * connection; /**< pointer to next node */
 
 } NSProvider_internal;
 
 typedef struct
 {
-    uint64_t messageId;
-    char providerId[NS_DEVICE_ID_LENGTH];
-    NSSyncType state;
+    uint64_t messageId;                      /**< message Id */
+    char providerId[NS_DEVICE_ID_LENGTH];    /**< provider Id */
+    NSSyncType state;                        /**< sync type state */
 
-    NSProviderConnectionInfo * connection;
+    NSProviderConnectionInfo * connection;   /**< pointer to next node */
 
 } NSSyncInfo_internal;
 
+/**
+ * API to check consumer started.
+ *
+ * @return boolean value
+ */
 bool NSIsStartedConsumer(void);
+
+/**
+ * Set start value of consumer.
+ *
+ * @param   setValue        value to set.
+ */
 void NSSetIsStartedConsumer(bool setValue);
 
+/**
+ * Set provider changed callback.
+ *
+ * @param cb        provider state callback.
+ */
 void NSSetProviderChangedCb(NSProviderStateCallback cb);
+
+/**
+ * Provider changed.
+ *
+ * @param provider      notification provider.
+ * @param response      provider state.
+ */
 void NSProviderChanged(NSProvider * provider, NSProviderState response);
 
+/**
+ * Set message posted callback.
+ *
+ * @param cb      message received callback.
+ */
 void NSSetMessagePostedCb(NSMessageReceivedCallback  cb);
+
+/**
+ * Message post.
+ *
+ * @param obj     message object.
+ */
 void NSMessagePost(NSMessage * obj);
 
+/**
+ * set notification sync callback.
+ *
+ * @param cb      sync information received callback.
+ */
 void NSSetNotificationSyncCb(NSSyncInfoReceivedCallback cb);
+
+/**
+ * Notification sync.
+ *
+ * @param sync sync information.
+ */
 void NSNotificationSync(NSSyncInfo * sync);
 
+/**
+ * Get consumer ID.
+ *
+ * @return   return consumer ID.
+ */
 char ** NSGetConsumerId(void);
+
+/**
+ * Set consumer ID.
+ *
+ * @param   cId        consumer ID.
+ */
 void NSSetConsumerId(char * cId);
 
+/**
+ * create request uri with consumer ID.
+ *
+ * @param   uri        request uri.
+ *
+ * @return    return request query.
+ */
 char * NSMakeRequestUriWithConsumerId(const char * uri);
 
+/**
+ * create task.
+ *
+ * @param NSTaskType      task type.
+ * @param void *          void data.
+ *
+ * @return created task.
+ */
 NSTask * NSMakeTask(NSTaskType, void *);
+
+/**
+ * push event API
+ *
+ * @param task  notification task
+ *
+ * @return OK if success.
+ */
 NSResult NSConsumerPushEvent(NSTask *);
 
+/**
+ * Get message.
+ *
+ * @param payload         representation payload.
+ *
+ * @return message.
+ */
 NSMessage * NSGetMessage(OCRepPayload * payload);
+
+/**
+ * Copy message.
+ *
+ * @param msg    notification message.
+ *
+ * @return new message.
+ */
 NSMessage * NSCopyMessage(NSMessage *);
+
+/**
+ * Remove message.
+ *
+ * @param msg    notification message.
+ */
 void NSRemoveMessage(NSMessage *);
 
+/**
+ * Get provider after clean.
+ *
+ * @param pId        provider Id
+ * @param mUri       message uri
+ * @param sUri       sync uri
+ * @param tUri       topic uri
+ * @param connection provider connection information
+ */
 void NSGetProviderPostClean(
         char * pId, char * mUri, char * sUri, char * tUri, NSProviderConnectionInfo * connection);
 
+/**
+ * Get provider.
+ *
+ * @param clientResponse    client response.
+ *
+ * @return new provider.
+ */
 NSProvider_internal * NSGetProvider(OCClientResponse * clientResponse);
+
+/**
+ * Create provider connections.
+ *
+ * @param inAddr   device address.
+ *
+ * @return provider connection information.
+ */
 NSProviderConnectionInfo * NSCreateProviderConnections(OCDevAddr *);
+
+/**
+ * Copy provider connections.
+ *
+ * @param NSProviderConnectionInfo     connection information.
+ *
+ * @return provider connection information.
+ */
 NSProviderConnectionInfo * NSCopyProviderConnections(NSProviderConnectionInfo *);
+
+/**
+ * Remove connections.
+ *
+ * @param NSProviderConnectionInfo    connection to remove.
+ */
 void NSRemoveConnections(NSProviderConnectionInfo *);
 
+/**
+ * Copy provider internal.
+ */
 NSProvider_internal * NSCopyProvider_internal(NSProvider_internal *);
+
+/**
+ * Copy provider.
+ */
 NSProvider * NSCopyProvider(NSProvider_internal *);
+
+/**
+ * Remove provider internal.
+ */
 void NSRemoveProvider_internal(void *);
+
+/**
+ * Remove provider.
+ *
+ * @param NSProvider        provider to remove.
+ */
 void NSRemoveProvider(NSProvider *);
 
+/**
+ * Copy topic node.
+ *
+ * @param NSTopicLL    new topic node.
+ *
+ * @return new topic node list.
+ */
 NSTopicLL * NSCopyTopicNode(NSTopicLL *);
+
+/**
+ * Remove topic node.
+ *
+ * @param NSTopicLL    topic node to remove.
+ */
 void NSRemoveTopicNode(NSTopicLL *);
+
+/**
+ * Inssert topic node.
+ *
+ * @param NSTopicLL   head node of the list.
+ * @param NSTopicLL   new node to add.
+ *
+ * @return NS_OK to success, otherwise NS_ERROR.
+ */
 NSResult NSInsertTopicNode(NSTopicLL *, NSTopicLL *);
 
+/**
+ * Copy topic list.
+ *
+ * @param NSTopicLL     head node of the list.
+ *
+ * @return new head node of list.
+ */
 NSTopicLL * NSCopyTopicLL(NSTopicLL *);
+
+/**
+ * Remove topic list.
+ *
+ * @param NSTopicLL    head node to remove.
+ */
 void NSRemoveTopicLL(NSTopicLL *);
 
+/**
+ * Invoke request.
+ *
+ * @param handle        OCDoHandle of resource
+ * @param method        OCMethod type
+ * @param addr          device address
+ * @param queryUri      query uri
+ * @param payload       oc payload
+ * @param callbackFunc  callback function
+ * @param callbackData  callback data
+ * @param cd            oc client context deleter
+ * @param type          oc connectivity type
+ *
+ * @return oc stack result
+ */
 OCStackResult NSInvokeRequest(OCDoHandle * handle,
         OCMethod method, const OCDevAddr * addr,
         const char * queryUrl, OCPayload * payload,
         void * callbackFunc, void * callbackData,
         OCClientContextDeleter cd, OCConnectivityType type);
 
+/**
+ * OC stack result.
+ *
+ * @param ret    return value.
+ *
+ * @return true if ret value found, otherwise false.
+ */
 bool NSOCResultToSuccess(OCStackResult ret);
 
 #ifdef __cplusplus
index e46d8b1..f522edb 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_NOTIFICATION_H_
 #define _NS_CONSUMER_NOTIFICATION_H_
@@ -32,14 +32,53 @@ extern "C" {
 #include "NSStructs.h"
 #include "ocstack.h"
 
+/**
+ * Consumer communication task processing.
+ *
+ * @param task notification task
+ */
 void NSConsumerCommunicationTaskProcessing(NSTask *);
 
+/**
+ * Consumer subscribe provider.
+ *
+ * @param NSProvider   notification provider.
+ *
+ * @return NS_OK if success, otherwise NS_ERROR.
+ */
 NSResult NSConsumerSubscribeProvider(NSProvider *);
 
+/**
+ * Consumer message listener.
+ *
+ * @param ctx            void pointer
+ * @param handle         OCDoHandle
+ * @param clientResponse client response
+ *
+ * @return oc stack application result
+ */
 OCStackApplicationResult NSConsumerMessageListener(void *, OCDoHandle, OCClientResponse *);
 
+/**
+ * Consumer sync information listener.
+ *
+ * @param ctx            void pointer
+ * @param handle         OCDoHandle
+ * @param clientResponse client response
+ *
+ * @return oc stack application result
+ */
 OCStackApplicationResult NSConsumerSyncInfoListener(void *, OCDoHandle, OCClientResponse *);
 
+/**
+ * Introspect topic.
+ *
+ * @param ctx            void pointer
+ * @param handle         OCDoHandle
+ * @param clientResponse client response
+ *
+ * @return oc stack application result
+ */
 OCStackApplicationResult NSIntrospectTopic(void *, OCDoHandle, OCClientResponse *);
 
 #ifdef __cplusplus
index 01b3a25..b89ea80 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_DISCOVERY_H_
 #define _NS_CONSUMER_DISCOVERY_H_
@@ -30,14 +30,44 @@ extern "C" {
 #include "ocstack.h"
 #include "NSStructs.h"
 
+/**
+ * Consumer discovery task processing
+ *
+ * @param notification task information
+ */
 void NSConsumerDiscoveryTaskProcessing(NSTask *);
 
+/**
+ * Notification consumer presence listener
+ *
+ * @param ctx            void pointer
+ * @param handle         OCDoHandle
+ * @param clientResponse client response
+ *
+ * @return oc stack application result
+ */
 OCStackApplicationResult NSConsumerPresenceListener(void *, OCDoHandle, OCClientResponse *);
 
-// for discover result
+/**
+ * Provider discover listener
+ *
+ * @param ctx            void pointer
+ * @param handle         OCDoHandle
+ * @param clientResponse client response
+ *
+ * @return oc stack application result
+ */
 OCStackApplicationResult NSProviderDiscoverListener(void *, OCDoHandle, OCClientResponse *);
 
-// for checking Permission
+/**
+ * Introspect provider
+ *
+ * @param ctx            void pointer
+ * @param handle         OCDoHandle
+ * @param clientResponse client response
+ *
+ * @return oc stack application result
+ */
 OCStackApplicationResult NSIntrospectProvider(void *, OCDoHandle, OCClientResponse *);
 
 #ifdef __cplusplus
index 27a11bd..4a27e84 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_INTERNAL_TASK_CONTROLLER_H_
 #define _NS_CONSUMER_INTERNAL_TASK_CONTROLLER_H_
@@ -29,26 +29,81 @@ extern "C" {
 #include "NSConsumerMemoryCache.h"
 #include "NSConsumerCommunication.h"
 
+/**
+ * Get message cache list.
+ *
+ * @return message cache list.
+ */
 NSCacheList ** NSGetMessageCacheList(void);
 
+/**
+ * Set message cache list.
+ *
+ * @param cache list to set message
+ */
 void NSSetMessageCacheList(NSCacheList *);
 
+/**
+ * Get provider cache list.
+ *
+ * @return provider cache list.
+ */
 NSCacheList ** NSGetProviderCacheList(void);
 
+/**
+ * Cancel all subscription.
+ */
 void NSCancelAllSubscription(void);
 
+/**
+ * Set provider cache list.
+ *
+ * @param cache  cache list
+ */
 void NSSetProviderCacheList(NSCacheList *);
 
+/**
+ * Destroy message cache list.
+ */
 void NSDestroyMessageCacheList(void);
 
+/**
+ * Destory Internal cache list.
+ */
 void NSDestroyInternalCachedList(void);
 
+/**
+ * Find message using Id.
+ *
+ * @param message Id.
+ *
+ * @return notification message
+ */
 NSMessage * NSMessageCacheFind(const char *);
 
+/**
+ * Find provider using provider ID.
+ *
+ * @param provider Id
+ *
+ * @return provider information
+ */
 NSProvider_internal * NSProviderCacheFind(const char *);
 
+/**
+ * Find provider from address.
+ *
+ * @param addr   address to find provider
+ *
+ * @return provider information
+ */
 NSProvider_internal * NSFindProviderFromAddr(OCDevAddr * addr);
 
+/**
+ * Consumer internal task processing.
+ *
+ * @param notification task information
+ */
 void NSConsumerInternalTaskProcessing(NSTask *);
 
 #ifdef __cplusplus
index 5c8aa93..b2e082a 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_MQPLUGIN_H_
 #define _NS_CONSUMER_MQPLUGIN_H_
@@ -29,6 +29,7 @@ extern "C" {
 #include "NSCommon.h"
 #include "NSStructs.h"
 
+/** consumer MQ task processing. */
 void NSConsumerMQTaskProcessing(NSTask *);
 #endif
 
index 4688734..fc08e8c 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_MEMORY_CACHE_H_
 #define _NS_CONSUMER_MEMORY_CACHE_H_
@@ -30,19 +30,98 @@ extern "C" {
 #include <pthread.h>
 #include "NSConsumerCommon.h"
 
+/**
+ * Creates consumer storage list.
+ *
+ * @return new cache list.
+ */
 NSCacheList * NSConsumerStorageCreate(void);
+
+/**
+ * Read list.
+ *
+ * @param list    cache list.
+ * @param findId  find element by given Id.
+ *
+ * @return cache element for given Id, otherwise NULL.
+ */
 NSCacheElement * NSConsumerStorageRead(NSCacheList * list, const char * findId);
+
+/**
+ * Write list.
+ *
+ * @param list     cache list.
+ * @param newObj   new cache element object.
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSConsumerStorageWrite(NSCacheList * list, NSCacheElement * newObj);
+
+/**
+ * Delete list for given Id.
+ *
+ * @param list    cache list.
+ * @param delId   delete element by given Id.
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSConsumerStorageDelete(NSCacheList * list, const char * delId);
+
+/**
+ * Destroy list.
+ *
+ * @param list cache list.
+ *
+ * @return OK success.
+ */
 NSResult NSConsumerStorageDestroy(NSCacheList * list);
 
+/**
+ * Get cache mutex.
+ *
+ * @return reference mutex, otherwise NULL.
+ */
 pthread_mutex_t * NSGetCacheMutex(void);
 
+/**
+ * Compare data with given Id
+ *
+ * @param type   cache type.
+ * @param data   cache data.
+ * @param id     Id to comapre.
+ *
+ * @return true if success, otherwise false.
+ */
 bool NSConsumerCompareIdCacheData(NSCacheType type, void * data, const char * id);
 
+/**
+ * Write provide to cache.
+ *
+ * @param list     cache list.
+ * @param newObj   new cache object.
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSConsumerCacheWriteProvider(NSCacheList * list, NSCacheElement * newObj);
+
+/**
+ * Pop provider cache list.
+ *
+ * @param list cache list.
+ *
+ * @return head , otherwise null.
+ */
 NSCacheElement * NSPopProviderCacheList(NSCacheList * list);
 
+/**
+ * Get provider from addr.
+ *
+ * @param list   cache list.
+ * @param addr   device address.
+ * @param port   port.
+ *
+ * @return cache element for addr & port, otherwise NULL.
+ */
 NSCacheElement * NSGetProviderFromAddr(NSCacheList * list, const char * addr, uint16_t port);
 
 #ifdef __cplusplus
index a6f779c..f67c156 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_LISTENER_H_
 #define _NS_CONSUMER_LISTENER_H_
@@ -31,8 +31,16 @@ extern "C" {
 #include "NSCommon.h"
 #include "ocstack.h"
 
+/**
+ * Initialize consumer listener
+ *
+ * @return OK if success, otherwise ERROR CODE.
+ */
 NSResult NSConsumerListenerInit(void);
 
+/**
+ * Terminate consumer listener
+ */
 void NSConsumerListenerTermiate(void);
 
 #ifdef __cplusplus
index efaa24f..0032a2d 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_QUEUE_H_
 #define _NS_CONSUMER_QUEUE_H_
@@ -27,29 +27,70 @@ extern "C" {
 
 #include <stdbool.h>
 
+/** notification consumer queue object structure */
 typedef struct _NSConsumerQueueObject
 {
-    void * data;
-    struct _NSConsumerQueueObject * next;
+    void * data; /**< data */
+    struct _NSConsumerQueueObject * next; /**< pointer to next node */
 } NSConsumerQueueObject;
 
+/** notification consumer queue structure */
 typedef struct
 {
-    int size;
-    NSConsumerQueueObject * head;
-    NSConsumerQueueObject * tail;
+    int size; /**< size of queue */
+    NSConsumerQueueObject * head; /**< pointer to first node */
+    NSConsumerQueueObject * tail; /**< pointer to last node */
 } NSConsumerQueue;
 
+/**
+ * create queue
+ *
+ * @return new created queue
+ */
 NSConsumerQueue * NSCreateQueue(void);
 
+/**
+ * destroy queue
+ *
+ * @param queue to destroy
+ */
 void NSDestroyQueue(NSConsumerQueue *);
 
+/**
+ * push consumer queue
+ *
+ * @param head pointer of queue
+ * @param queue object to push
+ *
+ * @return true if push, otherwise false
+ */
 bool NSPushConsumerQueue(NSConsumerQueue *, NSConsumerQueueObject *);
 
+/**
+ * pop queue object
+ *
+ * @param head of queue
+ *
+ * @return queue object
+ */
 NSConsumerQueueObject * NSPopQueue(NSConsumerQueue *);
 
+/**
+ * get queue size
+ *
+ * @param head of queue
+ *
+ * @return size of queue
+ */
 int NSGetQueueSize(NSConsumerQueue *);
 
+/**
+ * check queue is empty or not
+ *
+ * @param head of queue
+ *
+ * @return true or false
+ */
 bool NSIsQueueEmpty(NSConsumerQueue *);
 
 #ifdef __cplusplus
index 682d0e1..9cf241b 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_MESSAGEHANDLER_H_
 #define _NS_CONSUMER_MESSAGEHANDLER_H_
@@ -33,14 +33,43 @@ extern "C" {
 #include "NSStructs.h"
 #include "NSConsumerCommon.h"
 
+/**
+ * API to initialize consumer message handler.
+ *
+ * @return OK if success.
+ */
 NSResult NSConsumerMessageHandlerInit(void);
 
+/**
+ * API to exit consumer message handler.
+ */
 void NSConsumerMessageHandlerExit(void);
 
+/**
+ * push event API
+ *
+ * @param notification task information
+ *
+ * @return OK if success.
+ */
 extern NSResult NSConsumerPushEvent(NSTask *);
 
+/**
+ * Find message by id.
+ *
+ * @param id to find message from list
+ *
+ * @return notification message detail
+ */
 NSMessage * NSConsumerFindNSMessage(const char *);
 
+/**
+ * Find provider by id.
+ *
+ * @param id to find the provider from list
+ *
+ * @return provider information
+ */
 NSProvider_internal * NSConsumerFindNSProvider(const char *);
 
 #ifdef __cplusplus
index c673b5c..e54f4fd 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_CONSUMER_SYSTEM_H_
 #define _NS_CONSUMER_SYSTEM_H_
@@ -27,6 +27,11 @@ extern "C" {
 
 #include "NSCommon.h"
 
+/**
+ * Initialize consumer system
+ *
+ * @return OK if success, otherwise ERROR CODE.
+ */
 NSResult NSConsumerSystemInit(void);
 
 #ifdef __cplusplus
index 51ecbea..403d0fc 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_THREAD_H_
 #define _NS_THREAD_H_
@@ -39,28 +39,58 @@ typedef enum
 
 typedef struct
 {
-    bool isStarted;
-    pthread_t thread_id;
-    pthread_mutex_t mutex;
-    pthread_mutexattr_t mutex_attr;
+    bool isStarted;                 /**< check started or not */
+    pthread_t thread_id;            /**< thread Id */
+    pthread_mutex_t mutex;          /**< mutex variable */
+    pthread_mutexattr_t mutex_attr; /**< mutex attribute variable */
 } NSConsumerThread;
 
 #endif
 
+/** callback function for notification thread */
 typedef void *(*NSThreadFunc)(void *);
 
-NSConsumerThread * NSThreadInit(NSThreadFunc, void *);
-
-void NSThreadLock(NSConsumerThread *);
-
-void NSThreadUnlock(NSConsumerThread *);
-
-void NSThreadJoin(NSConsumerThread *);
-
-void NSThreadStop(NSConsumerThread *);
-
-void NSDestroyThreadHandle(NSConsumerThread *);
-
+/**
+ * Initialize thread
+ * @param[in] func   callback function
+ * @param[in] data   data
+ * @return handle of notification consumer thread
+ */
+NSConsumerThread * NSThreadInit(NSThreadFunc func, void * data);
+
+/**
+ * lock thread
+ * @param[in] handle   consumer thread handle
+ */
+void NSThreadLock(NSConsumerThread * handle);
+
+/**
+ * unlock thread
+ * @param[in] handle   consumer thread handle
+ */
+void NSThreadUnlock(NSConsumerThread * handle);
+
+/**
+ * join thread
+ * @param[in] handle   consumer thread handle
+ */
+void NSThreadJoin(NSConsumerThread * handle);
+
+/**
+ * stop thread
+ * @param[in] handle   consumer thread handle
+ */
+void NSThreadStop(NSConsumerThread * handle);
+
+/**
+ * destroy thread handle
+ * @param[in] handle   consumer thread handle
+ */
+void NSDestroyThreadHandle(NSConsumerThread * handle);
+
+/**
+ * thread detach
+ */
 void NSThreadDetach(void);
 
 #ifdef __cplusplus
index a96b26c..5f8d3df 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_CALLBACK_RESPONSE__H_\r
 #define _NS_PROVIDER_CALLBACK_RESPONSE__H_\r
 #include "NSStructs.h"\r
 #include "NSUtil.h"\r
 \r
+/**\r
+ * register subscriber request callback\r
+ *\r
+ * @param subscribeRequestCb    subscriber request callback.\r
+ */\r
 void NSRegisterSubscribeRequestCb(NSSubscribeRequestCallback subscribeRequestCb);\r
+/**\r
+ * register sync callback\r
+ *\r
+ * @param syncCb    sync callback.\r
+ */\r
 void NSRegisterSyncCb(NSProviderSyncInfoCallback syncCb);\r
+/**\r
+ * subscriber request callback\r
+ * @param[in] consumer     notification consumer\r
+ */\r
 void NSSubscribeRequestCb(NSConsumer *consumer);\r
+/**\r
+ * sync callback\r
+ * @param[in] sync   notification sync information\r
+ */\r
 void NSSyncCb(NSSyncInfo *sync);\r
 \r
 #endif /* _NS_PROVIDER_CALLBACK_RESPONSE__H_ */\r
index 6512fdf..4c14523 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_DISCOVERY_H_\r
 #define _NS_PROVIDER_DISCOVERY_H_\r
 #include "NSProviderScheduler.h"\r
 #include "NSProviderResource.h"\r
 \r
+/**\r
+ * start presence\r
+ *\r
+ * @return NS_OK if success, otherwise ERROR CODE.\r
+ */\r
 NSResult NSStartPresence(void);\r
+/**\r
+ * stop presence\r
+ *\r
+ * @return NS_OK if success, otherwise ERROR CODE.\r
+ */\r
 NSResult NSStopPresence(void);\r
 \r
 #endif /* _NS_PROVIDER_DISCOVERY_H_ */\r
index 6000ed4..1b826e3 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_LISTENER__H_\r
 #define _NS_PROVIDER_LISTENER__H_\r
@@ -39,26 +39,76 @@ extern "C" {
 #include "NSUtil.h"\r
 #include "NSProviderMemoryCache.h"\r
 \r
+/**\r
+ * Notification entity handler callback.\r
+ * @param[in] flag                   entity handler falg\r
+ * @param[in] entityHandlerRequest   entity handler request to handle the incomming requests\r
+ * @param[in] callback               callback function\r
+ * @return entity handler result\r
+ */\r
 OCEntityHandlerResult NSEntityHandlerNotificationCb(OCEntityHandlerFlag flag,\r
         OCEntityHandlerRequest *entityHandlerRequest, void* callback);\r
 \r
+/**\r
+ * Message entity handler callback.\r
+ * @param[in] flag                  entity handler falg\r
+ * @param[in] entityHandlerRequest  entity handler request to handle the incomming requests\r
+ * @param[in] callback              callback function\r
+ * @return entity handler result\r
+ */\r
 OCEntityHandlerResult NSEntityHandlerMessageCb(OCEntityHandlerFlag flag,\r
         OCEntityHandlerRequest *entityHandlerRequest, void* callback);\r
 \r
+/**\r
+ * Sync entity handler callback.\r
+ * @param[in] flag                  entity handler falg\r
+ * @param[in] entityHandlerRequest  entity handler request to handle the incomming requests\r
+ * @param[in] callback              callback function\r
+ * @return entity handler result\r
+ */\r
 OCEntityHandlerResult NSEntityHandlerSyncCb(OCEntityHandlerFlag flag,\r
         OCEntityHandlerRequest *entityHandlerRequest, void* callback);\r
 \r
+/**\r
+ * Topic entity handler callback.\r
+ * @param[in] flag                  entity handler falg\r
+ * @param[in] entityHandlerRequest  entity handler request to handle the incomming requests\r
+ * @param[in] callback              callback function\r
+ * @return entity handler result\r
+ */\r
 OCEntityHandlerResult NSEntityHandlerTopicCb(OCEntityHandlerFlag flag,\r
         OCEntityHandlerRequest *entityHandlerRequest, void* callback);\r
 \r
+/**\r
+ * provider connection state listener.\r
+ * @param[in] info           provider connection information\r
+ * @param[in] isConnected    connection state\r
+ */\r
 void NSProviderConnectionStateListener(const CAEndpoint_t * info, bool isConnected);\r
 \r
+/**\r
+ * provider adapter state listener.\r
+ * @param[in] adapter     transport adapter\r
+ * @param[in] enabled     connection state\r
+ */\r
 void NSProviderAdapterStateListener(CATransportAdapter_t adapter, bool enabled);\r
 \r
 #ifdef WITH_MQ\r
+/**\r
+ * get provider MQ response callback.\r
+ * @param[in] handle            dohandle\r
+ * @param[in] clientResponse    oc client response\r
+ * @return oc stack application result\r
+ */\r
 OCStackApplicationResult NSProviderGetMQResponseCB(void * ctx, OCDoHandle handle,\r
         OCClientResponse * clientResponse);\r
 \r
+/**\r
+ * publish provider MQ response callback.\r
+ * @param[in] handle            dohandle\r
+ * @param[in] clientResponse    oc client response\r
+ * @return oc stack application result\r
+ */\r
 OCStackApplicationResult NSProviderPublishMQResponseCB(void *ctx, OCDoHandle handle,\r
         OCClientResponse *clientResponse);\r
 #endif\r
index f7e81ea..a87ec3a 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_CACHEADAPTER__H_\r
 #define _NS_PROVIDER_CACHEADAPTER__H_\r
 #include "oic_string.h"\r
 #include "NSUtil.h"\r
 \r
+/**\r
+ * Create NS provider storage.\r
+ *\r
+ * @return new list.\r
+ */\r
 NSCacheList * NSProviderStorageCreate(void);\r
+\r
+/**\r
+ * Read NS provider storage for the given Id.\r
+ *\r
+ * @param list         NS cache list.\r
+ * @param findId       Id to find in list.\r
+ *\r
+ * @return new list.\r
+ */\r
 NSCacheElement * NSProviderStorageRead(NSCacheList * list, const char * findId);\r
+\r
+/**\r
+ * Add new object in list.\r
+ *\r
+ * @param list         NS cache list.\r
+ * @param newObj       new object to add.\r
+ *\r
+ * @return OK if write success , otherwise ERROR.\r
+ */\r
 NSResult NSProviderStorageWrite(NSCacheList * list, NSCacheElement * newObj);\r
+\r
+/**\r
+ * Delete cache list for the given id.\r
+ *\r
+ * @param list        NS cache list.\r
+ * @param delId       Id to delete in list.\r
+ *\r
+ * @return OK if state updated , otherwise FAIL.\r
+ */\r
 NSResult NSProviderStorageDelete(NSCacheList * list, const char * delId);\r
+\r
+/**\r
+ * Destroy the list.\r
+ *\r
+ * @param list NS cache list.\r
+ *\r
+ * @return OK after destroy.\r
+ */\r
 NSResult NSProviderStorageDestroy(NSCacheList * list);\r
 \r
+/**\r
+ * Delete cache data.\r
+ *\r
+ * @param NSCacheType  cache type to delete data.\r
+ * @param cache data.\r
+ *\r
+ * @return OK if data deleted.\r
+ */\r
 NSResult NSProviderDeleteCacheData(NSCacheType, void *);\r
 \r
+/**\r
+ * Comapre Id in cache data.\r
+ *\r
+ * @param cache type.\r
+ * @param cache data.\r
+ * @param Id to comapre.\r
+ *\r
+ * @return True if id available, otherwise false.\r
+ */\r
 bool NSProviderCompareIdCacheData(NSCacheType, void *, const char *);\r
 \r
+/**\r
+ * Checks whether data is found.\r
+ *\r
+ * @param cache type.\r
+ * @param cache data.\r
+ * @param Id to comapre.\r
+ *\r
+ * @return True if id available, otherwise false.\r
+ */\r
 bool NSProviderIsFoundCacheData(NSCacheType, void *, void*);\r
 \r
+/**\r
+ * Update sub scription state for the given id.\r
+ *\r
+ * @param NS cache list.\r
+ * @param Id to update in list.\r
+ * @param value to update in list.\r
+ *\r
+ * @return OK if state updated , otherwise ERROR.\r
+ */\r
 NSResult NSCacheUpdateSubScriptionState(NSCacheList *, char *, bool);\r
 \r
+\r
+/**\r
+ * Delete data using observation Id.\r
+ *\r
+ * @param NSCacheList   NS cache list.\r
+ * @param id            observation id.\r
+ *\r
+ * @return OK if state updated , otherwise ERROR.\r
+ */\r
 NSResult NSProviderDeleteSubDataFromObId(NSCacheList * list, OCObservationId id);\r
 \r
+/**\r
+ * Get topics from cache data\r
+ *\r
+ * @param regTopicList register topic list.\r
+ *\r
+ * @return topics.\r
+ */\r
 NSTopicLL * NSProviderGetTopicsCacheData(NSCacheList * regTopicList);\r
 \r
+/**\r
+ * Get consumer topics for the given id.\r
+ *\r
+ * @param regTopicList register topic list.\r
+ * @param conTopicList consumer topic list.\r
+ * @param consumerId   consumer Id.\r
+ *\r
+ * @return topics.\r
+ */\r
 NSTopicLL * NSProviderGetConsumerTopicsCacheData(NSCacheList * regTopicList,\r
         NSCacheList * conTopicList, const char * consumerId);\r
 \r
+/**\r
+ * Checks whether topic is subscribed.\r
+ *\r
+ * @param conTopicList  Consumer topic list.\r
+ * @param cId           consumer Id.\r
+ * @param topicName     topic name.\r
+ *\r
+ * @return True if topic subscribed, otherwise false.\r
+ */\r
 bool NSProviderIsTopicSubScribed(NSCacheElement * conTopicList, char * cId, char * topicName);\r
 \r
+/**\r
+ * Delete consumer topic from consumer topic list.\r
+ *\r
+ * @param conTopicList Consumer topic list.\r
+ * @param topicSubData topic subscribed data.\r
+ *\r
+ * @return OK if deleted , otherwise ERROR.\r
+ */\r
 NSResult NSProviderDeleteConsumerTopic(NSCacheList * conTopicList,\r
         NSCacheTopicSubData * topicSubData);\r
 \r
index 18679f8..426d2fb 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_NOTIFICATION_H_\r
 #define _NS_PROVIDER_NOTIFICATION_H_\r
 #include "oic_malloc.h"\r
 #include "NSUtil.h"\r
 \r
+/**\r
+ * Register resource.\r
+ *\r
+ * @return OK if success, otherwise ERROR.\r
+ */\r
 NSResult NSRegisterResource(void);\r
 \r
 #endif /* _NS_PROVIDER_NOTIFICATION_H_ */\r
index 061e411..6e83587 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_PROVIDER_RESOURCE_H_
 #define _NS_PROVIDER_RESOURCE_H_
         } \
     }
 
+/**
+ * Create resource.
+ *
+ * @param uri     resource URI.
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSCreateResource(char *uri);
 
+/**
+ * Publish resource to cloud.
+ *
+ * @param host    server address.
+ *
+ * @return OK if success.
+ */
 NSResult NSPublishResourceToCloud(char *host);
 
+/**
+ * Register resource.
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSRegisterResource(void);
 
+/**
+ * Remove resource.
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSUnRegisterResource(void);
 
+/**
+ * Put notification resource.
+ *
+ * @param[in] policy    notification policy
+ * @param[in] handle    resource handler
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSPutNotificationResource(bool policy, OCResourceHandle * handle);
 
+/**
+ * Put message resource.
+ *
+ * @param[in] msg      notification message
+ * @param[in] handle   resource handler
+ *
+ * @return OK if success, otherwise ERROR.
+ */
 NSResult NSPutMessageResource(NSMessage *msg, OCResourceHandle * handle);
 
+/**
+ * Put sync resource.
+ *
+ * @param[in] sync     notification sync inforamtion
+ * @param[in] handle   resource handler
+ *
+ * @return success code.
+ */
 NSResult NSPutSyncResource(NSSyncInfo *sync, OCResourceHandle * handle);
 
+/**
+ * Put topic resource.
+ *
+ * @param[in] topicList   notification topic list
+ * @param[in] handle      resource handler
+ *
+ * @return success code.
+ */
 NSResult NSPutTopicResource(NSTopicList *topicList, OCResourceHandle * handle);
 
 #endif /* _NS_PROVIDER_RESOURCE_H_ */
index 4c63998..a63430f 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _PROVIDER_SCHEDULER_H_\r
 #define _PROVIDER_SCHEDULER_H_\r
@@ -34,8 +34,8 @@
 #include "oic_string.h"\r
 #include "NSUtil.h"\r
 \r
-extern NSTask* NSHeadMsg[THREAD_COUNT]; // Current MSG;\r
-extern NSTask* NSTailMsg[THREAD_COUNT]; // Recently MSG;\r
+extern NSTask* NSHeadMsg[THREAD_COUNT]; /**< Current MSG */\r
+extern NSTask* NSTailMsg[THREAD_COUNT]; /**< Recently MSG */\r
 \r
 extern pthread_t NSThread[THREAD_COUNT];\r
 extern pthread_mutex_t NSMutex[THREAD_COUNT];\r
@@ -48,11 +48,47 @@ extern void * NSSubScriptionSchedule(void *ptr);
 extern void * NSNotificationSchedule(void *ptr);\r
 extern void * NSTopicSchedule(void * ptr);\r
 \r
+/**\r
+ * set list\r
+ */\r
 void NSSetList(void);\r
+\r
+/**\r
+ * Initialize scheduler.\r
+ *\r
+ * @return true if initialized, otherwise false.\r
+ */\r
 bool NSInitScheduler(void);\r
+\r
+/**\r
+ * start scheduler.\r
+ *\r
+ * @return true if scheduler start, otherwise false.\r
+ */\r
 bool NSStartScheduler(void);\r
+\r
+/**\r
+ * stop scheduler.\r
+ *\r
+ * @return true if scheduler stop, otherwise false.\r
+ */\r
 bool NSStopScheduler(void);\r
-void NSPushQueue(NSSchedulerType, NSTaskType, void*);\r
-void NSFreeData(NSSchedulerType, NSTask * );\r
+\r
+/**\r
+ * Push queue.\r
+ *\r
+ * @param[in] schedulerType   scheduler type\r
+ * @param[in] taskType        task type\r
+ * @param[in] data            data to push\r
+ */\r
+void NSPushQueue(NSSchedulerType schedulerType, NSTaskType taskType, void* data);\r
+\r
+/**\r
+ * Free data.\r
+ *\r
+ * @param[in] type    scheduler type\r
+ * @param[in] task    task type\r
+ */\r
+void NSFreeData(NSSchedulerType type, NSTask * task);\r
 \r
 #endif /* _PROVIDER_SCHEDULER_H_ */\r
index 58e8dfc..d5ccfd0 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_SUBSCRIPTION_H_\r
 #define _NS_PROVIDER_SUBSCRIPTION_H_\r
 \r
 NSCacheList * consumerSubList;\r
 \r
+/**\r
+ * Initialize subscription list\r
+ *\r
+ * @return NS_OK if initialized, otherwise ERROR CODES.\r
+ */\r
 NSResult NSInitSubscriptionList(void);\r
+\r
+/**\r
+ * Set subscription access policy\r
+ *\r
+ * @param policy   access policy\r
+ *\r
+ * @return NS_OK if success, otherwise ERROR CODES.\r
+ */\r
 NSResult NSSetSubscriptionAccessPolicy(bool policy);\r
+\r
+/**\r
+ * Send access policy response\r
+ *\r
+ * @param entityHandlerRequest    request on entity handler\r
+ *\r
+ * @return NS_OK if success, otherwise ERROR CODES.\r
+ */\r
 NSResult NSSendAccessPolicyResponse(OCEntityHandlerRequest *entityHandlerRequest);\r
+\r
+/**\r
+ * Handle subscription\r
+ *\r
+ * @param entityHandlerRequest     request on entity hadler\r
+ * @param resourceType             resource type\r
+ */\r
 void NSHandleSubscription(OCEntityHandlerRequest *entityHandlerRequest,\r
         NSResourceType resourceType);\r
+\r
+/**\r
+ * Handle Unsubscription\r
+ *\r
+ * @param entityHandlerRequest     request on entity hadler\r
+ */\r
 void NSHandleUnsubscription(OCEntityHandlerRequest *entityHandlerRequest);\r
+\r
+/**\r
+ * Acceptance from user\r
+ *\r
+ * @param entityHandlerRequest     request on entity hadler\r
+ */\r
 void NSAskAcceptanceToUser(OCEntityHandlerRequest *entityHandlerRequest);\r
+\r
+/**\r
+ * Send consumer subscription response\r
+ *\r
+ * @param entityHandlerRequest     request on entity hadler\r
+ *\r
+ * @return NS_OK if success, otherwise ERROR CODES.\r
+ */\r
 NSResult NSSendConsumerSubResponse(OCEntityHandlerRequest *entityHandlerRequest);\r
+\r
+/**\r
+ * Send response\r
+ *\r
+ * @param id        id to find in list\r
+ * @param accepted  true or false value\r
+ *\r
+ * @return NS_OK if success, otherwise ERROR CODES.\r
+ */\r
 NSResult NSSendResponse(const char * id, bool accepted);\r
 \r
 #endif /* _NS_PROVIDER_SUBSCRIPTION_H_ */\r
index cc07bd9..e0145ba 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************
-//
-// Copyright 2016 Samsung Electronics All Rights Reserved.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+/******************************************************************
+ *
+ * Copyright 2016 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 #ifndef _NS_PROVIDER_SYSTEM__H_
 #define _NS_PROVIDER_SYSTEM__H_
 #include "NSStructs.h"
 #include "NSUtil.h"
 
+/**
+ * set provider connection state.
+ *
+ * @param state    connection sstate to set.
+ */
 void NSSetProviderConnectionState(NSConnectionState state);
+
+/**
+ * get provider connection state.
+ *
+ * @return connection state.
+ */
 NSConnectionState NSGetProviderConnectionState(void);
 
+/**
+ * Initialize provider information.
+ *
+ * @param userInfo     user information to intialize.
+ */
 void NSInitProviderInfo(const char * userInfo);
+
+/**
+ * Deintialize provider information.
+ */
 void NSDeinitProviderInfo(void);
+
+/**
+ * get provider information
+ *
+ * @return provider information.
+ */
 NSProviderInfo * NSGetProviderInfo(void);
+
+/**
+ * get user information
+ *
+ * @return user information.
+ */
 const char * NSGetUserInfo(void);
+
+/**
+ * get policy
+ *
+ * @return policy value.
+ */
 bool NSGetPolicy(void);
+
+/**
+ * set policy
+ *
+ * @param policy   policy value to set.
+ */
 void NSSetPolicy(bool policy);
+
+/**
+ * get resource security value.
+ *
+ * @return resource security value.
+ */
 bool NSGetResourceSecurity(void);
+
+/**
+ * set resource security value.
+ *
+ * @param secured    true value for security.
+ */
 void NSSetResourceSecurity(bool secured);
 
 #ifdef WITH_MQ
+/**
+ * set MQ server information
+ *
+ * @param serverUri           server uri
+ * @param devAddr             device address
+ */
 void NSSetMQServerInfo(const char * serverUri, OCDevAddr * devAddr);
+
+/**
+ * get MQ server information.
+ *
+ * @return MQ server information.
+ */
 NSMQServerInfo * NSGetMQServerInfo();
 #endif
 
index 8a61f67..3a792e9 100644 (file)
@@ -1,22 +1,22 @@
-//******************************************************************\r
-//\r
-// Copyright 2016 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 2016 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 _NS_PROVIDER_TOPIC_H_\r
 #define _NS_PROVIDER_TOPIC_H_\r
 #include "NSProviderResource.h"\r
 #include "NSProviderSubscription.h"\r
 \r
+/** Notification topic synchronize structure */\r
 typedef struct {\r
-    pthread_cond_t * condition;\r
-    pthread_mutex_t * mutex;\r
-    char * consumerId;\r
-    NSTopicLL * topics;\r
+    pthread_cond_t * condition; /**< conditional variable */\r
+    pthread_mutex_t * mutex;    /**< mutex variable */\r
+    char * consumerId;          /**< consumer ID */\r
+    NSTopicLL * topics;         /**< pointer to topic linked list */\r
 } NSTopicSync;\r
 \r
+/** Notification topic synchronize result structure */\r
 typedef struct {\r
-    pthread_cond_t * condition;\r
-    pthread_mutex_t * mutex;\r
-    void * topicData;\r
-    NSResult result;\r
+    pthread_cond_t * condition; /**< conditional variable */\r
+    pthread_mutex_t * mutex;    /**< mutex variable */\r
+    void * topicData;           /**< topic data */\r
+    NSResult result;            /**< notification result */\r
 } NSTopicSyncResult;\r
 \r
+/** consumer topic list */\r
 NSCacheList * consumerTopicList;\r
+/** registered topic list */\r
 NSCacheList * registeredTopicList;\r
 \r
+/**\r
+ * Initialize the topic list.\r
+ *\r
+ * @return NS_OK if intialized, otherwise NS_FAIL.\r
+ */\r
 NSResult NSInitTopicList(void);\r
+\r
+/**\r
+ * Get the topic with given consumer Id.\r
+ *\r
+ * @param consumerId     Id to get topic.\r
+ *\r
+ * @return topic.\r
+ */\r
 NSTopicList * NSGetTopics(char *consumerId);\r
 \r
+/**\r
+ * Check topic is subscribed or not.\r
+ *\r
+ * @param consumerId         Id to find topic.\r
+ * @param topic              topic name.\r
+ *\r
+ * @return true if subscribed, otherwise fail.\r
+ */\r
 bool NSIsTopicSubscribed(char *consumerId, char *topic);\r
 \r
 #endif /* _NS_PROVIDER_TOPIC_H_ */\r
index b3672e0..bca83ef 100644 (file)
@@ -1,27 +1,32 @@
-//******************************************************************
-//
-// 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.
+ *
+ ******************************************************************/
 
 #include <stdio.h>
 #include "ocpayload.h"
 #include "NSCommon.h"
 
+/**
+ * Remove the message
+ *
+ * @param msg    msg to remove
+ */
 void removeMessage(NSMessage * msg)
 {
     if (msg == NULL)
@@ -66,6 +71,11 @@ void removeMessage(NSMessage * msg)
     free(msg);
 }
 
+/**
+ * Remove the given topics
+ *
+ * @param topics    topic to remove
+ */
 void removeTopics(NSTopicLL * topics)
 {
     NSTopicLL * iter = topics;