Attila Sasvari created OOZIE-2832:
-------------------------------------
Summary: Turn off doclint in JDK 8 Javadoc
Key: OOZIE-2832
URL: https://issues.apache.org/jira/browse/OOZIE-2832
Project: Oozie
Issue Type: Improvement
Reporter: Attila Sasvari
Priority: Minor
Compiling Oozie with JDK8 results in a lot of doclint warnings:
{code}
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) {
{code}
and warnings about HTML entries like
{code}
[WARNING]
/Users/asasvari/workspace/apache/oozie/client/src/main/java/org/apache/oozie/client/OozieClient.java:76:
warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
{code}
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+:
{code}
<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>
{code}
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
