From: Kenichi Handa <handa@m17n.org>
Date: Thu, 27 Dec 2007 01:14:29 +0000 (+0000)
Subject: (struct font_driver): Docstring of member `shape' is improved.
X-Git-Tag: emacs-pretest-23.0.90~8295^2~78
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=778686b1903df7ee1f9e068caafc2b672217a51a;p=emacs.git

(struct font_driver): Docstring of member `shape' is improved.
---

diff --git a/src/font.h b/src/font.h
index ab19e0617a7..2433cdb0d34 100644
--- a/src/font.h
+++ b/src/font.h
@@ -446,7 +446,18 @@ struct font_driver
   int (*end_for_frame) P_ ((FRAME_PTR f));
 
   /* Optional.
-     Shape text in LGSTRING.  */
+
+     Shape text in LGSTRING.  See the docstring of `font-make-gstring'
+     for the format of LGSTRING.  If the (N+1)th element of LGSTRING
+     is nil, input of shaping is from the 1st to (N)th elements.  In
+     each input glyph, FROM, TO, CHAR, and CODE are already set.
+
+     This function updates all fields of the input glyphs.  If the
+     output glyphs (M) are more than the input glyphs (N), (N+1)th
+     through (M)th elements of LGSTRING are updated possibly by making
+     a new glyph object and storing it in LGSTRING.  If (M) is greater
+     than the length of LGSTRING, nil should be return.  In that case,
+     this function is called again with the larger LGSTRING.  */
   Lisp_Object (*shape) P_ ((Lisp_Object lgstring));
 };