Function: face-documentation

face-documentation is a byte-compiled function defined in faces.el.gz.

Signature

(face-documentation FACE)

Documentation

Get the documentation string for FACE.

If FACE is a face-alias, get the documentation for the target face.

View in manual

Probably introduced at or before Emacs version 20.1.

Aliases

face-doc-string (obsolete since 29.1)

Source Code

;; Defined in /usr/src/emacs/lisp/faces.el.gz
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Face documentation.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun face-documentation (face)
  "Get the documentation string for FACE.
If FACE is a face-alias, get the documentation for the target face."
  (let ((alias (get face 'face-alias)))
    (if alias
        (let ((doc (documentation-property alias 'face-documentation)))
	  (format "%s is an alias for the face `%s'.%s" face alias
                  (if doc (format "\n%s" doc)
                    "")))
      (documentation-property face 'face-documentation))))