From: hyunho Date: Tue, 21 Aug 2018 05:05:08 +0000 (+0900) Subject: Fix doxygen errors X-Git-Tag: accepted/tizen/unified/20180824.062653~10 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F18%2F187218%2F2;p=platform%2Fcore%2Fappfw%2Fwatchface-complication.git Fix doxygen errors Change-Id: I0d85c165f2dc0558125313e84cd9de4c0ef40489 Signed-off-by: hyunho --- diff --git a/doc/watchface-complication_doc.h b/doc/watchface-complication_doc.h index 3c0b9fb..7e61062 100644 --- a/doc/watchface-complication_doc.h +++ b/doc/watchface-complication_doc.h @@ -23,7 +23,7 @@ * @brief The watchface complication provides feature to receive and request watchface complication data. * It also provides editable management feature to request edit for complication and design elements to editor. * @section WATCHFACE_COMPLICATION_MODULE_HEADER Required Header - * \#include + * \#include \n * \#include * * @section WATCHFACE_COMPLICATION_MODULE_OVERVIEW Overview diff --git a/watchface-complication-provider/include/watchface-complication-provider.h b/watchface-complication-provider/include/watchface-complication-provider.h index 21a6b65..73bf041 100644 --- a/watchface-complication-provider/include/watchface-complication-provider.h +++ b/watchface-complication-provider/include/watchface-complication-provider.h @@ -185,7 +185,7 @@ int watchface_complication_provider_notify_update( * @since_tizen 5.0 * @privilege http://tizen.org/privilege/datasharing * @remarks This function is for complication provider's setup application which - * speicified in provider app's manifest file with setup-appid attribute. + * specified in provider app's manifest file with setup-appid attribute. * @param[in] handle The editable handle * @param[in] context The new context data of complication provider. * @return #WATCHFACE_COMPLICATION_ERROR_NONE on success, @@ -217,7 +217,7 @@ int watchface_complication_provider_setup_reply_to_editor(app_control_h handle, * @details Using this function, setup app can tell what kind of UI should be displayed * @since_tizen 5.0 * @remarks This function is for complication provider's setup application which - * speicified in provider app's manifest file with setup-appid attribute. + * specified in provider app's manifest file with setup-appid attribute. * @param[in] handle The editable handle * @param[out] is_editing The value that tell it's editing mode. * @return #WATCHFACE_COMPLICATION_ERROR_NONE on success, @@ -251,7 +251,7 @@ int watchface_complication_provider_setup_is_editing(app_control_h handle, * through the app_control event callback's app_control_h handle parameter * @since_tizen 5.0 * @remarks This function is for complication provider's setup application which - * speicified in provider app's manifest file with setup-appid attribute. + * specified in provider app's manifest file with setup-appid attribute. * @remarks The @a context should be released using bundle_free(). * @param[in] handle The editable handle * @param[out] context app's setup context data @@ -605,7 +605,7 @@ int watchface_complication_provider_data_is_valid(bundle *shared_data, * @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported * @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory - * #retval #WATCHFACE_COMPLICATION_ERROR_IO_ERROR I/O error + * @retval #WATCHFACE_COMPLICATION_ERROR_IO_ERROR I/O error * @see watchface_complication_event_type_e * @see watchface_complication_transfer_event() * @see watchface_complication_provider_event_get_provider_id() diff --git a/watchface-complication/include/watchface-complication.h b/watchface-complication/include/watchface-complication.h index e2de190..9cc32a5 100644 --- a/watchface-complication/include/watchface-complication.h +++ b/watchface-complication/include/watchface-complication.h @@ -62,15 +62,16 @@ typedef void (*watchface_complication_updated_cb)( /** * @brief Called when the complication provider error is occured. + * @details Following error codes can be delivered. + * #WATCHFACE_COMPLICATION_ERROR_PROVIDER_NOT_AVAILABLE : Provider application is not available now for some reason. (eg. uninstall, disable) \n + * #WATCHFACE_COMPLICATION_ERROR_IO_ERROR : Provider application is not responding for update request. \n + * #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY : Out of memory. * @since_tizen 5.0 * @param[in] complication_id A number that identifies the complication * @param[in] provider_id The name of the provider. * The @a provider_id can be used only in the callback. To use outside, make a copy. * @param[in] type The type shown in the complication - * @param[in] error The error related with complication provider \n - * #WATCHFACE_COMPLICATION_ERROR_PROVIDER_NOT_AVAILABLE : Provider aplication is not available now for some reason. (eg. uninstall, disable) \n - * #WATCHFACE_COMPLICATION_ERROR_IO_ERROR : Provider aplication is not responding for update request. \n - * #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY : Out of memory \n + * @param[in] error The error related with complication provider * @param[in] user_data The user data passed from the callback function */ typedef void (*watchface_complication_error_cb)( @@ -274,7 +275,7 @@ int watchface_complication_send_update_request(complication_h handle); * @since_tizen 5.0 * @privilege http://tizen.org/privilege/packagemanager.info * @remarks The @a created_handle should be released using watchface_complication_destroy(). - * Package manager privliege is needed to lookup provider application. + * Package manager privilege is needed to lookup provider application. * @param[in] complication_id A number that identifies the complication * @param[in] default_provider_id The default provider id * @param[in] default_type The default type to display @@ -292,7 +293,7 @@ int watchface_complication_send_update_request(complication_h handle); * @retval #WATCHFACE_COMPLICATION_ERROR_DB Database error * @retval #WATCHFACE_COMPLICATION_ERROR_PERMISSION_DENIED Permission denied * @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported - * @retval #WATCHFACE_COMPLICATION_ERROR_PROVIDER_NOT_AVAILABLE Provider aplication is not available now for some reason. (eg. uninstall, disable) + * @retval #WATCHFACE_COMPLICATION_ERROR_PROVIDER_NOT_AVAILABLE Provider application is not available now for some reason. (eg. uninstall, disable) * @see watchface_complication_type_e * @see watchface_complication_event_type_e * @see watchface_complication_transfer_event() @@ -515,7 +516,7 @@ void _on_complication_update(int complication_id, watchface_complication_type_e type; watchface_complication_data_get_type(data, &type); - if (type == COMPLICATION_TIME) + if (type == WATCHFACE_COMPLICATION_TYPE_TIME) watchface_complication_data_get_timestamp(data, &value); } * @endcode @@ -694,7 +695,7 @@ int watchface_complication_data_get_screen_reader_text(const bundle *data, /** * @brief Transfers touch event to the complication provider. - * @details This function launchs the provider application with extra data, + * @details This function launches the provider application with extra data, * so that provider can tell it is launched by transferred touch event. * @since_tizen 5.0 * @privilege http://tizen.org/privilege/appmanager.launch @@ -804,7 +805,7 @@ int watchface_complication_allowed_list_destroy( * @since_tizen 5.0 * @param[in] handle The complication allowed list handle * @param[in] provider_id The complication provider id - * @param[in] types The complication types, values of #watchface_complication_type_e combinded with bitwise 'or' + * @param[in] types The complication types, values of #watchface_complication_type_e combined with bitwise 'or' * @return #WATCHFACE_COMPLICATION_ERROR_NONE on success, * otherwise an error code (see #watchface_complication_error_e) on failure * @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful @@ -876,7 +877,7 @@ int watchface_complication_allowed_list_delete(complication_allowed_list_h handl * @param[in] handle The complication allowed list handle * @param[in] index Index * @param[out] provider_id The complication provider id - * @param[out] types The complication types, values of #watchface_complication_type_e combinded with bitwise 'or' + * @param[out] types The complication types, values of #watchface_complication_type_e combined with bitwise 'or' * @return #WATCHFACE_COMPLICATION_ERROR_NONE on success, * otherwise an error code (see #watchface_complication_error_e) on failure * @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful