[MJAVADOC-387] Handle JDK8 -Xdoclint

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Implemented
• Affects Version/s: 2.10.4
• Fix Version/s: 3.0.0-M1, 3.0.0
• Component/s: javadoc
• Assignee: Michael Osipov
• Reporter: scolebourne2
• Created: 08/Feb/14 15:31
• Updated: 24/Jul/17 19:30
• Resolved: 15/Oct/16 17:39

Description

The Oracle team have added the doclint tool to JDK 8. The tool validates Javadoc as part of a standard Javadoc run. Unfortunately, with the default settings, it rejects many HTML elements that are perfectly acceptable to browsers, and all invalid Javadoc references (@links). This is likely to prove very unpopular with developers.

Action needed:
1) Provide a maven-javadoc-plugin configuration item and property that can control the doclint tool (currently this requires using additionalparam AFAICT).

2) Apply the -Xdoclint:none option by default, so that doclint is opt-in, not opt-out (ie. fix Oracle's messed up default). This will also make it much easier for developers to handle migration to JDK 8.

Issue Links

• depends upon: MJAVADOC-368 Can not use a comma (,) in option additionalparam
• relates to: MNG-5551 check that everything compile and run fine with Java 8