...
----
Run the `javadoc` task.

[listing.terminal.sample-command]
----
\$ ./gradlew javadoc

BUILD SUCCESSFUL
2 actionable tasks: 1 executed, 1 up-to-date
----

You can view the generated `javadoc` files by opening the HTML file located at `${subprojectName.raw}/build/docs/javadoc/index.html`.

You can also generate a Javadoc JAR for your library:

.build.gradle.kts
[source.multi-language-sample,kotlin]
----

    def "can build javadoc from modularized java"() {
        when:
        succeeds("javadoc")
        then:
        file("test/build/docs/javadoc/test/test/Test.html").assertExists()
        file("test/build/docs/javadoc/test/test/internal/TestInternal.html").assertExists()
    }

    @Issue("https://github.com/gradle/gradle/issues/19726")
    def "can build javadoc from modularized java with exclusions"() {

        result.assertTasksExecuted(':a:collectJavadoc', ':a:javadoc', ':a:javadocJar', ':a:classes', ':a:compileJava', ':a:processResources', ':b:javadoc', ':b:javadocJar', ':b:classes', ':b:compileJava', ':b:processResources', ':c:compileJava')
        output('javadocs') == ['a-javadoc.jar', 'b-javadoc.jar'] as Set
        jar('javadocs/a-javadoc.jar').assertContainsFile('ToolImpl.html')

    private final File file;
    private final File javadoc;
    private final File source;

    private final ModuleVersionIdentifier identifier;
    private final GradleModuleVersion moduleVersion;

    private final boolean resolved;
    private final DefaultEclipseComponentSelector attemptedSelector;

        succeeds("javadoc")
        then:
        file("build/docs/javadoc/index.html").text.contains("<title>? ? ? ?</title>")
        file("build/tmp/javadoc/javadoc.options").text.contains("-windowtitle '? ? ? ?'")
        result.assertTaskNotSkipped(":javadoc")

        when:
        executer.withBuildJvmOpts("-Dfile.encoding=UTF-8")
        succeeds("javadoc")
        then:

        this.classes = classes;
    }

    /**
     * A set of Jar files or directories containing javadoc.
     */
    public Set<File> getJavadoc() {
        return javadoc;
    }

    public void setJavadoc(Set<File> javadoc) {
        this.javadoc = javadoc;
    }

    /**
     * A set of directories containing sources.
     */
    public Set<File> getSources() {

        this.jarDirectories = jarDirectories;
    }

    /**
     * A set of Jar files or directories containing Javadoc.
     */
    public Set<Path> getJavadoc() {
        return javadoc;
    }

    public void setJavadoc(Set<Path> javadoc) {
        this.javadoc = javadoc;
    }

    /**
     * A set of Jar files or directories containing source code.
     */
    public Set<Path> getSources() {

        consumingModuleInfo('requires moda')
        consumingModuleClass('moda.ModaClass')

        when:
        succeeds ':javadoc'

        then:
        !file('build/docs/javadoc/consumer/package-summary.html').exists()
        file('build/docs/javadoc/consumer/module-summary.html').exists()
    }

            /**
             * This is Javadoc.
             */
            public class Foo {
            }
        """
    }

    def 'javadoc can be cached'() {
        when:
        withBuildCache().run "javadoc"

        then:
        taskIsNotCached()

        when:
        withBuildCache().succeeds 'clean', "javadoc"

        then:
        taskIsCached()
    }

    }

    def "finds broken javadoc links with leading javadoc path component"() {
        given:
        sampleDoc << """
=== Invalid Javadoc Links