Skip to content

References from a module description to top-level functions and properties are rendered as incorrect links #3891

Open
@fzhinkin

Description

@fzhinkin

Describe the bug
References to top-level functions and properties (but not to classes, objects, or their members) from a module description are rendered as links leading to a package's page, but not to corresponding declaration's pages. At the same time, references to these declarations from any regular KDoc are rendered as correct links.

Expected behaviour
References to top-level functions and properties are rendered as links leading to their own documentation pages.

To Reproduce
Here's an example of such a reference: https://github.com/Kotlin/kotlinx-io/blob/5e2cd344d1a2eb3007217326c150807f99d94ead/core/Module.md?plain=1#L93

To reproduce, checkout kotlinx-io dokka-top-level-ref-issue branch and run ./gradlew dokkaHtmlMultiModule.
Once HTML docs are rendered, open build/dokka/htmlMultiModule/kotlinx-io-core/kotlinx.io.files/index.html. On the top, inside the package description section, kotlinx.io.files.SystemFileSystem's link will lead to index.html instead of -system-file-system.html.

Installation

  • Operating system: macOs
  • Build tool: Gradle v8.9
  • Dokka version: 1.9.20

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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