Details
-
Improvement
-
Status: Resolved
-
Minor
-
Resolution: Won't Fix
-
None
-
None
-
None
-
None
Description
Compiling Oozie with JDK8 results in a lot of doclint warnings:
85 warnings [WARNING] Javadoc Warnings [WARNING] /Users/asasvari/workspace/apache/oozie/client/src/main/java/org/apache/oozie/cli/CLIParser.java:67: warning: no description for @param [WARNING] * @param hasArguments [WARNING] ^ [WARNING] /Users/asasvari/workspace/apache/oozie/client/src/main/java/org/apache/oozie/cli/OozieCLI.java:549: warning: no @param for jobType [WARNING] protected Options createScriptLanguageOptions(String jobType) {
and warnings about HTML entries like
[WARNING] /Users/asasvari/workspace/apache/oozie/client/src/main/java/org/apache/oozie/client/OozieClient.java:76: warning: empty <p> tag [WARNING] * <p> [WARNING] ^
Java 8 Javadoc is stricter than previous versions, and in certain cases it is more annoying than useful. With -Xdoclint:none it can disabled.
As -Xdoclint only exists for java8, we shall not pass it to earlier java versions.
To do this, a new profile can be added that is activated for JDK8+:
<profile>
<id>disable-doclint</id>
<activation>
<jdk>[1.8,)</jdk>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
</plugins>
</build>
</profile>
Attachments
Attachments
Issue Links
- is related to
-
OOZIE-2681 fix javadoc to compile on JDK8 again
-
- Closed
-