dokka icon indicating copy to clipboard operation
dokka copied to clipboard

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

Open adam-enko opened this issue 5 months ago • 2 comments

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 avatar Oct 03 '24 15:10 adam-enko