杀死特定标签的Javadoc警告

Question

在使用Maven构建时,是否有一种简单的方法/选项来防止javadoc警告？我们使用soyatec uml插件进行eclipse,它会插入特殊的标签,这会让我们的构建产生很多烦人的警告; 我已经环顾四周,包括在Soyatec网站上,并且空了.

@uml.property is an unknown tag

Answer 1

我能找到的唯一答案是配置自定义Javadoc标签.

一个例子可能是这样的:

<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中定义这些自定义标记,每个人都可以使用它来使所有工作受益.