Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.api.tasks.javadoc
[Java] Class Groovydoc

    java.lang.Object
      org.gradle.api.internal.ConventionTask
          org.gradle.api.tasks.SourceTask
              org.gradle.api.tasks.javadoc.Groovydoc

    public class Groovydoc
    extends SourceTask

Generates HTML API documentation for Groovy and Java classes. It uses Groovy's Groovydoc tool for this. 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.

Authors:
  Hans Dockter

Nested Class Summary
`static class` | `Groovydoc.Link` A Link class represent a link between groovydoc/javadoc output and url.

Constructor Summary
`Groovydoc()`

Method Summary
`protected void` | `generate()`
`AntGroovydoc` | `getAntGroovydoc()`
`java.io.File` | `getDestinationDir()` Returns the directory to generate the documentation into.
`java.lang.String` | `getDocTitle()` Returns the title for the package index(first) page.
`java.lang.String` | `getFooter()` Returns the html footer for each page.
`FileCollection` | `getGroovyClasspath()` Returns the classpath to use to locate classes referenced by the documented source.
`java.lang.String` | `getHeader()` Returns the html header for each page.
`java.util.Set` | `getLinks()` Returns links to groovydoc/javadoc output at the given URL.
`java.lang.String` | `getOverview()` Returns a html file to be used for overview documentation.
`java.lang.String` | `getWindowTitle()` Returns the browser window title for the documentation.
`boolean` | `isIncludePrivate()` Returns whether to include all classes and members (i.e. including private ones).
`boolean` | `isUse()` Returns whether to create class and package usage pages.
`void` | `link(java.lang.String url, java.lang.String packages)` Add links to groovydoc/javadoc output at the given URL.
`void` | `setAntGroovydoc(AntGroovydoc antGroovydoc)`
`void` | `setDestinationDir(java.io.File destinationDir)` Sets the directory to generate the documentation into.
`void` | `setDocTitle(java.lang.String docTitle)` Set's title for the package index(first) page (optional).
`void` | `setFooter(java.lang.String footer)` Set's footer text for each page (optional).
`void` | `setGroovyClasspath(FileCollection groovyClasspath)` Sets the classpath to use to locate classes referenced by the documented source.
`void` | `setHeader(java.lang.String header)` Set's header text for each page (optional).
`void` | `setIncludePrivate(boolean includePrivate)` Set's whether to include all classes and members (i.e. including private ones) if set to true.
`void` | `setLinks(java.util.Set links)` Sets links to groovydoc/javadoc output at the given URL.
`void` | `setOverview(java.lang.String overview)` Set's a html file to be used for overview documentation (optional).
`void` | `setUse(boolean use)` Set's whether to create class and package usage pages.
`void` | `setWindowTitle(java.lang.String windowTitle)` Set's the browser window title for the documentation.

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

Constructor Detail

### Groovydoc

    public Groovydoc()

Method Detail

### generate

    @TaskAction
    protected void generate()

### getAntGroovydoc

    public AntGroovydoc getAntGroovydoc()

### getDestinationDir

    @OutputDirectory
    public java.io.File getDestinationDir()

  Returns the directory to generate the documentation into.

  Returns:
    The directory.

### getDocTitle

    public java.lang.String getDocTitle()

  Returns the title for the package index(first) page. Returns null if not set.

### getFooter

    public java.lang.String getFooter()

  Returns the html footer for each page. Returns null if not set.

### getGroovyClasspath

    @InputFiles
    public FileCollection getGroovyClasspath()

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

  Returns:
    The classpath.

### getHeader

    public java.lang.String getHeader()

  Returns the html header for each page. Returns null if not set.

### getLinks

    public java.util.Set getLinks()

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

### getOverview

    public java.lang.String getOverview()

  Returns a html file to be used for overview documentation. Returns null if such a file is not set.

### getWindowTitle

    public java.lang.String getWindowTitle()

  Returns the browser window title for the documentation.

### isIncludePrivate

    public boolean isIncludePrivate()

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

### isUse

    public boolean isUse()

  Returns whether to create class and package usage pages.

### link

    public void link(java.lang.String url, java.lang.String packages)

  Add links to groovydoc/javadoc output at the given URL.
  Parameters:
    `url` - Base URL of external site
    `packages` - list of package prefixes

### setAntGroovydoc

    public void setAntGroovydoc(AntGroovydoc antGroovydoc)

### setDestinationDir

    public void setDestinationDir(java.io.File destinationDir)

  Sets the directory to generate the documentation into.

### setDocTitle

    public void setDocTitle(java.lang.String docTitle)

  Set's title for the package index(first) page (optional).
  Parameters:
    `docTitle` - the docTitle as html-code

### setFooter

    public void setFooter(java.lang.String footer)

  Set's footer text for each page (optional).
  Parameters:
    `footer` - the footer as html-code

### setGroovyClasspath

    public void setGroovyClasspath(FileCollection groovyClasspath)

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

### setHeader

    public void setHeader(java.lang.String header)

  Set's header text for each page (optional).
  Parameters:
    `header` - the header as html-code

### setIncludePrivate

    public void setIncludePrivate(boolean includePrivate)

  Set's whether to include all classes and members (i.e. including private ones) if set to true. Defaults to false.

### setLinks

    public void setLinks(java.util.Set links)

  Sets links to groovydoc/javadoc output at the given URL.
  Parameters:
    `links` - The links to set
  See Also:
    link(String, String[])

### setOverview

    public void setOverview(java.lang.String overview)

  Set's a html file to be used for overview documentation (optional).

### setUse

    public void setUse(boolean use)

  Set's whether to create class and package usage pages. Defaults to false.

### setWindowTitle

    public void setWindowTitle(java.lang.String windowTitle)

  Set's the browser window title for the documentation.
  Parameters:
    `windowTitle` - A text for the windows title

Groovy Documentation