*
 * <p>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.
 */
@CacheableTask
public abstract class Groovydoc extends SourceTask {
    private FileCollection groovyClasspath;

                </tr>
            </thead>
            <tr>
                <td>destinationDir</td>
                <td><literal><replaceable>${project.docsDir}</replaceable>/groovydoc</literal></td>
            </tr>
            <tr>
                <td>groovyClasspath</td>
                <td><literal>project.configurations.groovy</literal></td>
            </tr>
            <tr>

class GroovydocTest extends AbstractConventionTaskTest {
    private Groovydoc groovydoc

    def setup() {
        groovydoc = createTask(Groovydoc.class)
    }

    ConventionTask getTask() {
        return groovydoc
    }

    def "link with null URL is invalid"() {
        when:
        groovydoc.link(null, "package")

        then:
        thrown(InvalidUserDataException)
    }

        when:
        succeeds("groovydoc")
        then:
        executedAndNotSkipped(":groovydoc")
        file("build/docs/groovydoc/pkg/A.html").isFile()
        file("build/docs/groovydoc/pkg/B.html").isFile()

        when:
        assert bSource.delete()
        succeeds("groovydoc")
        then:
        executedAndNotSkipped(":groovydoc")
        file("build/docs/groovydoc/pkg/A.html").isFile()

    }

    def "time and version stamp can be enabled"() {
        when:
        buildFile << """
            groovydoc {
              noTimestamp = false
              noVersionStamp = false
            }
        """

        run "groovydoc"

        then:
        def text = file('build/docs/groovydoc/pkg/Thing.html').text
        text =~ GROOVY_DOC_TIMESTAMP_PATTERN
        text =~ GROOVY_DOC_VERSION_PATTERN
    }

        when:
        buildFile << "groovydoc {}"
        run "groovydoc"

        then:
        def doc = file('build/docs/groovydoc/DefaultPackage/Script.html')
        doc.exists()
        doc.text =~ GROOVY_DOC_MAIN_PATTERN
    }

    def "scripts can be disabled"() {
        assumeTrue(supportsScriptsInGroovydoc())
        when:
        buildFile << "groovydoc { processScripts = false }"
        run "groovydoc"

            }
        '''

        when:
        run "groovydoc"
        then:
        indexFile.exists()

        when:
        def snapshot = indexFile.snapshot();
        run "groovydoc"
        then:
        skipped ":groovydoc"
        indexFile.assertHasNotChangedSince(snapshot)

        when:
        buildFile << '''
            groovydoc.link('http://download.oracle.com/javase/1.5.0/docs/api', 'java.')

                        "name", "groovydoc",
                        "classname", "org.codehaus.groovy.ant.Groovydoc"
                ));

                antBuilder.invokeMethod("groovydoc", new Object[]{args, new Closure<Object>(this, this) {
                    public Object doCall(Object ignore) {
                        for (Groovydoc.Link link : links) {

        project.getTasks().register(GROOVYDOC_TASK_NAME, Groovydoc.class, groovyDoc -> {
            groovyDoc.setDescription("Generates Groovydoc API documentation for the main source code.");
            groovyDoc.setGroup(JavaBasePlugin.DOCUMENTATION_GROUP);

            JvmFeatureInternal mainFeature = JavaPluginHelper.getJavaComponent(project).getMainFeature();

}

${mavenCentralRepository()}

dependencies {
    customImplementation "$dependency"
}

task groovydoc(type: Groovydoc) {
    classpath = sourceSets.custom.runtimeClasspath
}

task verify {
    def compileCustomGroovyClasspath = compileCustomGroovy.groovyClasspath
    def groovydocGroovyClasspath = groovydoc.groovyClasspath
    doLast {
        assert compileCustomGroovyClasspath.files.any { it.name == "$jarFile" }