-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Description
Describe the Feature
Currently, if I want to pass any Doxygen command in Markdown format, it is rendered in GitHub, thus making the output a bit unpleasant.
Example
Suppose I want to use page command, I will have to use \page
command or PHP Markdown Extra, which will also be visible in GitHub.
Possible Solution
Add a way to pass commands in Markdown files without actually messing up the output of files in GitHub / GitLab flavor markdown. This can make the whole documentation cleaner.
Additional context
GitHub supports following comments
-
HTML comments
<!-- .... -->
- This is not rendered by Doxygen
-
[//]: <> (This is command )
,[//]: # (This is also a command in comment )
,[//]: # "Comment"
- Doxygen processes these comments, the command works only if they are on the next line. Additionally, after processing the comment, there is a
)
in the output when using[//]: # ()
.
- Doxygen processes these comments, the command works only if they are on the next line. Additionally, after processing the comment, there is a
To Reproduce
Use any Doxygen command in Markdown format and see it being rendered on GitHub.
Expected behavior
The command should not be visible in GitHub
Version
Applies to all version [I tried 1.11.0 also ]