search

j8unit-team / j8unit

Enhancement for JUnit4 to take advantage of Java 8
4 stars 2 forks source link

How to Javadoc @link to Union Types? #19

Open ghostcity opened 7 years ago

ghostcity commented 7 years ago

It looks like there is a problem with @link'ing to methods with Union Types. Consider the following method signature (of org.j8unit.generator.analysis.AccessScope):

public final <Renderer extends OriginRenderer & TargetRenderer> String getTestInterfaceSuperTypeDefinition(
    final Renderer renderer,
    final Entry<? extends Class<?>, ? extends Type> superType
) {
    [...]

The execution of javadoc causes a warning like this:

[...]
[WARNING] /home/sgasterstaedt/Projects/ghostcity/j8unit/tools/src/main/java/org/j8unit/generator/analysis/AccessScope.java:58: warning - Tag @link: can't find getTestInterfaceSuperTypeDefinition(OriginRenderer, Entry) in org.j8unit.generator.analysis.AccessScope
[...]

What can we do here?

ghostcity commented 7 years ago

Mmhhh,

the following @link declarations dont work neither:

 * <li>{@link #getTestInterfaceSuperTypeDefinition(Object, Entry)}</li>
 * <li>{@link #getTestInterfaceSuperTypeDefinition(OriginRenderer, Entry)}</li>
 * <li>{@link #getTestInterfaceSuperTypeDefinition(TargetRenderer, Entry)}</li>
 * <li>{@link #getTestInterfaceSuperTypeDefinition(Renderer, Entry)}</li>