From: JinWang An Date: Thu, 16 May 2024 02:55:19 +0000 (+0900) Subject: Fix Native API Reference docxygen syntax X-Git-Tag: accepted/tizen/8.0/unified/20240530.161328~5 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3393c2d915c1a9fe09eb5e171ff02825a0e635df;p=platform%2Fcore%2Fapi%2Fbase-utils.git Fix Native API Reference docxygen syntax Change-Id: Icaf34a2dbd34b2ce18294690224772325bc598ac Signed-off-by: JinWang An --- diff --git a/src/include/utils_i18n_measure.h b/src/include/utils_i18n_measure.h index b2e4187..3ad9eab 100644 --- a/src/include/utils_i18n_measure.h +++ b/src/include/utils_i18n_measure.h @@ -65,7 +65,7 @@ int i18n_measure_create(const i18n_formattable_h formattable, i18n_measure_unit_ /** * @brief Creates a polymorphic clone of the given @a clone object. * @since_tizen 2.3.2 and 3.0 - * @remarks The @c clone object should be released by the caller with the + * @remarks The @a clone object should be released by the caller with the * #i18n_measure_destroy() function. * * @param[in] measure The measure object to be cloned diff --git a/src/include/utils_i18n_ubrk.h b/src/include/utils_i18n_ubrk.h index 342639d..cab7650 100644 --- a/src/include/utils_i18n_ubrk.h +++ b/src/include/utils_i18n_ubrk.h @@ -203,8 +203,8 @@ int32_t i18n_ubrk_first(i18n_ubreak_iterator_h break_iter); int32_t i18n_ubrk_last(i18n_ubreak_iterator_h break_iter); /** - * @brief Sets the iterator position to the first boundary preceding the specified @c offset. - * @details The new position is always smaller than @c offset, or #I18N_UBRK_DONE. + * @brief Sets the iterator position to the first boundary preceding the specified @a offset. + * @details The new position is always smaller than @a offset, or #I18N_UBRK_DONE. * @remarks The specific error code can be obtained using the get_last_result() method. * Error codes are described in Exceptions section. * @since_tizen 2.3.1 @@ -218,8 +218,8 @@ int32_t i18n_ubrk_last(i18n_ubreak_iterator_h break_iter); int32_t i18n_ubrk_preceding(i18n_ubreak_iterator_h break_iter, int32_t offset); /** - * @brief Advances the iterator to the first boundary following the specified @c offset. - * @details The value returned is always greater than @c offset, or #I18N_UBRK_DONE. + * @brief Advances the iterator to the first boundary following the specified @a offset. + * @details The value returned is always greater than @a offset, or #I18N_UBRK_DONE. * @remarks The specific error code can be obtained using the get_last_result() method. * Error codes are described in Exceptions section. * @since_tizen 2.3.1 diff --git a/src/include/utils_i18n_ucalendar.h b/src/include/utils_i18n_ucalendar.h index 3eb12c8..c37acf6 100644 --- a/src/include/utils_i18n_ucalendar.h +++ b/src/include/utils_i18n_ucalendar.h @@ -486,9 +486,9 @@ int i18n_ucalendar_country_timezones_create(const char *country, i18n_uenumerati * @since_tizen 2.3.1 * * @param[out] result A buffer to receive the result, or @c NULL - * @param[in] result_capacity The capacity of the @c result buffer + * @param[in] result_capacity The capacity of the @a result buffer * - * @return The @c result string length, not including the terminating @c NULL. + * @return The @a result string length, not including the terminating @c NULL. * @exception #I18N_ERROR_NONE Successful * @exception #I18N_ERROR_INVALID_PARAMETER Invalid parameter */ @@ -518,9 +518,9 @@ int i18n_ucalendar_set_timezone(i18n_ucalendar_h calendar, const i18n_uchar *zon * * @param[in] calendar The #i18n_ucalendar_h to query. * @param[out] result Receives the calendar's time zone ID. - * @param[in] result_length The maximum size of the @c result. + * @param[in] result_length The maximum size of the @a result. * - * @return The total buffer size needed; if greater than @c result_length, the output was truncated. + * @return The total buffer size needed; if greater than @a result_length, the output was truncated. * @exception #I18N_ERROR_NONE Successful * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter */ @@ -643,7 +643,7 @@ int i18n_ucalendar_set_date(i18n_ucalendar_h calendar, int32_t year, int32_t mon * #I18N_UCALENDAR_DAY_OF_WEEK, #I18N_UCALENDAR_DAY_OF_WEEK_IN_MONTH, #I18N_UCALENDAR_AM_PM, * #I18N_UCALENDAR_HOUR, #I18N_UCALENDAR_HOUR_OF_DAY, #I18N_UCALENDAR_MINUTE, * #I18N_UCALENDAR_SECOND, #I18N_UCALENDAR_MILLISECOND. - * @param[in] amount The signed amount to add to the @c field. If the amount causes the + * @param[in] amount The signed amount to add to the @a field. If the amount causes the * value to exceed to maximum or minimum values for that field, the field is pinned * to a permissible value. * @@ -741,7 +741,7 @@ int i18n_ucalendar_clear(i18n_ucalendar_h calendar); int32_t i18n_ucalendar_get_limit(const i18n_ucalendar_h calendar, i18n_ucalendar_date_fields_e field, i18n_ucalendar_limit_type_e type); /** - * @brief Gets the locale for this @c calendar object. + * @brief Gets the locale for this @a calendar object. * @details You can choose between valid and actual locale. * @remarks The specific error code can be obtained using the get_last_result() * method. Error codes are described in Exceptions section and @@ -776,10 +776,10 @@ const char *i18n_ucalendar_get_tz_data_version(void); * @since_tizen 2.3.1 * * @param[in] id The input timezone ID to be canonicalized. - * @param[in] length The length of the @c id, or @c -1 if NULL-terminated. + * @param[in] length The length of the @a id, or @c -1 if NULL-terminated. * @param[out] result The buffer receives the canonical system timezone ID or the custom timezone ID in normalized format. - * @param[in] result_capacity The capacity of the @c result buffer. - * @param[out] is_system_id Receives if the given @c id is a known system timezone ID. + * @param[in] result_capacity The capacity of the @a result buffer. + * @param[out] is_system_id Receives if the given @a id is a known system timezone ID. * * @return The result string length, not including the terminating NULL. * @exception #I18N_ERROR_NONE Successful @@ -826,7 +826,7 @@ int i18n_ucalendar_get_keyword_values_for_locale(const char *key, const char *lo /** * @brief Returns whether the given day of the week is a weekday, a weekend day, * or a day that transitions from one to the other, for the locale and calendar system - * associated with this @c #i18n_ucalendar_h (the locale's region is often the most determinant factor). + * associated with this #i18n_ucalendar_h (the locale's region is often the most determinant factor). * @details If a transition occurs at midnight, then the days before and after the * transition will have the type #I18N_UCALENDAR_WEEKDAY or #I18N_UCALENDAR_WEEKEND. * If a transition occurs at a time other than midnight, then the day of the @@ -849,11 +849,11 @@ int i18n_ucalendar_get_day_of_week_type(const i18n_ucalendar_h calendar, i18n_uc /** * @brief Returns the time during the day at which the weekend begins or ends in this calendar system. * @details If i18n_ucalendar_get_day_of_week_type() returns #I18N_UCALENDAR_WEEKEND_ONSET - * for the specified @c day_of_week, return the time at which the weekend begins. If + * for the specified @a day_of_week, return the time at which the weekend begins. If * i18n_ucalendar_get_day_of_week_type() returns #I18N_UCALENDAR_WEEKEND_CEASE for - * the specified @c day_of_week, return the time at which the weekend ends. If + * the specified @a day_of_week, return the time at which the weekend ends. If * i18n_ucalendar_get_day_of_week_type() returns some other #i18n_ucalendar_weekday_type_e - * for the specified @c day_of_week, it is an error condition (#I18N_ERROR_INVALID_PARAMETER). + * for the specified @a day_of_week, it is an error condition (#I18N_ERROR_INVALID_PARAMETER). * @remarks The specific error code can be obtained using the get_last_result() * method. Error codes are described in Exceptions section and * #i18n_error_code_e description. diff --git a/src/include/utils_i18n_uchar.h b/src/include/utils_i18n_uchar.h index 26978dd..07a0e6f 100644 --- a/src/include/utils_i18n_uchar.h +++ b/src/include/utils_i18n_uchar.h @@ -296,7 +296,7 @@ int i18n_uchar_get_int_property_min_value(i18n_uchar_uproperty_e which, int32_t * @brief Gets the maximum value for an enumerated/integer/binary Unicode property. * @details Can be used together with i18n_uchar_get_int_property_min_value to allocate arrays of * UnicodeSet or similar. Examples for min/max values (for unicode 3.2): for undefined - * #i18n_uchar_uproperty_e constant values, min/max values will be @c 0/ @c -1. + * #i18n_uchar_uproperty_e constant values, min/max values will be @c 0 / @c -1. * @since_tizen 4.0 * * @param[in] which #i18n_uchar_uproperty_e selector constant, identifies which binary diff --git a/src/include/utils_i18n_udate.h b/src/include/utils_i18n_udate.h index e1bb6ca..6fd6d28 100644 --- a/src/include/utils_i18n_udate.h +++ b/src/include/utils_i18n_udate.h @@ -256,7 +256,7 @@ int i18n_udate_to_calendar_date_field(i18n_udate_format_field_e field, i18n_ucal * @since_tizen 2.3.1 * * @param[in] format The format to copy. - * @param[out] format_clone A pointer to clone of @c format. + * @param[out] format_clone A pointer to clone of @a format. * * @return Error code. Error codes not listed below are described in #i18n_error_code_e * @retval #I18N_ERROR_NONE Successful diff --git a/src/include/utils_i18n_udatepg.h b/src/include/utils_i18n_udatepg.h index 5d0a281..780aff0 100644 --- a/src/include/utils_i18n_udatepg.h +++ b/src/include/utils_i18n_udatepg.h @@ -234,7 +234,7 @@ int i18n_udatepg_create_empty(i18n_udatepg_h *dtpg); * @since_tizen 2.3.1 * * @param[in] dtpg An #i18n_udatepg_h handle to be copied. Must not be @c NULL. - * @param[out] dtpg_clone A pointer to clone of @c dtpg handle. + * @param[out] dtpg_clone A pointer to clone of @a dtpg handle. * * @return The obtained error code. * @retval #I18N_ERROR_NONE Successful @@ -256,17 +256,17 @@ int i18n_udatepg_clone(const i18n_udatepg_h dtpg, i18n_udatepg_h *dtpg_clone); * @since_tizen 2.3.1 * * @param[in] dtpg An #i18n_udatepg_h handle. Must not be @c NULL. - * @param[in] skeleton The @c skeleton is a pattern containing only the variable fields; + * @param[in] skeleton The @a skeleton is a pattern containing only the variable fields; * for example, "MMMdd" and "mmhh" are skeletons. Must not be @c NULL. - * @param[in] length The length of @c skeleton, >= 0. + * @param[in] length The length of @a skeleton, >= 0. * @param[in] options Options for forcing the length of specified fields in the - * returned pattern to match those in the @c skeleton (when this + * returned pattern to match those in the @a skeleton (when this * would not happen otherwise). For default behavior, use * #I18N_UDATEPG_MATCH_NO_OPTIONS. - * @param[out] best_pattern The best pattern found from the given @c skeleton. - * @param[in] capacity The capacity of @c best_pattern, >= 0. + * @param[out] best_pattern The best pattern found from the given @a skeleton. + * @param[in] capacity The capacity of @a best_pattern, >= 0. * - * @return The length of @c best_pattern. + * @return The length of @a best_pattern. * * @exception #I18N_ERROR_NONE Successful * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter @@ -289,9 +289,9 @@ int32_t i18n_udatepg_get_best_pattern_with_options(i18n_udatepg_h dtpg, const i1 * @param[in] pattern Input pattern, such as "dd/MMM". Must not be @c NULL. * @param[in] length The length of @c pattern, >= 0. * @param[out] skeleton Such as "MMMdd". - * @param[in] capacity The capacity of @c skeleton, >= 0. + * @param[in] capacity The capacity of @a skeleton, >= 0. * - * @return The length of @c skeleton. + * @return The length of @a skeleton. * * @exception #I18N_ERROR_NONE Successful * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter @@ -316,7 +316,7 @@ int32_t i18n_udatepg_get_skeleton(i18n_udatepg_h dtpg, const i18n_uchar *pattern * @param[in] pattern Input pattern, such as "dd/MMM". Must not be @c NULL. * @param[in] length The length of @c pattern, >= 0. * @param[out] base_skeleton Such as "Md". - * @param[in] capacity The capacity of base @c skeleton, >= 0. + * @param[in] capacity The capacity of @a base_skeleton, >= 0. * * @return The length of @c base_skeleton. * diff --git a/src/include/utils_i18n_uset.h b/src/include/utils_i18n_uset.h index 7e564a2..d341f19 100644 --- a/src/include/utils_i18n_uset.h +++ b/src/include/utils_i18n_uset.h @@ -922,7 +922,7 @@ int32_t i18n_uset_span(const i18n_uset_h set, const i18n_uchar *str, int32_t len * * @param[in] set the set. Must not be @c NULL. * @param[in] str start of the input string - * @param[in] length length of the @ string; >= 0, can be @c -1 for NULL-terminated + * @param[in] length length of the @a str; >= 0, can be @c -1 for NULL-terminated * @param[in] span_condition specifies the containment condition * * @return the start of the trailing substring according to the @a span_condition;