在 Gradle 中启用 HTML5 Javadoc

Question

我们已经将一个Java项目升级到JDK10。当运行构建脚本时，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中指定HTML 5 (-html5)?

到目前为止，build.gradle 文件的 javadoc 部分相当简单：

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

Answer 1

options.addBooleanOption很简单：

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

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

Answer 2

当您的 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>

在 Gradle 中启用 HTML5 Javadoc

Enable HTML5 Javadoc in Gradle

java

javadoc

gradle

java-10