[FriBidi-commit] fribidi/lib fribidi-bidi-type.h, 1.3, 1.4 fribidi.h, 1.2, 1.3

[Behdad Esfahbod]

Update of /cvs/fribidi/fribidi/lib
In directory pdx:/tmp/cvs-serv14139/lib

Modified Files:
	fribidi-bidi-type.h fribidi.h 
Log Message:
Not serious changed.  Going to remove easy-to-replace compatibility stuff.


Index: fribidi-bidi-type.h
===================================================================
RCS file: /cvs/fribidi/fribidi/lib/fribidi-bidi-type.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- a/fribidi-bidi-type.h	4 Jun 2004 09:41:11 -0000	1.3
+++ b/fribidi-bidi-type.h	9 Jun 2004 08:56:53 -0000	1.4
@@ -43,7 +43,8 @@
 #define fribidi_get_bidi_type FRIBIDI_NAMESPACE(get_bidi_type)
 /* fribidi_get_bidi_type - get character bidi type
  *
- * This function returns the bidi type of a character.
+ * This function returns the bidi type of a character.  There are a few macros
+ * defined in fribidi-bidi-types.h for querying a bidi type.
  */
 FRIBIDI_ENTRY FriBidiCharType
 fribidi_get_bidi_type (
@@ -66,7 +67,8 @@
 #define fribidi_get_bidi_types FRIBIDI_NAMESPACE(get_bidi_types)
 /* fribidi_get_bidi_types - get bidi types for an string of characters
  *
- * This function finds the bidi types of an string of characters.
+ * This function finds the bidi types of an string of characters.  See
+ * fribidi_get_bidi_type for more information.
  */
      FRIBIDI_ENTRY void fribidi_get_bidi_types (
   const FriBidiChar *str,	/* input string */

Index: fribidi.h
===================================================================
RCS file: /cvs/fribidi/fribidi/lib/fribidi.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- a/fribidi.h	7 Jun 2004 20:38:21 -0000	1.2
+++ b/fribidi.h	9 Jun 2004 08:56:53 -0000	1.3
@@ -43,13 +43,21 @@
 #endif /* FRIBIDI_CHARSETS */
 
 
+/* See fribidi-bidi.h for the core functions fribidi_get_par_embedding_levels
+ * and fribidi_reorder_line which are probably the main calls you need.  See
+ * README for a better understanding of what calls you need.
+ */
+
+
 #define fribidi_shape FRIBIDI_NAMESPACE(shape)
 /* fribidi_shape - do bidi-dependent shaping
  *
  * This function does all shaping work that depends on the resolved embedding
  * levels of the characters.  Currently it does mirroring and Arabic shaping,
  * but the list may grow later.  Individual shaping features can be turned
- * on/off using environmental setting functions fribidi_env_*.
+ * on/off using environmental setting functions fribidi_env_*.  Feel free to
+ * do your own shaping before or after calling this function, but you should
+ * take care of embedding levels yourself then.
  */
 FRIBIDI_ENTRY void fribidi_shape (
   const FriBidiLevel *embedding_level_list,	/* input list of embedding