[ 
https://jira.codehaus.org/browse/MJAVADOC-387?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=354907#comment-354907
 ] 

Thomas Vestergaard commented on MJAVADOC-387:
---------------------------------------------

While I appreciate the goal of {{doclint}} to improve the quality of JavaDoc 
HTML, I really disapproves of Oracles chosen approach of trying to force 
developers to adhere to some random standard without any warning or burn-in 
period - i.e. we had never heard of {{doclint}} before it broke our 
release-build. (Imagine telling your manager, that the build-error was because 
the generated documentation would not have been valid HTML...)
The preferred solution for either {{doclint}} or the JavaDoc-plugin would be to 
simply output these validations as warnings rather than hard errors. But since 
this is not an option (Oracle ain't budging), I support that the desired 
behaviour of the Maven JavaDoc plugin should be to disable these validation by 
default.

> Handle JDK8 -Xdoclint
> ---------------------
>
>                 Key: MJAVADOC-387
>                 URL: https://jira.codehaus.org/browse/MJAVADOC-387
>             Project: Maven Javadoc Plugin
>          Issue Type: Improvement
>            Reporter: Stephen Colebourne
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.1.6#6162)

Reply via email to