Empty javadocs #37

Open
opened 2025-12-30 01:19:49 +01:00 by adam · 4 comments
Owner
Originally created by @jamesward on GitHub (Feb 6, 2024). The docs (like https://pkl-lang.org/main/current/kotlin-binding/codegen.html) say to look in the javadocs / kdocs for more info on using the Java / Kotlin libraries, but the javadoc.jar files are essentially empty, like: https://repo1.maven.org/maven2/org/pkl-lang/pkl-config-kotlin/0.25.1/pkl-config-kotlin-0.25.1-javadoc.jar https://repo1.maven.org/maven2/org/pkl-lang/pkl-codegen-kotlin/0.25.1/pkl-codegen-kotlin-0.25.1-javadoc.jar https://repo1.maven.org/maven2/org/pkl-lang/pkl-codegen-java/0.25.1/pkl-codegen-java-0.25.1-javadoc.jar
Author
Owner

@bioball commented on GitHub (Feb 6, 2024):

Hm, that's weird. Thanks for pointing it out.

@bioball commented on GitHub (Feb 6, 2024): Hm, that's weird. Thanks for pointing it out.
Author
Owner

@stackoverflow commented on GitHub (Feb 8, 2024):

Hi @jamesward. These libraries are in Kotlin, not Java, so the javadocs are empty. Is it common for Kotlin libs to populate the javadocs jar instead of rely on the sources jar for docs? I checked some Kotlin libs like kolinx.reflect.lite and they had empty javadocs.

@stackoverflow commented on GitHub (Feb 8, 2024): Hi @jamesward. These libraries are in Kotlin, not Java, so the javadocs are empty. Is it common for Kotlin libs to populate the javadocs jar instead of rely on the sources jar for docs? I checked some Kotlin libs like `kolinx.reflect.lite` and they had empty javadocs.
Author
Owner

@jamesward commented on GitHub (Feb 8, 2024):

While not all Kotlin libraries put the dakka docs into the javadoc.jar it definitely is possible and we do it for example with grpc-kotlin. This allows us to get the javadocs in sites that pull them from Maven Central, like: https://javadocs.dev/io.grpc/grpc-kotlin-stub/latest

@jamesward commented on GitHub (Feb 8, 2024): While not all Kotlin libraries put the dakka docs into the javadoc.jar it definitely is possible and we do it for example with grpc-kotlin. This allows us to get the javadocs in sites that pull them from Maven Central, like: https://javadocs.dev/io.grpc/grpc-kotlin-stub/latest
Author
Owner

@jamesward commented on GitHub (Feb 8, 2024):

Also note that the javadoc.jar is also empty for the pk-codegen-java library.

@jamesward commented on GitHub (Feb 8, 2024): Also note that the javadoc.jar is also empty for the pk-codegen-java library.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pkl#37