PublishGuideTask (Grace Framework

org.grails.gradle.plugin.doc.PublishGuideTask

```
@CompileStatic
class PublishGuideTask
extends DefaultTask
```
A task used to publish the user guide if a publin that is in GDoc format
Authors:
Graeme Rocher
Michael Yan
Since:
3.0

Properties Summary

Properties
Type	Name and description
`Boolean`	`asciidoc`
`Boolean`	`bookmarks`
`File`	`groovydocDir`
`File`	`javadocDir`
`String`	`language`
`Collection`	`macros`
`File`	`propertiesFile`
`File`	`resourcesDir`
`String`	`singleHtml`
`File`	`sourceDir`
`String`	`sourceRepo`
`File`	`targetDir`
`File`	`workDir`

Constructor Summary

Constructors
Constructor and description
`PublishGuideTask()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`execute(InputChanges inputs)`
	`protected void`	`publishGuide()`

- Property Detail
  - @org.gradle.api.tasks.Input
    @Optional
    Boolean asciidoc
  - @org.gradle.api.tasks.Input
    @Optional
    Boolean bookmarks
  - @org.gradle.api.tasks.InputDirectory
    @Optional
    File groovydocDir
  - @org.gradle.api.tasks.InputDirectory
    @Optional
    File javadocDir
  - @org.gradle.api.tasks.Input
    @Optional
    String language
  - @org.gradle.api.tasks.Input
    @Optional
    Collection macros
  - @org.gradle.api.tasks.InputFile
    @Optional
    File propertiesFile
  - @org.gradle.api.tasks.InputDirectory
    @Optional
    File resourcesDir
  - @org.gradle.api.tasks.Input
    @Optional
    String singleHtml
  - @org.gradle.api.tasks.InputDirectory
    File sourceDir
  - @org.gradle.api.tasks.Input
    @Optional
    String sourceRepo
  - @org.gradle.api.tasks.OutputDirectory
    @Optional
    File targetDir
  - @org.gradle.api.tasks.OutputDirectory
    @Optional
    File workDir
- Constructor Detail
  - PublishGuideTask()
- Method Detail
  - @org.gradle.api.tasks.TaskAction
    void execute(InputChanges inputs)
  - protected void publishGuide()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class PublishGuideTask

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@org.gradle.api.tasks.Input
@Optional
Boolean asciidoc

@org.gradle.api.tasks.Input
@Optional
Boolean bookmarks

@org.gradle.api.tasks.InputDirectory
@Optional
File groovydocDir

@org.gradle.api.tasks.InputDirectory
@Optional
File javadocDir

@org.gradle.api.tasks.Input
@Optional
String language

@org.gradle.api.tasks.Input
@Optional
Collection macros

@org.gradle.api.tasks.InputFile
@Optional
File propertiesFile

@org.gradle.api.tasks.InputDirectory
@Optional
File resourcesDir

@org.gradle.api.tasks.Input
@Optional
String singleHtml

@org.gradle.api.tasks.InputDirectory
File sourceDir

@org.gradle.api.tasks.Input
@Optional
String sourceRepo

@org.gradle.api.tasks.OutputDirectory
@Optional
File targetDir

@org.gradle.api.tasks.OutputDirectory
@Optional
File workDir

Constructor Detail

PublishGuideTask()

Method Detail

@org.gradle.api.tasks.TaskAction
void execute(InputChanges inputs)

protected void publishGuide()

[Groovy] Class PublishGuideTask

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@org.gradle.api.tasks.Input@OptionalBoolean asciidoc

@org.gradle.api.tasks.Input@OptionalBoolean bookmarks

@org.gradle.api.tasks.InputDirectory@OptionalFile groovydocDir

@org.gradle.api.tasks.InputDirectory@OptionalFile javadocDir

@org.gradle.api.tasks.Input@OptionalString language

@org.gradle.api.tasks.Input@OptionalCollection macros

@org.gradle.api.tasks.InputFile@OptionalFile propertiesFile

@org.gradle.api.tasks.InputDirectory@OptionalFile resourcesDir

@org.gradle.api.tasks.Input@OptionalString singleHtml

@org.gradle.api.tasks.InputDirectoryFile sourceDir

@org.gradle.api.tasks.Input@OptionalString sourceRepo

@org.gradle.api.tasks.OutputDirectory@OptionalFile targetDir

@org.gradle.api.tasks.OutputDirectory@OptionalFile workDir

Constructor Detail

PublishGuideTask()

Method Detail

@org.gradle.api.tasks.TaskActionvoid execute(InputChanges inputs)

protected void publishGuide()

@org.gradle.api.tasks.Input
@Optional
Boolean asciidoc

@org.gradle.api.tasks.Input
@Optional
Boolean bookmarks

@org.gradle.api.tasks.InputDirectory
@Optional
File groovydocDir

@org.gradle.api.tasks.InputDirectory
@Optional
File javadocDir

@org.gradle.api.tasks.Input
@Optional
String language

@org.gradle.api.tasks.Input
@Optional
Collection macros

@org.gradle.api.tasks.InputFile
@Optional
File propertiesFile

@org.gradle.api.tasks.InputDirectory
@Optional
File resourcesDir

@org.gradle.api.tasks.Input
@Optional
String singleHtml

@org.gradle.api.tasks.InputDirectory
File sourceDir

@org.gradle.api.tasks.Input
@Optional
String sourceRepo

@org.gradle.api.tasks.OutputDirectory
@Optional
File targetDir

@org.gradle.api.tasks.OutputDirectory
@Optional
File workDir

@org.gradle.api.tasks.TaskAction
void execute(InputChanges inputs)