Плагин Maven JavaDoc, выдающий предупреждения вместо ошибок - PullRequest
Новая
       37

Плагин Maven JavaDoc, выдающий предупреждения вместо ошибок

0 голосов
/ 11 июня 2018

Я добавил в свой файл 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, но выдает предупреждения вместо ошибок, когда комментарии отсутствуют или нет описания,Я хочу, чтобы он выдавал ошибки, может кто-нибудь помочь с этим?Заранее спасибо!Выкидывал следующие предупреждения в консоль 

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] ^

1 Ответ

0 голосов
/ 11 июня 2018

Если вы хотите установить ошибку для сбоя сборки, вы также можете использовать 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>
...