在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.我们如何-html5在gradle中指定HTML 5()？

到目前为止,我们文件的javadoc部分build.gradle相当简单:

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>