maven - 特定のタグに対する Javadoc 警告の強制終了

Question

Mavenでビルドするときにjavadocの警告を防ぐ簡単な方法/オプションはありますか? 私たちは Eclipse 用の soyatec UML プラグインを使用しており、ビルドに多くの迷惑な警告をスローさせる特別なタグを挿入します。私は soyatec のサイトを含めて見回しましたが、何もありませんでした。

@uml.property は不明なタグです

Answer 1

これに対する唯一の答えは、Configure Custom Javadoc Tagsです。

例は次のようになります。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.8.1</version>
            <configuration>
                <tags>
                    <tag>
                        <name>uml.property</name>
                        <!-- The value X makes javadoc ignoring the tag -->
                        <placement>X</placement>
                    </tag>
                    <tag>
                        <name>some.other.property</name>
                        <placement>X</placement>
                    </tag>
                    <tag>
                        <name>some.third.property</name>
                        <placement>X</placement>
                    </tag>
                </tags>
            </configuration>
        </plugin>
    </plugins>
</build>

実行すると、出力に次のように表示されます。

mvn javadoc:javadoc

<lots of output>
Note: Custom tags that were not seen:  @uml.property
<maybe more output>

また、次のコマンドを使用して、エラーおよび警告以外のメッセージを無効にすることができます。

mvn javadoc:javadoc -Dquiet

---

これらすべてのタグを定義するのは難しい作業かもしれませんが、完了すると警告は表示されなくなります。

そして、これらのカスタム タグを親 pom で定義して、誰もがすべての作業に役立つようにする必要があります。