Question

I currently use doxymacs to syntax highlight doxygen comments and keywords in the C++ files on a collaborative project I’m working on.

However, in the project, there are “plans” files which are basically very long doxygen comments with lots of todos, bugs etc, all using html tags for organisation and presentation.

At present doxymacs only highlights keywords like “todo” and “bug” etc. How can I make it also syntax highlight the html tags within the doxygen comment?

I can do this by switching to “html-mode” but then I lose the standard doxymacs highlighting of “todo” etc. Just being able to use both modes together or combine them would be useful.

So for example, if I had:

/*!
    \todo Test todo
    <ul>
     <li> Some text. </li>
     <li> Some more text. </li>
    </ul>

*/

I’d like the <ul> tags etc to be coloured a different colour to the normal text within the /*! */ comments.

Answer 1

This will font-lock anything in <> as keywords in comments in c-derived modes:

(defun my-c-font-lock-doxy-html (limit)
  (while (re-search-forward "<.+?>" limit 'move)
    (let ((beg (match-beginning 0))
          (end (match-end 0)))
      (if (nth 4 (syntax-ppss beg))
          (when (nth 4 (syntax-ppss end))
            (c-put-font-lock-face beg end 'font-lock-keyword-face))
        (goto-char end))))
  nil)

(defun my-c-mode-common-hook ()
  (font-lock-add-keywords nil '((my-c-font-lock-doxy-html))))

(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)