version up to 1.0.8

[platform/upstream/fribidi.git] / doc / fribidi_get_par_embedding_levels.3

diff --git a/doc/fribidi_get_par_embedding_levels.3 b/doc/fribidi_get_par_embedding_levels.3
index bc48d48..bfb9ba6 100644 (file)
--- a/doc/fribidi_get_par_embedding_levels.3
+++ b/doc/fribidi_get_par_embedding_levels.3
@@ -1,13 +1,13 @@
 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!

-.TH "fribidi_get_par_embedding_levels" 3 "2 December 2012" "GNU FriBidi 0.19.4" "Programmer's Manual"
+.TH "fribidi_get_par_embedding_levels" 3 "13 October 2019" "c2man fribidi-deprecated.h" "Programmer's Manual"

 .SH "NAME"
 fribidi_get_par_embedding_levels \- get bidi embedding levels of a paragraph
 .SH "SYNOPSIS"
 .ft B
 #include <fribidi.h>
 .sp
 .SH "NAME"
 fribidi_get_par_embedding_levels \- get bidi embedding levels of a paragraph
 .SH "SYNOPSIS"
 .ft B
 #include <fribidi.h>
 .sp

-FriBidiLevel fribidi_get_par_embedding_levels
+extern FriBidiLevel fribidi_get_par_embedding_levels

 .br
 (
 .br
 .br
 (
 .br


@@ -27,71 +27,7 @@ FriBidiLevel fribidi_get_par_embedding_levels
 Input list of bidi types as returned by
 fribidi_get_bidi_types().
 .sp
 Input list of bidi types as returned by
 fribidi_get_bidi_types().
 .sp

-Possible values for a \fBconst FriBidiCharType\fR are as follows:
-.RS 0.75in
-.PD 0
-.ft B
-.nr TL \w'FRIBIDI_TYPE_LTR'u+0.2i
-.ft R
-.TP \n(TLu
-\fBFRIBIDI_TYPE_LTR\fR
-Left-To-Right letter.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_RTL\fR
-Right-To-Left letter.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_AL\fR
-Arabic Letter.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_EN\fR
-European Numeral.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_AN\fR
-Arabic Numeral.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_ES\fR
-European number Separator.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_ET\fR
-European number Terminator.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_CS\fR
-Common Separator.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_NSM\fR
-Non Spacing Mark.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_BN\fR
-Boundary Neutral.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_BS\fR
-Block Separator.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_SS\fR
-Segment Separator.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_WS\fR
-WhiteSpace.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_ON\fR
-Other Neutral.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_LRE\fR
-Left-to-Right Embedding.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_RLE\fR
-Right-to-Left Embedding.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_LRO\fR
-Left-to-Right Override.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_RLO\fR
-Right-to-Left Override.
-.TP \n(TLu
-\fBFRIBIDI_TYPE_PDF\fR
-Pop Directional Flag.
-.RE
-.PD
+Since there are 23 possible values for a \fBconst FriBidiCharType\fR, they are not all listed here.

 .TP
 .B "const FriBidiStrIndex len"
 Input string length of the paragraph.
 .TP
 .B "const FriBidiStrIndex len"
 Input string length of the paragraph.


@@ -127,29 +63,21 @@ Weak Right To Left paragraph.
 .B "FriBidiLevel *embedding_levels"
 Output list of embedding levels.
 .SH "DESCRIPTION"
 .B "FriBidiLevel *embedding_levels"
 Output list of embedding levels.
 .SH "DESCRIPTION"

-This function finds the bidi embedding levels of a single paragraph,
-as defined by the Unicode Bidirectional Algorithm available at
-http://www.unicode.org/reports/tr9/.  This function implements rules P2 to
-I1 inclusive, and parts 1 to 3 of L1, except for rule X9 which is
-implemented in fribidi_remove_bidi_marks().  Part 4 of L1 is implemented
-in fribidi_reorder_line().
-
-There are a few macros defined in fribidi-bidi-types.h to work with this
-embedding levels.
-.SH "RETURNS"
-Maximum level found plus one, or zero if any error occured
-(memory allocation failure most probably).
+Deprecated interface to fribidi_get_par_embedding_levels_ex(). Refer to
+it for documentation.

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-fribidi_charset_to_unicode(3),
-fribidi_unicode_to_charset(3),
-fribidi_parse_charset(3),

 fribidi_shape_arabic(3),
 fribidi_get_par_direction(3),
 fribidi_shape_arabic(3),
 fribidi_get_par_direction(3),

+fribidi_get_par_embedding_levels_ex(3),

 fribidi_reorder_line(3),
 fribidi_get_bidi_type(3),
 fribidi_get_bidi_types(3),
 fribidi_get_bidi_type_name(3),
 fribidi_debug_status(3),
 fribidi_reorder_line(3),
 fribidi_get_bidi_type(3),
 fribidi_get_bidi_types(3),
 fribidi_get_bidi_type_name(3),
 fribidi_debug_status(3),

+fribidi_set_debug(3),
+fribidi_charset_to_unicode(3),
+fribidi_unicode_to_charset(3),
+fribidi_parse_charset(3),

 fribidi_mirroring_status(3),
 fribidi_set_mirroring(3),
 fribidi_reorder_nsm_status(3),
 fribidi_mirroring_status(3),
 fribidi_set_mirroring(3),
 fribidi_reorder_nsm_status(3),


@@ -157,12 +85,13 @@ fribidi_set_reorder_nsm(3),
 fribidi_log2vis_get_embedding_levels(3),
 fribidi_get_type(3),
 fribidi_get_type_internal(3),
 fribidi_log2vis_get_embedding_levels(3),
 fribidi_get_type(3),
 fribidi_get_type_internal(3),

-fribidi_remove_bidi_marks(3),
-fribidi_log2vis(3),

 fribidi_join_arabic(3),
 fribidi_get_joining_type(3),
 fribidi_get_joining_types(3),
 fribidi_get_joining_type_name(3),
 fribidi_get_mirror_char(3),
 fribidi_shape_mirroring(3),
 fribidi_join_arabic(3),
 fribidi_get_joining_type(3),
 fribidi_get_joining_types(3),
 fribidi_get_joining_type_name(3),
 fribidi_get_mirror_char(3),
 fribidi_shape_mirroring(3),

-fribidi_shape(3)
+fribidi_get_bracket(3),
+fribidi_get_bracket_types(3),
+fribidi_shape(3),
+fribidi_remove_bidi_marks(3)