Package org.gradle.api.tasks.scala

Class ScalaDoc

    • Constructor Detail

      • ScalaDoc

        public ScalaDoc()

    • Method Detail

      • getDestinationDir

        @OutputDirectory
public java.io.File getDestinationDir()
        Returns the directory to generate the API documentation into.

      • setDestinationDir

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

      • getFilteredCompilationOutputs

        @InputFiles
@IgnoreEmptyDirectories
@PathSensitive(RELATIVE)
protected FileTree getFilteredCompilationOutputs()
        Returns the compilation outputs needed by Scaladoc filtered to include TASTy files.

        NOTE: This is only useful with Scala 3 or later. Scala 2 only processes source files.

        Returns:
        the compilation outputs produced from the sources
        Since:
        7.3

      • getCompilationOutputs

        @Internal
public ConfigurableFileCollection getCompilationOutputs()
        Returns the compilation outputs produced by the sources that are generating Scaladoc.
        Returns:
        the compilation outputs produced from the sources
        Since:
        7.3

      • getClasspath

        @Classpath
public FileCollection getClasspath()

        Returns the classpath to use to locate classes referenced by the documented source.

        Returns:
        The classpath.

      • setClasspath

        public void setClasspath​(FileCollection classpath)

      • getScalaClasspath

        @Classpath
public FileCollection getScalaClasspath()
        Returns the classpath to use to load the ScalaDoc tool.

      • setScalaClasspath

        public void setScalaClasspath​(FileCollection scalaClasspath)

      • getScalaDocOptions

        public ScalaDocOptions getScalaDocOptions()
        Returns the ScalaDoc generation options.

      • setScalaDocOptions

        @Deprecated
public void setScalaDocOptions​(ScalaDocOptions scalaDocOptions)
        Deprecated.
        Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use scalaDocOptions(Action) instead.
        Sets the ScalaDoc generation options.

      • scalaDocOptions

        public void scalaDocOptions​(Action<? super ScalaDocOptions> action)
        Configures the ScalaDoc generation options.
        Since:
        8.11

      • getTitle

        @Nullable
@Optional
@Input
public java.lang.String getTitle()
        Returns the documentation title.

      • setTitle

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

      • getMaxMemory

        @Internal
public Property<java.lang.String> getMaxMemory()
        Returns the amount of memory allocated to this task. Ex. 512m, 1G
        Since:
        6.5

      • getJavaLauncher

        public Property<JavaLauncher> getJavaLauncher()
        A JavaLauncher used to run the Scaladoc tool.
        Since:
        7.2

      • generate

        protected void generate()

      • getObjectFactory

        @Inject
protected abstract ObjectFactory getObjectFactory()

      • getAntBuilder

        @Inject
protected abstract org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()

      • getWorkerExecutor

        @Inject
protected abstract WorkerExecutor getWorkerExecutor()

      • getJavaToolchainService

        @Inject
protected abstract JavaToolchainService getJavaToolchainService()