From: mk5004.lee Date: Wed, 13 Nov 2019 03:49:13 +0000 (+0900) Subject: Update doxygen X-Git-Tag: submit/tizen_5.5/20191115.050841~1^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=dce8bb32af6ff015f75755cd76071881229ea6cb;p=platform%2Fcore%2Fapi%2Fnotification.git Update doxygen Change-Id: I885d0d70b6076b918de09c861340786d5d85292e Signed-off-by: mk5004.lee --- diff --git a/notification-ex/api/notification_ex_button.h b/notification-ex/api/notification_ex_button.h index 0d8d8de1..69164565 100644 --- a/notification-ex/api/notification_ex_button.h +++ b/notification-ex/api/notification_ex_button.h @@ -94,7 +94,7 @@ int noti_ex_item_button_get_title(noti_ex_item_h handle, char **title); * @remarks After the multi-language handle setted successfully, noti_ex_item_button_get_title() \n * will return the multi-language text. * @remarks The #noti_ex_item_h handle keeps its own copy of #noti_ex_multi_lang_h. \n - * Therefore, you can destroy @ multi after it was set for @ handle. + * Therefore, you can destroy @a multi after it was set for @ handle. * @remarks You can pass NULL to @a multi, if you want to remove multi-language text. * @param[in] handle The notification_ex button item handle * @param[in] multi The multi-language handle diff --git a/notification-ex/api/notification_ex_checkbox.h b/notification-ex/api/notification_ex_checkbox.h index 2263f133..dd3d90e8 100644 --- a/notification-ex/api/notification_ex_checkbox.h +++ b/notification-ex/api/notification_ex_checkbox.h @@ -95,7 +95,7 @@ int noti_ex_item_checkbox_get_title(noti_ex_item_h handle, char **title); * @remarks After the multi-language handle setted successfully, \n * noti_ex_item_checkbox_get_title() will return the multi-language text. * @remarks The #noti_ex_item_h handle keeps its own copy of #noti_ex_multi_lang_h. \n - * Therefore, you can destroy @ multi after it was set for @ handle. + * Therefore, you can destroy @a multi after it was set for @ handle. * @remarks You can pass NULL to @a multi, if you want to remove the multi-language text. * @param[in] handle The notification_ex item handle * @param[in] multi The multi-language handle diff --git a/notification-ex/api/notification_ex_entry.h b/notification-ex/api/notification_ex_entry.h index 821e420c..98acf64f 100644 --- a/notification-ex/api/notification_ex_entry.h +++ b/notification-ex/api/notification_ex_entry.h @@ -115,7 +115,7 @@ int noti_ex_item_entry_set_text(noti_ex_item_h handle, const char *text); * @remarks After the multi-language handle setted successfully, \n * noti_ex_item_entry_get_text() will return the multi-language text. \n * @remarks The #noti_ex_item_h handle keeps its own copy of #noti_ex_multi_lang_h. \n - * Therefore, you can destroy @ multi after it was set for @ handle. + * Therefore, you can destroy @a multi after it was set for @ handle. * @remarks You can pass NULL to @a multi, if you want to remove the multi-language text. * @param[in] handle The notification_ex item handle * @param[in] multi The multi-language handle diff --git a/notification-ex/api/notification_ex_input_selector.h b/notification-ex/api/notification_ex_input_selector.h index 192a6775..9afab314 100644 --- a/notification-ex/api/notification_ex_input_selector.h +++ b/notification-ex/api/notification_ex_input_selector.h @@ -122,7 +122,7 @@ int noti_ex_item_input_selector_set_contents(noti_ex_item_h handle, const char * * @remarks After the multi-language handle setted successfully, \n * noti_ex_item_input_selector_get_contents() will return the multi-language text. \n * @remarks The #noti_ex_item_h handle keeps its own copy of #noti_ex_multi_lang_h list. \n - * Therefore, you can destroy @ multi_language_list after it was set for @ handle. + * Therefore, you can destroy @a multi_language_list after it was set for @ handle. * @remarks You can pass NULL to @a multi_language_list, if you want to remove the multi-language text. * @param[in] handle The notification_ex item handle * @param[in] multi_language_list The list of noti_ex_multi_lang_h diff --git a/notification-ex/api/notification_ex_text.h b/notification-ex/api/notification_ex_text.h index a2307d60..214e6e1f 100644 --- a/notification-ex/api/notification_ex_text.h +++ b/notification-ex/api/notification_ex_text.h @@ -145,7 +145,7 @@ int noti_ex_item_text_get_hyperlink(noti_ex_item_h handle, char **hyperlink); * @remarks After the multi-language handle setted successfully, \n * noti_ex_item_text_get_contents() will return the multi-language text. \n * @remarks The #noti_ex_item_h handle keeps its own copy of #noti_ex_multi_lang_h. \n - * Therefore, you can destroy @ multi after it was set for @ handle. + * Therefore, you can destroy @a multi after it was set for @ handle. * @remarks You can pass NULL to @a multi, if you want to remove the multi-language text. * @param[in] handle The notification_ex item handle * @param[in] multi The multi-language handle diff --git a/notification/include/notification.h b/notification/include/notification.h index 6aa83341..6df7751e 100644 --- a/notification/include/notification.h +++ b/notification/include/notification.h @@ -114,14 +114,14 @@ int notification_get_image(notification_h noti, notification_image_type_e type, * @details If input_time is @c 0, time information is taken from the current time. * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif * @param[in] noti The notification handle - * @param[in] input_time The input time. If you want the time stamp to not be shown, set this as NOTIFICATION_DO_NOT_SHOW_TIME_STAMP + * @param[in] input_time The input time. If you want the time stamp to not be shown, set this as #NOTIFICATION_DO_NOT_SHOW_TIME_STAMP * @return #NOTIFICATION_ERROR_NONE on success, * otherwise any other value on failure * @retval #NOTIFICATION_ERROR_NONE Success * @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter * @pre Notification handle should be created by notification_create(). * @see notification_create() - * @see NOTIFICATION_DO_NOT_SHOW_TIME_STAMP + * @see #NOTIFICATION_DO_NOT_SHOW_TIME_STAMP * @par Sample code: * @code #include @@ -475,7 +475,7 @@ int notification_set_led(notification_h noti, notification_led_op_e operation, i { notification_h noti = NULL; int noti_err = NOTIFICATION_ERROR_NONE; - notification_led_type_e type = NOTIFICATION_LED_OP_OFF; + notification_led_op_e type; noti_err = notification_get_led(noti, &type, NULL); if (noti_err != NOTIFICATION_ERROR_NONE) @@ -763,7 +763,7 @@ int notification_get_property(notification_h noti, int *flags); /** * @brief Sets applications to display the notification. - * @details All display application is enabled(NOTIFICATION_DISPLAY_APP_ALL) if you do not call this function. + * @details All display application is enabled(#NOTIFICATION_DISPLAY_APP_ALL) if you do not call this function. * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif * @param[in] noti The notification handle * @param[in] applist The with | operation @@ -1616,7 +1616,7 @@ int notification_get_noti_block_state(notification_block_state_e *state); * Note that you should set an app_control for handling the event for user input using notification_set_event_handler(). * #NOTIFICATION_EVENT_TYPE_CLICK_ON_TEXT_INPUT_BUTTON is the event type for the text input. * You can get the text the user enters in the app_control handle that is passed as a result of the event. - * The app_control will contain APP_CONTROL_DATA_TEXT key, so you can get the text using app_control_get_extra_data() using APP_CONTROL_DATA_TEXT key. + * The app_control will contain #APP_CONTROL_DATA_TEXT key, so you can get the text using app_control_get_extra_data() using APP_CONTROL_DATA_TEXT key. * The value will contain the text user enters. * * Note that you are able to make the switching button to the text input box. @@ -1811,7 +1811,7 @@ int notification_set_text_input(notification_h noti, int text_input_max_length); return; noti_err = notification_set_text(noti, - NOTIFICATION_TEXT_TYPE_CONTENT_EXTENTION, + NOTIFICATION_TEXT_TYPE_CONTENT_EXTENSION, "message", NULL, NOTIFICATION_VARIABLE_TYPE_NONE); @@ -1819,12 +1819,12 @@ int notification_set_text_input(notification_h noti, int text_input_max_length); return; noti_err = notification_set_image(noti, - NOTIFICATION_IMAGE_TYPE_EXTENTION, + NOTIFICATION_IMAGE_TYPE_EXTENSION, image_path); if (noti_err != NOTIFICATION_ERROR_NONE) return; - noti_err = notification_set_layout(noti, NOTIFICATION_LY_EXTENTION); + noti_err = notification_set_layout(noti, NOTIFICATION_LY_EXTENSION); if (noti_err != NOTIFICATION_ERROR_NONE) return;