ライブラリjarを作成し、他のプロジェクトに提供する場合JavaDocも提供すると色々と都合がよい。
Mavenでライブラリjarを作成するときに一緒にJavaDocのjarも作成してしまおう！
pom.xmlを編集する
pom.xmlにJavaDocのjarを作成する設定を追記する。
<build>
<plugins>
<!-- 他のplugin情報 -->
・・・
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
<configuration>
<show>protected</show>
<!-- <doclint>none</doclint> -->
</configuration>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
ここでのポイントは２点
- confingrationの
<show>protected</show>
これはJavaDocに公開するレベルをprotectedまで対象にする指定。
通常はpublicだけなので公開レベルを広げたければprotectedやprivateを指定する。 - confingrationの
<doclint>none</doclint>
例ではコメントアウトしているが、コメントアウトを外すとJavaDoc生成時にdoclintツールのチェックを行わないという意味になる。（コメントアウトしているのでチェックが行われる）
Java 8以降、Javadocツールにはdoclintが導入されJavadocコメントのHTMLとドキュメントタグに対する様々なチェックを行うが、そのことにより標準に準拠した記載が必要となり、特定のフォーマット違反があるとJavadocの生成が失敗する。
標準に準拠した記載が望まれるが、どうしても準拠出来ない場合はチェックを無効にする。
上記の設定して./mvnw.cmd clean packageや./mvnw.cmd javadoc:javadocでJavaDocのjarを生成しよう。