From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 9 Jul 2011 14:36:58 +0000 (+0300)
Subject: Update commentary on bidi.c.
X-Git-Tag: emacs-pretest-24.0.90~104^2~275^2~2
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=95e1afc692e2f999fa23daa3ecaa439db5830cc5;p=emacs.git

Update commentary on bidi.c.
---

diff --git a/src/bidi.c b/src/bidi.c
index 962afef435f..5b26ecf0854 100644
--- a/src/bidi.c
+++ b/src/bidi.c
@@ -35,11 +35,16 @@ along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
    details about its algorithm that finds the next visual-order
    character by resolving their levels on the fly.
 
-   The two other entry points are bidi_paragraph_init and
+   Two other entry points are bidi_paragraph_init and
    bidi_mirror_char.  The first determines the base direction of a
    paragraph, while the second returns the mirrored version of its
    argument character.
 
+   A few auxiliary entry points are used to initialize the bidi
+   iterator for iterating an object (buffer or string), push and pop
+   the bidi iterator state, and save and restore the state of the bidi
+   cache.
+
    If you want to understand the code, you will have to read it
    together with the relevant portions of UAX#9.  The comments include
    references to UAX#9 rules, for that very reason.