PublishGuideTask (Grails 7.0.0-SNAPSHOT)

grails.doc.gradle.PublishGuideTask

@org.gradle.api.tasks.CacheableTask
class PublishGuideTask
extends DefaultTask

Gradle task for generating a gdoc-based HTML user guide.

Properties Summary

Properties
Type	Name and description
`Property<java.lang.Boolean>`	`asciidoc`
`Property<java.lang.String>`	`language`
`ListProperty<java.lang.Object>`	`macros`
`MapProperty<java.lang.String, java.lang.Object>`	`properties`
`ConfigurableFileCollection`	`propertiesFiles`
`MapProperty<java.lang.String, java.io.File>`	`propertiesWithFilePaths`
`DirectoryProperty`	`resourcesDir`
`DirectoryProperty`	`rootProjectDir`
`DirectoryProperty`	`sourceDir`
`Property<java.lang.String>`	`sourceRepo`
`DirectoryProperty`	`targetDir`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Map<java.lang.String, java.lang.String>`	`getRelativizedPropertiesWithFilePaths()`
	`java.lang.Object`	`publishGuide()`

- Property Detail
  - @java.util.Optional
    @org.gradle.api.tasks.Input
    final Property<java.lang.Boolean> asciidoc
  - @java.util.Optional
    @org.gradle.api.tasks.Input
    final Property<java.lang.String> language
  - @java.util.Optional
    @org.gradle.api.tasks.Input
    final ListProperty<java.lang.Object> macros
  - @java.util.Optional
    @org.gradle.api.tasks.Input
    final MapProperty<java.lang.String, java.lang.Object> properties
  - @java.util.Optional
    @org.gradle.api.tasks.InputFiles
    @org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
    final ConfigurableFileCollection propertiesFiles
  - @org.gradle.api.tasks.Internal
    final MapProperty<java.lang.String, java.io.File> propertiesWithFilePaths
  - @java.util.Optional
    @org.gradle.api.tasks.InputDirectory
    @org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
    final DirectoryProperty resourcesDir
  - @org.gradle.api.tasks.Internal
    final DirectoryProperty rootProjectDir
  - @org.gradle.api.tasks.InputDirectory
    @org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
    final DirectoryProperty sourceDir
  - @java.util.Optional
    @org.gradle.api.tasks.Input
    final Property<java.lang.String> sourceRepo
  - @org.gradle.api.tasks.OutputDirectory
    final DirectoryProperty targetDir
- Constructor Detail
  - @javax.inject.Inject
    PublishGuideTask(ObjectFactory objects, Project project)
- Method Detail
  - @java.util.Optional
    @org.gradle.api.tasks.Input
    java.util.Map<java.lang.String, java.lang.String> getRelativizedPropertiesWithFilePaths()
  - @org.gradle.api.tasks.TaskAction
    java.lang.Object publishGuide()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class PublishGuideTask

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@java.util.Optional
@org.gradle.api.tasks.Input
final Property<java.lang.Boolean> asciidoc

@java.util.Optional
@org.gradle.api.tasks.Input
final Property<java.lang.String> language

@java.util.Optional
@org.gradle.api.tasks.Input
final ListProperty<java.lang.Object> macros

@java.util.Optional
@org.gradle.api.tasks.Input
final MapProperty<java.lang.String, java.lang.Object> properties

@java.util.Optional
@org.gradle.api.tasks.InputFiles
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final ConfigurableFileCollection propertiesFiles

@org.gradle.api.tasks.Internal
final MapProperty<java.lang.String, java.io.File> propertiesWithFilePaths

@java.util.Optional
@org.gradle.api.tasks.InputDirectory
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final DirectoryProperty resourcesDir

@org.gradle.api.tasks.Internal
final DirectoryProperty rootProjectDir

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

@java.util.Optional
@org.gradle.api.tasks.Input
final Property<java.lang.String> sourceRepo

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

Constructor Detail

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

Method Detail

@java.util.Optional
@org.gradle.api.tasks.Input
java.util.Map<java.lang.String, java.lang.String> getRelativizedPropertiesWithFilePaths()

@org.gradle.api.tasks.TaskAction
java.lang.Object publishGuide()

[Groovy] Class PublishGuideTask

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@java.util.Optional@org.gradle.api.tasks.Inputfinal Property<java.lang.Boolean> asciidoc

@java.util.Optional@org.gradle.api.tasks.Inputfinal Property<java.lang.String> language

@java.util.Optional@org.gradle.api.tasks.Inputfinal ListProperty<java.lang.Object> macros

@java.util.Optional@org.gradle.api.tasks.Inputfinal MapProperty<java.lang.String, java.lang.Object> properties

@java.util.Optional@org.gradle.api.tasks.InputFiles@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)final ConfigurableFileCollection propertiesFiles

@org.gradle.api.tasks.Internalfinal MapProperty<java.lang.String, java.io.File> propertiesWithFilePaths

@java.util.Optional@org.gradle.api.tasks.InputDirectory@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)final DirectoryProperty resourcesDir

@org.gradle.api.tasks.Internalfinal DirectoryProperty rootProjectDir

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

@java.util.Optional@org.gradle.api.tasks.Inputfinal Property<java.lang.String> sourceRepo

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

Constructor Detail

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

Method Detail

@java.util.Optional@org.gradle.api.tasks.Inputjava.util.Map<java.lang.String, java.lang.String> getRelativizedPropertiesWithFilePaths()

@org.gradle.api.tasks.TaskActionjava.lang.Object publishGuide()

@java.util.Optional
@org.gradle.api.tasks.Input
final Property<java.lang.Boolean> asciidoc

@java.util.Optional
@org.gradle.api.tasks.Input
final Property<java.lang.String> language

@java.util.Optional
@org.gradle.api.tasks.Input
final ListProperty<java.lang.Object> macros

@java.util.Optional
@org.gradle.api.tasks.Input
final MapProperty<java.lang.String, java.lang.Object> properties

@java.util.Optional
@org.gradle.api.tasks.InputFiles
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final ConfigurableFileCollection propertiesFiles

@org.gradle.api.tasks.Internal
final MapProperty<java.lang.String, java.io.File> propertiesWithFilePaths

@java.util.Optional
@org.gradle.api.tasks.InputDirectory
@org.gradle.api.tasks.PathSensitive(value: PathSensitivity.RELATIVE)
final DirectoryProperty resourcesDir

@org.gradle.api.tasks.Internal
final DirectoryProperty rootProjectDir

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

@java.util.Optional
@org.gradle.api.tasks.Input
final Property<java.lang.String> sourceRepo

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

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

@java.util.Optional
@org.gradle.api.tasks.Input
java.util.Map<java.lang.String, java.lang.String> getRelativizedPropertiesWithFilePaths()

@org.gradle.api.tasks.TaskAction
java.lang.Object publishGuide()