在Gradle中启用HTML5 Javadoc

Question

我们已经将一个Java项目升级到JDK 10。运行构建脚本时，Javadoc会输出一个警告：

javadoc: warning - You have not specified the version of HTML to use.
The default is currently HTML 4.01, but this will change to HTML5
in a future release. To suppress this warning, please specify the
version of HTML used in your documentation comments and to be
generated by this doclet, using the -html4 or -html5 options.

为了构建项目，我们使用gradle。我们如何在gradle中指定超文本标记语言5（-html5）？

到目前为止，我们构建的javadoc部分。gradle文件相当简单：

javadoc {
    include 'com/company/project/pkg/*'
}

Answer 1

当为maven项目获取上述错误时，可以将以下代码片段放入pom中。xml：

       <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>${javadocplugin.version}</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <additionalOptions>-html5</additionalOptions>
            </configuration>
        </plugin>

Answer 2

使用选项很简单。addBooleanOption：

javadoc {
    include 'com/company/project/pkg/*'
    options.addBooleanOption('html5', true)
}

注意，您必须使用addBooleanOption，而不是addStringOption。后者在没有值的情况下（例如，“”）无法工作，然后会生成无效的命令行。