# Groovydoc

API Documentation: | `Groovydoc`

Generates HTML API documentation for Groovy source, and optionally, Java source.

This task uses Groovy's Groovydoc tool to generate the API documentation. Please note that the Groovydoc tool has some severe limitations at the moment (for example no doc for properties comments). The version of the Groovydoc that is used, is the one from the Groovy defined in the build script. Please note also, that the Groovydoc tool prints to System.out for many of its statements and does circumvents our logging currently.

### Properties

Property | Description
`classpath` | The classpath used to locate classes referenced by the documented sources.
`destinationDir` | The directory to generate the documentation into.
`docTitle` | The title for the package index(first) page. Set to `null` when there is no document title.
`excludes` | The set of exclude patterns.
`footer` | The html footer for each page. Set to `null` when there is no footer.
`groovyClasspath` | The classpath containing the Groovy library to be used.
`header` | The html header for each page. Set to `null` when there is no header.
`includePrivate` | Returns whether to include all classes and members (i.e. including private ones).
`includes` | The set of include patterns.
`links` | The links to groovydoc/javadoc output at the given URL.
`overview` | Returns a html file to be used for overview documentation. Set to `null` when there is no overview file.
`source` | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
`use` | Returns whether to create class and package usage pages.
`windowTitle` | The browser window title for the documentation. Set to `null` when there is no window title.

### Property details

#### `FileCollection` `classpath`

The classpath used to locate classes referenced by the documented sources.

Default with `groovy` plugin:
  `sourceSets.main.output + sourceSets.main.compileClasspath`

#### `File` `destinationDir`

The directory to generate the documentation into.

Default with `groovy` plugin:
  ``${project.docsDir}`/groovydoc`

#### `String` `docTitle`

The title for the package index(first) page. Set to `null` when there is no document title.

Default with `groovy` plugin:
  `project.apiDocTitle`

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

The set of exclude patterns.

Default with `groovy` plugin:
  `[]`

#### `String` `footer`

The html footer for each page. Set to `null` when there is no footer.

Default with `groovy` plugin:
  `null`

#### `FileCollection` `groovyClasspath`

The classpath containing the Groovy library to be used.

Default with `groovy` plugin:
  `project.configurations.groovy`

#### `String` `header`

The html header for each page. Set to `null` when there is no header.

Default with `groovy` plugin:
  `null`

#### `boolean` `includePrivate`

Returns whether to include all classes and members (i.e. including private ones).

Default with `groovy` plugin:
  `false`

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

The set of include patterns.

Default with `groovy` plugin:
  `[]`

#### ``Set`<`Link`>` `links`

The links to groovydoc/javadoc output at the given URL.

Default with `groovy` plugin:
  `[]`

#### `String` `overview`

Returns a html file to be used for overview documentation. Set to `null` when there is no overview file.

Default with `groovy` plugin:
  `null`

#### `FileTree` `source`

The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

Default with `groovy` plugin:
  `sourceSets.main.groovy`

#### `boolean` `use`

Returns whether to create class and package usage pages.

Default with `groovy` plugin:
  `false`

#### `String` `windowTitle`

The browser window title for the documentation. Set to `null` when there is no window title.

Default with `groovy` plugin:
  `project.apiDocTitle`

### Script blocks

No script blocks

### 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.
`link(url, packages)` | Add links to groovydoc/javadoc output at the given URL.
`source(sources)` | Adds some source to this task. The given source objects will be evaluated as for `Project.files()`.

### 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.

#### `void` `link`(`String` url, ``String`...` packages)

Add links to groovydoc/javadoc output at the given URL.

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

Adds some source to this task. The given source objects will be evaluated as for `Project.files()`.