如何在Maven Javadoc插件中禁用Javadoc警告？

Question

我正在使用Maven Javadoc插件.它输出如下警告:

[ERROR] /home/monperrus/spoon/src/main/java/spoon/visitor/CtVisitor.java:144:
      warning: no @param for <T>

如何将这些警告显示为[WARNING](而不是令人困惑[ERROR])？

Answer 1

如何将这些警告显示为[警告](而不是混淆[错误])？如何在Maven中完全禁用Javadoc警告？

如果您正在讨论Java 8中引入的javadoc lint警告,那么您应该能够执行以下操作.根据您使用的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>

看到关于关闭doclint的这个好讨论.

如果您只是想摆脱丢失的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>

Answer 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]"前缀.

Answer 3

您也可以从命令行禁用它,以防您只想本地抑制但不编码.

mvn clean install -Dadditionalparam=-Xdoclint:none

正如Spring Monkey指出的那样,在较新的版本中你可能需要将其传递给

mvn clean install -DadditionalJOption=-Xdoclint:none

Answer 4

从 v3.0.0 开始，doclint添加了新的配置选项来配置文档 linting。这可以用来抑制这些警告。

<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>

对于 < 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>

Answer 5

从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参数文件。