Javadoc link in README.md is broken

amazon-ion / ion-schema-kotlin

A Kotlin reference implementation of the Ion Schema Specification.

https://amazon-ion.github.io/ion-schema/

Apache License 2.0

26 stars 14 forks source link

Closed ivoanjo closed 4 years ago

ivoanjo commented 4 years ago

No JavaDoc is released for artifact com.amazon.ion:ion-schema-kotlin:1.0.0. Please try other versions. [...]

Only two versions are listed on that site: 0.8.0 and 1.0.0 and neither has javadoc available.

pbcornell commented 4 years ago

Thank you for pointing this out, Ivo. The javadoc.jar is available for download at maven.apache.org, but is clearly not available at javadoc.io.

I suspect this is related to Kotlin's dokka tool; will take a closer look....

pbcornell commented 4 years ago

Looks like there are two issues:

javadoc.io doesn't recognize dokka's "html" outputFormat
Kotlin's dokka tool fails on JDK 10 or higher when the "javadoc" outputFormat is specified (dokka/294)

pbcornell commented 4 years ago

The link Javadoc link in README.md (http://www.javadoc.io/doc/com.amazon.ion/ion-schema-kotlin) now points to generated javadoc content for a new release, v1.0.1.

Thanks again for identifying this issue, Ivo. Closing.