配置gradle构建以禁止Javadoc控制台警告

时间:2018-09-06 13:27:44

标签: gradle javadoc

我正在使用gradle的javadoc plugin配置gradle构建。由于出现了Javadoc棉绒错误,我得以阻止构建失败,但是对于那些我不在乎的棉绒错误,仍然有数百行控制台输出。

有什么主意如何消除这些与棉绒相关的控制台消息?

我正在谈论的示例输出(但屏幕和屏幕已满):

/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命令的标志。

2 个答案:

答案 0 :(得分: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仍会显示所有警告和错误消息,并且似乎仍然是默认行为。

答案 1 :(得分:0)

您可以在Javadoc任务的options块内设置outputLevel,但不幸的是,即使QUIET级别也不足以满足您的要求

  

关闭非错误和非警告消息,仅保留   警告和错误出现,使它们更易于查看。

因此,使用提供的任务设置,我认为您很困惑。

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