Fix doxygen errors 31/237631/1 accepted/tizen/unified/20200702.141721 submit/doxygen/20200702.051059 submit/tizen/20200702.051117
authorHyunjee Kim <hj0426.kim@samsung.com>
Thu, 2 Jul 2020 04:50:15 +0000 (13:50 +0900)
committerHyunjee Kim <hj0426.kim@samsung.com>
Thu, 2 Jul 2020 04:50:15 +0000 (13:50 +0900)
Change-Id: Ic358c7ab52d99fe31c8299f9eff3d90c97c14c34

src/include/utils_i18n.h
src/include/utils_i18n_ucnv.h
src/include/utils_i18n_ucnvsel.h
src/include/utils_i18n_unormalization.h
src/include/utils_i18n_unumsys.h
src/include/utils_i18n_utext.h

index d5fe606..97710b7 100644 (file)
@@ -1699,27 +1699,27 @@ extern "C" {
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_get_NFC_instance</td>
+ *    <td>#i18n_unormalization_get_nfc_instance</td>
  *    <td>unorm2_getNFCInstance</td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_get_NFD_instance</td>
+ *    <td>#i18n_unormalization_get_nfd_instance</td>
  *    <td>unorm2_getNFDInstance</td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_get_NFKC_instance</td>
+ *    <td>#i18n_unormalization_get_nfkc_instance</td>
  *    <td>unorm2_getNFKCInstance</td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_get_NFKD_instance</td>
+ *    <td>#i18n_unormalization_get_nfkd_instance</td>
  *    <td>unorm2_getNFKDInstance</td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_get_NFKC_casefold_instance</td>
+ *    <td>#i18n_unormalization_get_nfkc_casefold_instance</td>
  *    <td>unorm2_getNFKCCasefoldInstance</td>
  * </tr>
  * <tr>
@@ -1779,12 +1779,12 @@ extern "C" {
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_has_boundary_before</td>
+ *    <td>#i18n_unormalizer_has_boundary_before</td>
  *    <td>unorm2_hasBoundaryBefore</td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNORMALIZATION_MODULE</td>
- *    <td>#i18n_unormalization_has_boundary_after</td>
+ *    <td>#i18n_unormalizer_has_boundary_after</td>
  *    <td>unorm2_hasBoundaryAfter</td>
  * </tr>
  * <tr>
@@ -4343,7 +4343,7 @@ extern "C" {
  * </tr>
  * <tr>
  *    <td>@ref CAPI_BASE_UTILS_I18N_UNUMSYS_MODULE</td>
- *    <td>i18n_unumsys_create_available_names</td>
+ *    <td>i18n_unumsys_get_available_names</td>
  *    <td>unumsys_openAvailableNames</td>
  * </tr>
  * <tr>
index 0775425..3da49be 100644 (file)
@@ -91,7 +91,7 @@ int i18n_ucnv_compare_names(const char *name1, const char *name2);
  *          A converter name for ICU 1.5 and above may contain options like a locale specification to control the specific behavior of the newly instantiated converter.
  *          The meaning of the options depends on the particular converter. If an option is not defined for or recognized by a given converter, then it is ignored.
  *
- *          Options are appended to the converter name string, with a #I18N_UCNV_OPTION_SEP_CHAR between the name and the first option and also between adjacent options.
+ *          Options are appended to the converter name string, with a "," between the name and the first option and also between adjacent options.
  *
  *
  *          The conversion behavior and names can vary between platforms. ICU may convert some characters differently from other platforms.
index 8264621..e89ed0d 100644 (file)
@@ -117,7 +117,7 @@ int i18n_ucnvsel_serialize(const i18n_uconverter_selector_h sel, void *buffer, i
  * @brief   Selects converters that can map all characters in a UTF-16 string, ignoring the excluded code points.
  * @since_tizen 6.0
  * @remarks The @a enumeration is valid until @a sel is released.
- * @param[in] sel          An #i18n_uconvert_selector_h
+ * @param[in] sel          An #i18n_uconverter_selector_h
  * @param[in] string       UTF-16 string
  * @param[in] length       Length of the string, or -1 if NUL-terminated
  * @param[out] enumeration An enumeration containing encoding names. The returned encoding names and their order will be the same as supplied when building the selector.
@@ -132,7 +132,7 @@ int i18n_ucnvsel_select_for_string(const i18n_uconverter_selector_h sel, const i
  * @brief   Selects converters that can map all characters in a UTF-8 string, ignoring the excluded code points.
  * @since_tizen 6.0
  * @remarks The @a enumeration is valid until @a sel is released.
- * @param[in] sel          An #i18n_uconvert_selector_h
+ * @param[in] sel          An #i18n_uconverter_selector_h
  * @param[in] string       UTF-8 string
  * @param[in] length       Length of the string, or -1 if NUL-terminated
  * @param[out] enumeration An enumeration containing encoding names. The returned encoding names and their order will be the same as supplied when building the selector.
index 8d59876..32bf27c 100644 (file)
@@ -118,7 +118,7 @@ int i18n_unormalization_get_nfc_instance(i18n_unormalizer_h* normalizer);
 
 /**
  * @brief      Returns an #i18n_unormalizer_h instance for Unicode NFD normalization.
- * @details Same as #i18n_unormalization_get_instance(NULL, "nfc", I18N_UNORM2_DECOMPOSE, n2).
+ * @details Same as #i18n_unormalization_get_instance(NULL, "nfc", I18N_UNORMALIZATION_DECOMPOSE, n2).
  *                     Returns an unmodifiable singleton instance. Do not delete it.
  * @since_tizen 6.0
  * @param[out] normalizer      The requested #i18n_unormalizer_h, if successful
@@ -146,7 +146,7 @@ int i18n_unormalization_get_nfkc_instance(i18n_unormalizer_h* normalizer);
 
 /**
  * @brief      Returns an #i18n_unormalizer_h instance for Unicode NFKD normalization.
- * @details Same as #i18n_unormalization_get_instance(NULL, "nfkc", I18N_UNORM2_DECOMPOSE, n2).
+ * @details Same as #i18n_unormalization_get_instance(NULL, "nfkc", I18N_UNORMALIZATION_DECOMPOSE, n2).
  *                     Returns an unmodifiable singleton instance. Do not delete it.
  * @since_tizen 6.0
  * @param[out] normalizer      The requested #i18n_unormalizer_h, if successful
@@ -190,7 +190,7 @@ int i18n_unormalization_get_nfkc_casefold_instance(i18n_unormalizer_h* normalize
 int i18n_unormalization_create_filtered(i18n_unormalizer_h normalizer, const i18n_uset_h *filter_set, i18n_unormalizer_h *normalizer2);
 
 /**
- * @brief      Closes a #i18n_unormalizer_h from #i18n_unormalization_open_filtered().
+ * @brief      Closes a #i18n_unormalizer_h from #i18n_unormalization_create_filtered().
  * @details Do not destroy instances from #i18n_unormalization_get_instance()
  * @since_tizen 6.0
  * @param[in] normalizer       An #i18n_unormalizer_h to be closed
@@ -243,7 +243,7 @@ int i18n_unormalization_append(i18n_unormalizer_h normalizer, i18n_uchar *first,
 
 /**
  * @brief      Gets the decomposition mapping of @a code_point.
- * @details Roughly equivalent to normalizing the String form of @a code_point on an #I18N_UNORM2_DECOMPOSE #i18n_unormalizer_h,
+ * @details Roughly equivalent to normalizing the String form of @a code_point on an #I18N_UNORMALIZATION_DECOMPOSE #i18n_unormalizer_h,
  *                     but much faster, and except that this function returns a negative value and does not write a string
  *                     if @a code_point does not have a decomposition mapping in this instance's data.
  *                     This function is independent of the mode of the UNormalizer2.
index 7a6fe13..08bf89c 100644 (file)
@@ -72,7 +72,7 @@ int i18n_unumsys_create(const char *locale, i18n_unumsys_h *unumsys);
 
 /**
  * @brief      Creates an #i18n_unumsys_h using the name of one of the predefined numbering systems specified by CLDR and known to ICU,
- *                     such as "latn", "arabext", or "hanidec"; the full list is returned by #i18n_unumsys_create_available_names.
+ *                     such as "latn", "arabext", or "hanidec"; the full list is returned by #i18n_unumsys_get_available_names.
  * @since_tizen 6.0
  * @param[in] name     The name of the numbering system for which an #i18n_unumsys_h should be created.
  * @param[out] unumsys An #i18n_unumsys_h handle for the specified name, or NULL if an error occurred.
index 64a69b7..ee71020 100644 (file)
@@ -181,7 +181,7 @@ int i18n_utext_create_for_uchars(i18n_utext_h uta, const i18n_uchar *s, int64_t
  *
  *                     The built-in #i18n_utext_h implementations for UTF8 and i18n_uchar * support deep cloning.
  *                     The #i18n_utext_h returned from a deep clone will be writable, assuming that the text provider is able to support writing,
- *                     even if the source #i18n_utext_h had been made non-writable by means of #i18n_utext_freeze().
+ *                     even if the source #i18n_utext_h had been made non-writable by means of i18n_utext_freeze().
  *
  *                     A shallow clone replicates only the #i18n_utext_h handle data; it does not make a copy of the underlying text.
  *                     Shallow clones can be used as an efficient way to have multiple iterators active in a single text string that is not being modified.
@@ -381,7 +381,7 @@ i18n_ubool i18n_utext_move_index32(i18n_utext_h ut, int32_t delta);
  *                     i18n_utext_h ut = whatever;
  *                     i18n_utext_previous(ut);
  *                     i18n_utext_get_native_index(ut);
- *                     #endcode
+ *                     @endcode
  *                     This function is most useful during forwards iteration, where it will get the native index of
  *                     the character most recently returned from i18n_utext_next().
  * @since_tizen 6.0