Emacs Stack Exchange is a question and answer site for those using, extending or developing Emacs. It only takes a minute to sign up.
Sign up to join this community
I am working with the C-source code of Emacs using the built-in c-mode, and would like Emacs to automatically highlight functions and variables within comments with a different color: In the following example, how can I make pos-visible-in-window-p a different color?
/* See the doc-string for `pos-visible-in-window-p'. */
This seems to work for me:
(require 'cc-mode)
(setq yashi-font-lock-doc-comments
(let ((symbol "[a-zA-Z0-9_-]+"))
`((,(concat "`" symbol "'")
0 ,c-doc-markup-face-name prepend nil))
))
(setq yashi-font-lock-keywords
`((,(lambda (limit)
(c-font-lock-doc-comments "/\\*" limit
yashi-font-lock-doc-comments)
))))
(add-hook 'c-mode-hook
(lambda ()
(setq c-doc-comment-style '((c-mode . yashi)))))
*scratch* buffer and typed M-x eval-buffer RET. Then I opened a new buffer foo.c, which defaults to c-mode. I typed: /* See the doc-string for [backtick]pos-visible-in-window-p'. */ The function pos-visible-in-window-p did not receive any different color than the rest of the comment -- i.e., the function is font-lock-comment-face. I verified the face by placing my cursor on the function and typing: C-u C-x =
– lawlist
Feb 7 '16 at 6:13
foo-bar, so I committed - from symbol regexp. Third, I left /**\n as the start of comment. I've removed it too. Would you mind to test it again?
– Yasushi Shoji
Feb 9 '16 at 2:26
font-lock-doc-face instead of font-lock-comment-face. This indicates that this method was intended to be used for doxygen-like comments, not for general highlighting inside comments. One drawback is that you can only have one doc-style, so you can't highlight symbols and doxygen comments. An alternative approach would be to use a plain font-lock rule that highlight symbols inside backtick-tick, that also check that they are inside comments using syntax-ppss.
– Lindydancer
Feb 11 '16 at 10:13
(font-lock-add-keywords 'c-mode '(("`\\([a-z-]+\\)'" 1 'font-lock-function-name-face prepend))). This does not check if`foo'is in a comment, though. – Constantine Feb 6 '16 at 21:24c-font-lock-doc-commentsmight be appropriate. However, the method used byc-modeto achieve its highlighting is quite complex. – lawlist Feb 6 '16 at 21:39emacs-lisp-modehighlights functions and variables within comments, and find that I really miss that visual behavior when working inc-mode. The answer of @Constantine is essentially a textbook example fromfont-lockclass 101. I'm most interested in a spiffy modification of the syntactic functions used byc-modeto achieve the desired effect. I am already familiar with the find features for functions and variables. – lawlist Feb 6 '16 at 22:51gtkdoc,autodoc, andjavadoc) would be enough -- it would be nice to leave the logic ofc-font-lock-doc-commentsalone). Also, I just realized that one could modifybug-reference-modeto achieve something similar. (That way we could easily have clickable buttons that call 'describe-function` ordescribe-variable.) – Constantine Feb 7 '16 at 0:08