diff options
| author | Eli Zaretskii | 2017-06-10 12:08:45 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2017-06-10 12:08:45 +0300 |
| commit | 187a71df596a331a23bf86ee314c12035f42aff2 (patch) | |
| tree | 0bff0f1a213ee7923d1d7c1d94bea145b7f687ea /doc | |
| parent | f361c54e6abc5ba5fa5ce6cc9734b5283e0e6aa3 (diff) | |
| download | emacs-187a71df596a331a23bf86ee314c12035f42aff2.tar.gz emacs-187a71df596a331a23bf86ee314c12035f42aff2.zip | |
Clarify documentation of 'face-spec-set'
* lisp/faces.el (face-spec-set): Clarify the description of
SPEC-TYPE in the doc string.
* doc/lispref/display.texi (Defining Faces): Clarify the
description of 'face-spec-set's SPEC-TYPE argument. (Bug#27246)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/display.texi | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index aa75dcf5a0a..4a895f74a5d 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -2531,16 +2531,20 @@ This function also defines @var{face} as a valid face name if it is | |||
| 2531 | not already one, and (re)calculates its attributes on existing frames. | 2531 | not already one, and (re)calculates its attributes on existing frames. |
| 2532 | 2532 | ||
| 2533 | @cindex override spec @r{(for a face)} | 2533 | @cindex override spec @r{(for a face)} |
| 2534 | The argument @var{spec-type} determines which spec to set. If it is | 2534 | The optional argument @var{spec-type} determines which spec to set. |
| 2535 | @code{nil} or @code{face-override-spec}, this function sets the | 2535 | If it is omitted or @code{nil} or @code{face-override-spec}, this |
| 2536 | @dfn{override spec}, which overrides over all other face specs on | 2536 | function sets the @dfn{override spec}, which overrides face specs on |
| 2537 | @var{face}. If it is @code{customized-face} or @code{saved-face}, | 2537 | @var{face} of all the other types mentioned below. This is useful |
| 2538 | this function sets the customized spec or the saved custom spec. If | 2538 | when calling this function outside of Custom code. If @var{spec-type} |
| 2539 | it is @code{face-defface-spec}, this function sets the default face | 2539 | is @code{customized-face} or @code{saved-face}, this function sets the |
| 2540 | spec (the same one set by @code{defface}). If it is @code{reset}, | 2540 | customized spec or the saved custom spec, respectively. If it is |
| 2541 | this function clears out all customization specs and override specs | 2541 | @code{face-defface-spec}, this function sets the default face spec |
| 2542 | from @var{face} (in this case, the value of @var{spec} is ignored). | 2542 | (the same one set by @code{defface}). If it is @code{reset}, this |
| 2543 | Any other value of @var{spec-type} is reserved for internal use. | 2543 | function clears out all customization specs and override specs from |
| 2544 | @var{face} (in this case, the value of @var{spec} is ignored). The | ||
| 2545 | effect of any other value of @var{spec-type} on the face specs is | ||
| 2546 | reserved for internal use, but the function will still define | ||
| 2547 | @var{face} itself and recalculate its attributes, as described above. | ||
| 2544 | @end defun | 2548 | @end defun |
| 2545 | 2549 | ||
| 2546 | @node Attribute Functions | 2550 | @node Attribute Functions |