-
Notifications
You must be signed in to change notification settings - Fork 418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Publish javadoc for other picocli modules #1298
Comments
The io.freefair.aggregate-javadoc gradle plugin may also be useful. (See also this StackOverflow answer).
To resolve the "package not visible" errors when building with Java 11, perhaps this is needed:
Maybe need to check https://github.com/freefair/gradle-plugins/blob/master/maven-plugin/src/main/java/io/freefair/gradle/plugins/maven/javadoc/ResolveJavadocLinks.java Raised issue freefair/gradle-plugins#486 for problem when building with Java 8. Raised issue #487 for problem when building with Java 11. |
|
It may be possible to do the compile tasks with Java 8, and the Javadoc tasks with Java 11, using Gradle's toolchain feature: https://blog.gradle.org/java-toolchains Generating multi-module JPMS javadoc: https://stackoverflow.com/questions/53973319/how-to-generate-javadoc-for-multiple-modules Potentially useful for dealing with non-modular dependencies:
|
As mentioned in #1296, the API Docs for the package
picocli.groovy
are not up-to-date: The Groovy classes were previously in the main picocli jar, now they are in a separatepicocli-groovy
jar. These javadoc pages are still there from when these classes were in the picocli jar.This task is to publish Javadoc for the other jars, not just for the picocli jar, but for all of these:
picocli
picocli-codegen
picocli-groovy
picocli-shell-jline2
picocli-shell-jline3
picocli-spring-boot-starter
One idea to deal with this is to generate javadoc for each module and copy them to subdirectories of
${PROJECT-DIR}/build/docs/apidoc
in thecopyDocs
task inbuild.gradle
. This would leave them as independent sets of documents, so we need to link to their top-level pages from the user manual and project README.An alternative idea is to treat the picocli modules like Java 9 Modules and use the Java 9+ javadoc tool to generate a single interlinked set of api documents for all picocli modules.
The latter idea would introduce a dependency on Java 9 or later. Currently only Java 8 is required to build picocli. I am not sure that I want to require Java 9+ to build the project. It would be good to explore if building a single integrated set of javadoc documents can be done optionally only if the current Java version is 9 or higher.
https://xy2401.com/local-docs/oracle/java/11/javadoc/javadoc-command.html#GUID-EFE927BC-DB00-4876-808C-ED23E1AAEF7D
http://tutorials.jenkov.com/java/modules.html#migrating-to-java-9
https://github.com/tfesenko/Java-Modules-JPMS-CheatSheet
https://www.oracle.com/corporate/features/understanding-java-9-modules.html
The text was updated successfully, but these errors were encountered: