Javadoc
Generates HTML API documentation for Java classes.
If you create your own Javadoc tasks remember to specify the 'source' property! Without source the Javadoc task will not create any documentation. Example:
plugins {
    id 'java'
}
task myJavadocs(type: Javadoc) {
  source = sourceSets.main.allJava
}
Content copied to clipboard
An example how to create a task that runs a custom doclet implementation:
plugins {
    id 'java'
}
configurations {
  jaxDoclet
}
dependencies {
  //jaxDoclet "some.interesting:Dependency:1.0"
}
task generateRestApiDocs(type: Javadoc) {
  source = sourceSets.main.allJava
  destinationDir = reporting.file("rest-api-docs")
  options.docletpath = configurations.jaxDoclet.files.asType(List)
  options.doclet = "com.lunatech.doclets.jax.jaxrs.JAXRSDoclet"
  options.addStringOption("jaxrscontext", "http://localhost:8080/myapp")
}
Content copied to clipboard
Properties
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  The extra properties extension in this object's extension container.
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Functions
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Returns the Javadoc generation options.
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Specifies whether this task should fail when errors are encountered during Javadoc generation.
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Convenience method for configuring Javadoc generation options.
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Sets whether Javadoc generation is accompanied by verbose output or not.
Link copied to clipboard
                  Link copied to clipboard
                  Link copied to clipboard
                  Returns the extension of the specified type.
Returns the extension of the specified extensionType.
Link copied to clipboard