From: Kenichi Handa Date: Tue, 16 Jun 2009 00:33:58 +0000 (+0000) Subject: (compose-region): Improve the docstring. X-Git-Tag: emacs-pretest-23.0.95~45 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b6cac59cc6486819db57809fd25573b2baa09970;p=emacs.git (compose-region): Improve the docstring. --- diff --git a/lisp/ChangeLog b/lisp/ChangeLog index a90a46acb36..8068e0d72eb 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2009-06-16 Kenichi Handa + + * composite.el (compose-region): Improve the docstring. + 2009-06-15 Stefan Monnier * vc.el (vc-default-revision-granularity): Remove to let the normal diff --git a/lisp/composite.el b/lisp/composite.el index ce34336cede..77eea9cb4ec 100644 --- a/lisp/composite.el +++ b/lisp/composite.el @@ -185,8 +185,17 @@ RULE is a cons of global and new reference point symbols (defun compose-region (start end &optional components modification-func) "Compose characters in the current region. -Characters are composed relatively, i.e. composed by overstricking or -stacking depending on ascent, descent and other properties. +Characters are composed relatively, i.e. composed by overstriking +or stacking depending on ascent, descent and other metrics of +glyphs. + +For instance, if the region has three characters \"XYZ\", X is +regarded as BASE glyph, and Y is displayed: + (1) above BASE if Y's descent value is not positive + (2) below BASE if Y's ascent value is not positive + (3) on BASE (i.e. at the BASE position) otherwise +and Z is displayed with the same rule while regarding the whole +XY glyphs as BASE. When called from a program, expects these four arguments.