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

Question

我正在使用 gradle 的javadoc 插件配置 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

在 Kotlin 构建脚本中执行此操作很棘手。由于某种原因，该options对象是 aMinimalJavadocOptions而不是CoreJavadocOptions意味着您没有获得该addStringOption方法。不过你可以投射它！作为一名 Kotlin 新手，我花了一些时间，但这是我发现的：

plugins {
    java
}

tasks {
    javadoc {
        options {
            (this as CoreJavadocOptions).addStringOption("Xdoclint:none", "-quiet")
        }
    }
}

Answer 2

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