Groovy Documentation

org.gradle.api.tasks.javadoc
Class Groovydoc

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

class Groovydoc
extends ConventionTask

This task generates html api doc for Groovy 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.

author:
Hans Dockter


Constructor Summary
Groovydoc(Project project, java.lang.String name)

 
Method Summary
AntGroovydoc getAntGroovydoc()

File getDestinationDir()

Returns the directory to generate the documentation into.

ExistingDirsFilter getExistentDirsFilter()

FileCollection getGroovyClasspath()

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

List getSrcDirs()

Returns the source directories containing the groovy source files to generate documentation for.

void setAntGroovydoc(AntGroovydoc antGroovydoc)

void setDestinationDir(File destinationDir)

Sets the directory to generate the documentation into.

void setExistentDirsFilter(ExistingDirsFilter existentDirsFilter)

void setGroovyClasspath(FileCollection groovyClasspath)

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

void setSrcDirs(List srcDirs)

Sets the source directories containing the groovy source files to generate documentation for.

 
Methods inherited from class ConventionTask
conv, conventionMapping, conventionMapping, conventionProperty, getConventionAwareHelper, getConventionMapping, setConventionAwareHelper, setConventionMapping
 
Methods inherited from class DefaultTask
leftShift, methodMissing, propertyMissing
 
Methods inherited from class AbstractTask
captureStandardOutput, compareTo, defineProperty, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuted, getLogger, getName, getPath, getProject, getSkipProperties, getStandardOutputCapture, getTaskDependencies, hasProperty, hashCode, isDidWork, isEnabled, isExecuted, onlyIf, onlyIf, property, setActions, setAdditionalProperties, setDependsOn, setDescription, setDidWork, setEnabled, setExecuted, setName, setProject, setProperty, setSkipProperties, setStandardOutputCapture, toString
 
Methods inherited from class java.lang.Object
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
 

Constructor Detail

Groovydoc

public Groovydoc(Project project, java.lang.String name)


 
Method Detail

getAntGroovydoc

public AntGroovydoc getAntGroovydoc()


getDestinationDir

public File getDestinationDir()

Returns the directory to generate the documentation into.

return:
The directory.


getExistentDirsFilter

public ExistingDirsFilter getExistentDirsFilter()


getGroovyClasspath

public FileCollection getGroovyClasspath()

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

return:
The classpath.


getSrcDirs

public List getSrcDirs()

Returns the source directories containing the groovy source files to generate documentation for.

return:
The source directories. Never returns null.


setAntGroovydoc

public void setAntGroovydoc(AntGroovydoc antGroovydoc)


setDestinationDir

public void setDestinationDir(File destinationDir)

Sets the directory to generate the documentation into.


setExistentDirsFilter

public void setExistentDirsFilter(ExistingDirsFilter existentDirsFilter)


setGroovyClasspath

public void setGroovyClasspath(FileCollection groovyClasspath)

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


setSrcDirs

public void setSrcDirs(List srcDirs)

Sets the source directories containing the groovy source files to generate documentation for.


 

Groovy Documentation