[LENS-824] Fix all javadoc warnings/errors

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.5
• Component/s: build
• Labels: newbie
• Assignee: Gabor Liptak
• Reporter: Raju Bairishetti
• Created: 15/Oct/15 04:44
• Updated: 22/Feb/16 04:21
• Resolved: 16/Nov/15 06:10

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:

---

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 &lt;)
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

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>

Issue Links

• is related to: LENS-493 Errors while generating javadoc on java8