如何在Gradle中设置Groovydoc的字符编码？

Question

我有使用UTF-8编码的Groovy代码，需要生成的Groovydoc HTML才能使用相同的代码。但是如何在Gradle中配置它？

Answer 1

Groovydoc工具以及Gradle的Groovydoc任务目前不支持encoding选项。但是，为Gradle JVM设置file.encoding系统属性应该可以正常工作。您可以通过GRADLE_OPTS环境变量或将systemProp.file.encoding=utf-8添加到gradle.properties来执行此操作。

Answer 2

令人惊讶的是，此问题在六年后以及许多Gradle版本中仍然存在：

在我向Groovydoc概述文件中添加Unicode字符（即箭头）并尝试在具有默认Windows-1251编码的计算机上组装Groovydoc时遇到了这个问题。

从Gradle 4.10.2开始，通过其AntGroovydoc方法向groovydoc任务提供自己的setAntGroovydoc实现，可以为Groovydoc使用其他选项。但是，由于该方法被认为是内部方法，因此解决方案有点笨拙。此外，AntGroovydoc显然不是为扩展而设计的，其子类将需要从原始类中大量复制粘贴。