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

UTF-16LE BOM not handled by source browser and \snippet (Origin: bugzilla #702491) #5214

doxygen opened this Issue Jul 2, 2018 · 0 comments


None yet
1 participant

doxygen commented Jul 2, 2018

status VERIFIED severity normal in component general for ---
Reported in version 1.8.4 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-06-17 16:59:23 +0000, Kevin Puetz wrote:

Created attachment 247050
example showing that parsing handles BOM and snippets/source browser do not

Although the documentation extract/parse functionality of doxygen seems to support utf16 with BOM (which seems to have been part of fixing bug 593928 and 576950), the source browser and snippet functionality still don't seem to.

In the attached test project, I have created two essentially identical documented classes, A and B. The source code for A is ASCII (being parsed as UTF8), the source code for B is in a file encoded in UTF16LE, with a BOM. Both classes' documentation extracts properly, but the source listing is garbled for test-utf16.h, and the snippet included in B::getB() is missing.

At build time, I get the error "C:/Desktop/UTF16 BOM test/test-utf16.h:13: Warning: block marked with [snippet_getB] for \snippet should appear twice in file test-utf16.h, found it 0 times", which fits with the snippet being missing; it's searching for the marked sans BOM,

I hit this when trying to document examples including a microsoft-style .rc file - rc.exe supports unicode only as CP_ACP (legacy ANSI code page, locale dependent) or utf16-le with a BOM. It does not support utf-8.

P.S. the little //~ ~snippet [marker] in the example is using a language filter to keep the snippet markers from showing up as part of the documentation (by making them part of an OUTPUT_LANGUAGE I will never build). It's a little weird :-). If I'm overlooking some cleaner way for a file to snippet bits of itself suggestions are welcome :-)

On 2013-07-02 18:59:02 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2013-08-23 15:04:34 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.5. 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.

On 2013-09-16 15:27:05 +0000, Kevin Puetz wrote:

Verified fixed, thank you very much.

@doxygen doxygen closed this Jul 19, 2018

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