indra-crossdoc: init

[zml2008]

crossdoc will automatically link between javadoc publications of modules
within a multi-module project. URL patterns are configurable, and a
helper task for publishing javadoc is provided.

Closes #32

Configuration

To generate javadoc, a baseUrl property must be set on the crossdoc extension:

indraCrossdoc {
  baseUrl().set(providers.gradleProperty("javadocPublishRoot")) // or a hardcoded URL
}

Other attributes can be specified too, like customizing the logic for how project URLs are constructed, relative to the base URL.

For example, if subprojects have a name prefix of foobar-, this could be stripped from the generated URLs with the following snippet:

indraCrossdoc {
  nameBasedUrlProvider {
    projectNamePrefix = 'foobar-'
  }
}

Tasks

• generateOfflineLinks: A helper task, that will populate arguments to be passed to the javadoc task.
• copyJavadoc: Copy the unpacked output of the javadoc task to another directory, following the relative path computed by the provider set in the project extension. The output directory can be provided as a command line argument, with the --output flag. By default, this output path is interpreted relative to the root project's project directory.