Gradle javadoc Search redirects to “/undefined/..” URL

Question

I'm generating the javadoc using Java 11 and gradle for a project that does not use modules using the configuration below.

The documentation is generated correctly, but navigating to a search result yields a file not found instead of the expected page. There is an extra "undefined/" in the URL before the package and class name (e.g. ".../doc/undefined/package/Class.html").

There is a similar question for javadoc with Maven, but I cannot see how to add the --no-module-directories option in gradle.

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"
        }
    }
}

score 10 · Accepted Answer · answered Dec 11 '18 at 21:30

10

You need to add a boolean option with the leading hyphen removed:

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

answered Dec 11 '18 at 21:30

Rangi Keen

935
9
29

score 1 · Answer 2 · answered Dec 18 '20 at 15:54

1

Alternatively, if you're not defining a custom task:

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

Adapted from a related post for specifying a module path.

answered Dec 18 '20 at 15:54

hertzsprung

9,445
4
42
77

Gradle javadoc Search redirects to “/undefined/..” URL

2 Answers2