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

python unicode docstrings are ignored (Origin: bugzilla #761139) #5941

doxygen opened this Issue Jul 2, 2018 · 0 comments


None yet
1 participant

doxygen commented Jul 2, 2018

status RESOLVED severity major in component general for ---
Reported in version 1.8.8 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2016-01-26 15:48:28 +0000, Anders Munch wrote:

Module, class and function docstrings in Python code are completely ignored if they are of the unicode variety with a u prefix.

It looks like raw strings (with an r prefix) are also ignored.

On 2016-01-26 18:46:12 +0000, albert wrote:

Can you please attach a self-contained example (source+config file in a tar or zip) that allows us to reproduce the problem?

On 2016-01-27 14:26:22 +0000, Anders Munch wrote:

Created attachment 319836
Reproducing example.

I included function examples for all prefix combinations, but in general practise only the lower-case u is used.
There's a snip og accented text in the unicode variations, so you can use it as a test case and check that the accented words are correctly encoded in the docs. That's assuming Doxygen interprets the encoding comment, which would be the proper thing to do.

The included Doxyfile is just a default-generated configuration. It doesn't look like any of the configuration options make a difference.

On 2016-01-27 15:44:02 +0000, albert wrote:

I have just pushed a proposed patch to github (pull request 448)

On 2016-02-03 10:16:17 +0000, albert wrote:

Code has been integrated in github

On 2016-09-05 13:46:32 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.12. Please verify if this is indeed the case. Reopen the
bug 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 closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment