Description
Describe the bug
According to the language specification QLDoc uses CommonMark, which supports raw HTML.
It appears that the VSCode extension supports HTML entity references (e.g. *
), and for some HTML elements simply shows their content without any special formatting (e.g. <b>bold</b>
).
However, <code>
elements are apparently completely omitted, not even their content is shown:
My use case is that I would like to write /** ... */
(a Javadoc comment) in a QLDoc, however */
is recognized as end of the QLDoc. Therefore the only workaround might be to use <code>/** ... */</code>
.
But this is not super important, I could probably also just omit */
from my QLDoc comment.
To Reproduce
- In a query file write the following QLDoc comment or add it to an existing element
/** * Test <code>code</code> */ <b>bold</b> <i>italic</i> */
- Hover over the QLDoc
❌ The text "code" is completely missing from the shown rendered QLDoc
Expected behavior
- At least the content of the
<code>
element should be shown in the rendered QLDoc (similar to how it is the case for<b>
) - Or ideally the content of the
<code>
element is shown and formatted as code
Additional context
The LGTM Query Console seems to support <code>
and even formats the text as code in the preview when hovering over a documented element: