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

Documentation is wrong about Doxygen alias for "verbatim embed:rst" #768

Closed
arwedus opened this issue Nov 24, 2021 · 2 comments · Fixed by #770
Closed

Documentation is wrong about Doxygen alias for "verbatim embed:rst" #768

arwedus opened this issue Nov 24, 2021 · 2 comments · Fixed by #770
Assignees
Labels
documentation Generated html, changelog, inline comments

Comments

@arwedus
Copy link
Contributor

arwedus commented Nov 24, 2021

Problem description:

The breathe manual suggests to create ALIASES for \verbatim embed:rst, including \verbatim embed:rst:leading-slashes, but that won't work due to a bug (or let's say, undocumented behavior) in doxygen.
An executable example project is contained in the doxygen issue.

Solution suggestion:

Just propose to use the following Doxyfile config option if the project convention is to have leading comment characters (upside of the bug in Doxygen: This works with ANY leading comment character, be it * , /// or //!).

ALIASES = rst="^^\verbatim embed:rst:leading-asterisk"
ALIASES += endrst="\endverbatim"
@jakobandersen
Copy link
Collaborator

I'm not really familiar with the ALIASES feature, but it sounds reasonable. Do I understand it correctly that then there would only be a need for 1 type of alias, the rst, and not both rstand rststar?
Could you make a pull request with an update to the documentation?

@arwedus
Copy link
Contributor Author

arwedus commented Nov 28, 2021

@jakobandersen : Exactly, that's why I told them that I am actually not much interested in a fix ;-).
We have now set the \rst alias as I have described in PR #770 and it works no matter which comment style (all our projects use a comment style with some leading comment character on each line).

@vermeeren vermeeren added the documentation Generated html, changelog, inline comments label Feb 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Generated html, changelog, inline comments
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants