Package org.gradle.docs.guides.internal

Class LegacyGuideDocumentationPlugin

java.lang.Object

org.gradle.docs.guides.internal.LegacyGuideDocumentationPlugin

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.Project>

public class LegacyGuideDocumentationPlugin
extends Object
implements org.gradle.api.Plugin<org.gradle.api.Project>

The guides base plugin provides conventions for all Gradle guides.

Adds the custom attributes to AsciidoctorTask for reference in Asciidoc files:

• samplescodedir: The directory containing samples code defined as "$projectDir/samples/code"
• samplesoutputdir: The directory containing expected samples output defined as "$projectDir/samples/output"

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GUIDE_EXTENSION_NAME

Constructor Summary

Constructors

Constructor	Description
LegacyGuideDocumentationPlugin()

Method Summary

Modifier and Type	Method	Description
void	apply(org.gradle.api.Project project)

Methods inherited from class java.lang.Object

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

Field Details

GUIDE_EXTENSION_NAME

public static final String GUIDE_EXTENSION_NAME

See Also:

• Constant Field Values

Constructor Details

LegacyGuideDocumentationPlugin

public LegacyGuideDocumentationPlugin()

Method Details

apply

public void apply(org.gradle.api.Project project)

Specified by:

apply in interface org.gradle.api.Plugin<org.gradle.api.Project>