org.gradle.docs.samples

Interface SampleSummary

All Known Subinterfaces:

Sample

All Known Implementing Classes:

SampleInternal

public interface SampleSummary

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>	getDescription()
org.gradle.api.provider.Property<java.lang.String>	getDisplayName()
org.gradle.api.provider.SetProperty<Dsl>	getDsls() By convention, this is both Groovy and Kotlin.
org.gradle.api.provider.Property<java.lang.Boolean>	getPromoted() By Convention this is true.
org.gradle.api.provider.Property<java.lang.String>	getSampleDocName()

Method Detail

getDescription

@Input
org.gradle.api.provider.Property<java.lang.String> getDescription()

Returns:

Property for configuring the sample description. The description is used within the sample index.

getDisplayName

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

Returns:

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

getSampleDocName

@Input
org.gradle.api.provider.Property<java.lang.String> getSampleDocName()

Returns:

Property for configuring the sample documentation name. This is the name other parts of the documentation would use to refer to the sample.

getCategory

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

Returns:

Property for configuring the category this sample appears in.

getDsls

@Input
org.gradle.api.provider.SetProperty<Dsl> getDsls()

By convention, this is both Groovy and Kotlin. Every sample must have at least one DSL.

Returns:

DSLs that should be expected for this sample.

getPromoted

@Input
org.gradle.api.provider.Property<java.lang.Boolean> getPromoted()

By Convention this is true.

Returns:

true if the samples should be listed in the samples index.