kdoc parser fails when there is a newline inside link/img text. #3661
Labels
bug
feedback: Google
An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs
Comments
vmishenev
added
the
feedback: Google
|
Curiously, it appears that inline doc comments on property parameters use a different system, in which this somewhat works: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The text was updated successfully, but these errors were encountered: