Javadoc (kordamp-gradle-plugins unspecified)

org.kordamp.gradle.plugin.base.plugins.Javadoc

@CompileStatic
class Javadoc
extends AbstractFeature

Authors:: Andres Almiray

Since:: 0.8.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Javadoc.Aggregate`
`static class`	`Javadoc.AutoLinks`

Properties Summary

Properties
Type	Name and description
`static String`	`PLUGIN_ID`
`Groovydoc.Aggregate`	`aggregate`
`Javadoc.AutoLinks`	`autoLinks`
`Boolean`	`copyDocFiles`
`Boolean`	`empty`
`Set<String>`	`excludes`
`Set<String>`	`includes`
`ExtStandardJavadocDocletOptions`	`options`
`String`	`title`

Constructor Summary

Constructors
Constructor and description
`Javadoc (ProjectConfigurationExtension config, Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`aggregate(Action<? super Aggregate> action)`
	`void`	`aggregate(Closure<Void> action)`
	`void`	`applyTo(Javadoc javadoc)`
	`void`	`autoLinks(Action<? super AutoLinks> action)`
	`void`	`autoLinks(Closure<Void> action)`
	`void`	`exclude(String str)`
	`boolean`	`getCopyDocFiles()`
	`boolean`	`getEmpty()`
	`void`	`include(String str)`
	`static void`	`merge(Javadoc o1, Javadoc o2)`
	`void`	`options(Action<? super ExtStandardJavadocDocletOptions> action)`
	`void`	`options(Closure<Void> action)`
	`void`	`postMerge()`
	`Map<String, Map<String, Object>>`	`toMap()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractFeature`	`isEnabledSet, isRoot, merge, normalize, postMerge, setEnabled`

- Property Detail
  - static final String PLUGIN_ID
  - final Groovydoc.Aggregate aggregate
  - final Javadoc.AutoLinks autoLinks
  - Boolean copyDocFiles
  - Boolean empty
  - Set<String> excludes
  - Set<String> includes
  - final ExtStandardJavadocDocletOptions options
  - String title
- Constructor Detail
  - Javadoc(ProjectConfigurationExtension config, Project project)
- Method Detail
  - void aggregate(Action<? super Aggregate> action)
  - void aggregate(@DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: Aggregate) Closure<Void> action)
  - void applyTo(Javadoc javadoc)
  - void autoLinks(Action<? super AutoLinks> action)
  - void autoLinks(@DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: AutoLinks) Closure<Void> action)
  - void exclude(String str)
  - boolean getCopyDocFiles()
  - boolean getEmpty()
  - void include(String str)
  - static void merge(Javadoc o1, Javadoc o2)
  - void options(Action<? super ExtStandardJavadocDocletOptions> action)
  - void options(@DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: ExtStandardJavadocDocletOptions) Closure<Void> action)
  - @Override void postMerge()
  - @Override Map<String, Map<String, Object>> toMap()

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Javadoc

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final String PLUGIN_ID

final Groovydoc.Aggregate aggregate

final Javadoc.AutoLinks autoLinks

Boolean copyDocFiles

Boolean empty

Set<String> excludes

Set<String> includes

final ExtStandardJavadocDocletOptions options

String title

Constructor Detail

Javadoc(ProjectConfigurationExtension config, Project project)

Method Detail

void aggregate(Action<? super Aggregate> action)

void aggregate(@DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: Aggregate) Closure<Void> action)

void applyTo(Javadoc javadoc)

void autoLinks(Action<? super AutoLinks> action)

void autoLinks(@DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: AutoLinks) Closure<Void> action)

void exclude(String str)

boolean getCopyDocFiles()

boolean getEmpty()

void include(String str)

static void merge(Javadoc o1, Javadoc o2)

void options(Action<? super ExtStandardJavadocDocletOptions> action)

void options(@DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: ExtStandardJavadocDocletOptions) Closure<Void> action)

@Override void postMerge()

@Override Map<String, Map<String, Object>> toMap()