Как отключить предупреждения Javadoc в Maven Javadoc Plugin?

Ответ 1

  Как отобразить эти предупреждения как [ПРЕДУПРЕЖДЕНИЕ] (а не сбивающий с толку [ОШИБКА])? Как полностью отключить предупреждения Javadoc в Maven?

Если вы говорите о предупреждениях javadoc lint, введенных в Java 8, то вы должны быть в состоянии сделать следующее. Есть несколько способов указать параметры в зависимости от того, какую версию плагина javadoc вы используете.

<plugins>
   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
         <additionalparam>-Xdoclint:none</additionalparam>
         <additionalOptions>-Xdoclint:none</additionalOptions>
         <additionalJOption>-Xdoclint:none</additionalJOption>
      </configuration>
   </plugin>
</plugins>

Посмотрите эту хорошую дискуссию об отключении доклинта.

Если вы просто хотите избавиться от отсутствующих предупреждений Jacadocs, вы можете использовать:

<configuration>
   <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
   <additionalOptions>-Xdoclint:all -Xdoclint:-missing</additionalOptions>
   <additionalJOptions>
     <additionalJOption>-Xdoclint:all</additionalJOption>
     <additionalJOption>-Xdoclint:-missing</additionalJOption>
   </additionalJOptions>
</configuration>

Ответ 2

maven-javadoc-plugin версии 2.9 и выше, установка Additionalparam, похоже, не работает. Новый параметр, который необходимо установить, - AdditionalJOption (см. документацию). Пример здесь:

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
            <additionalJOption>-Xdoclint:none</additionalJOption>
        </configuration>
   </plugin>

Обратите внимание, что предупреждение по-прежнему отображается в консоли, но не с запутанным префиксом [ERROR].

Также обратите внимание, что согласно коду maven-javadoc-plugin, если есть хотя бы одна ошибка Javadoc, все строки журнала будут иметь префикс [ERROR].

Ответ 3

Вы также можете отключить его из командной строки, если вы просто хотите локально подавить, но не кодифицировать.

mvn clean install -Dadditionalparam=-Xdoclint:none

как Spring Обезьяна указывает, что в новых версиях вам может потребоваться передать ее как

mvn clean install -DadditionalJOption=-Xdoclint:none

Ответ 4

Начиная с версии 3.0.0 maven-javadoc-plugin вы можете использовать параметр конфигурации doclint. Если вы просто хотите отключить "пропущенные" предупреждения, используйте all,-missing:

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

Для получения дополнительной информации см. документацию по параметру doclint.

Ответ 5

Компилируя все ответы и добавляя что-то еще, мы получаем следующее.

Чтобы настроить проект maven, вы должны добавить это в файл pom:

<plugins>
   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
         <additionalparam>-Xdoclint:none</additionalparam>
         <additionalJOption>-Xdoclint:none</additionalOptions>
      </configuration>
   </plugin>
</plugins>

Для Maven 2. 9+ вам нужна additionalJOption опция, а до этого вам нужна additionalparam пара. Вы можете иметь additionalparam в Maven 2. 9+, так как он не вызовет ошибок, но не заставит его работать. Я не проверял наличие additionalJOption JOption на более ранних версиях Maven.

Чтобы настроить его из командной строки, вы должны передать этот параметр:

mvn <goals> -Dadditionalparam=-Xdoclint:none -DadditionalJOption=-Xdoclint:none

Чтобы настроить его в своей среде оболочки, чтобы он применялся каждый раз к каждому проекту без необходимости делать что-либо еще, добавьте эту строку в инициализацию вашей оболочки (~/.bashrc или на Macs ~/.bash_profile, или что угодно еще оболочка использует):

export JAVA_TOOL_OPTIONS="-Dadditionalparam=-Xdoclint:none -DadditionalJOption=-Xdoclint:none"

Или, если у вас есть JAVA_TOOL_OPTIONS, добавьте эти параметры к нему.

Ответ 6

Начиная с версии 3.0.0 добавлена новая опция конфигурации doclint для настройки связывания документов. Это может быть использовано для подавления этих предупреждений.

<plugins>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.1.1</version>
    <configuration>
      <doclint>none</doclint>  <!-- Turnoff all checks -->
    </configuration>
    <executions>
      <execution>
        <id>attach-javadocs</id>
        <goals>
          <goal>jar</goal>
        </goals>
      </execution>
    </executions>
  </plugin>
</plugins>

Для & lt; v3.0.0, используйте, как упоминалось в предыдущих ответах

<plugins>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
      <additionalparam>-Xdoclint:none</additionalparam>  <!-- Turnoff all checks -->
    </configuration>
    <!-- executions.... -->
  </plugin>
</plugins>