[jira] [Commented] (ACCUMULO-4102) clean up javadoc errors under jdk8 linter

["Christopher Tubbs (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ACCUMULO-4102?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15090081#comment-15090081 ] 

Christopher Tubbs commented on ACCUMULO-4102:
---------------------------------------------

So, I started looking into this and ran into a few problems. First, the default doclint setting for the plugin appears to be {{all}}, which includes {{accessibility}}, {{html}}, {{missing}}, {{reference}}, and {{syntax}} (see {{javadoc -X}} with JDK8).

I'd have to look more closely at the errors from the other checks, but so far, I'm pretty sure we don't want {{missing}} at all. We don't care if standard tags are missing (they would be helpful... but not that important), otherwise we'd have enabled this with checkstyle awhile ago. So, we can just turn that one off. Unfortunately, I ran into MJAVADOC-368.

Even if we fix all the issues, then we'd still run into MPLUGIN-244. This was fixed in the 3.3 versions of the plugins, but (as I understand it) Maven 3.3 won't work with JDK1.6, so we'd be setting up users for failure if we switch to that, because then the plugin we create would only work on JDK 1.7 or later (with Maven 3.3 or later). An alternative solution is to exclude these generated HelpMojo classes from the javadoc. Maybe that's fine... but it might be better to just turn off all checks with ACCUMULO-4101 ({{-Xdoclint:none}}) or just limit ourselves to a single doclint group ({{-Xdoclint:syntax}}?) to check when generating with JDK8.

Thoughts?

> clean up javadoc errors under jdk8 linter
> -----------------------------------------
>
>                 Key: ACCUMULO-4102
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-4102
>             Project: Accumulo
>          Issue Type: Sub-task
>          Components: build, docs
>            Reporter: Sean Busbey
>            Assignee: Christopher Tubbs
>              Labels: beginner
>             Fix For: 1.6.5, 1.7.1, 1.8.0
>
>
> ACCUMULO-4101 disabled the jdk8 javadoc linter so we could build with java 8 in the short term.
> This ticket tracks removing the java 8 specific profile and correcting all of the javadoc errors needed to run javadoc.
> To ease implementation, I'd recommend whoever handles this make sub-tasks per module.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)