Table of Contents
| API Documentation: | 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}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")}| Property | Description |
classpath | The classpath to use to resolve type references in the source code. |
destinationDir | The directory to generate the documentation into. |
excludes | The set of exclude patterns. |
executable | The Javadoc executable to use to generate the Javadoc. When |
failOnError | Specifies whether this task should fail when errors are encountered during Javadoc generation. When |
includes | The set of include patterns. |
javadocTool | Configures the javadoc executable to be used to generate javadoc documentation. |
maxMemory | The amount of memory allocated to this task. |
modularity | The module path handling of this javadoc task. |
options | The Javadoc generation options. |
source | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist. |
title | The title for the generated documentation. |
| Method | Description |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included. |
source(sources) | Adds some source to this task. The given source objects will be evaluated as per |
FileCollectionclasspath
The classpath to use to resolve type references in the source code.
- Default with
javaplugin: project.sourceSets.main.compileClasspath
FiledestinationDir
The directory to generate the documentation into.
- Default with
javaplugin: ${project.docsDir}/javadoc
Stringexecutable
The Javadoc executable to use to generate the Javadoc. Whennull, the Javadoc executable forthe current JVM is used or from the toolchain if configured.
- Default with
javaplugin: null
Specifies whether this task should fail when errors are encountered during Javadoc generation. Whentrue,this task will fail on Javadoc error. Whenfalse, this task will ignore Javadoc errors.
- Default with
javaplugin: true
Property<JavadocTool>javadocTool
Property<JavadocTool>Configures the javadoc executable to be used to generate javadoc documentation.
- Default with
javaplugin: java.toolchain
ModularitySpecmodularity (read-only)
The module path handling of this javadoc task.
MinimalJavadocOptionsoptions (read-only)
The Javadoc generation options.
FileTreesource (read-only)
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
ThePathSensitivity for the sources is configured to bePathSensitivity.ABSOLUTE.If your sources are less strict, please change it accordingly by overriding this method in your subclass.
- Default with
javaplugin: project.sourceSets.main.allJava
Stringtitle
The title for the generated documentation.
- Default with
javaplugin: project.reporting.apiDocTitle
SourceTaskexclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElement as its parameter. The closure should return true or false. Example:
copySpec { from'source' into'destination'//an example of excluding files from certain configuration: exclude { it.file in configurations.someConf.files }}If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskinclude(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElement as its parameter.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
SourceTaskinclude(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
SourceTaskinclude(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
SourceTaskinclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
SourceTasksource(Object...
Object...Adds some source to this task. The given source objects will be evaluated as perProject.files(java.lang.Object[]).