Fix descriptions about API version 19/63819/3 accepted/tizen/common/20160330.120052 accepted/tizen/ivi/20160328.115559 accepted/tizen/mobile/20160328.115306 accepted/tizen/tv/20160328.115329 accepted/tizen/wearable/20160328.115445 submit/tizen/20160328.051116
authorHyunho Kang <hhstark.kang@samsung.com>
Mon, 28 Mar 2016 03:16:16 +0000 (12:16 +0900)
committerHyunho Kang <hhstark.kang@samsung.com>
Mon, 28 Mar 2016 05:22:02 +0000 (14:22 +0900)
Change-Id: I2dd1cf4321cc804477f0edc9f50d9e9e737efb7f
Signed-off-by: Hyunho Kang <hhstark.kang@samsung.com>
include/notification.h
include/notification_error.h
include/notification_internal.h
include/notification_list.h
include/notification_ongoing_flag.h
include/notification_status_internal.h
include/notification_text_domain.h
include/notification_type.h

index 1d574b4..e186d47 100755 (executable)
@@ -630,7 +630,7 @@ int notification_get_launch_option(notification_h noti,
  * @brief Sets the handler for a specific event.
  * @details When some event occurs on notification, application launched by app_control_send_launch_request with app_control handle.\n
  *          Setting event handler of a button means that the notification will show the button.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti The notification handle
  * @param[in] event_type event type
  * @param[in] event_handler app control handle
@@ -670,7 +670,7 @@ int notification_set_event_handler(notification_h noti, notification_event_type_
 /**
  * @brief Gets the event handler of a specific event.
  * @remarks You must release @a app_control using app_control_destroy().
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in]  noti        The notification handle
  * @param[in] event_type Launching option type
  * @param[out] option The pointer of App Control handler
@@ -1318,7 +1318,7 @@ int notification_post(notification_h noti);
 
 /**
  * @brief Gets the package name of the notification
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti Notification handle
  * @param[out] pkgname The package name of the notification
  * @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
@@ -1348,7 +1348,7 @@ int notification_get_pkgname(notification_h noti, char **pkgname);
 
 /**
  * @brief Adds a button on the notification
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti Notification handle
  * @param[in] button_index Button index
  * @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
@@ -1378,7 +1378,7 @@ int notification_add_button(notification_h noti, notification_button_index_e but
 
 /**
  * @brief Removes a button on the notification
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti Notification handle
  * @param[in] button_index Button index
  * @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
@@ -1411,7 +1411,7 @@ int notification_remove_button(notification_h noti, notification_button_index_e
  * @details The 'auto remove' option let the active notification be removed in several seconds after it shows. Default value is true.
  * @remarks When 'auto_remove' is set as false, the active notification will not be removed
  as long as the user removes the active notification or the app which posted the active notification removes the active notification.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti Notification handle
  * @param[in] auto_remove Auto remove option
  * @return #NOTIFICATION_ERROR_NONE On success, other value if failure
@@ -1440,7 +1440,7 @@ int notification_set_auto_remove(notification_h noti, bool auto_remove);
 /**
  * @brief Gets the 'auto remove' option of the active notification
  * @details The 'auto remove' option let the active notification be removed in several seconds after it shows. Default value is true.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti Notification handle
  * @param[out] auto_remove Auto remove option
  * @return #NOTIFICATION_ERROR_NONE On success, other value on failure
index 7670e8e..87b4e33 100644 (file)
@@ -48,7 +48,7 @@ typedef enum _notification_error {
        NOTIFICATION_ERROR_FROM_DBUS = TIZEN_ERROR_NOTIFICATION | 0x03, /**< Error from DBus */
        NOTIFICATION_ERROR_NOT_EXIST_ID = TIZEN_ERROR_NOTIFICATION | 0x04,      /**< Not exist private ID */
        NOTIFICATION_ERROR_SERVICE_NOT_READY = TIZEN_ERROR_NOTIFICATION | 0x05, /**< No reponse from notification service */
-       NOTIFICATION_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Function not implemented (@b Since: 2.4) */
+       NOTIFICATION_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Function not implemented (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
 } notification_error_e;
 
 /**
index c0fa4f3..c30e5ac 100644 (file)
@@ -586,7 +586,7 @@ NOTIFICATION_DEPRECATED_API int notification_get_execute_option(notification_h n
  * @brief Inserts a notification.
  * @details The notification will be inserted to the database and then it will appear in the notification area.
  *          When notification_create() is called, if priv_id is #NOTIFICATION_PRIV_ID_NONE, priv_id returns the internally set priv_id.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in]  noti    The notification handle
@@ -619,7 +619,7 @@ int notification_insert(notification_h noti,
  * @internal
  * @brief Updates a notification, asynchronously.
  * @details The updated notification will appear in the notification area.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @remarks This function updates the notification asynchronously.
@@ -653,7 +653,7 @@ int notification_update_async(notification_h noti,
  * @internal
  * @brief Registers a callback for all notification events.
  * @details The registered callback could be called for all notification events.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in] changed_cb The callback function
@@ -683,7 +683,7 @@ int notification_register_detailed_changed_cb(
 /**
  * @internal
  * @brief Unregisters a callback for all notification events.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in] changed_cb The callback function
index 7f794ba..ce77189 100644 (file)
@@ -49,7 +49,7 @@ typedef struct _notification_list *notification_list_h;
 /**
  * @brief Returns the notification list handle.
  * @details If count is equal to @c -1, all notifications are returned.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in]  type  The notification type
@@ -83,7 +83,7 @@ int notification_get_list(notification_type_e type,
 /**
  * @brief Returns the notification detail list handle of grouping data.
  * @details If count is equal to c -1, all notifications are returned.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in]  pkgname  The caller application package name
@@ -120,7 +120,7 @@ int notification_get_detail_list(const char *pkgname,
 
 /**
  * @brief Frees a notification list.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in] list The notification list handle
@@ -183,7 +183,7 @@ notification_list_h notification_list_get_head(notification_list_h list);
 
 /**
  * @brief Gets the tail pointer to the notification list.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
  * @param[in] list Notification list handle
  * @return Notification list handle on success, NULL on failure
index f1f5594..0777bf5 100644 (file)
@@ -26,7 +26,7 @@
 
 /**
  * @brief Sets the ongoing flag of the notification
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] noti  The notification handle
  * @param[in] ongoing_flag The ongoing flag
  * @return #NOTIFICATION_ERROR_NONE on success,
@@ -59,7 +59,7 @@ int notification_set_ongoing_flag(notification_h noti, bool ongoing_flag);
 
 /**
  * @brief Gets the ongoing flag of the notification
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in]  noti  The notification handle
  * @param[out] ongoing_flag The ongoing flag
  * @return #NOTIFICATION_ERROR_NONE on success,
index 800505f..0e10851 100644 (file)
@@ -38,7 +38,7 @@ extern "C" {
 /**
  * @internal
  * @brief Unregisters a callback for all notification events.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in] changed_cb The callback function
@@ -67,7 +67,7 @@ int notification_unregister_detailed_changed_cb(
 /**
  * @internal
  * @brief Called when a new message is posted.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] message The message posted
  * @param[in] data    The user data
  * @pre notification_status_monitor_message_cb_set() used to register this callback.
@@ -78,7 +78,7 @@ typedef void (*notification_status_message_cb)(const char *message, void *data);
 /**
  * @internal
  * @brief Registers a callback to receive a message.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] callback The callback function
  * @param[in] data     The user_data
  * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
@@ -91,7 +91,7 @@ int notification_status_monitor_message_cb_set(notification_status_message_cb ca
 /**
  * @internal
  * @brief Unregisters a callback to receive a message.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] callback The callback function
  * @param[in] data     The user_data
  * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
index f41a42e..e7bd4e2 100644 (file)
@@ -28,7 +28,7 @@ extern "C" {
 
 /**
  * @brief Sets the text domain to localize the notification.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] noti   The notification handle
  * @param[in] domain The text domain
  * @param[in] dir    The text dir
@@ -63,7 +63,7 @@ int notification_set_text_domain(notification_h noti,
 
 /**
  * @brief Gets the text domain from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks Do not free returned domain and dir. They are freed when notification_free() or notification_free_list() is called.
  * @param[in]  noti   The notification handle
  * @param[out] domain The domain
index da0d653..f2f9ea0 100644 (file)
@@ -61,7 +61,7 @@ typedef enum _notification_ly_type {
         /**< Layout for notification. Used to display images*/
        NOTIFICATION_LY_ONGOING_EVENT,
         /**< Layout for ongoing notification. Used to display text message.
-         * notifications with NOTIFICATION_LY_ONGOING_EVENT can not be protected from removing by user since tizen 2.4 */
+         * notifications with NOTIFICATION_LY_ONGOING_EVENT can not be protected from removing by user since tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */
        NOTIFICATION_LY_ONGOING_PROGRESS,
         /**< Layout for ongoing notification. Used to display progress*/
        NOTIFICATION_LY_MAX,
@@ -79,7 +79,7 @@ typedef enum  _notification_launch_option_type {
 
 /**
  * @brief Enumeration for event type on notification.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum _notification_event_type {
        NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1  = 0,  /** < Event type : Click on button 1 */
@@ -148,7 +148,7 @@ typedef enum _notification_count_display_type {
 
 /**
  * @brief Enumeration for button
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum _notification_button_index {
        NOTIFICATION_BUTTON_1 = 1, /**< button 1 */
@@ -419,7 +419,7 @@ typedef struct _notification_op {
 
 /**
  * @brief Enumeration for permission.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum notification_permission_type {
     NOTIFICATION_PERMISSION_TYPE_NONE = 0,