# ScalaDoc

API Documentation: | `ScalaDoc`

Generates HTML API documentation for Scala source files.

### Properties

Property | Description
`classpath` | The classpath to use to locate classes referenced by the documented source.
`compilationOutputs` | The compilation outputs produced by the sources that are generating Scaladoc.
`destinationDir` | The directory to generate the API documentation into.
`excludes` | The set of exclude patterns.
`includes` | The set of include patterns.
`javaLauncher` | A JavaLauncher used to run the Scaladoc tool.
`maxMemory` | The amount of memory allocated to this task. Ex. 512m, 1G
`scalaClasspath` | The classpath to use to load the ScalaDoc tool.
`scalaDocOptions` | The ScalaDoc 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 documentation title.

### Methods

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 `FileTreeElement` as its parameter. The closure should return true or false. Example:
`exclude(excludes)` | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any 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 multiple patterns 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 match any 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 match any 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 `FileTreeElement` as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
`include(includes)` | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file 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 multiple patterns 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 a file 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 a file 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 `Project.files(java.lang.Object[])`.

### Script blocks

No script blocks

### Property details

#### `FileCollection` `classpath`

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

Default with `scala` plugin:
  `project.sourceSets.main.output + project.sourceSets.main.compileClasspath`

#### `ConfigurableFileCollection` `compilationOutputs` (read-only)

The compilation outputs produced by the sources that are generating Scaladoc.

Default with `scala` plugin:
  `project.sourceSets.main.output`

#### `File` `destinationDir`

The directory to generate the API documentation into.

Default with `scala` plugin:
  ``${project.docsDir}`/scaladoc`

#### ``Set`<`String`>` `excludes`

The set of exclude patterns.

Default with `scala` plugin:
  `[]`

#### ``Set`<`String`>` `includes`

The set of include patterns.

Default with `scala` plugin:
  `[]`

#### ``Property`<`JavaLauncher`>` `javaLauncher`

A JavaLauncher used to run the Scaladoc tool.

Default with `scala` plugin:
  `java.toolchain`

#### ``Property`<`String`>` `maxMemory`

The amount of memory allocated to this task. Ex. 512m, 1G

Default with `scala` plugin:
  `null`

#### `FileCollection` `scalaClasspath`

The classpath to use to load the ScalaDoc tool.

Default with `scala` plugin:
  `scala-compiler` dependency matching the `scala-library` version found on `classpath`

#### `ScalaDocOptions` `scalaDocOptions` (read-only)

The ScalaDoc generation options.

#### `FileTree` `source` (read-only)

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.RELATIVE`.

Default with `scala` plugin:
  `project.sourceSets.main.scala`

#### `String` `title`

The documentation title.

Default with `scala` plugin:
  `project.reporting.apiDocTitle`

### Method details

#### `SourceTask` `exclude`(`Closure` excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a `FileTreeElement` 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 match any exclude pattern to be processed.

#### `SourceTask` `exclude`(``Iterable`<`String`>` excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.

#### `SourceTask` `exclude`(``String`...` excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.

#### `SourceTask` `exclude`(``Spec`<`FileTreeElement`>` 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 match any exclude pattern to be processed.

#### `SourceTask` `include`(`Closure` includeSpec)

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a `FileTreeElement` as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

#### `SourceTask` `include`(``Iterable`<`String`>` includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.

#### `SourceTask` `include`(``String`...` includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.

#### `SourceTask` `include`(``Spec`<`FileTreeElement`>` 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 a file must match at least one of the include patterns or specs to be included.

#### `SourceTask` `source`(``Object`...` sources)

Adds some source to this task. The given source objects will be evaluated as per `Project.files(java.lang.Object[])`.