Checkstyle preference on imports for javadocs

[Sean Busbey <bu...@cloudera.com>]

I'm going through our checkstyle warnings to try to bring things down.

Once of the things getting flagged is unused imports for imports that are
only used in javadocs.

The checkstyle docs on this[1] recommend using fully qualified class names
in such javadocs to avoid introducing a compile dependency just for docs.

I can either update our checkstyle config to count these imports as used,
or I can update our usage guide and the current violators.

Do we have a preference for either of these options?

[1]: http://checkstyle.sourceforge.net/config_imports.html#UnusedImports
-- 
Sean

Re: Checkstyle preference on imports for javadocs

[Ted Yu <yu...@gmail.com>]

bq. update our checkstyle config to count these imports as used

I would vote for the above option.

On Tue, Nov 18, 2014 at 10:38 AM, Sean Busbey <bu...@cloudera.com> wrote:

> I'm going through our checkstyle warnings to try to bring things down.
>
> Once of the things getting flagged is unused imports for imports that are
> only used in javadocs.
>
> The checkstyle docs on this[1] recommend using fully qualified class names
> in such javadocs to avoid introducing a compile dependency just for docs.
>
> I can either update our checkstyle config to count these imports as used,
> or I can update our usage guide and the current violators.
>
> Do we have a preference for either of these options?
>
> [1]: http://checkstyle.sourceforge.net/config_imports.html#UnusedImports
> --
> Sean
>