[
https://issues.apache.org/jira/browse/LENS-493?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14589210#comment-14589210
]
Raju Bairishetti commented on LENS-493:
---------------------------------------
[~raghavendra.singh] Thanks for pointing put.
This patch does not work for < java8. It works for only higher
versions(>=1.8).
We can fix all the errors in the javadocs as a permanent fix.
Until we fix all errors in javadocs, we can maintain one more profile with
javadoc-lint such that profile can be activated only if it is java8 (>=8).
{code}
diff --git a/pom.xml b/pom.xml
index 6335ca5..94ee377 100644
--- a/pom.xml
+++ b/pom.xml
@@ -335,7 +335,7 @@
<version>${javadoc.plugin.version}</version>
<inherited>false</inherited>
<configuration>
- <additionalparam>-Xdoclint:none</additionalparam>
+ <additionalparam>${javadoc.doclint.none}</additionalparam>
</configuration>
<reportSets>
<reportSet>
@@ -1322,5 +1322,14 @@
</plugins>
</build>
</profile>
+ <profile>
+ <id>java8-disable-strict-javadoc</id>
+ <activation>
+ <jdk>[1.8,)</jdk>
+ </activation>
+ <properties>
+ <javadoc.doclint.none>-Xdoclint:none</javadoc.doclint.none>
+ </properties>
+ </profile>
{code}
> Errors while generating javadoc on java8
> ----------------------------------------
>
> Key: LENS-493
> URL: https://issues.apache.org/jira/browse/LENS-493
> Project: Apache Lens
> Issue Type: Sub-task
> Components: build
> Reporter: Raju Bairishetti
> Assignee: Raju Bairishetti
> Fix For: 2.2
>
> Attachments: LENS-493.patch
>
>
> With JDK 8, we are unable to get Javadoc unless your tool meets the standards
> of doclint. Some of its rules are:
> {noformat}
> no self-closed HTML tags, such as <br /> or <a id="x" />
> no unclosed HTML tags, such as <ul> without matching </ul>
> no invalid HTML end tags, such as </br>
> no invalid HTML attributes, based on doclint's interpretation of W3C HTML 4.01
> no duplicate HTML id attribute
> no empty HTML href attribute
> no incorrectly nested headers, such as class documentation must have <h3>,
> not <h4>
> no invalid HTML tags, such as List<String> (where you forgot to escape using
> <)
> no broken @link references
> no broken @param references, they must match the actual parameter name
> no broken @throws references, the first word must be a class name
> {noformat}
> We don't get any output if it breaks any of the above rule. It throws errors.
> We can turn off doclint by configuring the following propery for javadoc
> plugin
> *<additionalparam>-Xdoclint:none</additionalparam>*
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
