Skip to content
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

Line break in table in module/package documentation not rendered correctly #1896

Closed
asfalcone opened this issue Apr 28, 2021 · 3 comments
Closed
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs
Milestone

Comments

@asfalcone
Copy link
Contributor

Describe the bug
<br> appears as text instead of an HTML tag when included inside of a table cell in markdown file used as module or package documentation

Expected behaviour
A line break appears in the table cell

Screenshots
image
image

Rendered correctly in Github:

APIs
Filled [Icons.Default]
[Icons.Filled]
Outlined [Icons.Outlined]
Rounded [Icons.Rounded]
Two tone [Icons.TwoTone]
Sharp [Icons.Sharp]

To Reproduce
pass a .md file via -includes to Dokka:

|  | APIs |
| ----- | ----- |
| Filled | [Icons.Default]<br>[Icons.Filled] |
| Outlined | [Icons.Outlined] |
| Rounded | [Icons.Rounded] |
| Two tone | [Icons.TwoTone] |
| Sharp | [Icons.Sharp] |

Installation

  • Operating system: macOS/Windows/Linux
  • Build tool: Gradle v6.8.0/Maven/Cli/3rd party plugin
  • Dokka version: 1.4.30
@asfalcone asfalcone added the bug label Apr 28, 2021
@MarcinAman
Copy link
Contributor

@asfalcone could you try it out with 1.4.32? I think this should not be a problem after this: #1805

@asfalcone
Copy link
Contributor Author

I am not seeing this fixed with 1.4.32

@MarcinAman MarcinAman added the feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs label Apr 29, 2021
@MarcinAman MarcinAman added this to the 1.5.0 milestone Apr 29, 2021
@kamildoleglo
Copy link
Contributor

Fix confirmed in 1.4.32. Basically ContentText has now an extra parameter HtmlContent if it should be treated as an HTML entity, based on DocTag's param content-type == "html"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs
Projects
None yet
Development

No branches or pull requests

3 participants