org.gradle.api.tasks.javadoc

クラス Groovydoc

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

org.gradle.api.tasks.javadoc.Groovydoc

すべての実装されたインタフェース:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, PatternFilterable, org.gradle.util.Configurable<Task>

public class Groovydoc
extends SourceTask

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.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	Groovydoc.Link A Link class represent a link between groovydoc/javadoc output and url.

インタフェースから継承されたネストされたクラス/インタフェース org.gradle.api.Task

Task.Namer

フィールドの概要

クラスから継承されたフィールド org.gradle.api.tasks.SourceTask

source

インタフェースから継承されたフィールド org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

コンストラクタの概要

コンストラクタ

コンストラクタと説明
Groovydoc()

メソッドの概要

修飾子とタイプ	メソッドと説明
protected void	generate()
AntGroovydoc	getAntGroovydoc()
FileCollection	getClasspath() Returns the classpath used to locate classes referenced by the documented sources.
File	getDestinationDir() Returns the directory to generate the documentation into.
String	getDocTitle() Returns the title for the package index(first) page.
String	getFooter() Returns the HTML footer for each page.
FileCollection	getGroovyClasspath() Returns the classpath containing the Groovy library to be used.
String	getHeader() Returns the HTML header for each page.
Set<Groovydoc.Link>	getLinks() Returns the links to groovydoc/javadoc output at the given URL.
String	getOverview() Returns a HTML file to be used for overview documentation.
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(String url, String... packages) Add links to groovydoc/javadoc output at the given URL.
void	setAntGroovydoc(AntGroovydoc antGroovydoc)
void	setClasspath(FileCollection classpath) Sets the classpath used to locate classes referenced by the documented sources.
void	setDestinationDir(File destinationDir) Sets the directory to generate the documentation into.
void	setDocTitle(String docTitle) Sets title for the package index(first) page (optional).
void	setFooter(String footer) Sets footer text for each page (optional).
void	setGroovyClasspath(FileCollection groovyClasspath) Sets the classpath containing the Groovy library to be used.
void	setHeader(String header) Sets header text for each page (optional).
void	setIncludePrivate(boolean includePrivate) Sets whether to include all classes and members (i.e. including private ones) if set to true.
void	setLinks(Set<Groovydoc.Link> links) Sets links to groovydoc/javadoc output at the given URL.
void	setOverview(String overview) Sets a HTML file to be used for overview documentation (optional).
void	setUse(boolean use) Sets whether to create class and package usage pages.
void	setWindowTitle(String windowTitle) Sets the browser window title for the documentation.

クラスから継承されたメソッド org.gradle.api.tasks.SourceTask

exclude, exclude, exclude, exclude, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source

クラスから継承されたメソッド org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

クラスから継承されたメソッド org.gradle.api.internal.AbstractTask

addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

Groovydoc

public Groovydoc()

メソッドの詳細

generate

protected void generate()

getDestinationDir

@OutputDirectory
public File getDestinationDir()

Returns the directory to generate the documentation into.

戻り値:

The directory to generate the documentation into

setDestinationDir

public void setDestinationDir(File destinationDir)

Sets the directory to generate the documentation into.

getGroovyClasspath

@InputFiles
public FileCollection getGroovyClasspath()

Returns the classpath containing the Groovy library to be used.

戻り値:

The classpath containing the Groovy library to be used

setGroovyClasspath

public void setGroovyClasspath(FileCollection groovyClasspath)

Sets the classpath containing the Groovy library to be used.

getClasspath

@InputFiles
public FileCollection getClasspath()

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

戻り値:

The classpath used to locate classes referenced by the documented sources

setClasspath

public void setClasspath(FileCollection classpath)

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

getAntGroovydoc

public AntGroovydoc getAntGroovydoc()

setAntGroovydoc

public void setAntGroovydoc(AntGroovydoc antGroovydoc)

isUse

@Input
public boolean isUse()

Returns whether to create class and package usage pages.

setUse

public void setUse(boolean use)

Sets whether to create class and package usage pages.

getWindowTitle

@Input
 @Optional
public String getWindowTitle()

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

setWindowTitle

public void setWindowTitle(String windowTitle)

Sets the browser window title for the documentation.

パラメータ:

windowTitle - A text for the windows title

getDocTitle

@Input
 @Optional
public String getDocTitle()

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

setDocTitle

public void setDocTitle(String docTitle)

Sets title for the package index(first) page (optional).

パラメータ:

docTitle - the docTitle as HTML

getHeader

@Input
 @Optional
public String getHeader()

Returns the HTML header for each page. Set to null when there is no header.

setHeader

public void setHeader(String header)

Sets header text for each page (optional).

パラメータ:

header - the header as HTML

getFooter

@Input
 @Optional
public String getFooter()

Returns the HTML footer for each page. Set to null when there is no footer.

setFooter

public void setFooter(String footer)

Sets footer text for each page (optional).

パラメータ:

footer - the footer as HTML

getOverview

public String getOverview()

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

setOverview

public void setOverview(String overview)

Sets a HTML file to be used for overview documentation (optional).

isIncludePrivate

@Input
public boolean isIncludePrivate()

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

setIncludePrivate

public void setIncludePrivate(boolean includePrivate)

Sets whether to include all classes and members (i.e. including private ones) if set to true.

getLinks

@Input
public Set<Groovydoc.Link> getLinks()

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

setLinks

public void setLinks(Set<Groovydoc.Link> links)

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

パラメータ:

links - The links to set

関連項目:

link(String, String...)

link

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

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

パラメータ:

url - Base URL of external site

packages - list of package prefixes