api / org.gradle.api.tasks.scala / ScalaDoc

ScalaDoc

@CacheableTask open class ScalaDoc : SourceTask

Generates HTML API documentation for Scala source files.

Constructors

ScalaDoc()

Generates HTML API documentation for Scala source files.

Functions

getClasspath	`open fun getClasspath(): FileCollection` Returns the classpath to use to locate classes referenced by the documented source.
getDestinationDir	`open fun getDestinationDir(): File` Returns the directory to generate the API documentation into.
getScalaClasspath	`open fun getScalaClasspath(): FileCollection` Returns the classpath to use to load the ScalaDoc tool.
getScalaDocOptions	`open fun getScalaDocOptions(): ScalaDocOptions` Returns the ScalaDoc generation options.
getSource	`open fun getSource(): FileTree` {@inheritDoc}
getTitle	`open fun getTitle(): String` Returns the documentation title.
setClasspath	`open fun setClasspath(classpath: FileCollection): Unit`
setDestinationDir	`open fun setDestinationDir(destinationDir: File): Unit`
setScalaClasspath	`open fun setScalaClasspath(scalaClasspath: FileCollection): Unit`
setScalaDocOptions	`open fun setScalaDocOptions(scalaDocOptions: ScalaDocOptions): Unit`
setTitle	`open fun setTitle(title: String): Unit`

Inherited Functions

exclude	`open fun exclude(vararg excludes: String): SourceTask` `open fun exclude(excludes: MutableIterable<String>): SourceTask` `open fun exclude(excludeSpec: Spec<FileTreeElement>): SourceTask` `open fun exclude(excludeSpec: Closure<Any>): SourceTask` {@inheritDoc}
getExcludes	`open fun getExcludes(): MutableSet<String>` {@inheritDoc}
getIncludes	`open fun getIncludes(): MutableSet<String>` {@inheritDoc}
include	`open fun include(vararg includes: String): SourceTask` `open fun include(includes: MutableIterable<String>): SourceTask` `open fun include(includeSpec: Spec<FileTreeElement>): SourceTask` `open fun include(includeSpec: Closure<Any>): SourceTask` {@inheritDoc}
setExcludes	`open fun setExcludes(excludes: MutableIterable<String>): SourceTask` {@inheritDoc}
setIncludes	`open fun setIncludes(includes: MutableIterable<String>): SourceTask` {@inheritDoc}
setSource	`open fun setSource(source: FileTree): Unit` Sets the source for this task. `open fun setSource(source: Any): Unit` Sets the source for this task. The given source object is evaluated as per `org.gradle.api.Project#files(Object...)`.
source	`open fun source(vararg sources: Any): SourceTask` Adds some source to this task. The given source objects will be evaluated as per `org.gradle.api.Project#files(Object...)`.