読者です 読者をやめる 読者になる 読者になる

javadoc の html を生成したときに一番最初のページに説明を追加したい

java

Java Platform SE 8

例えば下記の「このドキュメントはJava(tm) Platform, Standard EditionのAPI仕様です。」と書かれてるようなところ。

f:id:nise_nabe:20160310114112p:plain

下記ページをみると「概要コメント・ファイル」と呼ぶらしいファイルを使うことができればよいらしい。 通常は -overview でパスを指定するとのこと。

docs.oracle.com

mavenjavadoc を生成している場合は下記ページ「Overview Comment File: overview.html」を参考に、 src/main/javadoc ディレクトリを作って overview.html を作成してその中に記載すれば良いらしい。

Apache Maven Javadoc Plugin – Using Javadoc Resources

一応上記のように src/main/javadoc/overview.html に記載したものが javadoc の最初のページに反映されたが パッケージの下の部分に表示されてしまい、上のほうに表示されなかったのであとで追記するかも。