Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add support for maths formulas #9

Open
ggegoge opened this issue Apr 19, 2021 · 2 comments
Open

add support for maths formulas #9

ggegoge opened this issue Apr 19, 2021 · 2 comments

Comments

@ggegoge
Copy link

ggegoge commented Apr 19, 2021

Hi,

the Doxygen documentation has the ability to include LaTeX-y maths formulas with either something like @f$ \sin x @f$ or @f[ \sin x @f] for the so called display mode. Unfortunately there seems to be no highlighting for neither the @f$ tags nor the formula inside with the package. Highlighting the tags with the highlight-doxygen-command face and perhaps the interiors of the LaTeX formula with some different face would be very helpful

@Lindydancer
Copy link
Owner

Lindydancer commented Apr 19, 2021 via email

@ggegoge
Copy link
Author

ggegoge commented Apr 28, 2021

Hi

Obviously it would be amazing to have complete latex highlighting inside formulas (complete ie with subscripts and superscripts being resized etc) but I suppose it is not trivial to do at all.

Eg in the famous org-mode when you have math tex fragments it doesn't get rendered using the usual latex rendering but with a single face (until you use the org pretty entities something but for me that is too much).

To be honest it would be enough to simply have the @f$ delimiters highlighted like all others since my problems with those maths fragments in Doxygen were usually me getting lost with the formula being hard to distinguish from standard docstrings which led me to some dumb mistakes as writing @$f by accident.

And I think that having the two things

  1. the markers @f$ highlighted the same way all other Doxygen commands are highlighted
  2. the formula itself being highlighted with some different face (perhaps inheriting from the LaTeX face font-latex-math-face)

would be more than enough to make editing maths in Doxygen easy and simple.

Of course I understand that you may not have the energy. Maintaining open source projects is a hobby and some users behave as if the maintainers were some kind of workers made to fullfill their needs which is quite far from reality. And it is understandable it may get tiring. So no pressure from me.

If I were more fluent in emacs lisp I would try to make the necessary changes myself and then just send you a merge request. Unfortunately I'm no elispian.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants