【问题标题】:Maven JavaDoc plugin giving warnings instead of ErrorsMaven JavaDoc 插件给出警告而不是错误
【发布时间】:2018-06-11 10:08:29
【问题描述】:

我在 pox.xml 中添加了 maven java doc 插件依赖项,如下所示

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.0</version>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

并且使用 java 1.8 版,但是当缺少 cmets 或没有描述时,它会抛出警告而不是错误。 我希望它抛出错误,有人可以帮忙吗?提前致谢! 它在控制台中抛出以下警告

7 warnings
[WARNING] Javadoc Warnings
[WARNING] javadoc: warning - Multiple sources of package comments found for package "javax.servlet"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "javax.servlet.http"
[WARNING] C:\SOFTDEV\LPIS\LPISDEPT\WEBAPP\branches\DEVELOPMENT\web\lpis_web\src\main\java\ie\gov\agriculture\lpis\web\auth\servlet\LPISAuthenticationServlet.java:61: warning: no description for @throws
[WARNING] * @throws IOException
[WARNING] ^
[WARNING] C:\SOFTDEV\LPIS\LPISDEPT\WEBAPP\branches\DEVELOPMENT\web\lpis_web\src\main\java\ie\gov\agriculture\lpis\web\editcache\filter\attribute\EditFilterAttribute.java:32: warning: no description for @param
[WARNING] * @param currentEntityFilter
[WARNING] ^
[WARNING] C:\SOFTDEV\LPIS\LPISDEPT\WEBAPP\branches\DEVELOPMENT\web\lpis_web\src\main\java\ie\gov\agriculture\lpis\web\editcache\filter\factory\EntityFilter.java:19: warning: no description for @param
[WARNING] * @param projectId
[WARNING] ^
[WARNING] C:\SOFTDEV\LPIS\LPISDEPT\WEBAPP\branches\DEVELOPMENT\web\lpis_web\src\main\java\ie\gov\agriculture\lpis\web\editcache\filter\factory\EntityFilter.java:20: warning: no description for @param
[WARNING] * @param attributeValues
[WARNING] ^
[WARNING] C:\SOFTDEV\LPIS\LPISDEPT\WEBAPP\branches\DEVELOPMENT\web\lpis_web\src\main\java\ie\gov\agriculture\lpis\web\editcache\filter\factory\FilterFactory.java:40: warning: no description for @param
[WARNING] * @param parameter
[WARNING] ^

【问题讨论】:

    标签: maven javadoc maven-javadoc-plugin


    【解决方案1】:

    如果您想设置错误以使构建失败,您也可以使用 failOnWarnings。

    更多信息见https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#failOnWarnings

       <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.0</version>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
                                <configuration>
                                     <failOnWarnings>true</failOnWarnings>
                                </configuration>
            </plugin>
    

    【讨论】:

    • @KavithaYeleti 是的。因为更改日志级别是不可行的。'但是为什么要将它作为错误而不是警告?
    猜你喜欢
    • 2017-01-29
    • 2014-04-11
    • 1970-01-01
    • 2020-12-09
    • 2018-12-23
    • 1970-01-01
    • 2012-01-13
    • 2021-10-18
    • 1970-01-01
    相关资源
    最近更新 更多