Search code examples
javadocgradle

Can't get overview.html into javadoc with gradle

Using the latest gradle, I am trying to get the standard overview.html to appear in the javadocs for my project. I have tried several different methods of configuration with no luck. Here's the latest:

javadoc.ext["overview"] = "${projectDir}/src/main/java/overview.html"

No errors are reported, however, the overview blurb does not appear in the javadocs index page. I can get this to work invoking javadoc from the command line or an IDE.

Thanks for helping. (I have checked the gradle docs.)

Solution

  • Not sure how you came up with that syntax. Starting from the DSL reference for the Javadoc task, you should eventually arrive at:

    javadoc {
    options.overview = "overview.html" // relative to source root
}

    According to the docs for the Javadoc tool, this seems to be the default, but is only shown if you have at least two packages.