mirror of
https://github.com/apple/pkl.git
synced 2026-01-13 07:10:41 +01:00
Empty javadocs #37
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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
@bioball commented on GitHub (Feb 6, 2024):
Hm, that's weird. Thanks for pointing it out.
@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.liteand they had empty javadocs.@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):
Also note that the javadoc.jar is also empty for the pk-codegen-java library.