Generate aggregate javadoc api documentation


(Adam Murdoch) #1

Often, the javadoc for multiple projects needs to be aggregated together into a single set of documentation.

Implementation ideas

One approach is to add a new ‘aggregate-docs’ plugin, that adds a ‘javadocAll’ task and wires it up to document the project’s API plus the API of all projects in its compile-time dependencies.

Extra credit

Some ideas for building on this:

  • Extend this to generate aggregate groovydoc and scaladoc. * Integrate with the application and java-library plugins, to automatically include the aggregate api documentation in the distributions. * Generate an aggregate test report.