web-dev-qa-db-ja.com

Maven Javadoc PluginでJavadoc警告を無効にする方法は？

私はMaven Javadocプラグインを使用しています。次のように警告を出力します。

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

これらの警告を[WARNING]として表示する方法（混乱する[ERROR]ではない）？

mavenjavadocmaven-javadoc-plugin
19
Martin Monperrus

これらの警告を[警告]として表示するにはどうすればよいですか（混乱を招く[エラー]ではありません）。 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>
18
Gray

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のコードに従って、少なくとも1つのJavadocエラーがある場合、すべてのログ行の先頭に[ERROR]が付けられることに注意してください。

13
Spring Monkey

ローカルで抑制したいが成文化したくない場合は、コマンドラインから無効にすることもできます。

mvn clean install -Dadditionalparam=-Xdoclint:none

spring Monkeyが指摘するように、新しいバージョンでは、次のように渡す必要があります

mvn clean install -DadditionalJOption=-Xdoclint:none
8
Paul Back

maven-javadoc-pluginのバージョン3.0.0以降、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
hzpz

すべての回答をコンパイルして、他に何かを追加すると、次のようになります。

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が必要です。エラーは発生しませんが、Maven 2.9以降ではadditionalparamを使用できますが、機能しません。以前のバージョンのmavenでadditionalJOptionを使用することはテストしていません。

コマンドラインから設定するには、このパラメーターを渡す必要があります：

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

シェル環境で構成する場合、他に何もする必要なくすべてのプロジェクトに毎回適用されるように、この行をシェルの初期化（~/.bashrcまたはMacの場合~/.bash_profile、またはシェルが使用する他のすべて）：

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

または、Java_TOOL_OPTIONS、それらのパラメーターをそれに追加します。

1
Daniel C. Sobral

V3.0.0以降、ドキュメントのリンティングを設定するために新しい doclint configオプションが追加されました。これは、これらの警告を抑制するために使用できます。

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