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

Markdown not properly applied to Java files #2615

Closed
kjt0429 opened this issue Aug 9, 2022 · 3 comments
Closed

Markdown not properly applied to Java files #2615

kjt0429 opened this issue Aug 9, 2022 · 3 comments
Labels

Comments

@kjt0429
Copy link

kjt0429 commented Aug 9, 2022

Describe the bug
Markdown not properly applied to Java files

Expected behaviour
Markdown properly applied to Java files

Screenshots

To Reproduce
Steps to reproduce the behavior, ideally with an example project

// temp.java

/**
 * Title A~~<br> 
 * Title B~~
 *
 * Body description~
 */
class A
{
  ...
}

I expected like below.

Title A~~
Title B~~

but showing

Title A~~ Title B~~

Even looking at the html file, it was �checked that the br-tag disappeared. It only happens in .java files.

Dokka configuration

  • default

Installation

  • Operating system: macOS
  • Build tool: Gradle v6.6.0
  • Dokka version: 1.7.10

Additional context
Add any other context about the problem here

Are you willing to provide a PR?
Providing a PR can drastically speed up the process of fixing this bug

@kjt0429 kjt0429 added the bug label Aug 9, 2022
@IgnatBeresnev
Copy link
Member

Hi! Java's Javadoc format does not support Markdown, it only supports HTML-like tags, so this is the intended behaviour

This page has a lot of examples of what's possible with Javadoc.

In your particular case, this should work:

/**
 * Title A~~
 * <p>
 * Title B~~
 */

Also worth noting that Javadoc support is not ideal at the moment, and not all tags may work.

@IgnatBeresnev
Copy link
Member

JFYI: <br> should probably be supported as an html tag, it's mentioned in #2262 already

Closing this issue since <br> is not related to the description about markdown support.

@kjt0429
Copy link
Author

kjt0429 commented Aug 11, 2022

@IgnatBeresnev thanks for your reply

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants