diff src/term.c @ 44372:65c0edf0d53c

Comment change.
author Richard M. Stallman <rms@gnu.org>
date Wed, 03 Apr 2002 15:19:39 +0000
parents c9baf4b00820
children 01b93e5e53a7
line wrap: on
line diff
--- a/src/term.c	Wed Apr 03 14:47:16 2002 +0000
+++ b/src/term.c	Wed Apr 03 15:19:39 2002 +0000
@@ -1637,11 +1637,23 @@
 }
 
 
-/* Produce glyphs for the display element described by IT.  The
-   function fills output fields of IT with pixel information like the
-   pixel width and height of a character, and maybe produces glyphs at
+/* Produce glyphs for the display element described by IT.  *IT
+   specifies what we want to produce a glyph for (character, image, ...),
+   and where in the glyph matrix we currently are (glyph row and hpos).
+   produce_glyphs fills in output fields of *IT with information such as the
+   pixel width and height of a character, and maybe output actual glyphs at
    the same time if IT->glyph_row is non-null.  See the explanation of
-   struct display_iterator in dispextern.h for an overview.  */
+   struct display_iterator in dispextern.h for an overview.
+
+   produce_glyphs also stores the result of glyph width, ascent
+   etc. computations in *IT.
+
+   IT->glyph_row may be null, in which case produce_glyphs does not
+   actually fill in the glyphs.  This is used in the move_* functions
+   in xdisp.c for text width and height computations.
+
+   Callers usually don't call produce_glyphs directly;
+   instead they use the macro PRODUCE_GLYPHS.  */
 
 void 
 produce_glyphs (it)