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

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

Open
fzhinkin opened this issue Oct 30, 2024 · 0 comments
Labels
bug feedback: Kotlin libs Feedback from Kotlin's internal libraries

Comments

@fzhinkin
Copy link

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
@fzhinkin fzhinkin added the bug label Oct 30, 2024
@whyoleg whyoleg added the feedback: Kotlin libs Feedback from Kotlin's internal libraries label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug feedback: Kotlin libs Feedback from Kotlin's internal libraries
Projects
None yet
Development

No branches or pull requests

2 participants