QtCreator qch doxygen code tags
-
Hello,
I stumbled upon problem with doxygen tag \code that is inside source file.
When generating HTML output I can see correctly example code, line by line correctly placed in HTML output), but when loading generated gch into QtCreator all example code is in one line without any indention, although I do see that code documentation style is applied but with x position of 0.
Using \verbatim do resolve this, but varbatim is used for different purpose.Used version:
QtCreator - 3.6.1
doxygen - 1.8.11 -
Hi,
Can you show an sample comment code that triggers that ?
-
Sorry for late reply.
Here are screens from both HTML and QtCreator.HTML:
https://i.imgsafe.org/a0731dd.jpg
QtCreator:
https://i.imgsafe.org/c7497eb.jpg
Edit:
I used custom config for doxygen, but with default one + enable QCH output in QtCreator is same.
Seams like in QtC style for code is messed up. -
Can you test something ? Remove the * from the lines that are not the start nor stop of the comment block.
-
The only thing that stands out to me is your use of
\brief
. That command is handled differently between QDoc and Doxygen - indeed, the wording of you comment suggests that you're expecting Doxygen'sQT_AUTOBRIEF
option to be enabled, yet the image you've attached suggests that option is not in affect (possibly because of your explicit\brief
).Anyway, try either:
- removing the
\brief
; and/or - adding a blank link between the
\brief
line, and the "more detailed description" line.
It probably should work fine the way you have it, but give that a go anyway, just to see if that's the source of the issue.
Cheers.
- removing the
-
Can you share your doxygen config ? And which version is it ?
-
doxygen 1.8.11
Qt 5.6 QtCreator 3.6.1doxy config:
https://mega.nz/#!09tB3JgK!Z102QbGp-MetJ7O0-vdkq5uJmPVJWdngJj_VQrdMT1MTried with default generated by doxy, only enable QCH same result.
-