配置 gradle 构建以抑制 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

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

Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.

所以使用提供的任务设置，我认为你卡住了。

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

Answer 2

可以使用 Xdoclint 选项抑制 warnings/errors：

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 仍然显示所有警告和错误消息，而且似乎是默认行为。

配置 gradle 构建以抑制 javadoc 控制台警告

Configure gradle build to suppress javadoc console warnings

javadoc

gradle