#650 Checkstyle is unable to understand complex generic usages for JavaDoc

release_1.0
open
Oliver Burn
5
2014-02-09
2011-08-10
Lucas
No

Checkstyle is unable to understand complex generic usages and is unable to distinguish the parameters from the method signature.
This is the test case:

One interface and one class

public interface Foo<T> {}

public abstract class Shell<S> {
  /**
   * Does something.
   * @param callable This is a param.
   * @return This is a result.
   * @throws IOException This is an exception.
   */
  protected <R, T extends Foo<S> & Callable<? extends R>> R bar(final T callable)
      throws IOException {
    return null;
  }
}

In this case, even if all the Javadocs are present for all the parameters, I get this error

Expected @param tag for ''.

Thanks

Discussion

  • Roman Ivanov
    Roman Ivanov
    2013-11-05

    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -3,6 +3,7 @@
    
     One interface and one class
    
    +:::java
     public interface Foo<T> {}
    
     public abstract class Shell<S> {
    
    • Group: --> release_1.0
     
  • Roman Ivanov
    Roman Ivanov
    2013-11-05

    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -3,7 +3,7 @@
    
     One interface and one class
    
    -:::java
    +~~~~~~
     public interface Foo<T> {}
    
     public abstract class Shell<S> {
    @@ -18,7 +18,7 @@
         return null;
       }
     }
    -
    +~~~~~~
    
     In this case, even if all the Javadocs are present for all the parameters, I get this error
    
     
  • Roman Ivanov
    Roman Ivanov
    2013-11-05

    • summary: Checkstyle is unable to understand complex generic usages --> Checkstyle is unable to understand complex generic usages for JavaDoc
     
  • Roman Ivanov
    Roman Ivanov
    2014-02-06

    • labels: Tests --> Tests, JavaDoc