CreateReleaseDropDownTask (Grails 7.0.0-SNAPSHOT)

grails.doc.dropdown.CreateReleaseDropDownTask

@groovy.transform.CompileStatic
@org.gradle.api.tasks.CacheableTask
abstract class CreateReleaseDropDownTask
extends DefaultTask

Duplicates the documentation and modifies source files to add a release dropdown to the documentation

Since:: 6.2.1

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`CreateReleaseDropDownTask.1`

Properties Summary

Properties
Type	Name and description
`Property<java.lang.String>`	`additionalPath`
`Property<java.lang.String>`	`docBaseUrl`
`ConfigurableFileCollection`	`filesToAddDropdowns`
`RegularFileProperty`	`gitTags`
`Property<java.lang.String>`	`githubSlug`
`Property<SoftwareVersion>`	`minimumVersion`
`DirectoryProperty`	`modifiedPagesDirectory`
`Property<java.lang.String>`	`projectVersion`
`DirectoryProperty`	`sourceDocsDirectory`
`Property<java.lang.String>`	`versionHtml`

Constructor Summary

Constructors
Constructor and description
`CreateReleaseDropDownTask(ObjectFactory objects, Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`createReleaseDropDown()` Add the release dropdown to the documentation

- Property Detail
  - @org.gradle.api.tasks.Input
    final Property<java.lang.String> additionalPath
  - @org.gradle.api.tasks.Input
    final Property<java.lang.String> docBaseUrl
  - @org.gradle.api.tasks.InputFiles
    @org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
    final ConfigurableFileCollection filesToAddDropdowns
  - @org.gradle.api.tasks.InputFile
    @org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
    final RegularFileProperty gitTags
  - @org.gradle.api.tasks.Input
    final Property<java.lang.String> githubSlug
  - @org.gradle.api.tasks.Input
    final Property<SoftwareVersion> minimumVersion
  - @org.gradle.api.tasks.OutputDirectory
    final DirectoryProperty modifiedPagesDirectory
  - @org.gradle.api.tasks.Input
    final Property<java.lang.String> projectVersion
  - @org.gradle.api.tasks.InputDirectory
    @org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
    final DirectoryProperty sourceDocsDirectory
  - @org.gradle.api.tasks.Input
    final Property<java.lang.String> versionHtml
- Constructor Detail
  - @javax.inject.Inject
    CreateReleaseDropDownTask(ObjectFactory objects, Project project)
- Method Detail
  - @org.gradle.api.tasks.TaskAction
    void createReleaseDropDown()
    
    Add the release dropdown to the documentation

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class CreateReleaseDropDownTask

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@org.gradle.api.tasks.Input
final Property<java.lang.String> additionalPath

@org.gradle.api.tasks.Input
final Property<java.lang.String> docBaseUrl

@org.gradle.api.tasks.InputFiles
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final ConfigurableFileCollection filesToAddDropdowns

@org.gradle.api.tasks.InputFile
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final RegularFileProperty gitTags

@org.gradle.api.tasks.Input
final Property<java.lang.String> githubSlug

@org.gradle.api.tasks.Input
final Property<SoftwareVersion> minimumVersion

@org.gradle.api.tasks.OutputDirectory
final DirectoryProperty modifiedPagesDirectory

@org.gradle.api.tasks.Input
final Property<java.lang.String> projectVersion

@org.gradle.api.tasks.InputDirectory
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final DirectoryProperty sourceDocsDirectory

@org.gradle.api.tasks.Input
final Property<java.lang.String> versionHtml

Constructor Detail

@javax.inject.Inject
CreateReleaseDropDownTask(ObjectFactory objects, Project project)

Method Detail

@org.gradle.api.tasks.TaskAction
void createReleaseDropDown()

[Groovy] Class CreateReleaseDropDownTask

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@org.gradle.api.tasks.Inputfinal Property<java.lang.String> additionalPath

@org.gradle.api.tasks.Inputfinal Property<java.lang.String> docBaseUrl

@org.gradle.api.tasks.InputFiles@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)final ConfigurableFileCollection filesToAddDropdowns

@org.gradle.api.tasks.InputFile@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)final RegularFileProperty gitTags

@org.gradle.api.tasks.Inputfinal Property<java.lang.String> githubSlug

@org.gradle.api.tasks.Inputfinal Property<SoftwareVersion> minimumVersion

@org.gradle.api.tasks.OutputDirectoryfinal DirectoryProperty modifiedPagesDirectory

@org.gradle.api.tasks.Inputfinal Property<java.lang.String> projectVersion

@org.gradle.api.tasks.InputDirectory@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)final DirectoryProperty sourceDocsDirectory

@org.gradle.api.tasks.Inputfinal Property<java.lang.String> versionHtml

Constructor Detail

@javax.inject.InjectCreateReleaseDropDownTask(ObjectFactory objects, Project project)

Method Detail

@org.gradle.api.tasks.TaskActionvoid createReleaseDropDown()

@org.gradle.api.tasks.Input
final Property<java.lang.String> additionalPath

@org.gradle.api.tasks.Input
final Property<java.lang.String> docBaseUrl

@org.gradle.api.tasks.InputFiles
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final ConfigurableFileCollection filesToAddDropdowns

@org.gradle.api.tasks.InputFile
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final RegularFileProperty gitTags

@org.gradle.api.tasks.Input
final Property<java.lang.String> githubSlug

@org.gradle.api.tasks.Input
final Property<SoftwareVersion> minimumVersion

@org.gradle.api.tasks.OutputDirectory
final DirectoryProperty modifiedPagesDirectory

@org.gradle.api.tasks.Input
final Property<java.lang.String> projectVersion

@org.gradle.api.tasks.InputDirectory
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final DirectoryProperty sourceDocsDirectory

@org.gradle.api.tasks.Input
final Property<java.lang.String> versionHtml

@javax.inject.Inject
CreateReleaseDropDownTask(ObjectFactory objects, Project project)

@org.gradle.api.tasks.TaskAction
void createReleaseDropDown()