A B C D E F G I K L N O P R S T U V W Z

A

AnsiCharactersToPlainTextOutputStream - Class in org.gradle.docs.internal.exemplar

AnsiCharactersToPlainTextOutputStream() - Constructor for class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

apply(Project) - Method in class org.gradle.docs.guides.internal.GuidesDocumentationPlugin

apply(Project) - Method in class org.gradle.docs.guides.internal.LegacyGuideDocumentationPlugin

apply(Project) - Method in class org.gradle.docs.internal.BuildDocumentationPlugin

apply(Project) - Method in class org.gradle.docs.internal.DocumentationBasePlugin

apply(Project) - Method in class org.gradle.docs.samples.internal.LegacySamplesDocumentationPlugin

apply(Project) - Method in class org.gradle.docs.samples.internal.SamplesDocumentationPlugin

apply(Project) - Method in class org.gradle.docs.snippets.internal.SnippetsDocumentationPlugin

AsciidoctorContentTest - Class in org.gradle.docs.internal.exemplar

AsciidoctorContentTest() - Constructor for class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

AsciidoctorContentTestCase - Interface in org.gradle.docs.internal.exemplar

AsciidoctorContentTestConsoleType - Enum in org.gradle.docs.internal.exemplar

AsciidoctorContentTestParameters - Interface in org.gradle.docs.internal.exemplar

AsciidoctorContentTestWorkerAction - Class in org.gradle.docs.internal.exemplar

AsciidoctorContentTestWorkerAction() - Constructor for class org.gradle.docs.internal.exemplar.AsciidoctorContentTestWorkerAction

AsciidoctorTasks - Class in org.gradle.docs.internal.configure

AsciidoctorTasks() - Constructor for class org.gradle.docs.internal.configure.AsciidoctorTasks

assertNameDoesNotContainsDisallowedCharacters(Named, String, Object...) - Static method in class org.gradle.docs.internal.Asserts

Asserts - Class in org.gradle.docs.internal

Asserts() - Constructor for class org.gradle.docs.internal.Asserts

B

BuildDocumentationPlugin - Class in org.gradle.docs.internal

BuildDocumentationPlugin() - Constructor for class org.gradle.docs.internal.BuildDocumentationPlugin

C

call() - Method in class org.gradle.docs.samples.internal.TemplateInternal

capitalize(String) - Static method in class org.gradle.docs.internal.StringUtils

Capitalizes the first letter of the string.

CheckLinks - Class in org.gradle.docs.internal.tasks

CheckLinks() - Constructor for class org.gradle.docs.internal.tasks.CheckLinks

CheckLinks.CheckLinksAction - Class in org.gradle.docs.internal.tasks

CheckLinks.CheckLinksParameters - Interface in org.gradle.docs.internal.tasks

CheckLinksAction() - Constructor for class org.gradle.docs.internal.tasks.CheckLinks.CheckLinksAction

cleanStaleFiles(AsciidoctorTask) - Static method in class org.gradle.docs.internal.configure.AsciidoctorTasks

close() - Method in class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

common(Action<? super ConfigurableFileCollection>) - Method in class org.gradle.docs.samples.internal.SampleInternal

common(Action<? super ConfigurableFileCollection>) - Method in interface org.gradle.docs.samples.Sample

Configure common content.

composite(OutputNormalizer...) - Static method in class org.gradle.docs.internal.exemplar.OutputNormalizers

configureResources(AsciidoctorTask, Collection<? extends RenderableContentBinary>) - Static method in class org.gradle.docs.internal.configure.AsciidoctorTasks

configureSources(AsciidoctorTask, Collection<? extends RenderableContentBinary>) - Static method in class org.gradle.docs.internal.configure.AsciidoctorTasks

ContentBinaries - Class in org.gradle.docs.internal.configure

ContentBinaries() - Constructor for class org.gradle.docs.internal.configure.ContentBinaries

copy() - Method in class org.gradle.docs.samples.internal.tasks.SyncWithProvider

createCheckTaskForAsciidoctorContentBinary(Project, String, Collection<? extends TestableAsciidoctorContentBinary>, TaskProvider<Task>) - Static method in class org.gradle.docs.internal.configure.ContentBinaries

createCheckTasksForContentBinary(TaskContainer, TestableRenderedContentLinksBinary, TaskProvider<Task>) - Static method in class org.gradle.docs.internal.configure.ContentBinaries

createTasksForContentBinary(TaskContainer, ViewableContentBinary) - Static method in class org.gradle.docs.internal.configure.ContentBinaries

createTasksForSampleContentBinary(TaskContainer, SampleContentBinary) - Static method in class org.gradle.docs.internal.configure.ContentBinaries

D

deleteDirectory(File) - Static method in class org.gradle.docs.internal.FileUtils

DOCS_TEST_IMPLEMENTATION_CONFIGURATION_NAME - Static variable in class org.gradle.docs.internal.DocumentationBasePlugin

DOCS_TEST_SOURCE_SET_NAME - Static variable in class org.gradle.docs.internal.DocumentationBasePlugin

DOCS_TEST_TASK_NAME - Static variable in class org.gradle.docs.internal.DocumentationBasePlugin

DOCUMENTATION_EXTENSION_NAME - Static variable in class org.gradle.docs.internal.DocumentationBasePlugin

DOCUMENTATION_GROUP_NAME - Static variable in class org.gradle.docs.internal.DocumentationBasePlugin

DocumentationBasePlugin - Class in org.gradle.docs.internal

DocumentationBasePlugin() - Constructor for class org.gradle.docs.internal.DocumentationBasePlugin

DocumentationExtension - Interface in org.gradle.docs

DocumentationExtensionInternal - Class in org.gradle.docs.internal

DocumentationExtensionInternal(ObjectFactory) - Constructor for class org.gradle.docs.internal.DocumentationExtensionInternal

Dsl - Enum in org.gradle.docs.samples

E

execute() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTestWorkerAction

execute() - Method in class org.gradle.docs.internal.tasks.CheckLinks.CheckLinksAction

F

FileUtils - Class in org.gradle.docs.internal

FileUtils() - Constructor for class org.gradle.docs.internal.FileUtils

flush() - Method in class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

G

generate() - Method in class org.gradle.docs.guides.internal.tasks.GenerateGuidePageAsciidoc

generate() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSamplePageAsciidoc

generate() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSanityCheckTests

generate() - Method in class org.gradle.docs.samples.internal.tasks.GenerateTestSource

generate() - Method in class org.gradle.docs.samples.internal.tasks.SamplesReport

GenerateGuidePageAsciidoc - Class in org.gradle.docs.guides.internal.tasks

GenerateGuidePageAsciidoc() - Constructor for class org.gradle.docs.guides.internal.tasks.GenerateGuidePageAsciidoc

GenerateSampleIndexAsciidoc - Class in org.gradle.docs.samples.internal.tasks

GenerateSampleIndexAsciidoc() - Constructor for class org.gradle.docs.samples.internal.tasks.GenerateSampleIndexAsciidoc

GenerateSamplePageAsciidoc - Class in org.gradle.docs.samples.internal.tasks

GenerateSamplePageAsciidoc() - Constructor for class org.gradle.docs.samples.internal.tasks.GenerateSamplePageAsciidoc

GenerateSanityCheckTests - Class in org.gradle.docs.samples.internal.tasks

GenerateSanityCheckTests() - Constructor for class org.gradle.docs.samples.internal.tasks.GenerateSanityCheckTests

GenerateTestSource - Class in org.gradle.docs.samples.internal.tasks

GenerateTestSource() - Constructor for class org.gradle.docs.samples.internal.tasks.GenerateTestSource

genericAttributes() - Static method in class org.gradle.docs.internal.configure.AsciidoctorTasks

getArchiveFile() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getAssembleTask() - Method in class org.gradle.docs.samples.internal.SampleInternal

getAttributes() - Method in class org.gradle.docs.guides.internal.tasks.GenerateGuidePageAsciidoc

getAttributes() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSamplePageAsciidoc

getBaseDirectory() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getBaseName() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getBinaries() - Method in class org.gradle.docs.guides.internal.GuidesInternal

getBinaries() - Method in class org.gradle.docs.samples.internal.SamplesInternal

getBinaries() - Method in class org.gradle.docs.snippets.internal.SnippetsInternal

getCategory() - Method in interface org.gradle.docs.guides.GuideSummary

getCategory() - Method in interface org.gradle.docs.samples.SampleSummary

getCheckLinksTaskName() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getCheckLinksTaskName() - Method in interface org.gradle.docs.internal.TestableRenderedContentLinksBinary

getCheckLinksTaskName() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getCheckTask() - Method in class org.gradle.docs.samples.internal.SampleInternal

getClasspath() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

getCommonContent() - Method in interface org.gradle.docs.samples.Sample

getContent() - Method in class org.gradle.docs.samples.internal.SampleInstallBinary

getContentFile() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestCase

getContentFile() - Method in interface org.gradle.docs.internal.TestableAsciidoctorContentBinary

getConventionalDirectory() - Method in enum org.gradle.docs.samples.Dsl

getDefaultConsoleType() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

Note: The default console type doesn't affect the console choice requireing user interaction like `init` task or `--scan` flag

getDefaultConsoleType() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestParameters

getDescription() - Method in interface org.gradle.docs.guides.Guide

Short description of the guide.

getDescription() - Method in interface org.gradle.docs.samples.SampleSummary

getDestinationDirectory() - Method in class org.gradle.docs.samples.internal.tasks.SyncWithProvider

getDisplayName() - Method in interface org.gradle.docs.guides.GuideSummary

getDisplayName() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getDisplayName() - Method in enum org.gradle.docs.samples.Dsl

getDisplayName() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getDisplayName() - Method in interface org.gradle.docs.samples.SampleSummary

getDistribution() - Method in interface org.gradle.docs.guides.Guides

getDistribution() - Method in class org.gradle.docs.guides.internal.GuidesInternal

getDistribution() - Method in class org.gradle.docs.samples.internal.SamplesInternal

getDistribution() - Method in interface org.gradle.docs.samples.Samples

getDocumentationInstallRoot() - Method in class org.gradle.docs.guides.internal.GuidesInternal

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

getDocumentationInstallRoot() - Method in class org.gradle.docs.samples.internal.SamplesInternal

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

getDsl() - Method in class org.gradle.docs.samples.internal.SampleArchiveBinary

getDsl() - Method in class org.gradle.docs.samples.internal.tasks.ValidateSampleBinary

getDslLabel() - Method in enum org.gradle.docs.samples.Dsl

getDsls() - Method in interface org.gradle.docs.samples.SampleSummary

By convention, this is both Groovy and Kotlin.

getDsls() - Method in interface org.gradle.docs.snippets.Snippet

By convention, this is both Groovy and Kotlin.

getDslSpecificContent() - Method in class org.gradle.docs.samples.internal.SampleInstallBinary

getExcludes() - Method in class org.gradle.docs.samples.internal.SampleInstallBinary

getExcludes() - Method in class org.gradle.docs.samples.internal.tasks.InstallSample

getExcludes() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getExecOperations() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTestWorkerAction

getExplicitSanityCheck() - Method in class org.gradle.docs.samples.internal.SampleExemplarBinary

getFileOperations() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTestWorkerAction

getGradleUserHomeDirectory() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestParameters

getGradleVersion() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getGradleVersion() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

getGradleVersion() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestParameters

getGradleVersion() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getGroovyContent() - Method in interface org.gradle.docs.samples.Sample

By convention, this is the "groovy" directory in the sample directory.

getGuideDirectory() - Method in interface org.gradle.docs.guides.Guide

By convention, this is the guide name off the extension's guide root directory.

getGuideDirectory() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getGuideName() - Method in interface org.gradle.docs.guides.Guide

Guide name used to locate the project within the repository and tag issues with the right label.

getGuideName() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getGuides() - Method in interface org.gradle.docs.DocumentationExtension

getGuides() - Method in class org.gradle.docs.internal.DocumentationExtensionInternal

getGuidesRoot() - Method in interface org.gradle.docs.guides.Guides

By convention, this is src/docs/guides

getIndexDocument() - Method in interface org.gradle.docs.internal.tasks.CheckLinks.CheckLinksParameters

getIndexDocument() - Method in class org.gradle.docs.internal.tasks.CheckLinks

getIndexFile() - Method in class org.gradle.docs.guides.internal.tasks.GenerateGuidePageAsciidoc

getIndexFile() - Method in class org.gradle.docs.internal.tasks.ViewDocumentation

getIndexPageFile() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getIndexPageFile() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getInstallDirectory() - Method in class org.gradle.docs.samples.internal.SampleInstallBinary

getInstallDirectory() - Method in class org.gradle.docs.samples.internal.SampleInternal

getInstallDirectory() - Method in class org.gradle.docs.samples.internal.tasks.InstallSample

getInstalledIndexPageFile() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getInstalledIndexPageFile() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getInstalledSamples() - Method in interface org.gradle.docs.samples.SamplesDistribution

getInstallRoot() - Method in class org.gradle.docs.samples.internal.SamplesInternal

By convention, this is buildDir/working/samples/install

getKotlinContent() - Method in interface org.gradle.docs.samples.Sample

By convention, this is the "kotlin" directory in the sample directory.

getMainSource() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getMainSourceAsTree() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getMinimumGradleVersion() - Method in interface org.gradle.docs.guides.Guide

Minimum Gradle version this guide works on.

getName() - Method in class org.gradle.docs.guides.internal.GuideBinary

getName() - Method in class org.gradle.docs.guides.internal.GuideInternal

getName() - Method in class org.gradle.docs.samples.internal.SampleBinary

getName() - Method in class org.gradle.docs.samples.internal.SampleInternal

getName() - Method in class org.gradle.docs.samples.internal.TemplateInternal

getName() - Method in class org.gradle.docs.snippets.internal.SnippetBinary

getName() - Method in class org.gradle.docs.snippets.internal.SnippetInternal

getObjectFactory() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

getOutputDirectory() - Method in class org.gradle.docs.samples.internal.tasks.GenerateTestSource

getOutputFile() - Method in class org.gradle.docs.guides.internal.tasks.GenerateGuidePageAsciidoc

getOutputFile() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSampleIndexAsciidoc

getOutputFile() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSamplePageAsciidoc

getOutputFile() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSanityCheckTests

getPermalink() - Method in interface org.gradle.docs.guides.GuideSummary

getPromoted() - Method in interface org.gradle.docs.samples.SampleSummary

By Convention this is true.

getPublishedGuides() - Method in interface org.gradle.docs.guides.Guides

getPublishedGuides() - Method in class org.gradle.docs.guides.internal.GuidesInternal

getPublishedSamples() - Method in class org.gradle.docs.samples.internal.SamplesInternal

getPublishedSamples() - Method in interface org.gradle.docs.samples.Samples

getPublishedSnippets() - Method in class org.gradle.docs.snippets.internal.SnippetsInternal

getPublishedSnippets() - Method in interface org.gradle.docs.snippets.Snippets

getReadmeFile() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSamplePageAsciidoc

getReadmeFile() - Method in interface org.gradle.docs.samples.Sample

By Convention, this is README.adoc within the sample directory.

getReadmeName() - Method in class org.gradle.docs.samples.internal.tasks.InstallSample

getRenderedDocumentation() - Method in interface org.gradle.docs.guides.GuidesDistribution

This is HTML and resources.

getRenderedDocumentation() - Method in interface org.gradle.docs.samples.SamplesDistribution

This is HTML and resources.

getRenderedDocumentationRoot() - Method in class org.gradle.docs.guides.internal.GuidesInternal

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

getRenderedDocumentationRoot() - Method in class org.gradle.docs.samples.internal.SamplesInternal

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

getRenderedIndexPageFile() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getRenderedIndexPageFile() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getRenderedPageFile() - Method in interface org.gradle.docs.internal.TestableRenderedContentLinksBinary

getRenderedPermalink() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getRenderedPermalink() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getReportFile() - Method in class org.gradle.docs.samples.internal.tasks.ValidateSampleBinary

getRepositoryPath() - Method in interface org.gradle.docs.guides.Guide

Path of repository relative to https://github.com.

getRepositoryPath() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getResourceFiles() - Method in interface org.gradle.docs.internal.RenderableContentBinary

getResourceSpec() - Method in interface org.gradle.docs.internal.RenderableContentBinary

getSampleDirectory() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getSampleDirectory() - Method in interface org.gradle.docs.samples.Sample

By convention, this is the sample name off the extension's sample root directory.

getSampleDocName() - Method in interface org.gradle.docs.samples.SampleSummary

getSampleIndexFile() - Method in interface org.gradle.docs.samples.Samples

This is an asciidoc file, not the generated HTML.

getSampleInstallDirectory() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getSampleLinkName() - Method in class org.gradle.docs.samples.internal.SampleInstallBinary

getSampleName() - Method in class org.gradle.docs.samples.internal.tasks.ValidateSampleBinary

getSamples() - Method in interface org.gradle.docs.DocumentationExtension

getSamples() - Method in class org.gradle.docs.internal.DocumentationExtensionInternal

getSamples() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSampleIndexAsciidoc

getSamples() - Method in class org.gradle.docs.samples.internal.tasks.SamplesReport

getSamplesRoot() - Method in interface org.gradle.docs.samples.Samples

By convention, this is src/samples

getSampleSummary() - Method in class org.gradle.docs.samples.internal.tasks.GenerateSamplePageAsciidoc

getSnippets() - Method in interface org.gradle.docs.DocumentationExtension

getSnippets() - Method in class org.gradle.docs.internal.DocumentationExtensionInternal

getSnippetsRoot() - Method in interface org.gradle.docs.snippets.Snippets

By convention, this is src/docs/snippets

getSource() - Method in class org.gradle.docs.samples.internal.tasks.InstallSample

getSource() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getSourceAsTree() - Method in class org.gradle.docs.samples.internal.tasks.InstallSample

getSourceAsTree() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getSourceDirectory() - Method in interface org.gradle.docs.samples.Template

getSourcePageFile() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getSourcePageFile() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getSourcePattern() - Method in interface org.gradle.docs.internal.RenderableContentBinary

getSourcePermalink() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getSourcePermalink() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getStartingSample() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestCase

getStartingSampleDirectory() - Method in interface org.gradle.docs.internal.TestableAsciidoctorContentBinary

getSummary() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getTarget() - Method in interface org.gradle.docs.samples.Template

getTemplateDirectory() - Method in interface org.gradle.docs.samples.Template

getTemplates() - Method in class org.gradle.docs.samples.internal.SamplesInternal

getTemplates() - Method in interface org.gradle.docs.samples.Samples

getTemplatesRoot() - Method in interface org.gradle.docs.samples.Samples

By convention, this is src/samples/templates

getTestCases() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

getTestCases() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestParameters

getTestedInstallDirectory() - Method in class org.gradle.docs.samples.internal.SampleExemplarBinary

getTestedInstalledSamples() - Method in interface org.gradle.docs.samples.SamplesDistribution

getTestedInstallRoot() - Method in class org.gradle.docs.samples.internal.SamplesInternal

By convention, this is buildDir/working/samples/testing

getTestedWorkingDirectory() - Method in class org.gradle.docs.samples.internal.SampleExemplarBinary

getTestsContent() - Method in class org.gradle.docs.samples.internal.SampleExemplarBinary

getTestsContent() - Method in interface org.gradle.docs.samples.Sample

getValidationReport() - Method in class org.gradle.docs.samples.internal.SampleArchiveBinary

getViewablePageFile() - Method in interface org.gradle.docs.internal.ViewableContentBinary

getViewTaskName() - Method in class org.gradle.docs.guides.internal.GuideContentBinary

getViewTaskName() - Method in interface org.gradle.docs.internal.ViewableContentBinary

getViewTaskName() - Method in class org.gradle.docs.samples.internal.SampleContentBinary

getWorkerExecuter() - Method in class org.gradle.docs.internal.tasks.CheckLinks

getWorkerExecutor() - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

getWorkerLeaseService() - Method in class org.gradle.docs.samples.internal.tasks.InstallSample

getWorkerLeaseService() - Method in class org.gradle.docs.samples.internal.tasks.LockReleasingAsciidoctorTask

getWorkerLeaseService() - Method in class org.gradle.docs.samples.internal.tasks.SyncWithProvider

getWorkerLeaseService() - Method in class org.gradle.docs.samples.internal.tasks.ZipSample

getWorkingDirectory() - Method in class org.gradle.docs.samples.internal.SampleInstallBinary

getWorkspaceDirectory() - Method in interface org.gradle.docs.internal.exemplar.AsciidoctorContentTestParameters

getZipFile() - Method in class org.gradle.docs.samples.internal.SampleArchiveBinary

getZipFile() - Method in class org.gradle.docs.samples.internal.tasks.ValidateSampleBinary

getZippedSamples() - Method in interface org.gradle.docs.samples.SamplesDistribution

GradleUserHomePathOutputNormalizer - Class in org.gradle.docs.internal.exemplar

GradleUserHomePathOutputNormalizer(File) - Constructor for class org.gradle.docs.internal.exemplar.GradleUserHomePathOutputNormalizer

groovy(Action<? super ConfigurableFileCollection>) - Method in class org.gradle.docs.samples.internal.SampleInternal

groovy(Action<? super ConfigurableFileCollection>) - Method in interface org.gradle.docs.samples.Sample

Configure Groovy content.

Guide - Interface in org.gradle.docs.guides

GUIDE_EXTENSION_NAME - Static variable in class org.gradle.docs.guides.internal.LegacyGuideDocumentationPlugin

GuideBinary - Class in org.gradle.docs.guides.internal

GuideBinary(String) - Constructor for class org.gradle.docs.guides.internal.GuideBinary

GuideContentBinary - Class in org.gradle.docs.guides.internal

GuideContentBinary(String) - Constructor for class org.gradle.docs.guides.internal.GuideContentBinary

GuideInternal - Class in org.gradle.docs.guides.internal

GuideInternal(String) - Constructor for class org.gradle.docs.guides.internal.GuideInternal

guides(Action<? super Guides>) - Method in interface org.gradle.docs.DocumentationExtension

Guides - Interface in org.gradle.docs.guides

guides(Action<? super Guides>) - Method in class org.gradle.docs.internal.DocumentationExtensionInternal

GuidesDistribution - Interface in org.gradle.docs.guides

GuidesDocumentationPlugin - Class in org.gradle.docs.guides.internal

GuidesDocumentationPlugin() - Constructor for class org.gradle.docs.guides.internal.GuidesDocumentationPlugin

GuidesInternal - Class in org.gradle.docs.guides.internal

GuidesInternal(ObjectFactory) - Constructor for class org.gradle.docs.guides.internal.GuidesInternal

GuideSummary - Interface in org.gradle.docs.guides

I

InstallSample - Class in org.gradle.docs.samples.internal.tasks

Installs the sample's zip to the given directory.

InstallSample() - Constructor for class org.gradle.docs.samples.internal.tasks.InstallSample

IOUtils - Class in org.gradle.docs.internal

IOUtils() - Constructor for class org.gradle.docs.internal.IOUtils

K

kotlin(Action<? super ConfigurableFileCollection>) - Method in class org.gradle.docs.samples.internal.SampleInternal

kotlin(Action<? super ConfigurableFileCollection>) - Method in interface org.gradle.docs.samples.Sample

Configure Kotlin content.

L

LegacyGuideDocumentationPlugin - Class in org.gradle.docs.guides.internal

The guides base plugin provides conventions for all Gradle guides.

LegacyGuideDocumentationPlugin() - Constructor for class org.gradle.docs.guides.internal.LegacyGuideDocumentationPlugin

LegacySamplesDocumentationPlugin - Class in org.gradle.docs.samples.internal

LegacySamplesDocumentationPlugin() - Constructor for class org.gradle.docs.samples.internal.LegacySamplesDocumentationPlugin

LockReleasingAsciidoctorTask - Class in org.gradle.docs.samples.internal.tasks

LockReleasingAsciidoctorTask(WorkerExecutor) - Constructor for class org.gradle.docs.samples.internal.tasks.LockReleasingAsciidoctorTask

N

newOutputCapturingStream(AsciidoctorContentTestConsoleType) - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTestWorkerAction

normalize(String, ExecutionMetadata) - Method in class org.gradle.docs.internal.exemplar.GradleUserHomePathOutputNormalizer

O

org.gradle.docs - package org.gradle.docs

org.gradle.docs.guides - package org.gradle.docs.guides

org.gradle.docs.guides.internal - package org.gradle.docs.guides.internal

org.gradle.docs.guides.internal.tasks - package org.gradle.docs.guides.internal.tasks

org.gradle.docs.internal - package org.gradle.docs.internal

org.gradle.docs.internal.configure - package org.gradle.docs.internal.configure

org.gradle.docs.internal.exemplar - package org.gradle.docs.internal.exemplar

org.gradle.docs.internal.tasks - package org.gradle.docs.internal.tasks

org.gradle.docs.samples - package org.gradle.docs.samples

org.gradle.docs.samples.internal - package org.gradle.docs.samples.internal

org.gradle.docs.samples.internal.tasks - package org.gradle.docs.samples.internal.tasks

org.gradle.docs.snippets - package org.gradle.docs.snippets

org.gradle.docs.snippets.internal - package org.gradle.docs.snippets.internal

OutputNormalizers - Class in org.gradle.docs.internal.exemplar

OutputNormalizers() - Constructor for class org.gradle.docs.internal.exemplar.OutputNormalizers

P

processAsciidocSources() - Method in class org.gradle.docs.samples.internal.tasks.LockReleasingAsciidoctorTask

R

RenderableContentBinary - Interface in org.gradle.docs.internal

S

Sample - Interface in org.gradle.docs.samples

Represent a sample to be documented.

SampleArchiveBinary - Class in org.gradle.docs.samples.internal

Represents a sample tailored for a particular DSL.

SampleArchiveBinary(String) - Constructor for class org.gradle.docs.samples.internal.SampleArchiveBinary

SampleBinary - Class in org.gradle.docs.samples.internal

SampleBinary(String) - Constructor for class org.gradle.docs.samples.internal.SampleBinary

SampleContentBinary - Class in org.gradle.docs.samples.internal

SampleContentBinary(String) - Constructor for class org.gradle.docs.samples.internal.SampleContentBinary

SampleExemplarBinary - Class in org.gradle.docs.samples.internal

SampleExemplarBinary(String) - Constructor for class org.gradle.docs.samples.internal.SampleExemplarBinary

SampleInstallBinary - Class in org.gradle.docs.samples.internal

SampleInstallBinary(String) - Constructor for class org.gradle.docs.samples.internal.SampleInstallBinary

SampleInternal - Class in org.gradle.docs.samples.internal

SampleInternal(String, TaskContainer) - Constructor for class org.gradle.docs.samples.internal.SampleInternal

samples(Action<? super Samples>) - Method in interface org.gradle.docs.DocumentationExtension

samples(Action<? super Samples>) - Method in class org.gradle.docs.internal.DocumentationExtensionInternal

Samples - Interface in org.gradle.docs.samples

SamplesDistribution - Interface in org.gradle.docs.samples

This represents the outputs of the samples section of the documentation.

SamplesDocumentationPlugin - Class in org.gradle.docs.samples.internal

SamplesDocumentationPlugin() - Constructor for class org.gradle.docs.samples.internal.SamplesDocumentationPlugin

SamplesInternal - Class in org.gradle.docs.samples.internal

SamplesInternal(ObjectFactory) - Constructor for class org.gradle.docs.samples.internal.SamplesInternal

SamplesReport - Class in org.gradle.docs.samples.internal.tasks

Generates report with list of samples and the resolved attributes of the sample.

SamplesReport() - Constructor for class org.gradle.docs.samples.internal.tasks.SamplesReport

SampleSummary - Interface in org.gradle.docs.samples

Snippet - Interface in org.gradle.docs.snippets

SnippetBinary - Class in org.gradle.docs.snippets.internal

SnippetBinary(String) - Constructor for class org.gradle.docs.snippets.internal.SnippetBinary

SnippetInternal - Class in org.gradle.docs.snippets.internal

SnippetInternal(String) - Constructor for class org.gradle.docs.snippets.internal.SnippetInternal

snippets(Action<? super Snippets>) - Method in interface org.gradle.docs.DocumentationExtension

snippets(Action<? super Snippets>) - Method in class org.gradle.docs.internal.DocumentationExtensionInternal

Snippets - Interface in org.gradle.docs.snippets

SnippetsDocumentationPlugin - Class in org.gradle.docs.snippets.internal

SnippetsDocumentationPlugin() - Constructor for class org.gradle.docs.snippets.internal.SnippetsDocumentationPlugin

SnippetsInternal - Class in org.gradle.docs.snippets.internal

SnippetsInternal(ObjectFactory) - Constructor for class org.gradle.docs.snippets.internal.SnippetsInternal

StringUtils - Class in org.gradle.docs.internal

StringUtils() - Constructor for class org.gradle.docs.internal.StringUtils

SyncWithProvider - Class in org.gradle.docs.samples.internal.tasks

SyncWithProvider(ProjectLayout, ProviderFactory) - Constructor for class org.gradle.docs.samples.internal.tasks.SyncWithProvider

T

Template - Interface in org.gradle.docs.samples

TemplateInternal - Class in org.gradle.docs.samples.internal

TemplateInternal(String) - Constructor for class org.gradle.docs.samples.internal.TemplateInternal

TestableAsciidoctorContentBinary - Interface in org.gradle.docs.internal

TestableAsciidoctorGuideContentBinary - Class in org.gradle.docs.guides.internal

TestableAsciidoctorGuideContentBinary(String) - Constructor for class org.gradle.docs.guides.internal.TestableAsciidoctorGuideContentBinary

TestableAsciidoctorSampleContentBinary - Class in org.gradle.docs.samples.internal

TestableAsciidoctorSampleContentBinary(String) - Constructor for class org.gradle.docs.samples.internal.TestableAsciidoctorSampleContentBinary

TestableRenderedContentLinksBinary - Interface in org.gradle.docs.internal

testCase(Action<? super AsciidoctorContentTestCase>) - Method in class org.gradle.docs.internal.exemplar.AsciidoctorContentTest

tests(Action<? super ConfigurableFileCollection>) - Method in class org.gradle.docs.samples.internal.SampleInternal

tests(Action<? super ConfigurableFileCollection>) - Method in interface org.gradle.docs.samples.Sample

Configure testing content.

toFunctional(OutputNormalizer) - Static method in class org.gradle.docs.internal.exemplar.OutputNormalizers

toKebabCase(String) - Static method in class org.gradle.docs.internal.StringUtils

Like StringUtils.toSnakeCase(String), except separated by hyphens.

toLowerCamelCase(String) - Static method in class org.gradle.docs.internal.StringUtils

Capitalizes every word in a string, removes all spaces and joins them together as one identifier.

toSnakeCase(String) - Static method in class org.gradle.docs.internal.StringUtils

Splits a string based on uppercase letters and rejoins them with underscores and makes the identifier lowercase.

toString() - Method in class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

toString(InputStream, Charset) - Static method in class org.gradle.docs.internal.IOUtils

toSummary(ObjectFactory, SampleInternal) - Static method in class org.gradle.docs.samples.internal.SamplesDocumentationPlugin

toTitleCase(String) - Static method in class org.gradle.docs.internal.StringUtils

Capitalizes every word in a string.

U

uncapitalize(String) - Static method in class org.gradle.docs.internal.StringUtils

Makes the first letter of the string lowercase.

UserInputOutputVerifier - Class in org.gradle.docs.internal.exemplar

UserInputOutputVerifier(List<String>) - Constructor for class org.gradle.docs.internal.exemplar.UserInputOutputVerifier

V

validate() - Method in class org.gradle.docs.samples.internal.tasks.ValidateSampleBinary

ValidateSampleBinary - Class in org.gradle.docs.samples.internal.tasks

ValidateSampleBinary() - Constructor for class org.gradle.docs.samples.internal.tasks.ValidateSampleBinary

valueOf(String) - Static method in enum org.gradle.docs.internal.exemplar.AsciidoctorContentTestConsoleType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gradle.docs.samples.Dsl

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.gradle.docs.internal.exemplar.AsciidoctorContentTestConsoleType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.gradle.docs.samples.Dsl

Returns an array containing the constants of this enum type, in the order they are declared.

verify(String, String, boolean) - Method in class org.gradle.docs.internal.exemplar.UserInputOutputVerifier

ViewableContentBinary - Interface in org.gradle.docs.internal

ViewDocumentation - Class in org.gradle.docs.internal.tasks

ViewDocumentation() - Constructor for class org.gradle.docs.internal.tasks.ViewDocumentation

W

write(int) - Method in class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

write(byte[]) - Method in class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

write(byte[], int, int) - Method in class org.gradle.docs.internal.exemplar.AnsiCharactersToPlainTextOutputStream

Z

ZipSample - Class in org.gradle.docs.samples.internal.tasks

Zips a sample to the given location.

ZipSample() - Constructor for class org.gradle.docs.samples.internal.tasks.ZipSample

A B C D E F G I K L N O P R S T U V W Z