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.

Sign up for GitHub

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

Jump to bottom

<tt> missinterpreted #8743

Closed
buhtz opened this issue Aug 29, 2021 · 3 comments
Closed

<tt> missinterpreted #8743

buhtz opened this issue Aug 29, 2021 · 3 comments
Labels
bug documentation bug in the documentation

Comments

@buhtz
Copy link

buhtz commented Aug 29, 2021

Please see this line in your doc files.

doxygen/doc/docblocks.doc

Line 462 in 0b13cc6

so called documentation strings (<tt>"""</tt>). Such strings are stored in \c __doc__

I am not sure which doc technology you are using. But in fact the result is not correct.
See https://www.doxygen.nl/manual/docblocks.html#pythonblocks
albert-github added a commit to albert-github/doxygen that referenced this issue Aug 29, 2021
@albert-github
issue doxygen#8743 <tt> missinterpreted
0629f58 
One of the exceptions where the double quotes have to be escaped (as done a bit further down in the same document already.
@albert-github albert-github added bug documentation bug in the documentation labels Aug 29, 2021
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #8744

doxygen added a commit that referenced this issue Aug 30, 2021
@doxygen
Merge pull request #8744 from albert-github/feature/issue_8743
b8b5332 
issue #8743 <tt> missinterpreted
@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 Aug 30, 2021
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

doxygen pushed a commit that referenced this issue Sep 1, 2021
@albert-github @doxygen
issue #8743 <tt> missinterpreted
ec8f340 
One of the exceptions where the double quotes have to be escaped (as done a bit further down in the same document already.
@doxygen
Copy link
Owner

doxygen commented Dec 31, 2021

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.3.
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 31, 2021
@doxygen doxygen closed this as completed Dec 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug documentation bug in the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@doxygen @albert-github @buhtz