diff options
| author | Kenichi Handa <handa@m17n.org> | 2009-06-16 00:33:58 +0000 |
|---|---|---|
| committer | Kenichi Handa <handa@m17n.org> | 2009-06-16 00:33:58 +0000 |
| commit | b6cac59cc6486819db57809fd25573b2baa09970 (patch) | |
| tree | 8e5e256a3361145be420e4ddddf82ceccf76dfe4 /lisp/composite.el | |
| parent | 977b85f4d91050c0e35bcd88768d906c1df25af7 (diff) | |
| download | emacs-b6cac59cc6486819db57809fd25573b2baa09970.tar.gz | |
(compose-region): Improve the docstring.
Diffstat (limited to 'lisp/composite.el')
| -rw-r--r-- | lisp/composite.el | 13 |
1 files changed, 11 insertions, 2 deletions
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. |