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

When kdoc has a codeblock containing */, Dokka does not render any Kdoc for the property. #3846

Open
adam-enko opened this issue Oct 3, 2024 · 1 comment
Labels

Comments

@adam-enko
Copy link
Member

adam-enko commented Oct 3, 2024

Describe the bug

KDoc with a Markdown codeblock that contains */ results in nothing being rendered.

/**
 * Hello, welcome to the KDoc for the [a] property.
 *
 * ```
 * */
 * ```
 *
 * Thanks for visiting!
 */
 val a = ""

Expected behaviour

Dokka can handle */ inside of a code block, and will render the value.

Screenshots

  • Actual result:
    image

To Reproduce

/**
 * Class defined in child project a
 */
class ChildProjectAClass {
  /**
   * Hello, welcome to the KDoc for the [a] property.
   *
   * ```
   * */
   * ```
   *
   * Thanks for visiting!
   */
  val a = ""
}

Installation

  • Dokka version: 2.0.0-Beta

The issue reproduces with both K1 and K2 org.jetbrains.dokka.experimental.tryK2=true analysers.

Additional context

IntelliJ is also unhappy https://youtrack.jetbrains.com/issue/KT-71380

image
@adam-enko adam-enko added the bug label Oct 3, 2024
@vmishenev
Copy link
Member

This is a duplication of #2712

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