Подавление предупреждений Javadoc 21 DocLint специально для «нет основного описания»JAVA

Программисты JAVA общаются здесь
Ответить
Anonymous
 Подавление предупреждений Javadoc 21 DocLint специально для «нет основного описания»

Сообщение Anonymous »

Я только что обновил свою сборку с Java 17 до Java 21. В Maven у меня для Javadoc установлено значение DocLint, все с использованием параметра компилятора Maven Javadoc Plugin -Xlint:all.
Как это обычно бывает с классами Java, у меня есть множество геттеров в следующей форме:

Код: Выделить всё

  /** @return foo. */
public Foo getFoo() {
return foo;
}
В Java 17 Javadocs создавалась просто отлично. Теперь в Java 21 я получаю следующее предупреждение (их очень много!) по всей моей большой базе кода:

Код: Выделить всё

warning: no main description
Кажется, Javadoc теперь хочет, чтобы я это сделал:

Код: Выделить всё

  /**
* Returns foo.
* @return foo.
*/
public Foo getFoo() {
return foo;
}
Мне трудно понять полезность этого нового предупреждения. Я хотел бы подавить это предупреждение в конфигурации для всего проекта.
Я думаю, что смогу отключить всю группу DocLint, используя -Xdoclint all,-missing, но это подавлять все предупреждения, связанные с отсутствием документации Javadoc. Я определенно хочу получить предупреждение, если я вообще оставлю Javadoc для получения информации!
Как я могу подавить только предупреждение Javadoc DocLint, связанное с отсутствует «основное описание», если @return тем не менее присутствует? В качестве альтернативы, если это невозможно, как лучше всего сообщить команде Javadoc, что добавление все большего и большего количества бессмысленных предупреждений, которые невозможно подавить индивидуально в какой-то момент даже у этих пользователей (например, я), которым нравится держать нашу документацию по API очень аккуратной, чтобы вообще отказаться от пользователя линтера?
Хотя я понимаю, что кто-то просто отключит линтер полностью, я' лучше быть более конкретным.
См. также мой отдельный (связанный) вопрос. Отключите предупреждение об отсутствии комментария в документе Java 17 только для перечислений в плагине Maven Javadoc.

Подробнее здесь: https://stackoverflow.com/questions/775 ... escription
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «JAVA»