You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@jclouds.apache.org by Andrew Gaul <no...@github.com> on 2014/07/19 01:55:03 UTC

[jclouds] Allow Javadoc to reference imports (#446)

These style errors continue to creep in due to IDE misconfiguration so
we might as well stop checking for it.
You can merge this Pull Request by running:

  git pull https://github.com/andrewgaul/jclouds unused-imports-javadoc

Or you can view, comment on it, or merge it online at:

  https://github.com/jclouds/jclouds/pull/446

-- Commit Summary --

  * Allow Javadoc to reference imports

-- File Changes --

    M resources/checkstyle.xml (4)

-- Patch Links --

https://github.com/jclouds/jclouds/pull/446.patch
https://github.com/jclouds/jclouds/pull/446.diff

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by BuildHive <no...@github.com>.
[jclouds ยป jclouds #1389](https://buildhive.cloudbees.com/job/jclouds/job/jclouds/1389/) ABORTED

[(what's this?)](https://www.cloudbees.com/what-is-buildhive)

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446#issuecomment-49496917

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by Andrew Gaul <no...@github.com>.
Closed #446.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446#event-145936153

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-java-7-pull-requests #1479](https://jclouds.ci.cloudbees.com/job/jclouds-java-7-pull-requests/1479/) FAILURE
Looks like there's a problem with this pull request

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446#issuecomment-49499345

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-pull-requests #1008](https://jclouds.ci.cloudbees.com/job/jclouds-pull-requests/1008/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446#issuecomment-49494835

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by Andrew Phillips <no...@github.com>.
> @@ -42,7 +42,9 @@
>          </module>
>          <module name="SimplifyBooleanExpression"/>
>          <module name="UnnecessaryParentheses"/>
> -        <module name="UnusedImports"/>
> +        <module name="UnusedImports">
> +            <property name="processJavadoc" value="true"/>
> +        </module>

This _enables_ or _disables_ checking? From the description, I'm not sure whether you're suggesting adding or removing this check?

Personally, it seems like a reasonable check to have? Or does it cause too much overhead?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446/files#r15143300

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by Andrew Phillips <no...@github.com>.
> @@ -42,7 +42,9 @@
>          </module>
>          <module name="SimplifyBooleanExpression"/>
>          <module name="UnnecessaryParentheses"/>
> -        <module name="UnusedImports"/>
> +        <module name="UnusedImports">
> +            <property name="processJavadoc" value="true"/>
> +        </module>

> This commit allows Javadoc to reference imports, i.e., partially disables the check.

Ah, OK, thanks for explaining. [From the docs](http://checkstyle.sourceforge.net/config_imports.html) I think I now understand what this does.

Looks like something is [in the works](https://bugs.eclipse.org/bugs/show_bug.cgi?id=128661) for Eclipse, but +1 to merge this in the meantime. Thanks, @andrewgaul!


---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446/files#r15150938

Re: [jclouds] Allow Javadoc to reference imports (#446)

Posted by Andrew Gaul <no...@github.com>.
> @@ -42,7 +42,9 @@
>          </module>
>          <module name="SimplifyBooleanExpression"/>
>          <module name="UnnecessaryParentheses"/>
> -        <module name="UnusedImports"/>
> +        <module name="UnusedImports">
> +            <property name="processJavadoc" value="true"/>
> +        </module>

This commit allows Javadoc to reference imports, i.e., partially disables the check.  I prefer the existing behavior, i.e., warning about imports only referenced by Javadoc.  The Checkstyle manual also suggests this:

> Optionally: it is referenced in Javadoc comments. This check is off by default, as it is considered bad practice to introduce a compile time dependency for documentation purposes only. As an example, the import java.util.Date would be considered referenced with the Javadoc comment {@link Date}. The alternative to avoid introducing a compile time dependency would be to write the Javadoc comment as {@link java.util.Date}.

However, I do not know which IDE configuration to recommend to stop people from introducing these violations.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds/pull/446/files#r15147078