procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add font-lock-doc-markup-face (bug#50041)

Browse source 
This face is intended for mark-up syntax and constructs inside text
using font-lock-doc-face; ie, documentation comments and strings in
programming modes.

* lisp/font-lock.el (font-lock-doc-markup-face): New face.
* lisp/cus-theme.el (custom-theme--listed-faces): Add it to the list.
* doc/lispref/modes.texi (Faces for Font Lock): Document it.
* etc/NEWS: Mention it.
This commit is contained in:
Mattias Engdegård 2021-08-13 12:47:39 +02:00
parent a3dd5f1216
commit 1bfbb2b706
4 changed files with 32 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/lispref/modes.texi
View file

@ -3444,9 +3444,17 @@ for string constants.
@item font-lock-doc-face
@vindex font-lock-doc-face
for documentation strings in the code. This inherits, by default, from
for documentation embedded in program code inside specially-formed
comments or strings. This face inherits, by default, from
@code{font-lock-string-face}.
@item font-lock-doc-markup-face
@vindex font-lock-doc-markup-face
for mark-up elements in text using @code{font-lock-doc-face}.
It is typically used for the mark-up constructs in documentation embedded
in program code, following conventions such as Haddock, Javadoc or Doxygen.
This face inherits, by default, from @code{font-lock-constant-face}.
@item font-lock-negation-char-face
@vindex font-lock-negation-char-face
for easily-overlooked negation characters.

9
etc/NEWS
View file

@ -149,6 +149,15 @@ invoked with the '--declarations' command-line option.
** New command 'font-lock-update', bound to 'C-x x f'.
This command updates the syntax highlighting in this buffer.
+++
** A new standard face 'font-lock-doc-markup-face'.
Intended for documentation mark-up syntax and tags inside text that
uses 'font-lock-doc-face', with which it should harmonise. It would
typically be used in structured documentation comments in program
source code by language-specific modes, for mark-up conventions like
Haddock, Javadoc or Doxygen. By default this face inherits from
'font-lock-constant-face'.
** The new NonGNU ELPA archive is enabled by default alongside GNU ELPA.
+++

2
lisp/cus-theme.el
View file

@ -66,7 +66,7 @@ Do not call this mode function yourself. It is meant for internal use."
shadow secondary-selection trailing-whitespace
font-lock-builtin-face font-lock-comment-delimiter-face
font-lock-comment-face font-lock-constant-face
font-lock-doc-face font-lock-function-name-face
font-lock-doc-face font-lock-doc-markup-face font-lock-function-name-face
font-lock-keyword-face font-lock-negation-char-face
font-lock-preprocessor-face font-lock-regexp-grouping-backslash
font-lock-regexp-grouping-construct font-lock-string-face

14
lisp/font-lock.el
View file

@ -312,6 +312,9 @@ If a number, only buffers greater than this size have fontification messages."
(defvar font-lock-doc-face 'font-lock-doc-face
"Face name to use for documentation.")
(defvar font-lock-doc-markup-face 'font-lock-doc-markup-face
"Face name to use for documentation mark-up.")
(defvar font-lock-keyword-face 'font-lock-keyword-face
"Face name to use for keywords.")
@ -2003,7 +2006,16 @@ Sets various variables using `font-lock-defaults' and
(defface font-lock-doc-face
'((t :inherit font-lock-string-face))
"Font Lock mode face used to highlight documentation."
"Font Lock mode face used to highlight documentation embedded in program code.
It is typically used for special documentation comments or strings."
:group 'font-lock-faces)
(defface font-lock-doc-markup-face
'((t :inherit font-lock-constant-face))
"Font Lock mode face used to highlight embedded documentation mark-up.
It is meant for mark-up elements in text that uses `font-lock-doc-face', such
as the constructs of Haddock, Javadoc and similar systems."
:version "28.1"
:group 'font-lock-faces)
(defface font-lock-keyword-face