*
* These are typical classes of usage for #i18n_utext_h:
*
- * Application Level Use - applications would use one of the #i18n_utext_create_for* functions
+ * Application Level Use - applications would use one of the @ref CAPI_BASE_UTILS_I18N_UTEXT_MODULE functions
* on their input text, and pass the resulting #i18n_utext_h to the desired ICU service.
*
* ICU Services use - services (eg. break iteration) would operate on input
* Text providers use - text providers are the #i18n_utext_h implementations
* for the various text storage formats.
* The Text Access API offers 2 built in providers - for UTF8 and UTF16 encoded strings.
- * Implementing custom i18n_utext_h providers is not supported.
+ * Implementing custom #i18n_utext_h providers is not supported.
*
* <em>Iterating over text</em>
*
* Here is sample code for a forward iteration over the contents of an #i18n_utext_h
*
- * <code>
+ * @code
* i18n_uchar32 c;
* i18n_utext *ut = i18n_utext_create_for_UTF8(SOME_UTF8_ENCODED_STRING);
*
* for (c=i18n_utext_next32_from(ut, 0); c>=0; c=i18n_utext_next32(ut)) {
* // do whatever with the codepoint c here.
* }
- * </code>
+ * @endcode
*
* And here is similar code to iterate in the reverse direction, from the end
* of the text towards the beginning.
*
- * <code>
+ * @code
* i18n_uchar32 c;
* i18n_utext *ut = i18n_utext_create_for_UTF8(SOME_UTF8_ENCODED_STRING);
* int textLength = i18n_utext_native_length(ut);
* for (c=i18n_utext_previous32_from(ut, textLength); c>=0; c=i18n_utext_previous32(ut)) {
* // do whatever with the codepoint c here.
* }
- * </code>
+ * @endcode
*
* <em>Characters and Indexing</em>
*
/**
* @brief Destroys the #i18n_utext_h handle and release its resources.
- * @details An #i18n_utext_h can be reset to refer to new string by using one of the #i18n_utext_create_for() functions without first closing the #i18n_utext_h.
+ * @details An #i18n_utext_h can be reset to refer to new string by using one of the i18n_utext_create_for_UTF8() or i18n_utext_create_for_uchars() functions without first closing the #i18n_utext_h.
* @since_tizen 6.0
* @param[in] ut The #i18n_utext_h handle to be released.
*/
* @brief Creates a read-only #i18n_utext_h implementation for UTF-8 strings.
* @details Any invalid UTF-8 in the input will be handled in this way:
* a sequence of bytes that has the form of a truncated, but otherwise valid,
- * UTF-8 sequence will be replaced by a single unicode replacement character, \uFFFD.
- * Any other illegal bytes will each be replaced by a \uFFFD.
+ * UTF-8 sequence will be replaced by a single unicode replacement character, @htmlonly \uFFFD @endhtmlonly.
+ * Any other illegal bytes will each be replaced by a @htmlonly \uFFFD @endhtmlonly.
* @since_tizen 6.0
* @remarks If @a utb is created (@a uta was NULL), then the created @a utb needs to be released using #i18n_utext_destroy().
* @param[in] uta An #i18n_utext_h handle. If NULL, a new #i18n_utext_h will be created. If non-NULL,
* @brief Sets the iteration index and return the code point at that index.
* @details Leave the iteration index at the start of the following code point.
* This function is the most efficient and convenient way to begin a forward iteration. The results are identical to the those from the sequence
- * <code>
- * i18n_utext_set_index();
+ * @code
+ * i18n_utext_set_native_index();
* i18n_utext_next32();
- * </code>
+ * @endcode
* @since_tizen 6.0
* @param[in] ut The text to be accessed.
* @param[in] native_index Iteration index, in the native units of the text provider.
* @details If the iteration position is already at the start of the text, zero is returned.
* The value returned is the same as that obtained from the following sequence,
* but without the side effect of changing the iteration position.
- * <code>
+ * @code
* i18n_utext_h ut = whatever;
* i18n_utext_previous(ut);
* i18n_utext_get_native_index(ut);
- * </code>
+ * #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