GroovydocOptions (kordamp-gradle-plugins unspecified)

org.kordamp.gradle.plugin.base.model.impl.GroovydocOptions

@CompileStatic
class GroovydocOptions
extends Object

Authors:: Andres Almiray

Since:: 0.4.0

Properties Summary

Properties
Type	Name and description
`String`	`docTitle`
`String`	`footer`
`String`	`header`
`boolean`	`includeAuthor`
`boolean`	`includeMainForScripts`
`boolean`	`includePrivate`
`Set<Groovydoc.Link>`	`links`
`boolean`	`noTimestamp`
`boolean`	`noVersionStamp`
`TextResource`	`overviewText`
`boolean`	`processScripts`
`boolean`	`use`
`String`	`windowTitle`

Constructor Summary

Constructors
Constructor and description
`GroovydocOptions ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`applyTo(Groovydoc groovydoc)`
	`void`	`cleanupLinks()`
	`boolean`	`isIncludeAuthorSet()`
	`boolean`	`isIncludeMainForScriptsSet()`
	`boolean`	`isIncludePrivateSet()`
	`boolean`	`isNoTimestampSet()`
	`boolean`	`isNoVersionStampSet()`
	`boolean`	`isProcessScriptsSet()`
	`boolean`	`isUseSet()`
	`void`	`link(String url, String[] packages)`
	`void`	`linkIfAbsent(String url, String[] packages)`
	`static void`	`merge(GroovydocOptions o1, GroovydocOptions o2)`
	`void`	`setIncludeAuthor(boolean includeAuthor)`
	`void`	`setIncludeMainForScripts(boolean includeMainForScripts)`
	`void`	`setIncludePrivate(boolean includePrivate)`
	`void`	`setNoTimestamp(boolean noTimestamp)`
	`void`	`setNoVersionStamp(boolean noVersionStamp)`
	`void`	`setProcessScripts(boolean processScripts)`
	`void`	`setUse(boolean use)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - String docTitle
  - String footer
  - String header
  - boolean includeAuthor
  - boolean includeMainForScripts
  - boolean includePrivate
  - Set<Groovydoc.Link> links
  - boolean noTimestamp
  - boolean noVersionStamp
  - TextResource overviewText
  - boolean processScripts
  - boolean use
  - String windowTitle
- Constructor Detail
  - GroovydocOptions()
- Method Detail
  - @CompileDynamic void applyTo(Groovydoc groovydoc)
  - void cleanupLinks()
  - boolean isIncludeAuthorSet()
  - boolean isIncludeMainForScriptsSet()
  - boolean isIncludePrivateSet()
  - boolean isNoTimestampSet()
  - boolean isNoVersionStampSet()
  - boolean isProcessScriptsSet()
  - boolean isUseSet()
  - void link(String url, String[] packages)
  - void linkIfAbsent(String url, String[] packages)
  - static void merge(GroovydocOptions o1, GroovydocOptions o2)
  - void setIncludeAuthor(boolean includeAuthor)
  - void setIncludeMainForScripts(boolean includeMainForScripts)
  - void setIncludePrivate(boolean includePrivate)
  - void setNoTimestamp(boolean noTimestamp)
  - void setNoVersionStamp(boolean noVersionStamp)
  - void setProcessScripts(boolean processScripts)
  - void setUse(boolean use)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GroovydocOptions

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String docTitle

String footer

String header

boolean includeAuthor

boolean includeMainForScripts

boolean includePrivate

Set<Groovydoc.Link> links

boolean noTimestamp

boolean noVersionStamp

TextResource overviewText

boolean processScripts

boolean use

String windowTitle

Constructor Detail

GroovydocOptions()

Method Detail

@CompileDynamic void applyTo(Groovydoc groovydoc)

void cleanupLinks()

boolean isIncludeAuthorSet()

boolean isIncludeMainForScriptsSet()

boolean isIncludePrivateSet()

boolean isNoTimestampSet()

boolean isNoVersionStampSet()

boolean isProcessScriptsSet()

boolean isUseSet()

void link(String url, String[] packages)

void linkIfAbsent(String url, String[] packages)

static void merge(GroovydocOptions o1, GroovydocOptions o2)

void setIncludeAuthor(boolean includeAuthor)

void setIncludeMainForScripts(boolean includeMainForScripts)

void setIncludePrivate(boolean includePrivate)

void setNoTimestamp(boolean noTimestamp)

void setNoVersionStamp(boolean noVersionStamp)

void setProcessScripts(boolean processScripts)

void setUse(boolean use)