# HG changeset patch
# User Kenichi Handa <handa@m17n.org>
# Date 1198718069 0
# Node ID c45d16b39212c11c9f495a873a122e377b3d5868
# Parent  a34e7fed064e227c87fc41d37d2713ce406d07e8
(struct font_driver): Docstring of member `shape' is improved.

diff -r a34e7fed064e -r c45d16b39212 src/font.h
--- a/src/font.h	Wed Dec 26 01:55:47 2007 +0000
+++ b/src/font.h	Thu Dec 27 01:14:29 2007 +0000
@@ -446,7 +446,18 @@
   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));
 };