maven-javadoc-плагин не принимает <additionalparam>-Xdoclint: нет </additionalparam> - PullRequest
Новая
       15

maven-javadoc-плагин не принимает <additionalparam>-Xdoclint: нет </additionalparam>

0 голосов
/ 28 сентября 2018

A mvn release:perform не работает из-за того, что не создаются Javadocs.Поэтому я попытался запустить 

mvn javadoc:javadoc

сам и вижу, что он не работает из-за комментариев javadoc в исходном коде, не имеющих определения для всех параметров и возвращаемых значений.Ошибки имеют формат: 

Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:jar (attach-javadocs) on project my-project: MavenReportException: Error while generating Javadoc:

Exit code: 1 - /my/file.java:36: warning: no description for @return

Это, однако, используется для работы.Так что же изменилось?

Я проверил документацию по maven-javadoc-plugin, и теперь (в версии 3.0) говорится, что параметр - это не AdditionalParam или Additionalparam, а AdditionalOptions и AdditionalJOptions.См. Документацию maven-javadoc-plugin .

Когда я искал параметр AdditionalParam, он не появляется.Я запутался, как это могло сработать.В поисках ответов некоторые люди говорят, что они используют то, что я использую, другие говорят, что они используют дополнительные JOption.См. Maven не работает в Java 8, когда теги Javadoc неполны .

Как это исправить?

Есть идеи о том, что вызвало проблему и какчтобы исправить это?

Что я пробовал

К счастью, я нашел работу, которая должна была отключить Javadoc linting из командной строки: 

mvn release:perform -Darugments="-Dmaven.javadoc.skip=true"

Kudo на code.i-harness.com публикует , который дал мне эту работу вокруг.

Итак, я прошел первоначальную проблему, но хочу / нужно очистить помпы, чтобы удалить ненужные параметры, или изменить их на новый / правильный синтаксис (еще не проверенный).

Поиски, которые были полезны

Поиск по SO дает эти полезные хиты:

1 Ответ

0 голосов
/ 28 сентября 2018

Вместо этого следует использовать параметр doclint : 

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.1</version>
    <configuration>
        <doclint>none</doclint>
    </configuration>
</plugin>

Это пропустит все проверки.Как правило, я бы порекомендовал запустить все проверки, за исключением отсутствия @return и @param.Таким образом, вместо none вы можете использовать: 

        <doclint>all,-missing</doclint>

Отдельные группы проверок могут быть включены или выключены (как -missing выше).Подробное описание групп можно найти в документации javadoc (внизу страницы).

...