Java maven plugin: javadoc

javadoc lets you produce API documentation for your code.

Documentation

official docs	https://maven.apache.org/plugins/maven-javadoc-plugin/
official 'usage' page	https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html
official configuration options	https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html
personal javadoc notes	java javadoc

javadoc-3

Usage

mvn javadoc:javadoc  # outputs in target/site/apidocs/

Configuration

pom.xml configuration

<project ...>
    <!-- dependency -->
    <dependencies>
        <dependency>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.1.0</version>
        </dependency>
    </dependencies>

    <!-- runner -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Build Docs

mvn javadoc:javadoc  # build javadocs