org.gradle.docs.samples

Interface SamplesDistribution

public interface SamplesDistribution

This represents the outputs of the samples section of the documentation.

Method Summary

Modifier and Type	Method and Description
org.gradle.api.file.ConfigurableFileTree	getInstalledSamples()
org.gradle.api.file.ConfigurableFileCollection	getRenderedDocumentation() This is HTML and resources.
org.gradle.api.file.ConfigurableFileTree	getTestedInstalledSamples()
org.gradle.api.file.ConfigurableFileCollection	getZippedSamples()

Method Detail

getInstalledSamples

org.gradle.api.file.ConfigurableFileTree getInstalledSamples()

Returns:

the collection of samples extracted as a consumer would see them

getZippedSamples

org.gradle.api.file.ConfigurableFileCollection getZippedSamples()

Returns:

a collection of samples in zip form

getTestedInstalledSamples

org.gradle.api.file.ConfigurableFileTree getTestedInstalledSamples()

Returns:

Collection of samples ready for testing

getRenderedDocumentation

org.gradle.api.file.ConfigurableFileCollection getRenderedDocumentation()

This is HTML and resources.

Returns:

collection of rendered documentation