Question

我正在使用Java 11和gradle为不使用以下配置的模块的项目生成Javadoc。

文档已正确生成，但是导航至搜索结果会产生未找到文件而不是预期页面的情况。包和类名之前的URL中还有一个额外的“ undefined /”（例如“ ... / doc / undefined / package / Class.html”）。

使用Maven的Javadoc有一个similar question，但我看不到如何在gradle中添加--no-module-directories选项。

task allJavadoc (type: Javadoc, description: 'Generate javadoc from all projects', group: 'Documentation') {
    destinationDir = file("$projectDir/doc")
    title = "Title"
    maxMemory = "2048m"
    failOnError true
    options.author false
    options.version true
    options.use true
    options.links "https://docs.oracle.com/en/java/javase/11/docs/api/"
    options.breakIterator true

    subprojects.each { proj ->
        proj.tasks.withType(Javadoc).each { javadocTask ->
            classpath += javadocTask.classpath
            excludes += javadocTask.excludes
            includes += "**/*.java"
        }
    }
}

Answer 1

您需要添加一个布尔选项，并删除前导连字符：

options.addBooleanOption "-no-module-directories", true

Answer 2

或者，如果您没有定义自定义任务：

javadoc {
  doFirst {
    options.addBooleanOption('-no-module-directories', true)
  }
}

改编自related post for specifying a module path。

Gradle javadoc搜索重定向到“ /undefined/..”URL

2 个答案: