search

lightbend / kalix-jvm-sdk

Java and Scala SDKs for Kalix
https://docs.kalix.io/java/index.html
Other
58 stars 39 forks source link

API docs mixing javadoc and scaladoc #1314

Closed octonato closed 1 year ago

octonato commented 1 year ago

I noticed that in https://docs.kalix.io/java/event-sourced-entities.html#_testing_the_entity, there is a link to the API docs for EventSourcedResult.

The java one is pointing to a scaladoc. That's probably some wrong settings in sbt.

The scala one is broken. It points to https://docs.kalix.io/java/_attachments/testkit-scala/kalix/scalasdk/testkit/EventSourcedResult.html, it should be https://docs.kalix.io/java/_attachments/scala-testkit-api/kalix/scalasdk/testkit/EventSourcedResult.html

We might have other broken links like that. Strange that link validation is not picking it.

And with the latest change in https://github.com/lightbend/kalix-jvm-sdk/pull/1312, the Spring SDK is correctly published, but the its index.html is a scaladoc one. It certainly overwrote the original javadoc index.html because the other javadoc files are published.

franciscolopezsancho commented 1 year ago

As per Sbt documentation, it seems that using scaladoc is unavoidable. See here