Skip to content

Annotations are missing the annotation name in 1.4.30 GFM format #1798

@bherbst

Description

@bherbst

Describe the bug
As of Dokka 1.4.30 annotations are missing their name from generated GFM docs.

For example, @Json(name = "param") val param: String is now rendering as @(name = param)param: String

Expected behaviour
I expect that the annotation name to show up in the generated docs.

To Reproduce
Here is a sample project.

Run ./gradlew dokkaGfm, then inspect /docs/core/core/-deep-thought/-deep-thought.md.

Swapping Dokka 1.4.30 for Dokka 1.4.20 results in the expected output.

Dokka configuration
Configuration of dokka used to reproduce the bug

tasks.dokkaGfm.configure {
    val outputPath = "$rootDir/docs"
    outputDirectory.set(buildDir.resolve(outputPath))
}

Installation

  • Operating system: macOS
  • Build tool: Gradle v6.3.0 (have also tried with Gradle 6.8.3)
  • Dokka version: 1.4.30

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions