Add doxygen comments for notification

Change-Id: I0b1ef304a494687e1b53fee0be82b4af56d7326b
Signed-off-by: pooja <pooja.k@partner.samsung.com>

service/notification/android/notification-service/src/main/jni/common/JniNotificationCommon.h

-//******************************************************************
-//
-// 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 _JNI_NOTIFICATION_COMMON_H_
 #define _JNI_NOTIFICATION_COMMON_H_
@@ -50,14 +50,32 @@ extern "C" {
 #define JNI_NS_ALLOW 500
 #define JNI_NS_DENY 600
 
+/**
+ * get the notification exception
+ * @param env    JNI interface pointer.
+ */
 jobject getNSException(JNIEnv *env, const char *file, const char *functionName, const int line,
                        const int code, const char *message);
+
+/**
+ * throw notification exception
+ * @param env    JNI interface pointer.
+ */
 void throwNSException(JNIEnv *env, jobject ex);
 
 #define GetNSException(code, message) getNSException(env, __FILE__, __func__, __LINE__, code, message)
 #define ThrowNSException(code, message) throwNSException(env, GetNSException(code, message))
 
+/**
+ * according to result code return message.
+ * @param nsresult      result value
+ */
 static const char *NSResultToChar(const int nsresult);
+
+/**
+ * Initialize the exception
+ * @param env    JNI interface pointer.
+ */
 int NSExceptionInit(JNIEnv *env);
 
 #ifdef __cplusplus

service/notification/android/notification-service/src/main/jni/consumer/JniNotificationConsumer.cpp

-//******************************************************************
-//
-// 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 "JniNotificationConsumer.h"
 #include "NSConsumerService.h"
@@ -43,6 +43,13 @@ jclass g_cls_TopicsList;
 jclass g_cls_OcRepresentation;
 jmethodID g_mid_OcRepresentation_N_ctor_bool = NULL;
 
+/**
+ * Get JNI environment.
+ *
+ * @param ret Initial environment value.
+ *
+ * @return return JNI envirinment value.
+ */
 static JNIEnv *GetJNIEnv(jint *ret)
 {
     JNIEnv *env = NULL;
@@ -71,6 +78,14 @@ static JNIEnv *GetJNIEnv(jint *ret)
     }
 }
 
+/**
+ * Get Native Provider.
+ *
+ * @param env          JNI interface pointer.
+ * @param jObj         java object.
+ *
+ * @return 1, exception return 0.
+ */
 static jlong getNativeProvider(JNIEnv *env, jobject jObj)
 {
 
@@ -89,6 +104,14 @@ static jlong getNativeProvider(JNIEnv *env, jobject jObj)
     return (env->GetLongField(jObj, nativeHandle));
 }
 
+/**
+ * Get java provider state.
+ *
+ * @param env          JNI interface pointer.
+ * @param state        provider state
+ *
+ * @return provider state.
+ */
 jobject getJavaProviderState(JNIEnv *env, OIC::Service::NSProviderState state)
 {
     NS_LOGD ("ConsumerService_getJavaProviderState - IN");
@@ -133,6 +156,14 @@ jobject getJavaProviderState(JNIEnv *env, OIC::Service::NSProviderState state)
     return providerState;
 }
 
+/**
+ * Get java sync type.
+ *
+ * @param env          JNI interface pointer.
+ * @param nsType       notification type.
+ *
+ * @return sync type.
+ */
 jobject getJavaSyncType(JNIEnv *env, OIC::Service::NSSyncInfo::NSSyncType nsType)
 {
     NS_LOGD ("ConsumerService_getJavaSyncType - IN");
@@ -179,6 +210,14 @@ jobject getJavaSyncType(JNIEnv *env, OIC::Service::NSSyncInfo::NSSyncType nsType
     return syncType;
 }
 
+/**
+ * Get java topic state.
+ *
+ * @param env          JNI interface pointer.
+ * @param nsState      notification state.
+ *
+ * @return topic state.
+ */
 jobject getJavaTopicState(JNIEnv *env, OIC::Service::NSTopic::NSTopicState nsState)
 {
     NS_LOGD ("ConsumerService_getJavaTopicState - IN");
@@ -219,6 +258,14 @@ jobject getJavaTopicState(JNIEnv *env, OIC::Service::NSTopic::NSTopicState nsSta
     return topicState;
 }
 
+/**
+ * Get java topics list.
+ *
+ * @param env          JNI interface pointer.
+ * @param topicList    topic list.
+ *
+ * @return topic list.
+ */
 jobject getJavaTopicsList(JNIEnv *env, std::shared_ptr<OIC::Service::NSTopicsList> topicList)
 {
     NS_LOGD ("ConsumerService_getJavaTopicsList - IN");
@@ -259,6 +306,15 @@ jobject getJavaTopicsList(JNIEnv *env, std::shared_ptr<OIC::Service::NSTopicsLis
     return obj_topicList;
 }
 
+/**
+ * Get Native topic state.
+ *
+ * @param env          JNI interface pointer.
+ * @param jTopic       topic object.
+ * @param state        topic state.
+ *
+ * @return true if state found, otherwise false.
+ */
 bool getNativeTopicState(JNIEnv *env,  jobject jTopic , OIC::Service::NSTopic::NSTopicState &state )
 {
     NS_LOGD ("ConsumerService_getNativeTopicState - IN");
@@ -292,6 +348,14 @@ bool getNativeTopicState(JNIEnv *env,  jobject jTopic , OIC::Service::NSTopic::N
 
 }
 
+/**
+ * Get Native topic name.
+ *
+ * @param env          JNI interface pointer.
+ * @param jTopic       topic object.
+ *
+ * @return  topic name.
+ */
 const char *getNativeTopicName(JNIEnv *env,  jobject jTopic)
 {
     NS_LOGD ("ConsumerService_getNativeTopicName - IN");
@@ -322,6 +386,14 @@ const char *getNativeTopicName(JNIEnv *env,  jobject jTopic)
 
 }
 
+/**
+ * Get Native topics list.
+ *
+ * @param env          JNI interface pointer.
+ * @param jTopicList   topic list.
+ *
+ * @return  topic list.
+ */
 std::shared_ptr<OIC::Service::NSTopicsList> getNativeTopicsList(JNIEnv *env, jobject jTopicList)
 {
     NS_LOGD ("ConsumerService_getNativeTopicsList - IN");
@@ -394,6 +466,14 @@ std::shared_ptr<OIC::Service::NSTopicsList> getNativeTopicsList(JNIEnv *env, job
     return nsTopicList;
 }
 
+/**
+ * Get java provider.
+ *
+ * @param env          JNI interface pointer.
+ * @param provider     notification provider.
+ *
+ * @return object of provider.
+ */
 jobject getJavaProvider(JNIEnv *env, std::shared_ptr<OIC::Service::NSProvider> provider)
 {
     NS_LOGD ("ConsumerService_getJavaProvider - IN");
@@ -445,6 +525,14 @@ jobject getJavaProvider(JNIEnv *env, std::shared_ptr<OIC::Service::NSProvider> p
     return obj_provider;
 }
 
+/**
+ * Get java message type.
+ *
+ * @param env          JNI interface pointer.
+ * @param type         message type.
+ *
+ * @return message type.
+ */
 jobject getJavaMessageType(JNIEnv *env, OIC::Service::NSMessage::NSMessageType type)
 {
     NS_LOGD ("ConsumerService_getJavaMessageType - IN");
@@ -489,6 +577,14 @@ jobject getJavaMessageType(JNIEnv *env, OIC::Service::NSMessage::NSMessageType t
     return messageType;
 }
 
+/**
+ * Get java message.
+ *
+ * @param env          JNI interface pointer.
+ * @param message      notification message.
+ *
+ * @return message object.
+ */
 jobject getJavaMessage(JNIEnv *env, OIC::Service::NSMessage message)
 {
     NS_LOGD ("ConsumerService_getJavaMessage - IN");
@@ -648,6 +744,9 @@ jobject getJavaMessage(JNIEnv *env, OIC::Service::NSMessage message)
     return obj_message;
 }
 
+/**
+ * On discover provider.
+ */
 void onDiscoverProvider(std::shared_ptr<OIC::Service::NSProvider> provider)
 {
     NS_LOGD ("ConsumerService_onDiscoverProvider - IN");
@@ -716,6 +815,9 @@ void onDiscoverProvider(std::shared_ptr<OIC::Service::NSProvider> provider)
     return ;
 }
 
+/**
+ * On provider state.
+ */
 void onProviderState( OIC::Service::NSProviderState state)
 {
     NS_LOGD ("ConsumerService_onProviderState -IN");
@@ -783,6 +885,9 @@ void onProviderState( OIC::Service::NSProviderState state)
 
 }
 
+/**
+ * On message posted.
+ */
 void onMessagePosted(OIC::Service::NSMessage message)
 {
     NS_LOGD ("ConsumerService_onMessagePosted -IN");
@@ -850,6 +955,9 @@ void onMessagePosted(OIC::Service::NSMessage message)
     return ;
 }
 
+/**
+ * On sync info received.
+ */
 void onSyncInfoReceived(OIC::Service::NSSyncInfo sync)
 {
     NS_LOGD ("ConsumerService_onSyncInfoReceived - IN");

service/notification/android/notification-service/src/main/jni/consumer/JniNotificationConsumer.h

-//******************************************************************
-//
-// 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.
+ *
+ ******************************************************************/
 
 /* DO NOT EDIT THIS FILE - it is machine generated */
 #include "JniNotificationCommon.h"

service/notification/android/notification-service/src/main/jni/provider/JniNotificationProvider.h

-//******************************************************************
-//
-// 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"
 

service/notification/cpp-wrapper/common/NSMessage.h

-//******************************************************************
-//
-// 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
@@ -31,8 +31,10 @@
 #include "NSMediaContents.h"
 #include "OCRepresentation.h"
 
+/** OIC namespace */
 namespace OIC
 {
+    /** service namespace */
     namespace Service
     {
         /**
@@ -45,11 +47,11 @@ namespace OIC
                 /** NSMessageType - enumeration for Notification service MessageType*/
                 enum class NSMessageType
                 {
-                    NS_MESSAGE_ALERT = 1,
-                    NS_MESSAGE_NOTICE = 2,
-                    NS_MESSAGE_EVENT = 3,
-                    NS_MESSAGE_INFO = 4,
-                    NS_MESSAGE_WARNING = 5,
+                    NS_MESSAGE_ALERT = 1,   /**< alert message */
+                    NS_MESSAGE_NOTICE = 2,  /**< notice message */
+                    NS_MESSAGE_EVENT = 3,   /**< event message */
+                    NS_MESSAGE_INFO = 4,    /**< information message */
+                    NS_MESSAGE_WARNING = 5, /**< warning message */
                 };
 
                 /**

service/notification/cpp-wrapper/common/NSUtils.h

-//******************************************************************
-//
-// 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 */
         };
     }
 }

service/notification/include/NSCommon.h

-//******************************************************************
-//
-// 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.