Java 11 javadoc fixes. Turn on failOnError #1386
Conversation
…s part of site lifecycle
| @@ -274,7 +270,7 @@ | |||
| <dependency> | |||
| <groupId>javax.activation</groupId> | |||
| <artifactId>javax.activation-api</artifactId> | |||
| <scope>runtime</scope> | |||
| <scope>compile</scope> | |||
There was a problem hiding this comment.
Is the scope change needed ?
There was a problem hiding this comment.
java.xml.bind requires java.activation, so java.activation needs to be on the module-path. To get the compiler plugin to do that I needed to change to compile scope. I have updated the jpa-cdi module-info and removed the requires java.activation since this module (jpa-cdi) does not require java.activation.
| @@ -28,6 +28,10 @@ | |||
| <artifactId>helidon-jersey-media-jsonp</artifactId> | |||
| <name>Helidon Jersey Media JSON-P</name> | |||
|
|
|||
| <properties> | |||
| <maven.javadoc.skip>true</maven.javadoc.skip> | |||
There was a problem hiding this comment.
This should probably not be skipped.
There was a problem hiding this comment.
These modules have no source to document. They already create empty javadoc jars. They are just bundle modules. I have verified javadoc won't run with just module-info. So this skip excludes them from the aggregated javadoc.
| @@ -28,6 +28,10 @@ | |||
| <artifactId>helidon-jersey-server</artifactId> | |||
| <name>Helidon Jersey Server</name> | |||
|
|
|||
| <properties> | |||
| <maven.javadoc.skip>true</maven.javadoc.skip> | |||
There was a problem hiding this comment.
This should probably not be skipped.
barchetta
changed the title
…e-image-extension
This PR does gets javadocs building on Java 11 (see issue #1223). To do so I broke cross reference links to third party javadocs. We will need to fix that later. But this gets javadocs building again. Here is a summary of the changes:
Comment out the configuration for links (
offlineLinks). Because we are generating Java 11 javadocs there are various issues withclass-pathandmodule-pathhygiene (plus the infamous Java 11 javadoc bug). So for now, we avoid that rat's nest. This means those cross-reference links are broken, but at least we have javadocs.Fix and add
module-infofiles as needed so themaven-javadoc-pluginpasses a correct module-path to javadoc. This usually meant addingrequirestatements.Switch to use the javadoc aggregate goal as part of the site lifecycle to build aggregated javadocs
Fix basic javadoc errors
Still working on an issue, where the aggregate goal does not work well unless the maven artifacts have already been built (it gets the module-path wrong). So for now we build the aggregated javadocs after the main build.
To build the aggregated javadocs you now run:
mvn site -Dversion.plugin.javadoc=3.2.0 -DskipTests -PjavadocIt will generate the aggregated javadocs and the documentation. This currently requires you to build version 3.2.0 of the
maven-javadoc-pluginyourself. We expect it to be released any day now so that hack will be removed shortly.