How to work around the stricter Java 8 Javadoc when using Maven
For now, the easiest way I know to work around the stricter Java 8 Javadoc when using Maven is deactivating it.
Since the parameter -Xdoclint:none
only exists in Java 8, defining this parameter breaks the build for any other Java. To prevent this, we can create a profile that will be active only for Java 8, making sure our solution works regardless of the Java version.
<profiles>
<profile>
<id>disable-java8-doclint</id>
<activation>
<jdk>[1.8,)</jdk>
</activation>
<properties>
<additionalparam>-Xdoclint:none</additionalparam>
</properties>
</profile>
</profiles>
Just add that to your POM and you're good to go.
For maven-javadoc-plugin 3.0.0 users:
Replace
<additionalparam>-Xdoclint:none</additionalparam>
by
<doclint>none</doclint>
Thanks @banterCZ!
Note that for the error no summary or caption for table
, using <table summary="">
won't work anymore. If that's your situation, add a <caption>
element to your table, like this:
<table>
<caption>Examples</caption>
...
</table>
Hope this helps someone out there. It took me a while until I found this out.
If you are using the maven javadoc plugin, you can use the failOnError
option to prevent it from stopping if it finds any html errors:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<failOnError>false</failOnError>
</configuration>
</plugin>
Or you can deactivate the strict html options completely with:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
</plugins>
For more info.