Неизвестный ТИП тега Javadoc с универсальными

#java #generics #javadoc

Вопрос:

У меня есть метод с javadoc:

 /**
 * Supplier interface mixed with {@link ServiceCast}.
 * @param <R> is <TYPE> of supplier.
 */
public interface ServiceCastSupplier<R> extends ServiceCast, Supplier<R> {

}
 

в конвейере я получаю ошибку:

 error: unknown tag: TYPE
[ERROR]      * @param <R> is <TYPE> of supplier
 

r.

почему это не нравится <R> , что в этом плохого?

Комментарии:

1. Дело <TYPE> в том, что ему это не нравится. Это не одна из переменных типа.

2. Попробуйте, @literal если вам нужно, чтобы это отображалось с помощью угловых скобок.

Ответ №1:

Идеальным решением было бы изменить документацию на

 /**
 * Supplier interface mixed with {@link ServiceCast}.
 * @param <R> is the type of supplier.
 */
 

т. е. <TYPE> полностью удалите, как это делает стандартная библиотека, если только она не имеет важного значения для вашего кода.

Если вам действительно нужно показать угловые скобки, вы можете использовать {@literal}

 /**
 * Supplier interface mixed with {@link ServiceCast}.
 * @param <R> is {@literal <TYPE>} of supplier.
 */