pkl icon indicating copy to clipboard operation
pkl copied to clipboard

Empty javadocs

Open jamesward opened this issue 1 year ago • 4 comments
trafficstars

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

jamesward avatar Feb 06 '24 05:02 jamesward

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

bioball avatar Feb 06 '24 06:02 bioball

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 avatar Feb 08 '24 15:02 stackoverflow

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 avatar Feb 08 '24 16:02 jamesward

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

jamesward avatar Feb 08 '24 16:02 jamesward