Package com.liferay.gradle.plugins.jsdoc

Class JSDocTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.liferay.gradle.plugins.node.task.ExecuteNodeTask
com.liferay.gradle.plugins.node.task.ExecuteNodeScriptTask
com.liferay.gradle.plugins.jsdoc.JSDocTask
All Implemented Interfaces:
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>
@CacheableTask public class JSDocTask extends com.liferay.gradle.plugins.node.task.ExecuteNodeScriptTask

  • 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
    Description
    JSDocTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<String>
    getCompleteArgs()
     
    org.gradle.api.resources.TextResource
    getConfiguration()
     
    File
    getDestinationDir()
     
    File
    getPackageJsonFile()
     
    File
    getReadmeFile()
     
    org.gradle.api.file.FileCollection
    getSourceDirs()
     
    File
    getTutorialsDir()
     
    void
    setConfiguration(org.gradle.api.resources.TextResource configurationTextResource)
     
    void
    setDestinationDir(Object destinationDir)
     
    void
    setPackageJsonFile(Object packageJsonFile)
     
    void
    setReadmeFile(Object readmeFile)
     
    void
    setSourceDirs(Iterable<Object> sourceDirs)
     
    void
    setSourceDirs(Object... sourceDirs)
     
    void
    setTutorialsDir(Object tutorialsDir)
     
    JSDocTask
    sourceDirs(Iterable<Object> sourceDirs)
     
    JSDocTask
    sourceDirs(Object... sourceDirs)
     

    Methods inherited from class com.liferay.gradle.plugins.node.task.ExecuteNodeScriptTask

    executeNode, getScriptFile, setScriptFile

    Methods inherited from class com.liferay.gradle.plugins.node.task.ExecuteNodeTask

    args, args, environment, environment, getArgs, getCommand, getEnvironment, getNodeDir, getNpmInstallRetries, getResult, getWorkingDir, isInheritProxy, isUseGradleExec, setArgs, setArgs, setCommand, setEnvironment, setInheritProxy, setNodeDir, setNpmInstallRetries, setUseGradleExec, setWorkingDir

    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

    acceptServiceReferences, 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 Details

    • JSDocTask

      public JSDocTask()

  • Method Details

    • getConfiguration

      @Optional public org.gradle.api.resources.TextResource getConfiguration()

    • getDestinationDir

      @OutputDirectory public File getDestinationDir()

    • getPackageJsonFile

      @InputFile @Optional @PathSensitive(RELATIVE) public File getPackageJsonFile()

    • getReadmeFile

      @InputFile @Optional @PathSensitive(RELATIVE) public File getReadmeFile()

    • getSourceDirs

      @InputFiles @PathSensitive(RELATIVE) public org.gradle.api.file.FileCollection getSourceDirs()

    • getTutorialsDir

      @InputDirectory @Optional @PathSensitive(RELATIVE) public File getTutorialsDir()

    • setConfiguration

      public void setConfiguration(org.gradle.api.resources.TextResource configurationTextResource)

    • setDestinationDir

      public void setDestinationDir(Object destinationDir)

    • setPackageJsonFile

      public void setPackageJsonFile(Object packageJsonFile)

    • setReadmeFile

      public void setReadmeFile(Object readmeFile)

    • setSourceDirs

      public void setSourceDirs(Iterable<Object> sourceDirs)

    • setSourceDirs

      public void setSourceDirs(Object... sourceDirs)

    • setTutorialsDir

      public void setTutorialsDir(Object tutorialsDir)

    • sourceDirs

      public JSDocTask sourceDirs(Iterable<Object> sourceDirs)

    • sourceDirs

      public JSDocTask sourceDirs(Object... sourceDirs)

    • getCompleteArgs

      @Internal protected List<String> getCompleteArgs()
      Overrides:
      getCompleteArgs in class com.liferay.gradle.plugins.node.task.ExecuteNodeScriptTask