Package org.gradle.docs.samples

Interface Samples

All Known Implementing Classes:
SamplesInternal
public interface Samples

  • Method Details

    • getSamplesRoot

      org.gradle.api.file.DirectoryProperty getSamplesRoot()
      By convention, this is src/samples
      Returns:
      The root sample directory.

    • getTemplatesRoot

      org.gradle.api.file.DirectoryProperty getTemplatesRoot()
      By convention, this is src/samples/templates
      Returns:
      The root template directory.

    • getSampleIndexFile

      org.gradle.api.file.RegularFileProperty getSampleIndexFile()
      This is an asciidoc file, not the generated HTML. By convention, this is documentationRoot/index.adoc
      Returns:
      The generated samples index file.

    • getDistribution

      SamplesDistribution getDistribution()
      Returns:
      Buildable elements of all the available samples.

    • getPublishedSamples

      org.gradle.api.NamedDomainObjectContainer<? extends Sample> getPublishedSamples()
      Returns:
      Container of all published samples. This is the primary configuration point for all samples.

    • getTemplates

      org.gradle.api.NamedDomainObjectContainer<? extends Template> getTemplates()
      Returns:
      Container of all templates. Templates are reusable parts of a sample.