org.gradle.docs.guides.internal

Class GuidesInternal

java.lang.Object

org.gradle.docs.guides.internal.GuidesInternal

All Implemented Interfaces:

Guides

public abstract class GuidesInternal
extends java.lang.Object
implements Guides

Constructor Summary

Constructors

Constructor and Description
GuidesInternal(org.gradle.api.model.ObjectFactory objectFactory)

Method Summary

Modifier and Type	Method and Description
org.gradle.api.DomainObjectSet<? super GuideBinary>	getBinaries()
GuidesDistribution	getDistribution()
abstract org.gradle.api.file.DirectoryProperty	getDocumentationInstallRoot() By convention, this is buildDir/working/guides/docs
org.gradle.api.NamedDomainObjectContainer<? extends GuideInternal>	getPublishedGuides()
abstract org.gradle.api.file.DirectoryProperty	getRenderedDocumentationRoot() By convention, this is buildDir/working/guides/render-samples

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getGuidesRoot

Constructor Detail

GuidesInternal

@Inject
public GuidesInternal(org.gradle.api.model.ObjectFactory objectFactory)

Method Detail

getPublishedGuides

public org.gradle.api.NamedDomainObjectContainer<? extends GuideInternal> getPublishedGuides()

Specified by:

getPublishedGuides in interface Guides

Returns:

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

getBinaries

public org.gradle.api.DomainObjectSet<? super GuideBinary> getBinaries()

getDistribution

public GuidesDistribution getDistribution()

Specified by:

getDistribution in interface Guides

Returns:

Buildable elements of all the available guides.

getDocumentationInstallRoot

public abstract org.gradle.api.file.DirectoryProperty getDocumentationInstallRoot()

By convention, this is buildDir/working/guides/docs

Returns:

The root directory for all documentation.

getRenderedDocumentationRoot

public abstract org.gradle.api.file.DirectoryProperty getRenderedDocumentationRoot()

By convention, this is buildDir/working/guides/render-samples

Returns:

The root directory for rendered documentation.