Fix documentation errors

	* utils_i18n_ucollator.h
	* utils_i18n_ulocale.h

Change-Id: I90c384bc648df4e67262a3a0246e6b79d103f4b0
Signed-off-by: Hyunjee Kim <hj0426.kim@samsung.com>

diff --git a/src/include/utils_i18n_ucollator.h b/src/include/utils_i18n_ucollator.h
index f66f180..57262b2 100644 (file)
--- a/src/include/utils_i18n_ucollator.h
+++ b/src/include/utils_i18n_ucollator.h
@@ -233,7 +233,7 @@ int i18n_ucollator_destroy(i18n_ucollator_h collator);
  * @param[in]    collator    The #i18n_ucollator_h containing the comparison rules
  * @param[in]    src         The source string
  * @param[in]    src_len     The length of the source, otherwise @c -1 if null-terminated
- * @param[in]    target      The target string
+ * @param[in]    dest        The target string
  * @param[in]    target_len  The length of the target, otherwise @c -1 if null-terminated
  * @param[out]   result      The result of comparing the strings \n
  *                           One of #I18N_UCOLLATOR_EQUAL, #I18N_UCOLLATOR_GREATER, or #I18N_UCOLLATOR_LESS
@@ -392,7 +392,7 @@ int i18n_ucollator_set_strength(i18n_ucollator_h collator, i18n_ucollator_streng
  * @brief Retrieves the reordering codes for this collator.
  * @details These reordering codes are a combination of #i18n_uscript_code_e codes and
  *          #i18n_ucollator_reorder_code_e entries.
- * since_tizen 4.0
+ * @since_tizen 4.0
  *
  * @param[in]    collator    The #i18n_collator_h to query
  * @param[in]    dest_size   The length of @a dest. If it is @c 0, then dest may be @c NULL and the function
@@ -665,7 +665,7 @@ int i18n_ucollator_get_sort_key(const i18n_ucollator_h collator, const i18n_ucha
  * @param[in]    collator       The #i18n_ucollator_h containing the collation rules
  * @param[in]    iter           #i18n_uchar_iter_h containing the string we need the sort key to be calculated for
  * @param[in]    state          Opaque state of sortkey iteration
- * @param[in]    dest          Buffer to hold the resulting sortkey part
+ * @param[in]    dest           Buffer to hold the resulting sortkey part
  * @param[out]   count          The number of sort key bytes required
  * @param[out]   result_length  The actual number of bytes of a sortkey. It can be smaller than
  *                              count if we have reached the end of the sort key.
@@ -705,9 +705,9 @@ int i18n_ucollator_next_sort_key_part(const i18n_ucollator_h collator,
  * @param[in]    n_levels       Number of levels required in the resulting bound (for most uses, the
  *                              recommended value is 1). See users guide for explanation on number of
  *                              levels a sortkey can have.
- * @param[in]    dest_size      The maximum size of result
- * @param[out]   dest           A pointer to a buffer to receive the resulting sortkey
- * @param[out]   result_length  The size needed to fully store the bound
+ * @param[in]    dest           A pointer to a buffer to receive the resulting sortkey.
+ * @param[out]   dest_length    The maximum size of result
+ * @param[out]   needed_size    The size needed to fully store the bound
  *
  * @retval #I18N_ERROR_NONE              Successful
  * @retval #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
@@ -891,7 +891,7 @@ int i18n_ucollator_safe_clone(i18n_ucollator_h collator, i18n_ucollator_h *clone
 /**
  * @brief Returns the current rules.
  * @details Delta defines whether full rules are returned or just the tailoring. Returns number of
- *          #i18n_uchar needed to store rules. If @a dest is @c NULL or @dest_size is not enough to
+ *          #i18n_uchar needed to store rules. If @a dest is @c NULL or @a dest_size is not enough to
  *          store rules, will store up to available space.
  *          See http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales
  * @remarks i18n_ucollator_get_rules() should normally be used instead.

diff --git a/src/include/utils_i18n_ulocale.h b/src/include/utils_i18n_ulocale.h
index 90c8416..81c28b9 100644 (file)
--- a/src/include/utils_i18n_ulocale.h
+++ b/src/include/utils_i18n_ulocale.h
@@ -99,16 +99,16 @@
  *                     i18n_xxx_count_available(). Some of them has also i18n_xxx_get_display_name().\n
  *                     Concerning POSIX/RFC1766 Locale IDs, the
  *                     i18n_locale_get_language()/i18n_ulocale_get_country()/i18n_ulocale_get_variant()/i18n_ulocale_get_name()
- *                     functions do understand the POSIX type form of language_COUNTRY.ENCODING@VARIANT and
+ *                     functions do understand the POSIX type form of language_COUNTRY.ENCODING\@VARIANT and
  *                     if there is not an ICU-stype variant, i18n_ulocale_get_variant() for example will return
- *                     the one listed after the @at sign. As well, the hyphen "-" is recognized as
+ *                     the one listed after the \@at sign. As well, the hyphen "-" is recognized as
  *                     a country/variant separator similarly to RFC1766. So for example, "en-us" will be
  *                     interpreted as en_US. As a result, i18n_ulocale_get_name() is far from a no-op,
  *                     and will have the effect of converting POSIX/RFC1766 IDs into ICU form, although it
  *                     does NOT map any of the actual codes (i.e. russian->ru) in any way. Applications should
  *                     call i18n_ulocale_get_name() at the point where a locale ID is coming from an external
  *                     source (user entry, OS, web browser) and pass the resulting string to other ICU
- *                     functions. For example, don't use de-de@EURO as an argument to resourcebundle.
+ *                     functions. For example, don't use de-de\@EURO as an argument to resourcebundle.
  *
  * @section CAPI_BASE_UTILS_I18N_ULOCALE_MODULE_SAMPLE_CODE_1 Sample Code 1
  * @brief Gets a default locale and a full name for the locale