diff options
| author | Eli Zaretskii | 2019-01-29 18:28:13 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2019-01-29 18:28:13 +0200 |
| commit | 73508e62459113be4c7c101648afbe541dd18558 (patch) | |
| tree | a70d2d37cc6d361dca0810e0d8d8b4a2597df651 | |
| parent | bf235ce339bbeabfd183f06857dbb4eb4a0119db (diff) | |
| download | emacs-73508e62459113be4c7c101648afbe541dd18558.tar.gz emacs-73508e62459113be4c7c101648afbe541dd18558.zip | |
Improve documentation of face numbers
* 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.
| -rw-r--r-- | doc/lispref/display.texi | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index b3ce7fbf6af..921d58a1f3a 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -3038,10 +3038,17 @@ value, which inherits from @var{face}'s global definition. | |||
| 3038 | This function returns a list of all defined face names. | 3038 | This function returns a list of all defined face names. |
| 3039 | @end defun | 3039 | @end defun |
| 3040 | 3040 | ||
| 3041 | @cindex face number | ||
| 3042 | @cindex face property of face symbols | ||
| 3041 | @defun face-id face | 3043 | @defun face-id face |
| 3042 | This function returns the @dfn{face number} of face @var{face}. This | 3044 | This function returns the @dfn{face number} of face @var{face}. This |
| 3043 | is a number that uniquely identifies a face at low levels within | 3045 | is a number that uniquely identifies a face at low levels within |
| 3044 | Emacs. It is seldom necessary to refer to a face by its face number. | 3046 | Emacs. It is seldom necessary to refer to a face by its face number. |
| 3047 | However, functions that manipulate glyphs, such as | ||
| 3048 | @code{make-glyph-code} and @code{glyph-face} (@pxref{Glyphs}) access | ||
| 3049 | the face numbers internally. Note that the face number is stored as | ||
| 3050 | the value of the @code{face} property of the face symbol, so we | ||
| 3051 | recommend not to set that property of a face to any value of your own. | ||
| 3045 | @end defun | 3052 | @end defun |
| 3046 | 3053 | ||
| 3047 | @defun face-documentation face | 3054 | @defun face-documentation face |