org.gradle.docs.guides

Interface GuideSummary

All Known Subinterfaces:

Guide

All Known Implementing Classes:

GuideInternal

public interface GuideSummary

Method Summary

Modifier and Type	Method and Description
org.gradle.api.provider.Property<java.lang.String>	getCategory()
org.gradle.api.provider.Property<java.lang.String>	getDisplayName()
org.gradle.api.provider.Property<java.lang.String>	getPermalink()

Method Detail

getCategory

org.gradle.api.provider.Property<java.lang.String> getCategory()

Returns:

Property for configuring the category this guide appears in.

getPermalink

org.gradle.api.provider.Property<java.lang.String> getPermalink()

Returns:

Property for configuring the guide documentation permalink.

getDisplayName

org.gradle.api.provider.Property<java.lang.String> getDisplayName()

Returns:

Property for configuring the guide display name. The display name is used within the guide index.