Package 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.SourceTask
org.gradle.api.tasks.javadoc.Groovydoc
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
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 limitations at the moment. The version of the Groovydoc that is used, is the one from the Groovy dependency defined in the build script.
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classA Link class represent a link between groovydoc/javadoc output and url.Nested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidgenerate()The most restrictive access level to include in the Groovydoc.org.gradle.api.internal.tasks.AntGroovydocDeprecated.Do not use this method.Returns the classpath used to locate classes referenced by the documented sources.protected org.gradle.internal.file.DeleterReturns the directory to generate the documentation into.Returns the title for the package index(first) page.Returns the HTML footer for each page.Returns the classpath containing the Groovy library to be used.Returns the HTML header for each page.Whether to include author paragraphs.Whether to include main method for scripts.getLinks()Returns the links to groovydoc/javadoc output at the given URL.Returns a HTML text to be used for overview documentation.Whether to process scripts.Returns the source for this task, after the include and exclude patterns have been applied.Returns the browser window title for the documentation.protected abstract WorkerExecutorbooleanReturns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).booleanReturns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).booleanisUse()Returns whether to create class and package usage pages.voidAdd links to groovydoc/javadoc output at the given URL.voidsetAntGroovydoc(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc) Deprecated.Do not use this method.voidsetClasspath(FileCollection classpath) Sets the classpath used to locate classes referenced by the documented sources.voidsetDestinationDir(File destinationDir) Sets the directory to generate the documentation into.voidsetDocTitle(String docTitle) Sets title for the package index(first) page (optional).voidSets footer text for each page (optional).voidsetGroovyClasspath(FileCollection groovyClasspath) Sets the classpath containing the Groovy library to be used.voidSets header text for each page (optional).voidsetLinks(Set<Groovydoc.Link> links) Sets links to groovydoc/javadoc output at the given URL.voidsetNoTimestamp(boolean noTimestamp) Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).voidsetNoVersionStamp(boolean noVersionStamp) Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).voidsetOverviewText(TextResource overviewText) Sets a HTML text to be used for overview documentation (optional).voidsetUse(boolean use) Sets whether to create class and package usage pages.voidsetWindowTitle(String windowTitle) Sets the browser window title for the documentation.Methods inherited from class org.gradle.api.tasks.SourceTaskexclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, sourceMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
Groovydocpublic Groovydoc()
 
- 
- 
Method Details- 
getWorkerExecutor
- 
generateprotected void generate()
- 
getSourceReturns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.- Overrides:
- getSourcein class- SourceTask
- Returns:
- The source.
 
- 
getDestinationDirReturns the directory to generate the documentation into.- Returns:
- The directory to generate the documentation into
 
- 
setDestinationDirSets the directory to generate the documentation into.
- 
getGroovyClasspathReturns the classpath containing the Groovy library to be used.- Returns:
- The classpath containing the Groovy library to be used
 
- 
setGroovyClasspathSets the classpath containing the Groovy library to be used.
- 
getClasspathReturns the classpath used to locate classes referenced by the documented sources.- Returns:
- The classpath used to locate classes referenced by the documented sources
 
- 
setClasspathSets the classpath used to locate classes referenced by the documented sources.
- 
getAntGroovydocDeprecated.Do not use this method.This is an internal API that will be removed.
- 
setAntGroovydocDeprecated.Do not use this method.This is an internal API that will be removed.
- 
isUseReturns whether to create class and package usage pages.
- 
setUsepublic void setUse(boolean use) Sets whether to create class and package usage pages.
- 
isNoTimestampReturns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
- 
setNoTimestamppublic void setNoTimestamp(boolean noTimestamp) Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
- 
isNoVersionStampReturns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
- 
setNoVersionStamppublic void setNoVersionStamp(boolean noVersionStamp) Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
- 
getWindowTitleReturns the browser window title for the documentation. Set tonullwhen there is no window title.
- 
setWindowTitleSets the browser window title for the documentation.- Parameters:
- windowTitle- A text for the windows title
 
- 
getDocTitleReturns the title for the package index(first) page. Set tonullwhen there is no document title.
- 
setDocTitleSets title for the package index(first) page (optional).- Parameters:
- docTitle- the docTitle as HTML
 
- 
getHeaderReturns the HTML header for each page. Set tonullwhen there is no header.
- 
setHeaderSets header text for each page (optional).- Parameters:
- header- the header as HTML
 
- 
getOverviewTextReturns a HTML text to be used for overview documentation. Set tonullwhen there is no overview text.
- 
setOverviewTextSets a HTML text to be used for overview documentation (optional).Example: overviewText = resources.text.fromFile("/overview.html")
- 
getAccessThe most restrictive access level to include in the Groovydoc.For example, to include classes and members with package, protected, and public access, use GroovydocAccess.PACKAGE.- Returns:
- the access property
- Since:
- 7.5
 
- 
getIncludeAuthorWhether to include author paragraphs.- Since:
- 7.5
 
- 
getProcessScriptsWhether to process scripts.- Since:
- 7.5
 
- 
getIncludeMainForScriptsWhether to include main method for scripts.- Since:
- 7.5
 
- 
getLinksReturns the links to groovydoc/javadoc output at the given URL.
- 
setLinksSets links to groovydoc/javadoc output at the given URL.- Parameters:
- links- The links to set
- See Also:
 
- 
linkAdd links to groovydoc/javadoc output at the given URL.- Parameters:
- url- Base URL of external site
- packages- list of package prefixes
 
- 
getDeleter@Inject protected org.gradle.internal.file.Deleter getDeleter()
 
-