2. JavaDoc Einbindung

Aus den JavaDoc-Kommentaren im Code lassen sich zwei Artefakte erzeugen:

ein JAR mit JavaDoc, das Entwicklungsumgebungen beim Verwenden der Klassen einblenden können
HTML-Seiten, die sich in die Maven-Site einbinden lassen

Erstellung der javadoc jar Datei

Um mit Maven eine javadoc jar Datei zu erstellen, sind folgende Elemente im Projekt wichtig:

<project>
    <build>
        <plugins>
            <!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-javadoc-plugin -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>${maven.javadoc.plugin}</version>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

    <reporting>
        <plugins>
            <!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-javadoc-plugin -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>${maven.javadoc.plugin}</version>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>javadoc</report>
                        </reports>
                    </reportSet>
                    <reportSet>
                        <id>tests</id>
                        <configuration>
                            <show>private</show>
                        </configuration>
                        <reports>
                            <report>test-javadoc</report>
                        </reports>
                    </reportSet>
                </reportSets>
            </plugin>
        </plugins>
    </reporting>
</project>

Das build plugin sorgt für den Aufruf von javadoc zur Generierung der Dokumentation und zur Erstellung der javadoc jar Datei.

Das reporting plugin sorgt für die Generierung der JavaDoc Webseiten innerhalb der site Dokumentation.