io.warp10.warpfleet.actions

Class GenerateDocumentation

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

io.warp10.warpfleet.actions.GenerateDocumentation

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public abstract class GenerateDocumentation
extends org.gradle.api.DefaultTask

The type Generate documentation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
GenerateDocumentation() Instantiates a new Generate documentation.

Method Summary

Modifier and Type	Method and Description
void	generateDocumentation() Generate documentation.
abstract org.gradle.api.provider.Property<java.lang.String>	getWfDest() Gets wf dest.
abstract org.gradle.api.provider.Property<java.lang.String>	getWfFormat() Gets wf format.
abstract org.gradle.api.provider.Property<java.lang.String>	getWfMacroDir() Gets wf macro dir.
abstract org.gradle.api.provider.Property<java.lang.String>	getWfSource() Gets wf source.
abstract org.gradle.api.provider.Property<java.lang.String>	getWfUrl() Gets wf url.

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

GenerateDocumentation

public GenerateDocumentation()

Instantiates a new Generate documentation.

Method Detail

getWfUrl

@Input
public abstract org.gradle.api.provider.Property<java.lang.String> getWfUrl()

Gets wf url.

Returns:

the wf url

getWfSource

@Input
 @Optional
public abstract org.gradle.api.provider.Property<java.lang.String> getWfSource()

Gets wf source.

Returns:

the wf source

getWfDest

@Input
public abstract org.gradle.api.provider.Property<java.lang.String> getWfDest()

Gets wf dest.

Returns:

the wf dest

getWfFormat

@Input
 @Optional
public abstract org.gradle.api.provider.Property<java.lang.String> getWfFormat()

Gets wf format.

Returns:

the wf format

getWfMacroDir

@Input
 @Optional
public abstract org.gradle.api.provider.Property<java.lang.String> getWfMacroDir()

Gets wf macro dir.

Returns:

the wf macro dir

generateDocumentation

public void generateDocumentation()
                           throws java.io.IOException

Generate documentation.

Throws:

java.io.IOException - the io exception