Mercurial > emacs
changeset 108362:e9328d74ba23
composite.el (compose-region, reference-point-alist): Fix typos in the doc
strings.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 01 May 2010 21:50:20 +0300 |
parents | c1fe9f79424a |
children | 642b031fce0f |
files | lisp/ChangeLog lisp/composite.el |
diffstat | 2 files changed, 17 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ChangeLog Fri Apr 30 12:00:48 2010 -0400 +++ b/lisp/ChangeLog Sat May 01 21:50:20 2010 +0300 @@ -1,3 +1,8 @@ +2010-05-01 Eli Zaretskii <eliz@gnu.org> + + * composite.el (compose-region, reference-point-alist): Fix typos + in the doc strings. + 2010-04-28 Alexander Klimov <alserkli@inbox.ru> (tiny change) * calc/calc-graph.el (calc-graph-plot): Use the proper form for
--- a/lisp/composite.el Fri Apr 30 12:00:48 2010 -0400 +++ b/lisp/composite.el Sat May 01 21:50:20 2010 +0300 @@ -44,7 +44,7 @@ A glyph reference point symbol is to be used to specify a composition rule in COMPONENTS argument to such functions as `compose-region'. -Meanings of glyph reference point codes are as follows: +The meaning of glyph reference point codes is as follows: 0----1----2 <---- ascent 0:tl or top-left | | 1:tc or top-center @@ -212,7 +212,7 @@ this case, TAB element has a special meaning. If the first characer is TAB, the glyphs are displayed with left padding space so that no pixel overlaps with the previous column. If the last -character is TAB, the glyphs are displayed with rigth padding +character is TAB, the glyphs are displayed with right padding space so that no pixel overlaps with the following column. If it is a vector or list, it is a sequence of alternate characters and @@ -222,7 +222,7 @@ A composition rule is a cons of global and new glyph reference point symbols. See the documentation of `reference-point-alist' for more -detail. +details. Optional 4th argument MODIFICATION-FUNC is a function to call to adjust the composition when it gets invalid because of a change of @@ -299,16 +299,16 @@ (compose-string-internal str 0 (length str) components))) (defun find-composition (pos &optional limit string detail-p) - "Return information about a composition at or nearest to buffer position POS. + "Return information about a composition at or near buffer position POS. If the character at POS has `composition' property, the value is a list -of FROM, TO, and VALID-P. +\(FROM TO VALID-P). FROM and TO specify the range of text that has the same `composition' property, VALID-P is t if this composition is valid, and nil if not. If there's no composition at POS, and the optional 2nd argument LIMIT -is non-nil, search for a composition toward LIMIT. +is non-nil, search for a composition toward the position given by LIMIT. If no composition is found, return nil. @@ -316,8 +316,9 @@ composition in; nil means the current buffer. If a valid composition is found and the optional 4th argument DETAIL-P -is non-nil, the return value is a list of FROM, TO, COMPONENTS, -RELATIVE-P, MOD-FUNC, and WIDTH. +is non-nil, the return value is a list of the form + + (FROM TO COMPONENTS RELATIVE-P MOD-FUNC WIDTH) COMPONENTS is a vector of integers, the meaning depends on RELATIVE-P. @@ -334,9 +335,9 @@ When Automatic Composition mode is on, this function also finds a chunk of text that is automatically composed. If such a chunk is found closer to POS than the position that has `composition' -property, the value is a list of FROM, TO, and a glyph gstring -the specify how the chunk is composed. See the function -`composition-get-gstring' for the format of the glyph string." +property, the value is a list of FROM, TO, and a glyph-string +that specifies how the chunk is to be composed. See the function +`composition-get-gstring' for the format of the glyph-string." (let ((result (find-composition-internal pos limit string detail-p))) (if (and detail-p (> (length result) 3) (nth 2 result) (not (nth 3 result))) ;; This is a valid rule-base composition.