P5Doclet
for Proce55ing
P5Doclet ver. 0.1
(C) 長 健太(ABA."Saba")
processing(proce55ing)アプリケーションのアプレット生成用ツールです。processingスケッチブックの'Export to web'と同様の動作をしますが、以下の違いがあります。
- アプレットページやソースコードページ用のテンプレートを利用できます
- アプリケーションの説明文をソースのコメントに書くことができ、説明文はアプレットページに書き込まれます
- processingアプリケーションのAPIドキュメントを生成できます
- doclet(Javadoc)として動作するので、Eclipseに組み込んで利用できます
P5DocletはJ2SDK1.4.2_04のjavadocで動作します。
出力例
ダウンロード
P5Docletはフリーソフトウェアです。
bclasses.jarの生成
最初にprocessingアプレットの基本クラスを含む'bclasses.jar'を生成してください。
'bclasses.jar'を生成するには、processingのスケッチブック(processing.exe)で、
- [File] -> [New]
- [File] -> [Rename] として 'bclasses'と入力
- [File] -> [Export to web]
bclasses.jarは'{processing root}/sketchbook/default/bclasses/applet/bclasses.jar'に生成されます。
Eclipseで使う
- processingアプリケーション用のプロジェクトを生成
(P5 vs Eclipseを参照)
- アプリケーションを書く
- '@p5'タグをコメント内で使うことで出力されるHTMLファイル内に埋め込まれる文字列を指定することができます
- 以下のファイルを'{project home}'にコピー
- applet_template.html - アプレットページのテンプレート
- source_template.html - ソースコードページのテンプレート
- bclasses.jar - processingアプリケーションの基本クラスを含むjarファイル
- このプロジェクトのJavadocを生成
- [Project] -> [Generate Javadoc]
- [Use Custom Doclet] をチェック
- [Doclet name] を 'jp.gr.java_conf.abagames.p5doclet.P5Doclet' にセット
- [Doclet classs path] を '{p5docletのzipを展開したディレクトリ}/p5doclet/p5doclet.jar' にセット
- [Finish] を押す
HTMLファイルとjarファイルは'{project home}/doc/'の下に生成されます。
APIドキュメントを生成したい場合は、
- 'applet_template.html'を編集して'[[javadochtml]]'タグを追加して、APIドキュメントへのリンクを設定
(例 <a href="[[javadochtml]]">API Document</a>)
- Javadocを生成
- [Create Javadoc for members with visibility] の [Package] をチェック
- [Next] を押す
- '-apidoc' を [Extra Javadoc options] に追加
- [Finish] を押す
スケッチブックで使う
- スケッチブックでアプリケーションを書く
- [Export to web] を行う
- 以下のファイルを '{project home}/applet/' にコピー
- applet_template.html - アプレットページのテンプレート
- source_template.html - ソースコードページのテンプレート
- p5doclet.jar - p5docletのjarファイル
- p5doclet.bat - doclet起動用バッチファイル
- 'p5doclet.bat' を編集して 'TARGET_FILE' 変数をjavaファイル名に設定
- 'p5doclet.bat' を起動
HTMLファイルとjarファイルは'{project home}/applet/doc/'の下に生成されます。
コメント
ご意見、ご感想は、cs8k-cyu@asahi-net.or.jpまでお願いします。