From: Jihoon Kim Date: Tue, 8 Oct 2019 08:08:18 +0000 (+0900) Subject: Revise documentation for fill response item X-Git-Tag: accepted/tizen/unified/20191017.011731~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d2212ffadf5b2c0c95f737b14226d1e8c7dc4586;p=platform%2Fcore%2Fuifw%2Fautofill.git Revise documentation for fill response item Change-Id: I3b09a44ca21b2fdb2667ac062228c9ac3ad479ae Signed-off-by: Jihoon Kim --- diff --git a/include/autofill_common.h b/include/autofill_common.h index 55a999c..6941b07 100644 --- a/include/autofill_common.h +++ b/include/autofill_common.h @@ -74,7 +74,7 @@ typedef struct autofill_auth_info_s *autofill_auth_info_h; typedef struct autofill_view_info_s *autofill_view_info_h; /** - * @brief The autofill fill response handle. + * @brief The handle for having a response of the requested autofill. * @since_tizen 5.5 */ typedef struct autofill_fill_response_s *autofill_fill_response_h; @@ -710,10 +710,10 @@ int autofill_save_view_info_add_item(autofill_save_view_info_h vi, autofill_save int autofill_save_view_info_foreach_item(autofill_save_view_info_h vi, autofill_save_item_cb callback, void *user_data); /** - * @brief Creates an autofill fill response. + * @brief Creates a handle for having a response of the requested autofill. * @since_tizen 5.5 * @remarks If the function succeeds, @a h handle must be released with autofill_fill_response_destroy(). - * @param[out] h The autofill fill response handle + * @param[out] h The handle for having a response of the requested autofill * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error * @retval #AUTOFILL_ERROR_INVALID_PARAMETER Invalid parameter @@ -721,9 +721,9 @@ int autofill_save_view_info_foreach_item(autofill_save_view_info_h vi, autofill_ int autofill_fill_response_create(autofill_fill_response_h *h); /** - * @brief Destroys an autofill fill response. + * @brief Destroys a handle for having a response of the requested autofill. * @since_tizen 5.5 - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error * @retval #AUTOFILL_ERROR_INVALID_PARAMETER Invalid parameter @@ -731,9 +731,9 @@ int autofill_fill_response_create(autofill_fill_response_h *h); int autofill_fill_response_destroy(autofill_fill_response_h h); /** - * @brief Sets the app ID in an autofill fill response. + * @brief Sets the app ID in the handle for having a response of the requested autofill. * @since_tizen 5.5 - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[in] app_id The app ID * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error @@ -742,10 +742,10 @@ int autofill_fill_response_destroy(autofill_fill_response_h h); int autofill_fill_response_set_app_id(autofill_fill_response_h h, const char *app_id); /** - * @brief Gets the app ID from an autofill fill response. + * @brief Gets the app ID from the handle for having a response of the requested autofill. * @since_tizen 5.5 * @remarks @a app_id must be released using free(). - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[out] app_id The app ID * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error @@ -755,9 +755,9 @@ int autofill_fill_response_set_app_id(autofill_fill_response_h h, const char *ap int autofill_fill_response_get_app_id(autofill_fill_response_h h, char **app_id); /** - * @brief Sets the view ID in an autofill fill response. + * @brief Sets the view ID in the handle for having a response of the requested autofill. * @since_tizen 5.5 - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[in] view_id The view ID * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error @@ -766,10 +766,10 @@ int autofill_fill_response_get_app_id(autofill_fill_response_h h, char **app_id) int autofill_fill_response_set_view_id(autofill_fill_response_h h, const char *view_id); /** - * @brief Gets the view ID from an autofill fill response. + * @brief Gets the view ID from the handle for having a response of the requested autofill. * @since_tizen 5.5 * @remarks @a view_id must be released using free(). - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[out] view_id The view ID * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error @@ -781,7 +781,7 @@ int autofill_fill_response_get_view_id(autofill_fill_response_h h, char **view_i /** * @brief Adds autofill fill response group. * @since_tizen 5.5 - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[in] it The autofill fill response group handle * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error @@ -792,7 +792,7 @@ int autofill_fill_response_add_group(autofill_fill_response_h h, autofill_fill_r /** * @brief Retrieves all groups of each fill response. * @since_tizen 5.5 - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function * @return 0 on success, otherwise a negative error value @@ -804,7 +804,7 @@ int autofill_fill_response_foreach_group(autofill_fill_response_h h, autofill_fi /** * @brief Gets the number of fill response group. * @since_tizen 5.5 - * @param[in] h The autofill fill response handle + * @param[in] h The handle for having a response of the requested autofill * @param[out] count The number of group * @return 0 on success, otherwise a negative error value * @retval #AUTOFILL_ERROR_NONE No error @@ -873,7 +873,7 @@ int autofill_fill_response_group_add_item(autofill_fill_response_group_h h, auto int autofill_fill_response_group_foreach_item(autofill_fill_response_group_h h, autofill_fill_response_item_cb callback, void *user_data); /** - * @brief Creates autofill response item. + * @brief Creates a handle for fill response item. * @since_tizen 5.5 * @remarks If the function succeeds, @a it handle must be released with autofill_fill_response_item_destroy(). * @param[out] it The autofill fill response item handle @@ -885,7 +885,7 @@ int autofill_fill_response_group_foreach_item(autofill_fill_response_group_h h, int autofill_fill_response_item_create(autofill_fill_response_item_h *it); /** - * @brief Destroys an autofill fill response item. + * @brief Destroys the handle for fill response item. * @since_tizen 5.5 * @param[in] it The autofill fill response item handle * @return 0 on success, otherwise a negative error value @@ -895,7 +895,7 @@ int autofill_fill_response_item_create(autofill_fill_response_item_h *it); int autofill_fill_response_item_destroy(autofill_fill_response_item_h it); /** - * @brief Clones an autofill fill response item. + * @brief Clones a handle for fill response item. * * @since_tizen 5.5 * @@ -909,7 +909,7 @@ int autofill_fill_response_item_destroy(autofill_fill_response_item_h it); int autofill_fill_response_item_clone(autofill_fill_response_item_h it, autofill_fill_response_item_h *clone); /** - * @brief Sets the autofill ID in an autofill fill response item. + * @brief Sets the autofill ID in the handle for fill response item. * @since_tizen 5.5 * @param[in] it The autofill fill response item handle * @param[in] id The autofill fill response item ID @@ -920,7 +920,7 @@ int autofill_fill_response_item_clone(autofill_fill_response_item_h it, autofill int autofill_fill_response_item_set_id(autofill_fill_response_item_h it, const char *id); /** - * @brief Gets the autofill ID from an autofill fill response item. + * @brief Gets the autofill ID from the handle for fill response item. * @since_tizen 5.5 * @remarks @a id must be released using free(). * @param[in] it The autofill fill response item handle @@ -933,7 +933,7 @@ int autofill_fill_response_item_set_id(autofill_fill_response_item_h it, const c int autofill_fill_response_item_get_id(autofill_fill_response_item_h it, char **id); /** - * @brief Sets the autofill value in an autofill fill response item. + * @brief Sets the autofill value in the handle for fill response item. * @since_tizen 5.5 * @param[in] it The autofill fill response item handle * @param[in] value The autofill fill response item value @@ -944,7 +944,7 @@ int autofill_fill_response_item_get_id(autofill_fill_response_item_h it, char ** int autofill_fill_response_item_set_value(autofill_fill_response_item_h it, const char *value); /** - * @brief Gets the autofill value from an autofill fill response item. + * @brief Gets the autofill value from the handle for fill response item. * @since_tizen 5.5 * @remarks @a value must be released using free(). * @param[in] it The autofill fill response item handle @@ -957,7 +957,7 @@ int autofill_fill_response_item_set_value(autofill_fill_response_item_h it, cons int autofill_fill_response_item_get_value(autofill_fill_response_item_h it, char **value); /** - * @brief Sets the presentation text in an autofill fill response item. + * @brief Sets the presentation text in the handle for fill response item. * @since_tizen 5.5 * @param[in] it The autofill fill response item handle * @param[in] presentation_text The presentation text @@ -968,7 +968,7 @@ int autofill_fill_response_item_get_value(autofill_fill_response_item_h it, char int autofill_fill_response_item_set_presentation_text(autofill_fill_response_item_h it, const char *presentation_text); /** - * @brief Gets the presentation text from an autofill fill response item. + * @brief Gets the presentation text from the handle for fill response item. * @since_tizen 5.5 * @remarks @a presentation_text must be released using free(). * @param[in] it The autofill fill response item handle @@ -981,7 +981,7 @@ int autofill_fill_response_item_set_presentation_text(autofill_fill_response_ite int autofill_fill_response_item_get_presentation_text(autofill_fill_response_item_h it, char **presentation_text); /** - * @brief Sets the autofill hint in an autofill fill response item. + * @brief Sets the type of autofill hint in the handle for fill response item. * @since_tizen 5.5 * @param[in] it The autofill fill response item handle * @param[in] hint The autofill hint @@ -992,7 +992,7 @@ int autofill_fill_response_item_get_presentation_text(autofill_fill_response_ite int autofill_fill_response_item_set_autofill_hint(autofill_fill_response_item_h it, autofill_hint_e hint); /** - * @brief Gets the autofill hint from an autofill fill response item. + * @brief Gets the type of autofill hint in the handle for fill response item. * @since_tizen 5.5 * @param[in] it The autofill fill response item handle * @param[out] hint The autofill hint