Package org.gosulang.gradle.tasks.gosudoc

Class GosuDoc

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, InfersGosuRuntime, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
    @CacheableTask
public abstract class GosuDoc
extends org.gradle.api.tasks.SourceTask
implements InfersGosuRuntime

    • 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
      GosuDoc()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void generate()  
      org.gradle.api.file.FileCollection getClasspath()
      Returns the classpath to use to locate classes referenced by the documented source.
      org.gradle.api.file.DirectoryProperty getDestinationDir()  
      protected abstract org.gradle.process.ExecOperations getExecOperations()  
      protected abstract org.gradle.api.file.FileSystemOperations getFileSystemOperations()  
      org.gradle.api.file.ConfigurableFileCollection getGosuClasspath()
      Returns the classpath to use to load the gosudoc tool.
      GosuDocOptions getGosuDocOptions()
      Returns the gosudoc generation options.
      protected abstract org.gradle.api.file.ProjectLayout getLayout()  
      protected abstract org.gradle.api.model.ObjectFactory getObjectFactory()  
      org.gradle.api.file.FileTree getSource()
      java.lang.String getTitle()
      Returns the documentation title.
      void setClasspath​(org.gradle.api.file.FileCollection classpath)  
      void setDestinationDir​(java.io.File destinationDir)
      Deprecated.
      Use getDestinationDir() methods
      void setGosuClasspath​(org.gradle.api.file.FileCollection gosuClasspath)  
      void setGosuDocOptions​(GosuDocOptions gosuDocOptions)  
      void setTitle​(java.lang.String title)  

      • Methods inherited from class org.gradle.api.tasks.SourceTask

        exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

      • Methods inherited from class org.gradle.api.internal.ConventionTask

        conventionMapping, conventionMapping, getConventionMapping

      • 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 Detail

      • GosuDoc

        public GosuDoc()

    • Method Detail

      • getExecOperations

        @Inject
protected abstract org.gradle.process.ExecOperations getExecOperations()

      • getFileSystemOperations

        @Inject
protected abstract org.gradle.api.file.FileSystemOperations getFileSystemOperations()

      • getObjectFactory

        @Inject
protected abstract org.gradle.api.model.ObjectFactory getObjectFactory()

      • getLayout

        @Inject
protected abstract org.gradle.api.file.ProjectLayout getLayout()

      • getSource

        @PathSensitive(RELATIVE)
public org.gradle.api.file.FileTree getSource()
        Overrides:
        getSource in class org.gradle.api.tasks.SourceTask

      • getDestinationDir

        @OutputDirectory
public org.gradle.api.file.DirectoryProperty getDestinationDir()
        Returns:
        the target directory to generate the API documentation.

      • setDestinationDir

        @Deprecated
public void setDestinationDir​(java.io.File destinationDir)
        Deprecated.
        Use getDestinationDir() methods
        See Also:
        DirectoryProperty

      • getClasspath

        @Classpath
@InputFiles
public org.gradle.api.file.FileCollection getClasspath()

        Returns the classpath to use to locate classes referenced by the documented source.

        Returns:
        The classpath.

      • setClasspath

        public void setClasspath​(org.gradle.api.file.FileCollection classpath)

      • getGosuClasspath

        @Classpath
@InputFiles
public org.gradle.api.file.ConfigurableFileCollection getGosuClasspath()
        Returns the classpath to use to load the gosudoc tool.
        Specified by:
        getGosuClasspath in interface InfersGosuRuntime
        Returns:
        the classpath to use to load the gosudoc tool.

      • setGosuClasspath

        public void setGosuClasspath​(org.gradle.api.file.FileCollection gosuClasspath)
        Specified by:
        setGosuClasspath in interface InfersGosuRuntime

      • getGosuDocOptions

        public GosuDocOptions getGosuDocOptions()
        Returns the gosudoc generation options.
        Returns:
        the gosudoc options

      • setGosuDocOptions

        public void setGosuDocOptions​(GosuDocOptions gosuDocOptions)

      • getTitle

        @Input
@Optional
public java.lang.String getTitle()
        Returns the documentation title.
        Returns:
        the documentation title.

      • setTitle

        public void setTitle​(java.lang.String title)

      • generate

        protected void generate()