JenkinsでローカルサーバーにJavaDocを生成するシェルスクリプトを作成したのでメモがてら公開します。
いちいちJavaDoc等の生成コマンドを手動でやるのは面倒なので、自動的に生成するようにしました。
今の時代、JavaDocを生成する機会があるかはわかりませんが……。
※Jenkinsのダウンロードは記載しません。
環境
・Mac
Jenkinsインストール済み、既にAdminでログイン済みであること。
JavaDocのプラグインをインストール済み。
デフォルトで用意されているApacheを利用しています。
実行するシェルスクリプト
定期的に実行に設定して、以下のシェルスクリプトを実行
Macの使用を前提としています。
#!/bin/sh -x
#-xを指定することで、あえてエラーを無視している
# Macで用意されているデフォルトのWebServerフォルダに移行
cd /Library/WebServer/Documents/〇〇
# Masterブランチから作成したいので「master」という名前のフォルダ名を作る
mkdir -p master
#パスを変数で所持する
path=~/Documents/〇〇
path2=~/Documents/〇〇
#Javadoc生成
#-d JavaDocを生成するフォルダ指定
#-subpackages サブパッケージ名を指定、サブパッケージ以下のフォルダを全て読む、「:」で複数のサブパッケージ指定
#-exclude 除外するサブパッケージ名 「:」で複数のサブパッケージ指定
javadoc -d master -private -charset utf-8 -docencoding utf-8 -windowtitle "〇〇APIドキュメント" -sourcepath ${path2}:${path} -subpackages 〇〇:〇〇 -exclude 〇〇:〇〇
ドキュメントの自動生成出来ると便利ですね。他の言語でもDoc生成の仕組みがあれば、javadocの部分を書き換えで動作するとお思います。