dokka icon indicating copy to clipboard operation
dokka copied to clipboard

Cross-module HTML links break with package names containing an uppercase character

Open OliverO2 opened this issue 2 months ago • 0 comments

Describe the bug With currently unpublished changes for TestBalloon, Dokka produced a link

  • from dokka/html/testBalloon-framework-core/de.infix.testBalloon.framework.core/-test/index.html
  • to dokka/html/testBalloon-framework-shared/de.infix.test-balloon.framework.shared/-abstract-test/index.html.

(Note the uppercase conversion for the package name).

However, the target document resides at a URL without the uppercase conversion for the package name:

  • dokka/html/testBalloon-framework-shared/de.infix.testBalloon.framework.shared/-abstract-test/index.html

Expected behaviour HTML links don't break in the presence of uppercase characters in package names.

Notable, intra-module links work with uppercase characters.

The Kotlin coding conventions state (emphasis added):

Names of packages are always lowercase and do not use underscores (org.example.project). Using multi-word names is generally discouraged, but if you do need to use multiple words, you can either just concatenate them together or use camel case (org.example.myProject).

OliverO2 avatar Oct 26 '25 19:10 OliverO2