Open owengray-google opened 4 months ago
Curiously, it appears that inline doc comments on property parameters use a different system, in which this somewhat works:
(However, note that the hoverover text on the 'working' picture is assist chip * image
. This is probably a separate bug.)
A breakline is supported for an inline markdown link to an element in IDE and Dokka:
/**
* Text
* [some
* link](https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png)
*
* Text:
* [some
* text][f]
*/
fun f() = 0
IDE:
MARKDOWN_INLINE_LINK
tag is [some\n * link](https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png)
. Then a CommonMark parser processes it as a list item.Note! It can work in the case of formatting like in the example with doc comments on property parameters :
vs
In the class A
, a tag is [some\n * img(https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png)
instead of [some\n * img](https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png)
If you have link text that is very long and splits onto multiple lines, like this, the kdoc parser does not recognize it as a link. We have run into this because ktfmt (https://github.com/facebook/ktfmt) is now formatting our kdoc syntax, producing the diff in this link. In the general case, like this link itself, I don't think it is viable to always require the link be on one line.
The CommonMark spec for markdown explicitly allows line breaks inside link text, and specifies that img tags use a superset of the link syntax.