Package org.gradle.docs.guides

Interface Guide

All Superinterfaces:
GuideSummary, org.gradle.api.Named
All Known Implementing Classes:
GuideInternal
public interface Guide extends org.gradle.api.Named, GuideSummary
Since:
0.1

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<String>
    getDescription()
    Short description of the guide.
    org.gradle.api.file.DirectoryProperty
    getGuideDirectory()
    By convention, this is the guide name off the extension's guide root directory.
    org.gradle.api.provider.Property<String>
    getGuideName()
    Guide name used to locate the project within the repository and tag issues with the right label.
    org.gradle.api.provider.Property<String>
    getMinimumGradleVersion()
    Minimum Gradle version this guide works on.
    org.gradle.api.provider.Property<String>
    getRepositoryPath()
    Path of repository relative to https://github.com.

    Methods inherited from interface org.gradle.docs.guides.GuideSummary

    getCategory, getDisplayName, getPermalink

    Methods inherited from interface org.gradle.api.Named

    getName

  • Method Details

    • getGuideDirectory

      org.gradle.api.file.DirectoryProperty getGuideDirectory()
      By convention, this is the guide name off the extension's guide root directory.
      Returns:
      Property for configuring the guide root directory.

    • getRepositoryPath

      org.gradle.api.provider.Property<String> getRepositoryPath()
      Path of repository relative to https://github.com.
      Returns:
      Property for configuring the guide repository.
      Since:
      0.15.8

    • getMinimumGradleVersion

      org.gradle.api.provider.Property<String> getMinimumGradleVersion()
      Minimum Gradle version this guide works on.
      Returns:
      Property for configuring the minimum Gradle version for the guide.
      Since:
      0.15.7

    • getDescription

      org.gradle.api.provider.Property<String> getDescription()
      Short description of the guide.
      Returns:
      Property for configuring the description.
      Since:
      0.15.8

    • getGuideName

      org.gradle.api.provider.Property<String> getGuideName()
      Guide name used to locate the project within the repository and tag issues with the right label.
      Returns:
      Property for configuring the repository URL and issue label.
      Since:
      0.16.1