From 45dd598a79d629b20c5b4a856ad541cadd739bac Mon Sep 17 00:00:00 2001 From: Ram Viswanadha Date: Tue, 8 Jun 2004 20:50:19 +0000 Subject: [PATCH] ICU-3820 fix doxygen warnings X-SVN-Rev: 15786 --- icu4c/source/common/unicode/ubidi.h | 48 +++++++++++++++++++---------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/icu4c/source/common/unicode/ubidi.h b/icu4c/source/common/unicode/ubidi.h index 35323d14c5..e84c8e470f 100644 --- a/icu4c/source/common/unicode/ubidi.h +++ b/icu4c/source/common/unicode/ubidi.h @@ -36,14 +36,14 @@ /** *\file - * \brief C API: BIDI algorithm + * \brief C API: BIDI algorithm * *

BIDI algorithm for ICU

* * This is an implementation of the Unicode Bidirectional algorithm. * The algorithm is defined in the - * Unicode Technical Report 9, - * version 5, also described in The Unicode Standard, Version 3.0 .

+ * Unicode Standard Annex #9, + * version 13, also described in The Unicode Standard, Version 4.0 .

* * Note: Libraries that perform a bidirectional algorithm and * reorder strings accordingly are sometimes called "Storage Layout Engines". @@ -297,7 +297,7 @@ *\endcode * */ - + /*DOCXX_TAG*/ /*@{*/ @@ -316,7 +316,7 @@ * specifying the level of a character to override whatever the * BiDi implementation would resolve it to. *

  • paraLevel can be set to the - * pesudo-level values UBIDI_DEFAULT_LTR + * pseudo-level values UBIDI_DEFAULT_LTR * and UBIDI_DEFAULT_RTL.
    • * * @@ -362,8 +362,8 @@ typedef uint8_t UBiDiLevel; */ #define UBIDI_MAX_EXPLICIT_LEVEL 61 -/** Bit flag for level input. - * Overrides directional properties. +/** Bit flag for level input. + * Overrides directional properties. * @stable ICU 2.0 */ #define UBIDI_LEVEL_OVERRIDE 0x80 @@ -459,8 +459,10 @@ ubidi_openSized(int32_t maxLength, int32_t maxRunCount, UErrorCode *pErrorCode); * associated with a UBiDi object.

    * * Important: - * If a UBiDi object is the child - * of another one (its parent), after calling + * A parent UBiDi object must not be destroyed or reused if + * it still has children. + * If a UBiDi object is the child + * of another one (its parent), after calling * ubidi_setLine(), then the child object must * be destroyed (closed) or reused (by calling * ubidi_setPara() or ubidi_setLine()) @@ -484,13 +486,13 @@ ubidi_close(UBiDi *pBiDi); * in the Unicode Technical Report is to take text stored in logical * (keyboard, typing) order and to determine the reordering of it for visual * rendering. - * Some legacy codepages store text in visual order, and for operations + * Some legacy systems store text in visual order, and for operations * with standard, Unicode-based algorithms, the text needs to be transformed * to logical order. This is effectively the inverse algorithm of the * described BiDi algorithm. Note that there is no standard algorithm for * this "inverse BiDi" and that the current implementation provides only an * approximation of "inverse BiDi".

    - * + * *

    With isInverse set to TRUE, * this function changes the behavior of some of the subsequent functions * in a way that they can be used for the inverse BiDi algorithm. @@ -528,12 +530,12 @@ ubidi_isInverse(UBiDi *pBiDi); /** * Perform the Unicode BiDi algorithm. It is defined in the - * Unicode Technical Report 9, - * version 5, - * also described in The Unicode Standard, Version 3.0 .

    + * Unicode Standard Anned #9, + * version 13, + * also described in The Unicode Standard, Version 4.0 .

    * * This function takes a single plain text paragraph with or without - * externally specified embedding levels from styled text + * externally specified embedding levels from styled text * and computes the left-right-directionality of each character.

    * * If the entire paragraph consists of text of only one direction, then @@ -609,7 +611,7 @@ ubidi_setPara(UBiDi *pBiDi, const UChar *text, int32_t length, * specified by referring to a UBiDi object representing * this information for a paragraph of text, and by specifying * a range of indexes in this paragraph.

    - * In the new line object, the indexes will range from 0 to limit-start.

    + * In the new line object, the indexes will range from 0 to limit-start-1.

    * * This is used after calling ubidi_setPara() * for a paragraph, and after line-breaking on that paragraph. @@ -1069,6 +1071,12 @@ ubidi_invertMap(const int32_t *srcMap, int32_t *destMap, int32_t length); * characters; see the description of the destSize * and options parameters and of the option bit flags. * + * @see UBIDI_DO_MIRRORING + * @see UBIDI_INSERT_LRM_FOR_NUMERIC + * @see UBIDI_KEEP_BASE_COMBINING + * @see UBIDI_OUTPUT_REVERSE + * @see UBIDI_REMOVE_BIDI_CONTROLS + * * @param pBiDi A pointer to a UBiDi object that * is set by ubidi_setPara() or * ubidi_setLine() and contains the reordering @@ -1102,6 +1110,12 @@ ubidi_invertMap(const int32_t *srcMap, int32_t *destMap, int32_t length); * to logically stored text (although this is still an * imperfect implementation of an "inverse BiDi" algorithm * because it uses the "forward BiDi" algorithm at its core). + * The available options are: + * #UBIDI_DO_MIRRORING, + * #UBIDI_INSERT_LRM_FOR_NUMERIC, + * #UBIDI_KEEP_BASE_COMBINING, + * #UBIDI_OUTPUT_REVERSE, + * #UBIDI_REMOVE_BIDI_CONTROLS * * @param pErrorCode must be a valid pointer to an error code value, * which must not indicate a failure before the function call. @@ -1154,7 +1168,7 @@ ubidi_writeReordered(UBiDi *pBiDi, * * @param options A bit set of options for the reordering that control * how the reordered text is written. - * See ubidi_writeReordered(). + * See the options parameter in ubidi_writeReordered(). * * @param pErrorCode must be a valid pointer to an error code value, * which must not indicate a failure before the function call.