[
https://issues.apache.org/jira/browse/LENS-824?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Raju Bairishetti updated LENS-824:
----------------------------------
Description:
Creating this jira to find and fix the javadoc warnings and errors.
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>*
was:Creating this jira to find and fix the javadoc warnings and errors.
> Fix all javadoc warnings/errors
> -------------------------------
>
> Key: LENS-824
> URL: https://issues.apache.org/jira/browse/LENS-824
> Project: Apache Lens
> Issue Type: Task
> Components: build
> Reporter: Raju Bairishetti
> Labels: newbie
> Fix For: 2.5
>
>
> Creating this jira to find and fix the javadoc warnings and errors.
> 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)
