Add doc and description for notification_ex mobule

Change-Id: I74588ef3881b8e20cd5a36c00e6959fdd70c60c1
Signed-off-by: SukHyung, Kang <shine.kang@samsung.com>

diff --git a/doc/notification_ex_doc.h b/doc/notification_ex_doc.h
new file mode 100644 (file)
index 0000000..2727e26
--- /dev/null
+++ b/doc/notification_ex_doc.h
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ *
+ * 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.
+ */
+
+/**
+ * @ingroup CAPI_APPLICATION_FRAMEWORK
+ * @defgroup NOTIFICATION_EX_MODULE Notification EX
+ * @brief Notification_ex APIs.
+ * @section NOTIFICATION_EX_MODULE_HEADER Required Header
+ *   \#include <notification_ex.h>
+ *
+ * @section NOTIFICATION_EX_MODULE_OVERVIEW Overview
+ * A notification ex API is an expanded API of notification.
+ * This API provides functions for creating, inserting and updating notification.
+ */

diff --git a/notification-ex/api/notification_ex.h b/notification-ex/api/notification_ex.h
index 99e6c28e2c6e5f23ec710806c97e47a92324f177..8ce824b644054a406aaba0035be51e3cc936ec67 100644 (file)
--- a/notification-ex/api/notification_ex.h
+++ b/notification-ex/api/notification_ex.h
@@ -38,11 +38,20 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Header for all notification_ex APIs.
  * @since_tizen 5.5
  */
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_app_control_action.h b/notification-ex/api/notification_ex_app_control_action.h
index bc7f1a279a0c100c4354266b007d6f8086707b75..d7ca25956fd88de32b6b9aed1528da0110e1fe32 100644 (file)
--- a/notification-ex/api/notification_ex_app_control_action.h
+++ b/notification-ex/api/notification_ex_app_control_action.h
@@ -24,6 +24,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex action handle with app control handle.
  * @details The notification_ex can define the action with noti_ex_action_h.
@@ -116,6 +121,10 @@ int noti_ex_action_app_control_set(noti_ex_action_h handle, app_control_h app_co
  */
 int noti_ex_action_app_control_get(noti_ex_action_h handle, app_control_h *app_control);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_button.h b/notification-ex/api/notification_ex_button.h
index 46cfcbfb647ba16857a0b94fc6ddf8032c093f1d..5093394e06c7cd6e6e9f1bf55137303df9f8aab2 100644 (file)
--- a/notification-ex/api/notification_ex_button.h
+++ b/notification-ex/api/notification_ex_button.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with a button.
  * @details The notification_ex item is the predefined type of notifications.
@@ -79,6 +84,10 @@ int noti_ex_item_button_create(noti_ex_item_h *handle, const char *id, const cha
  */
 int noti_ex_item_button_get_title(noti_ex_item_h handle, char **title);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_chat_message.h b/notification-ex/api/notification_ex_chat_message.h
index 574a78b8aa5bffe834e6e7fe53843528ce3ee863..50a3c2266be431776680d675200fdcff44ab2cdf 100644 (file)
--- a/notification-ex/api/notification_ex_chat_message.h
+++ b/notification-ex/api/notification_ex_chat_message.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Enumeration for notification_ex chat message type.
  * @since_tizen 5.5
@@ -232,6 +237,10 @@ int noti_ex_item_chat_message_get_time(noti_ex_item_h handle, noti_ex_item_h *ti
  */
 int noti_ex_item_chat_message_get_message_type(noti_ex_item_h handle, noti_ex_item_chat_message_type_e *message_type);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_checkbox.h b/notification-ex/api/notification_ex_checkbox.h
index 1b2e3f28e027dabb84da827737514bc0b6c6954d..ba71580181d3c45b5f2eb15eeee191c592d76a05 100644 (file)
--- a/notification-ex/api/notification_ex_checkbox.h
+++ b/notification-ex/api/notification_ex_checkbox.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with checkbox.
  * @details The notification_ex item is the predefined type of notifications.
@@ -104,6 +109,10 @@ int noti_ex_item_checkbox_get_title(noti_ex_item_h handle, char **title);
  */
 int noti_ex_item_checkbox_is_checked(noti_ex_item_h handle, bool *checked);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_entry.h b/notification-ex/api/notification_ex_entry.h
index 0e6079eb2eca5bcddb53b5d5c036f6252f3d5b2d..8938904203346c9d4852ed6cf31be7bc83ee1be1 100644 (file)
--- a/notification-ex/api/notification_ex_entry.h
+++ b/notification-ex/api/notification_ex_entry.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle for an entry item.
  * @details The notification_ex item is the predefined type of notifications.
@@ -101,6 +106,10 @@ int noti_ex_item_entry_get_text(noti_ex_item_h handle, char **text);
  */
 int noti_ex_item_entry_set_text(noti_ex_item_h handle, const char *text);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_event_info.h b/notification-ex/api/notification_ex_event_info.h
index f361355011868502bbfa5cd71a65a0bca1c3d32f..d13bb101172ab60cbfb6e44e5f03255b63e8a462 100644 (file)
--- a/notification-ex/api/notification_ex_event_info.h
+++ b/notification-ex/api/notification_ex_event_info.h
@@ -21,6 +21,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Enumeration for the type of notification_ex event.
  * @since_tizen 5.5
@@ -218,6 +223,10 @@ int noti_ex_event_info_get_item_id(noti_ex_event_info_h handle, char **item_id);
  */
 int noti_ex_event_info_get_request_id(noti_ex_event_info_h handle, int *req_id);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_group.h b/notification-ex/api/notification_ex_group.h
index 5fe21599f469215d6cc2e99b0936528b09cae2d3..ed03a95a2d25a30827f30d2b216eefc76b9243ec 100644 (file)
--- a/notification-ex/api/notification_ex_group.h
+++ b/notification-ex/api/notification_ex_group.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the group of notification_ex items.
  * @details The notification_ex item is the predefined type of notifications.
@@ -231,6 +236,10 @@ int _ex_item_group_foreach_child_cb(noti_ex_item_h handle, void *user_data) {
 int noti_ex_item_group_foreach_child(noti_ex_item_h handle,
                noti_ex_item_group_foreach_child_cb callback, void *user_data);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_image.h b/notification-ex/api/notification_ex_image.h
index 7490dddaa276a657ac875a5e3956dca8598cf418..ce9ab0071dd28646a5789a21347ee744094b1f57 100644 (file)
--- a/notification-ex/api/notification_ex_image.h
+++ b/notification-ex/api/notification_ex_image.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with an image.
  * @details The notification_ex item is the predefined type of notifications.
@@ -84,6 +89,10 @@ int noti_ex_item_image_create(noti_ex_item_h *handle, const char *id, const char
  */
 int noti_ex_item_image_get_image_path(noti_ex_item_h handle, char **image_path);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_input_selector.h b/notification-ex/api/notification_ex_input_selector.h
index 41e715fa6d49dadd6ff0b8fb8ed524af33e1df49..d5bacb5629039f44a259a5c2b837c0fd215d6685 100644 (file)
--- a/notification-ex/api/notification_ex_input_selector.h
+++ b/notification-ex/api/notification_ex_input_selector.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with input selector.
  * @details The notification_ex item is the predefined type of notifications.
@@ -107,6 +112,10 @@ int noti_ex_item_input_selector_get_contents(noti_ex_item_h handle, char ***list
  */
 int noti_ex_item_input_selector_set_contents(noti_ex_item_h handle, const char **contents, int count);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_item.h b/notification-ex/api/notification_ex_item.h
index 0cf6fc8649cedb3bbe6caeac267614c82da832a8..909c7c5cd36649628e5e91f499ac6ed86d059ac4 100644 (file)
--- a/notification-ex/api/notification_ex_item.h
+++ b/notification-ex/api/notification_ex_item.h
@@ -24,6 +24,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Predefined receiver group for the Ticker.
  * @since_tizen 5.5
@@ -1911,6 +1916,10 @@ int noti_ex_item_get_tag(noti_ex_item_h handle, char **tag);
  */
 int noti_ex_item_set_tag(noti_ex_item_h handle, const char *tag);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_manager.h b/notification-ex/api/notification_ex_manager.h
index 2d55a7f95d250826d59b68002598e1271e35bc8e..ad47766aaebf85ad338e3116c74c0c7439344549 100644 (file)
--- a/notification-ex/api/notification_ex_manager.h
+++ b/notification-ex/api/notification_ex_manager.h
@@ -25,6 +25,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief The notification_ex manager handle.
  * @since_tizen 5.5
@@ -580,6 +585,10 @@ void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
  */
 int noti_ex_manager_get_notification_count(noti_ex_manager_h handle, int *cnt);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_progress.h b/notification-ex/api/notification_ex_progress.h
index 9fbf5b6ec508d2ae9c13cbf17cd7e761a56fba10..e3d7a9d96488175c299dc5310b4241fcf480c286 100644 (file)
--- a/notification-ex/api/notification_ex_progress.h
+++ b/notification-ex/api/notification_ex_progress.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with progress.
  * @details The notification_ex item is the predefined type of notifications.
@@ -151,6 +156,10 @@ int noti_ex_item_progress_get_min(noti_ex_item_h handle, float *min);
  */
 int noti_ex_item_progress_get_max(noti_ex_item_h handle, float *max);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_reporter.h b/notification-ex/api/notification_ex_reporter.h
index 81b8e22da7d90ecff533d053482cc03f65a0ee5e..026837142586504b0c33933cae5cdd52a1c69f1e 100644 (file)
--- a/notification-ex/api/notification_ex_reporter.h
+++ b/notification-ex/api/notification_ex_reporter.h
@@ -25,6 +25,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief The notification_ex reporter handle.
  * @since_tizen 5.5
@@ -448,6 +453,10 @@ void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
 int noti_ex_reporter_find_by_root_id(noti_ex_reporter_h handle, const char *root_id,
                noti_ex_item_h *item);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_text.h b/notification-ex/api/notification_ex_text.h
index eab8d25302547309e90e5ae84a65b769aebd0998..ddee370e8d89f9e734f8c27398da4ded60a271b2 100644 (file)
--- a/notification-ex/api/notification_ex_text.h
+++ b/notification-ex/api/notification_ex_text.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with text.
  * @details The notification_ex item is the predefined type of notifications.
@@ -128,6 +133,10 @@ int noti_ex_item_text_get_contents(noti_ex_item_h handle, char **contents);
  */
 int noti_ex_item_text_get_hyperlink(noti_ex_item_h handle, char **hyperlink);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_time.h b/notification-ex/api/notification_ex_time.h
index 17ea6d5854bb92e4e3e09ea3ebf2bec03a8983a7..27b36013be05d6f84c1d511e4a50990bcfddbf64 100644 (file)
--- a/notification-ex/api/notification_ex_time.h
+++ b/notification-ex/api/notification_ex_time.h
@@ -23,6 +23,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex item handle with time.
  * @details The notification_ex item is the predefined type of notifications.
@@ -81,6 +86,10 @@ int noti_ex_item_time_create(noti_ex_item_h *handle, const char *id, time_t time
  */
 int noti_ex_item_time_get_time(noti_ex_item_h handle, time_t *time);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/notification-ex/api/notification_ex_visibility_action.h b/notification-ex/api/notification_ex_visibility_action.h
index 4b3392c50cbcb81ed7661b30f780c0f3b5afe57e..20e09f90094074b879a0a91bc120a9179754582e 100644 (file)
--- a/notification-ex/api/notification_ex_visibility_action.h
+++ b/notification-ex/api/notification_ex_visibility_action.h
@@ -24,6 +24,11 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup NOTIFICATION_EX_MODULE
+ * @{
+ */
+
 /**
  * @brief Creates the notification_ex action handle to control visibility.
  * @details The notification_ex can define the action with noti_ex_action_h.
@@ -88,6 +93,10 @@ int noti_ex_action_visibility_create(noti_ex_action_h *handle, const char *extra
  */
 int noti_ex_action_visibility_set(noti_ex_action_h handle, const char *id, bool visible);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif