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

Markdown formats missing in doxygen outputs. #6524

Closed
Slyware opened this issue Sep 20, 2018 · 5 comments
Closed

Markdown formats missing in doxygen outputs. #6524

Slyware opened this issue Sep 20, 2018 · 5 comments
Labels
enhancement a request to enhance doxygen, not a bug

Comments

@Slyware
Copy link

Slyware commented Sep 20, 2018

Hi.

The ouputs files (html, rtf, ...) don't interpret ==highlight== and strikethrough format tags nor html tags as underline. I know that they may not be in the official Markdown standard but they are largely used by a many Markdown editors or viewers like Github does!.
Unlike bold or italic format tags, the above tags are displayed as raw source text in the outputs.
Is there a way to add these tags in the Doxygen parser or to customise the preprocessor?
Thanks.
SJ

Doxygen version: 1.8.14

@albert-github
Copy link
Collaborator

In the current master version of doxygen some features should already be available. To see what you want can you please attach a, small, self contained example (source+config file in a tar or zip) that allows us to reproduce the problem?

@albert-github albert-github added the needinfo reported bug is incomplete, please add additional info label Sep 20, 2018
@Slyware
Copy link
Author

Slyware commented Sep 24, 2018

Hi.
Here is an example of MD source edited in Typora (with option "Highlitghing" checked).
Ok, I saw that some of these formats are Markdown extensions but they are commonly used and so usefull.
SupportDoxygen.zip
Typora rendering is here:
image
Thanks a lot.
SJ

@albert-github albert-github added enhancement a request to enhance doxygen, not a bug and removed needinfo reported bug is incomplete, please add additional info labels Oct 2, 2018
@albert-github albert-github changed the title Markdown formats missing in Doxygen outputs. Markdown formats missing in doxygen outputs. Oct 2, 2018
@albert-github
Copy link
Collaborator

Regarding the support for strikethrough: I've just pushed a proposed patch, pull request #6535
Regarding the support for for underline has recently been added by means of #6384
Regarding the support for highlighted text (==), this is not available in the GitHub specifications.

@albert-github
Copy link
Collaborator

Code has been integrated in master on github.

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Oct 13, 2018
@doxygen
Copy link
Owner

doxygen commented Dec 27, 2018

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.8.15.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 27, 2018
@doxygen doxygen closed this as completed Dec 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug
Projects
None yet
Development

No branches or pull requests

3 participants