masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-09 05:30:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation of face numbers

Browse source 
* doc/lispref/display.texi (Face Functions): Mention where the
face number is used and that it depends on the 'face' property
of the face symbol.  Improve indexing.
This commit is contained in:
Eli Zaretskii 2019-01-29 18:28:13 +02:00
parent bf235ce339
commit 73508e6245
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/lispref/display.texi
View file

@ -3038,10 +3038,17 @@ value, which inherits from @var{face}'s global definition.
This function returns a list of all defined face names. This function returns a list of all defined face names.
@end defun @end defun
@cindex face number
@cindex face property of face symbols
@defun face-id face @defun face-id face
This function returns the @dfn{face number} of face @var{face}. This This function returns the @dfn{face number} of face @var{face}. This
is a number that uniquely identifies a face at low levels within is a number that uniquely identifies a face at low levels within
Emacs. It is seldom necessary to refer to a face by its face number. Emacs. It is seldom necessary to refer to a face by its face number.
However, functions that manipulate glyphs, such as
@code{make-glyph-code} and @code{glyph-face} (@pxref{Glyphs}) access
the face numbers internally. Note that the face number is stored as
the value of the @code{face} property of the face symbol, so we
recommend not to set that property of a face to any value of your own.
@end defun @end defun
@defun face-documentation face @defun face-documentation face