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

b4qexyjb  于 12个月前  发布在  Maven
关注(0)|答案(7)|浏览(168)

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

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

字符串
如何不显示这些警告?

njthzxwz

njthzxwz1#

maven-javadoc-plugin的3.0.0版本开始,您可以使用doclint配置参数。如果您只想禁用“missing”警告,请使用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参数文档。

xxe27gdn

xxe27gdn2#

如何将这些警告显示为[错误](而不是令人困惑的[ERROR])?如何在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>

字符串
看看这个good discussion about turning off 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>

mwg9r5ms

mwg9r5ms3#

maven-javadoc-plugin 2.9版以后,设置additionalparam似乎不起作用。需要设置的新选项是additionalJOption(参见documentation)。这里有一个例子:

<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]为前缀。

oiopk7p5

oiopk7p54#

如果只想在本地抑制而不编码,也可以从命令行禁用它。

mvn clean install -Dadditionalparam=-Xdoclint:none

字符串
正如Spring Monkey指出的那样,在较新的版本中,您可能必须将其作为

mvn clean install -DadditionalJOption=-Xdoclint:none

qvtsj1bj

qvtsj1bj5#

从v3.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>

字符串
对于< 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>

pw9qyyiw

pw9qyyiw6#

编译所有的答案,并添加其他东西,我们有以下内容。

  • 要配置maven项目 *,您应该将以下内容添加到pom文件中:
<plugins>
   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
         <additionalJOption>-Xdoclint:none</additionalJOption>
      </configuration>
   </plugin>
</plugins>

字符串
对于Maven 2.9+,你需要additionalJOption,在此之前你需要additionalparam。你可以在Maven 2.9+上使用additionalparam,因为它不会导致错误,但它不会使它工作。我没有在早期版本的maven上测试additionalJOption

  • 要从命令行配置它 *,您应该传递此参数:
mvn <goals> -Dadditionalparam=-Xdoclint:none -DadditionalJOption=-Xdoclint:none

  • 要在您的shell环境中配置它 *,以便它每次都适用于每个项目,而无需您做任何其他事情,请将这一行添加到您的shell初始化(~/.bashrc或Mac ~/.bash_profile,或您的shell使用的任何其他内容):
export JAVA_TOOL_OPTIONS="-Dadditionalparam=-Xdoclint:none -DadditionalJOption=-Xdoclint:none"


或者,如果您有JAVA_TOOL_OPTIONS,则将这些参数附加到它。

lc8prwob

lc8prwob7#

maven插件页面显示了如何禁用它们_

<failOnWarnings>
<failOnError>

字符串
警告的默认值是false,所以它不会中断构建。错误的默认值(当然)是true。

相关问题