amadeusitgroup / asciidoctor-extension-apidoc Goto Github PK

In the case where the Javadoc of a project is hosted alongside the documentation via HTML backend (for instance via a Maven site), relative URIs work well to link from the userguide to the corresponding version of the Javadoc:

org.acme=./apidocs/

But when the Asciidoctor backend is standalone (pdf, confluence page, ...), the URIs need to become absolute:

org.acme=http://myserver/myproject/apidocs/

Rather than using 2 apidocs.properties files and having some duplication, the feature would be to have a new attribute apidocs_baseuri that could be set only for the standalone backends in order to automatically prefix the relative URIs:

<apidocs_baseuri>http://myserver/myproject/</apidocs_baseuri>

Travis CI seems to have disappeared a while back.
Could be the opportunity to move to GitHub actions and automate deployment to Maven central.

Give an example of using the extension with Gradle instead of Maven.
https://asciidoctor.org/docs/asciidoctor-gradle-plugin/

For instance:
org.springframework.web.cors.CorsConfiguration#addAllowedMethod(java.lang.String)
could be displayed as:
CorsConfiguration#addAllowedMethod(String)
and link to:
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/cors/CorsConfiguration.html#addAllowedMethod-java.lang.String-

A frequent mistake is to forget the trailing / for Javadoc base URLs.
i.e.
javax=https://jakarta.ee/specifications/platform/8/apidocs
instead of
javax=https://jakarta.ee/specifications/platform/8/apidocs/

It would be nice if the plugin would auto-correct that mistake/be more flexible, rather than ending with a broken Javadoc link.

Hello

apidoc seems to be broken when the javadoc is generated with the option that lays out the module inside the javadoc

When using the following following form `java.logging.Handler', apidoc generates the following link for the oracle website (using my configuration) : https://docs.oracle.com/en/java/javase/11/docs/api/java/util/logging/Handler.html
However, this has changed and the link above is broken: the module name whose java.logging.Handler belongs to is now used in the URI path of the resource it's the following :
https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/package-summary.html

Implementation idea :
module information is accessible using reflection, so it would be easy for any class of the JDK to layout the module in the javadoc.
However for other third-parties, access to the runtime classpath of the application is needed to generate the documentation