org.gradle.docs.snippets

Interface Snippets

All Known Implementing Classes:

SnippetsInternal

public interface Snippets

Method Summary

Modifier and Type	Method and Description
org.gradle.api.NamedDomainObjectContainer<? extends Snippet>	getPublishedSnippets()
org.gradle.api.file.DirectoryProperty	getSnippetsRoot() By convention, this is src/docs/snippets

Method Detail

getSnippetsRoot

org.gradle.api.file.DirectoryProperty getSnippetsRoot()

By convention, this is src/docs/snippets

Returns:

The root sample directory.

getPublishedSnippets

org.gradle.api.NamedDomainObjectContainer<? extends Snippet> getPublishedSnippets()

Returns:

Container of all published snippets. This is the primary configuration point for all snippets.