GNU bug report logs - #50041
Add font-lock-doc-markup-face

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Mattias Engdegård <mattiase <at> acm.org>
Subject: bug#50041: closed (Re: bug#50041: Add font-lock-doc-markup-face)
Date: Sat, 14 Aug 2021 09:03:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#50041: Add font-lock-doc-markup-face

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 50041 <at> debbugs.gnu.org.

-- 
50041: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=50041
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Mattias Engdegård <mattiase <at> acm.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 50041-done <at> debbugs.gnu.org, Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: Re: bug#50041: Add font-lock-doc-markup-face
Date: Sat, 14 Aug 2021 11:01:45 +0200

Thank you, pushed to master.

[Message part 3 (message/rfc822, inline)]

From: Mattias Engdegård <mattiase <at> acm.org>
To: bug-gnu-emacs <at> gnu.org
Subject: Add font-lock-doc-markup-face
Date: Fri, 13 Aug 2021 12:53:04 +0200

[Message part 4 (text/plain, inline)]

Add a standard face for mark-up syntax and keywords inside code documentation (doc comments/strings) whose body text is typically set in font-lock-doc-face. This could include various tags, brackets, quotes, keywords or other syntactically special characters.

Justification:

- A standard face means that users and theme authors can set it once for all modes needing it.
- Having a face that harmonises with font-lock-doc-face reduces the risk of bad ergonomics and aesthetics.
- Setting doc mark-up in a distinct face makes in-source documentation more readable.
- It also aids writing documentation by providing feed-back to the programmer in the same way as fontifying regular language constructs.

The CC modes have the foresight of already using `font-lock-doc-markup-face` if defined, anticipating its eventual addition, defaulting to `font-lock-constant-face`. I therefore propose that the new face will inherit from `font-lock-constant-face` by default.

Proposed patch attached.

[0001-Add-font-lock-doc-markup-face.patch (application/octet-stream, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.