Mercurial > emacs
changeset 103436:850fd8c37942
(compose-region): Improve the docstring.
| author | Kenichi Handa <handa@m17n.org> |
|---|---|
| date | Tue, 16 Jun 2009 00:33:18 +0000 |
| parents | 45564d023acc |
| children | ef6db6ed62db |
| files | lisp/composite.el |
| diffstat | 1 files changed, 11 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/composite.el Mon Jun 15 21:36:44 2009 +0000 +++ b/lisp/composite.el Tue Jun 16 00:33:18 2009 +0000 @@ -185,8 +185,17 @@ (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.