Package org.gradle.api.tasks.javadoc

Class Javadoc

  • All Implemented Interfaces:
    java.lang.Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, PatternFilterable, Configurable<Task>
    @CacheableTask
public abstract class Javadoc
extends SourceTask

    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")
 }

    • Constructor Detail

      • Javadoc

        public Javadoc()

    • Method Detail

      • generate

        protected void generate()

      • getSource

        @PathSensitive(RELATIVE)
public FileTree getSource()
        Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

        The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.

        Overrides:
        getSource in class SourceTask
        Returns:
        The source.

      • getJavadocTool

        public Property<JavadocTool> getJavadocTool()
        Configures the javadoc executable to be used to generate javadoc documentation.
        Since:
        6.7

      • getDestinationDir

        @Internal
@Nullable
public java.io.File getDestinationDir()

        Returns the directory to generate the documentation into.

        Returns:
        The directory.

      • getOutputDirectory

        @OutputDirectory
protected java.io.File getOutputDirectory()

      • setDestinationDir

        public void setDestinationDir​(java.io.File destinationDir)

        Sets the directory to generate the documentation into.

      • getMaxMemory

        @Internal
@Nullable
public java.lang.String getMaxMemory()
        Returns the amount of memory allocated to this task.

      • setMaxMemory

        public void setMaxMemory​(java.lang.String maxMemory)
        Sets the amount of memory allocated to this task.
        Parameters:
        maxMemory - The amount of memory

      • getTitle

        @Nullable
@Optional
@Input
public java.lang.String getTitle()

        Returns the title for the generated documentation.

        Returns:
        The title, possibly null.

      • setTitle

        public void setTitle​(@Nullable
                     java.lang.String title)

        Sets the title for the generated documentation.

      • isVerbose

        @Internal
public boolean isVerbose()
        Returns whether Javadoc generation is accompanied by verbose output.
        See Also:
        setVerbose(boolean)

      • setVerbose

        public void setVerbose​(boolean verbose)
        Sets whether Javadoc generation is accompanied by verbose output or not. The verbose output is done via println (by the underlying Ant task). Thus it is not handled by our logging.
        Parameters:
        verbose - Whether the output should be verbose.

      • getClasspath

        @Classpath
public FileCollection getClasspath()
        Returns the classpath to use to resolve type references in the source code.
        Returns:
        The classpath.

      • setClasspath

        public void setClasspath​(FileCollection classpath)
        Sets the classpath to use to resolve type references in this source code.
        Parameters:
        classpath - The classpath. Must not be null.

      • getModularity

        public ModularitySpec getModularity()
        Returns the module path handling of this javadoc task.
        Since:
        6.4

      • getOptions

        public MinimalJavadocOptions getOptions()
        Returns the Javadoc generation options.
        Returns:
        The options. Never returns null.

      • options

        public void options​(@DelegatesTo(MinimalJavadocOptions.class)
                    Closure<?> block)
        Convenience method for configuring Javadoc generation options.
        Parameters:
        block - The configuration block for Javadoc generation options.

      • options

        public void options​(Action<? super MinimalJavadocOptions> action)
        Convenience method for configuring Javadoc generation options.
        Parameters:
        action - The action for Javadoc generation options.
        Since:
        3.5

      • isFailOnError

        @Input
public boolean isFailOnError()
        Specifies whether this task should fail when errors are encountered during Javadoc generation. When true, this task will fail on Javadoc error. When false, this task will ignore Javadoc errors.

      • setFailOnError

        public void setFailOnError​(boolean failOnError)

      • getOptionsFile

        @Internal
public java.io.File getOptionsFile()

      • getExecutable

        @Nullable
@Optional
@Input
public java.lang.String getExecutable()
        Returns the Javadoc executable to use to generate the Javadoc. When null, the Javadoc executable for the current JVM is used or from the toolchain if configured.
        Returns:
        The executable. May be null.
        See Also:
        getJavadocTool()

      • setExecutable

        public void setExecutable​(@Nullable
                          java.lang.String executable)

      • getDeleter

        @Inject
protected org.gradle.internal.file.Deleter getDeleter()

      • getProjectLayout

        @Inject
protected ProjectLayout getProjectLayout()

      • getObjectFactory

        @Inject
protected ObjectFactory getObjectFactory()

      • getJavaModuleDetector

        @Inject
protected org.gradle.internal.jvm.JavaModuleDetector getJavaModuleDetector()

      • getProviderFactory

        @Inject
protected ProviderFactory getProviderFactory()