配置gradle build以抑制javadoc控制台警告

Question

我正在使用gradle的javadoc plugin配置gradle构建。由于javadoc lint错误，我能够阻止构建失败，但是对于那些我不关心的lint错误，仍然有数百行控制台输出。

有关如何抑制与linting相关的控制台消息的任何想法？

我正在谈论的示例输出（但屏幕和屏幕已满）：

/home/user/projects/my-project/src/main/java/my/package/MyObject.java:89: warning: no description for @param
     * @param myParam
       ^
/home/user/projects/my-project/src/main/java/my/package/MyObject.java:90: warning: no description for @return
     * @return
       ^
/home/user/projects/my-project/src/main/java/my/package/MyObject.java:101: warning: no @param for itemId
    List<MyItem> getMyItems(Long itemId);
                        ^

我应该澄清一下，我正在寻找构建配置中的解决方案 - 而不是每次运行时传递给gradle build命令的标志。

Answer 1

可以使用Xdoclint选项抑制警告/错误：

javadoc.options.addStringOption('Xdoclint:none', '-quiet')

这仍然会显示一些最糟糕的警告，但会删除绝大多数警告。

见：https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html

另外，根据gradle javadoc文档，您可以直接设置输出级别（VERBOSE或QUIET）。问题是QUIET仍然显示所有警告和错误消息，并且似乎是默认行为。

Answer 2

您可以在javadoc任务的outputLevel块中设置options但不幸的是，即使是QUIET级别对您来说还不够

关闭非错误和非警告消息，仅显示警告和错误，使其更易于查看。

因此，使用提供的任务设置，我认为你被卡住了。

其他解决方案：修复您的javadoc问题。