[English Version]

APIドキュメントを作ろう

プログラム書くときにAPIドキュメントがあると便利です。EA1のときはオマケでついてきたんですが、FCSになったらなくなっちゃったので自力で作りましょう。

しかし、EA1(Early Access 1)よりFCS(First Customer Ship)の方が開発者用っぽくなってるのは何故?

簡単に作ろう

取り敢えず使えるものを作るという考えでいくと

javadoc
  -d /midp-fcs/docs/html
  -sourcepath /midp-fcs/src/win32/classes;/midp-fcs/src/share/classes
  java.lang java.util
  javax.microedition.io javax.microedition.lcdui
  javax.microedition.midlet javax.microedition.rms

を実行すると良いです。何をやってるかというと

ということです。では早速と粘り強く打ち込み始めると、途中でピーピー言い始めて打ち込めなくなってしまうでしょう。

こんなときはバッチファイルを使います。上のコマンドを実行するsimpledoc.batを用意しました。ダウンロードして適当なところで

D:\midp-fcs>simpledoc

と叩いて下さい。\midp-fcs\docs\htmlの下にAPIドキュメントが作成されます。あらかじめ\midp-fcs\docs\htmlを作成しておくことを忘れずに。ディレクトリ構造が違う方は適当に修正してお使い下さい。

もうちょっと丁寧に

midp-fcs\build\win32\makefiles\Docs.gmkを見るともっと色々なオプションが指定されてるようです。粘り強く読み解くと

javadoc
    -d /midp-fcs/docs/html
    -sourcepath /midp-fcs/src/win32/classes;/midp-fcs/src/share/classes
    -use
    -J-mx180m
    -doctitle "MID Profile"
    -windowtitle "MID Profile"
    -header "<strong>MID Profile</strong>"
    -bottom "<font size="-1"><a href="mailto:midp-comments@sun.com">Submit a comment or suggestion</a> Version 1.0 of  MID Profile Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries. Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,Palo Alto, California, 94303, U.S.A. All Rights Reserved.</font>" -group "User Interface Package" "javax.microedition.lcdui" -group "Persistence Package" "javax.microedition.rms" -group "Application Lifecycle Package" "javax.microedition.midlet" -group "Networking Package" "javax.microedition.io" -group "Core Packages" "java.*" java.lang java.util javax.microedition.midlet javax.microedition.io javax.microedition.lcdui javax.microedition.rms

としたいようです。オプションの意味を知りたい方は

javadoc -help

と叩いて表示されるのをお読み下さい。

上のコマンドを実行するmidpdoc.batを用意しました。ダウンロードしてお使い下さい。これまたあらかじめ\midp-fcs\docs\htmlを作成しておくことを忘れずに。

CLDCのAPIも

ここまでだと「実際には使えるんだけどAPIドキュメントにはない」という事態がおきます。MIDPのベースとなっているCLDCに含まれるものがドキュメント化されていないからです。これらも含んだAPIドキュメントを作ってみましょう。

まずJava[tm] 2 Platform, Micro Edition CLDC - Sun Community Source Licensingに行って、ページの左側にある“How to Download”からリンクを辿ってj2me_cldc-1_0-src-winsol.zipをダウンロードします。

ダウンロードしたzipファイルを適当なディレクトリに展開します。ここではD:\j2me_cldc以下に展開したとしましょう。

そうしたら上のコマンドに

ということをすれば良いです。そうしたものがcldcdoc.batです。ダウンロードしてお使い下さい。くどくなりましたがあらかじめ\midp-fcs\docs\htmlを作成しておくことを忘れずに。


前の項目へ次の項目へ
「MIDPで遊ぼう!」のページへ
せぎてつ伝言板
このページの感想をどうぞ!
お名前(匿名OK):

メールアドレス:
最終更新日 : 2000年10月7日(土)
tetsu@segi.org