diff options
Diffstat (limited to 'deps/icu-small/source/common/unicode/ubiditransform.h')
| -rw-r--r-- | deps/icu-small/source/common/unicode/ubiditransform.h | 53 |
1 files changed, 29 insertions, 24 deletions
diff --git a/deps/icu-small/source/common/unicode/ubiditransform.h b/deps/icu-small/source/common/unicode/ubiditransform.h index 627b005ed4..5c08ed5df0 100644 --- a/deps/icu-small/source/common/unicode/ubiditransform.h +++ b/deps/icu-small/source/common/unicode/ubiditransform.h @@ -26,33 +26,38 @@ /** * \file * \brief Bidi Transformations + */ + +/** + * `UBiDiOrder` indicates the order of text. * - * <code>UBiDiOrder</code> indicates the order of text.<p> * This bidi transformation engine supports all possible combinations (4 in * total) of input and output text order: - * <ul> - * <li><logical input, visual output>: unless the output direction is RTL, this - * corresponds to a normal operation of the Bidi algorithm as described in the - * Unicode Technical Report and implemented by <code>UBiDi</code> when the - * reordering mode is set to <code>UBIDI_REORDER_DEFAULT</code>. Visual RTL - * mode is not supported by <code>UBiDi</code> and is accomplished through - * reversing a visual LTR string,</li> - * <li><visual input, logical output>: unless the input direction is RTL, this - * corresponds to an "inverse bidi algorithm" in <code>UBiDi</code> with the - * reordering mode set to <code>UBIDI_REORDER_INVERSE_LIKE_DIRECT</code>. - * Visual RTL mode is not not supported by <code>UBiDi</code> and is - * accomplished through reversing a visual LTR string,</li> - * <li><logical input, logical output>: if the input and output base directions - * mismatch, this corresponds to the <code>UBiDi</code> implementation with the - * reordering mode set to <code>UBIDI_REORDER_RUNS_ONLY</code>; and if the - * input and output base directions are identical, the transformation engine - * will only handle character mirroring and Arabic shaping operations without - * reordering,</li> - * <li><visual input, visual output>: this reordering mode is not supported by - * the <code>UBiDi</code> engine; it implies character mirroring, Arabic - * shaping, and - if the input/output base directions mismatch - string - * reverse operations.</li> - * </ul> + * + * - <logical input, visual output>: unless the output direction is RTL, this + * corresponds to a normal operation of the Bidi algorithm as described in the + * Unicode Technical Report and implemented by `UBiDi` when the + * reordering mode is set to `UBIDI_REORDER_DEFAULT`. Visual RTL + * mode is not supported by `UBiDi` and is accomplished through + * reversing a visual LTR string, + * + * - <visual input, logical output>: unless the input direction is RTL, this + * corresponds to an "inverse bidi algorithm" in `UBiDi` with the + * reordering mode set to `UBIDI_REORDER_INVERSE_LIKE_DIRECT`. + * Visual RTL mode is not not supported by `UBiDi` and is + * accomplished through reversing a visual LTR string, + * + * - <logical input, logical output>: if the input and output base directions + * mismatch, this corresponds to the `UBiDi` implementation with the + * reordering mode set to `UBIDI_REORDER_RUNS_ONLY`; and if the + * input and output base directions are identical, the transformation engine + * will only handle character mirroring and Arabic shaping operations without + * reordering, + * + * - <visual input, visual output>: this reordering mode is not supported by + * the `UBiDi` engine; it implies character mirroring, Arabic + * shaping, and - if the input/output base directions mismatch - string + * reverse operations. * @see ubidi_setInverse * @see ubidi_setReorderingMode * @see UBIDI_REORDER_DEFAULT |