Class Groovydoc

  • All Implemented Interfaces:
    Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, PatternFilterable, org.gradle.util.Configurable<Task>

    @CacheableTask
    public class Groovydoc
    extends SourceTask

    Generates HTML API documentation for Groovy source, and optionally, Java source.

    This task uses Groovy's Groovydoc tool to generate the API documentation. Please note that the Groovydoc tool has some limitations at the moment. The version of the Groovydoc that is used, is the one from the Groovy dependency defined in the build script.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Groovydoc.Link
      A Link class represent a link between groovydoc/javadoc output and url.
      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        Task.Namer
    • Constructor Summary

      Constructors 
      Constructor Description
      Groovydoc()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void generate()  
      org.gradle.api.internal.tasks.AntGroovydoc getAntGroovydoc()  
      FileCollection getClasspath()
      Returns the classpath used to locate classes referenced by the documented sources.
      File getDestinationDir()
      Returns the directory to generate the documentation into.
      String getDocTitle()
      Returns the title for the package index(first) page.
      String getFooter()
      Returns the HTML footer for each page.
      FileCollection getGroovyClasspath()
      Returns the classpath containing the Groovy library to be used.
      String getHeader()
      Returns the HTML header for each page.
      Set<Groovydoc.Link> getLinks()
      Returns the links to groovydoc/javadoc output at the given URL.
      TextResource getOverviewText()
      Returns a HTML text to be used for overview documentation.
      FileTree getSource()
      Returns the source for this task, after the include and exclude patterns have been applied.
      String getWindowTitle()
      Returns the browser window title for the documentation.
      boolean isIncludePrivate()
      Returns whether to include all classes and members (i.e.
      boolean isNoTimestamp()
      Returns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      boolean isNoVersionStamp()
      Returns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      boolean isUse()
      Returns whether to create class and package usage pages.
      void link​(String url, String... packages)
      Add links to groovydoc/javadoc output at the given URL.
      void setAntGroovydoc​(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc)  
      void setClasspath​(FileCollection classpath)
      Sets the classpath used to locate classes referenced by the documented sources.
      void setDestinationDir​(File destinationDir)
      Sets the directory to generate the documentation into.
      void setDocTitle​(String docTitle)
      Sets title for the package index(first) page (optional).
      void setFooter​(String footer)
      Sets footer text for each page (optional).
      void setGroovyClasspath​(FileCollection groovyClasspath)
      Sets the classpath containing the Groovy library to be used.
      void setHeader​(String header)
      Sets header text for each page (optional).
      void setIncludePrivate​(boolean includePrivate)
      Sets whether to include all classes and members (i.e.
      void setLinks​(Set<Groovydoc.Link> links)
      Sets links to groovydoc/javadoc output at the given URL.
      void setNoTimestamp​(boolean noTimestamp)
      Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      void setNoVersionStamp​(boolean noVersionStamp)
      Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      void setOverviewText​(TextResource overviewText)
      Sets a HTML text to be used for overview documentation (optional).
      void setUse​(boolean use)
      Sets whether to create class and package usage pages.
      void setWindowTitle​(String windowTitle)
      Sets the browser window title for the documentation.
      • Methods inherited from class org.gradle.api.internal.ConventionTask

        conventionMapping, conventionMapping, getConventionMapping
      • Methods inherited from class org.gradle.api.internal.AbstractTask

        addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
    • Constructor Detail

      • Groovydoc

        public Groovydoc()
    • Method Detail

      • generate

        protected void generate()
      • getSource

        @PathSensitive(RELATIVE)
        public FileTree getSource()
        Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
        Overrides:
        getSource in class SourceTask
        Returns:
        The source.
      • getDestinationDir

        @OutputDirectory
        public File getDestinationDir()
        Returns the directory to generate the documentation into.
        Returns:
        The directory to generate the documentation into
      • setDestinationDir

        public void setDestinationDir​(File destinationDir)
        Sets the directory to generate the documentation into.
      • getGroovyClasspath

        @Classpath
        public FileCollection getGroovyClasspath()
        Returns the classpath containing the Groovy library to be used.
        Returns:
        The classpath containing the Groovy library to be used
      • setGroovyClasspath

        public void setGroovyClasspath​(FileCollection groovyClasspath)
        Sets the classpath containing the Groovy library to be used.
      • getClasspath

        @Classpath
        public FileCollection getClasspath()
        Returns the classpath used to locate classes referenced by the documented sources.
        Returns:
        The classpath used to locate classes referenced by the documented sources
      • setClasspath

        public void setClasspath​(FileCollection classpath)
        Sets the classpath used to locate classes referenced by the documented sources.
      • getAntGroovydoc

        @Internal
        public org.gradle.api.internal.tasks.AntGroovydoc getAntGroovydoc()
      • setAntGroovydoc

        public void setAntGroovydoc​(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc)
      • isUse

        @Input
        public boolean isUse()
        Returns whether to create class and package usage pages.
      • setUse

        public void setUse​(boolean use)
        Sets whether to create class and package usage pages.
      • isNoTimestamp

        @Input
        public boolean isNoTimestamp()
        Returns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      • setNoTimestamp

        public void setNoTimestamp​(boolean noTimestamp)
        Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      • isNoVersionStamp

        @Input
        public boolean isNoVersionStamp()
        Returns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      • setNoVersionStamp

        public void setNoVersionStamp​(boolean noVersionStamp)
        Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
      • getWindowTitle

        @Input
        @Optional
        public String getWindowTitle()
        Returns the browser window title for the documentation. Set to null when there is no window title.
      • setWindowTitle

        public void setWindowTitle​(String windowTitle)
        Sets the browser window title for the documentation.
        Parameters:
        windowTitle - A text for the windows title
      • getDocTitle

        @Input
        @Optional
        public String getDocTitle()
        Returns the title for the package index(first) page. Set to null when there is no document title.
      • setDocTitle

        public void setDocTitle​(String docTitle)
        Sets title for the package index(first) page (optional).
        Parameters:
        docTitle - the docTitle as HTML
      • getHeader

        @Input
        @Optional
        public String getHeader()
        Returns the HTML header for each page. Set to null when there is no header.
      • setHeader

        public void setHeader​(String header)
        Sets header text for each page (optional).
        Parameters:
        header - the header as HTML
      • getFooter

        @Input
        @Optional
        public String getFooter()
        Returns the HTML footer for each page. Set to null when there is no footer.
      • setFooter

        public void setFooter​(String footer)
        Sets footer text for each page (optional).
        Parameters:
        footer - the footer as HTML
      • getOverviewText

        @Optional
        public TextResource getOverviewText()
        Returns a HTML text to be used for overview documentation. Set to null when there is no overview text.
      • setOverviewText

        public void setOverviewText​(TextResource overviewText)
        Sets a HTML text to be used for overview documentation (optional).

        Example: overviewText = resources.text.fromFile("/overview.html")

      • isIncludePrivate

        @Input
        public boolean isIncludePrivate()
        Returns whether to include all classes and members (i.e. including private ones).
      • setIncludePrivate

        public void setIncludePrivate​(boolean includePrivate)
        Sets whether to include all classes and members (i.e. including private ones) if set to true.
      • getLinks

        @Input
        public Set<Groovydoc.Link> getLinks()
        Returns the links to groovydoc/javadoc output at the given URL.
      • link

        public void link​(String url,
                         String... packages)
        Add links to groovydoc/javadoc output at the given URL.
        Parameters:
        url - Base URL of external site
        packages - list of package prefixes