-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Showing information from all \*only commands in XML output #7481
Showing information from all \*only commands in XML output #7481
Conversation
This fix reverts the changes from doxygen#381 (i.e issue doxygen#4214 "htmlonly content appears in generated XML output (Origin: bugzilla 646002)", as XML is seen as an output format that can be further processed and therefore should contain all possible information.
HTML | ||
</htmlonly> <htmlonly block="yes"> | ||
HTML with block | ||
</htmlonly> <rtfonly> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this! 👍
One "stretch goal" -- the documentation is stating this:
When you want to insert a HTML fragment that has block scope like a table or list which should appear outside
<p>..</p>
, this can lead to invalid HTML. You can use\htmlonly[block]
to make doxygen end the current paragraph and restart it after\endhtmlonly
.
Ideally that would hold also for the XML output, so either <htmlonly>
being inside a <para>
, or <htmlonly>
not being wrapped in a <para>
(instead of current <htmlonly block="yes">
being inside a <para>
). Basically so it doesn't need to be extracted out of the paragraph on the client side.
How hard would it be to implement it like this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In other words, the output looking like this instead:
<para>Text. <htmlonly>
HTML
</htmlonly></para>
<htmlonly>
HTML with block
</htmlonly>
<para><rtfonly>
RTF
</rtfonly> <manonly>
Man
</manonly> <latexonly>
LaTeX
</latexonly>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No idea at the moment how difficult this would be and whether this would be conceptual OK (as it is not really a "dump" anymore).
When really necessary I think best is to submit an issue for this as soon as this proposed pull request has been integrated in master on github.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, no problem. Asked only in case it would be easy to do on your side -- I can do the paragraph extraction on my side as well ;)
This fix reverts the changes from #381 (i.e issue #4214 "htmlonly content appears in generated XML output (Origin: bugzilla 646002)", as XML is seen as an output format that can be further processed and therefore should contain all possible information.