ScalaDoc (Groovy Documentation)

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.tasks.scala
[Java] Class ScalaDoc

java.lang.Object
  org.gradle.api.internal.ConventionTask
      org.gradle.api.tasks.SourceTask
          org.gradle.api.tasks.scala.ScalaDoc

public class ScalaDoc
extends SourceTask

Generates HTML API documentation for Scala source files.

Method Summary
`protected void`	`generate()`
`AntScalaDoc`	`getAntScalaDoc()`
`java.lang.Iterable`	`getClasspath()` Returns the classpath to use to locate classes referenced by the documented source.
`java.io.File`	`getDestinationDir()`
`FileCollection`	`getScalaClasspath()`
`ScalaDocOptions`	`getScalaDocOptions()`
`java.lang.String`	`getTitle()`
`void`	`setAntScalaDoc(AntScalaDoc antScalaDoc)`
`void`	`setClasspath(FileCollection classpath)`
`void`	`setDestinationDir(java.io.File destinationDir)`
`void`	`setScalaClasspath(FileCollection scalaClasspath)`
`void`	`setScalaDocOptions(ScalaDocOptions scalaDocOptions)`
`void`	`setTitle(java.lang.String title)`

Methods inherited from class SourceTask
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source

Method Detail

@TaskAction
protected void generate()

public AntScalaDoc getAntScalaDoc()

@InputFiles
public java.lang.Iterable getClasspath()

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

@OutputDirectory
public java.io.File getDestinationDir()

@InputFiles
public FileCollection getScalaClasspath()

public ScalaDocOptions getScalaDocOptions()

public java.lang.String getTitle()

public void setAntScalaDoc(AntScalaDoc antScalaDoc)

public void setClasspath(FileCollection classpath)

public void setDestinationDir(java.io.File destinationDir)

public void setScalaClasspath(FileCollection scalaClasspath)

public void setScalaDocOptions(ScalaDocOptions scalaDocOptions)

public void setTitle(java.lang.String title)

Groovy Documentation