From 9d7518593c13889885373f824aafa678f49a9859 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 27 Sep 2008 13:10:56 +0000 Subject: [PATCH] (Fcomposition_get_gstring, Fcompose_region_internal, Fcompose_string_internal) (Ffind_composition_internal): Doc fix. (syms_of_composite) : Doc fix. (syms_of_composite) : Doc fix. (syms_of_composite) : Doc fix. --- src/ChangeLog | 9 +++++++++ src/composite.c | 38 +++++++++++++++++++------------------- 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index 6e24106d08..7ceacd2d97 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,12 @@ +2008-09-27 Eli Zaretskii + + * composite.c (Fcomposition_get_gstring) + (Fcompose_region_internal, Fcompose_string_internal) + (Ffind_composition_internal): Doc fix. + (syms_of_composite) : Doc fix. + (syms_of_composite) : Doc fix. + (syms_of_composite) : Doc fix. + 2008-09-25 Chong Yidong * search.c (wordify): New argument for lax word-ends. diff --git a/src/composite.c b/src/composite.c index 1ec6f71855..9b3de0a615 100644 --- a/src/composite.c +++ b/src/composite.c @@ -1452,15 +1452,15 @@ composition_adjust_point (last_pt) DEFUN ("composition-get-gstring", Fcomposition_get_gstring, Scomposition_get_gstring, 4, 4, 0, doc: /* Return a glyph-string for characters between FROM and TO. -If the glhph string is for graphic display, FONT-OBJECT must be +If the glyph string is for graphic display, FONT-OBJECT must be a font-object to use for those characters. Otherwise (for terminal display), FONT-OBJECT must be nil. If the optional 4th argument STRING is not nil, it is a string containing the target characters between indices FROM and TO. -A glhph-string is a vector containing information about how to display -specific character sequence. The format is: +A glyph-string is a vector containing information about how to display +a specific character sequence. The format is: [HEADER ID GLYPH ...] HEADER is a vector of this form: @@ -1473,7 +1473,7 @@ where ID is an identification number of the glyph-string. It may be nil if not yet shaped. -GLYPH is a vector whose elements has this form: +GLYPH is a vector whose elements have this form: [ FROM-IDX TO-IDX C CODE WIDTH LBEARING RBEARING ASCENT DESCENT [ [X-OFF Y-OFF WADJUST] | nil] ] where @@ -1481,11 +1481,11 @@ where C is the character of the glyph. CODE is the glyph-code of C in FONT-OBJECT. WIDTH thru DESCENT are the metrics (in pixels) of the glyph. - X-OFF and Y-OFF are offests to the base position for the glyph. + X-OFF and Y-OFF are offsets to the base position for the glyph. WADJUST is the adjustment to the normal width of the glyph. -If GLYPH is nil, the remaining elements of the glhph-string vector -must be ignore. */) +If GLYPH is nil, the remaining elements of the glyph-string vector +should be ignored. */) (from, to, font_object, string) Lisp_Object font_object, from, to, string; { @@ -1520,7 +1520,7 @@ DEFUN ("compose-region-internal", Fcompose_region_internal, Compose text in the region between START and END. Optional 3rd and 4th arguments are COMPONENTS and MODIFICATION-FUNC -for the composition. See `compose-region' for more detail. */) +for the composition. See `compose-region' for more details. */) (start, end, components, modification_func) Lisp_Object start, end, components, modification_func; { @@ -1541,7 +1541,7 @@ DEFUN ("compose-string-internal", Fcompose_string_internal, Compose text between indices START and END of STRING. Optional 4th and 5th arguments are COMPONENTS and MODIFICATION-FUNC -for the composition. See `compose-string' for more detail. */) +for the composition. See `compose-string' for more details. */) (string, start, end, components, modification_func) Lisp_Object string, start, end, components, modification_func; { @@ -1563,7 +1563,7 @@ DEFUN ("find-composition-internal", Ffind_composition_internal, doc: /* Internal use only. Return information about composition at or nearest to position POS. -See `find-composition' for more detail. */) +See `find-composition' for more details. */) (pos, limit, string, detail_p) Lisp_Object pos, limit, string, detail_p; { @@ -1706,8 +1706,8 @@ syms_of_composite () DEFVAR_LISP ("compose-chars-after-function", &Vcompose_chars_after_function, doc: /* Function to adjust composition of buffer text. -The function is called with three arguments FROM, TO, and OBJECT. -FROM and TO specify the range of text of which composition should be +This function is called with three arguments: FROM, TO, and OBJECT. +FROM and TO specify the range of text whose composition should be adjusted. OBJECT, if non-nil, is a string that contains the text. This function is called after a text with `composition' property is @@ -1725,7 +1725,7 @@ The default value is the function `compose-chars-after'. */); DEFVAR_LISP ("auto-composition-function", &Vauto_composition_function, doc: /* Function to call to compose characters automatically. -The function is called from the display routine with four arguments, +This function is called from the display routine with four arguments: FROM, TO, WINDOW, and STRING. If STRING is nil, the function must compose characters in the region @@ -1737,7 +1737,7 @@ string. */); Vauto_composition_function = Qnil; DEFVAR_LISP ("composition-function-table", &Vcomposition_function_table, - doc: /* Char-able of functions for automatic character composition. + doc: /* Char-table of functions for automatic character composition. For each character that has to be composed automatically with preceding and/or following characters, this char-table contains a function to call to compose that character. @@ -1745,25 +1745,25 @@ a function to call to compose that character. The element at index C in the table, if non-nil, is a list of this form: ([PATTERN PREV-CHARS FUNC] ...) -PATTERN is a regular expression with which C and the surrounding +PATTERN is a regular expression which C and the surrounding characters must match. PREV-CHARS is a number of characters before C to check the -matching with PATTERN. If it is 0, PATTERN must match with C and -the following characters. If it is 1, PATTERN must match with a +matching with PATTERN. If it is 0, PATTERN must match C and +the following characters. If it is 1, PATTERN must match a character before C and the following characters. If PREV-CHARS is 0, PATTERN can be nil, which means that the single character C should be composed. FUNC is a function to return a glyph-string representing a -composition of the characters matching with PATTERN. It is +composition of the characters that match PATTERN. It is called with one argument GSTRING. GSTRING is a template of a glyph-string to return. It is already filled with a proper header for the characters to compose, and glyphs corresponding to those characters one by one. The -function must return a new glyph-string of the same header as +function must return a new glyph-string with the same header as GSTRING, or modify GSTRING itself and return it. See also the documentation of `auto-composition-mode'. */); -- 2.20.1